Class: AmznSpApi::CatalogItemsApiModel::ItemSearchResults

Inherits:
Object
  • Object
show all
Defined in:
lib/catalog_items_api_model/models/item_search_results.rb

Overview

Items in the Amazon catalog and search related metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemSearchResults

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 50

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::CatalogItemsApiModel::ItemSearchResults` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::CatalogItemsApiModel::ItemSearchResults`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.number_of_results = attributes[:number_of_results] if attributes.key?(:number_of_results)

  self.pagination = attributes[:pagination] if attributes.key?(:pagination)

  self.refinements = attributes[:refinements] if attributes.key?(:refinements)

  return unless attributes.key?(:items)
  return unless (value = attributes[:items]).is_a?(Array)

  self.items = value
end

Instance Attribute Details

#items ⇒ Object

A list of items from the Amazon catalog.



21
22
23
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 21

def items
  @items
end

#number_of_results ⇒ Object

For ‘identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (ASINs) that can be returned and paged through is 1000.



16
17
18
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 16

def number_of_results
  @number_of_results
end

#pagination ⇒ Object

Returns the value of attribute pagination.



18
19
20
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 18

def pagination
  @pagination
end

#refinements ⇒ Object

Returns the value of attribute refinements.



18
19
20
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 18

def refinements
  @refinements
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
30
31
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 24

def self.attribute_map
  {
    'number_of_results': :numberOfResults,
    'pagination': :pagination,
    'refinements': :refinements,
    'items': :items
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



125
126
127
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 125

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



44
45
46
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 44

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 34

def self.openapi_types
  {
    'number_of_results': :Object,
    'pagination': :Object,
    'refinements': :Object,
    'items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



100
101
102
103
104
105
106
107
108
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 100

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    number_of_results == other.number_of_results &&
    pagination == other.pagination &&
    refinements == other.refinements &&
    items == other.items
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 154

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    AmznSpApi::CatalogItemsApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 223

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 132

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


112
113
114
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 112

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



118
119
120
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 118

def hash
  [number_of_results, pagination, refinements, items].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 74

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "number_of_results", number_of_results cannot be nil.') if @number_of_results.nil?

  invalid_properties.push('invalid value for "pagination", pagination cannot be nil.') if @pagination.nil?

  invalid_properties.push('invalid value for "refinements", refinements cannot be nil.') if @refinements.nil?

  invalid_properties.push('invalid value for "items", items cannot be nil.') if @items.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 199

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 205

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



193
194
195
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 193

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



89
90
91
92
93
94
95
96
 
# File 'lib/catalog_items_api_model/models/item_search_results.rb', line 89

def valid?
  return false if @number_of_results.nil?
  return false if @pagination.nil?
  return false if @refinements.nil?
  return false if @items.nil?

  true
end