Class: AmzSpApi::CatalogItemsApiModel::ItemSummaryByMarketplace

Inherits:
Object
  • Object
show all
Defined in:
lib/catalog-items-api-model/models/item_summary_by_marketplace.rb

Overview

Summary details of an Amazon catalog item for the indicated Amazon marketplace.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemSummaryByMarketplace

Initializes the object

Parameters:

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

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
190
191
192
193
194
195
196
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::CatalogItemsApiModel::ItemSummaryByMarketplace` initialize method"
  end

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

  if attributes.key?(:'marketplace_id')
    self.marketplace_id = attributes[:'marketplace_id']
  end

  if attributes.key?(:'brand')
    self.brand = attributes[:'brand']
  end

  if attributes.key?(:'browse_classification')
    self.browse_classification = attributes[:'browse_classification']
  end

  if attributes.key?(:'color')
    self.color = attributes[:'color']
  end

  if attributes.key?(:'item_classification')
    self.item_classification = attributes[:'item_classification']
  end

  if attributes.key?(:'item_name')
    self.item_name = attributes[:'item_name']
  end

  if attributes.key?(:'manufacturer')
    self.manufacturer = attributes[:'manufacturer']
  end

  if attributes.key?(:'model_number')
    self.model_number = attributes[:'model_number']
  end

  if attributes.key?(:'package_quantity')
    self.package_quantity = attributes[:'package_quantity']
  end

  if attributes.key?(:'part_number')
    self.part_number = attributes[:'part_number']
  end

  if attributes.key?(:'size')
    self.size = attributes[:'size']
  end

  if attributes.key?(:'style')
    self.style = attributes[:'style']
  end

  if attributes.key?(:'website_display_group')
    self.website_display_group = attributes[:'website_display_group']
  end

  if attributes.key?(:'website_display_group_name')
    self.website_display_group_name = attributes[:'website_display_group_name']
  end
end

Instance Attribute Details

#brand ⇒ Object

Name of the brand associated with an Amazon catalog item.



21
22
23
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 21

def brand
  @brand
end

#browse_classification ⇒ Object

Returns the value of attribute browse_classification.



23
24
25
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 23

def browse_classification
  @browse_classification
end

#color ⇒ Object

Name of the color associated with an Amazon catalog item.



26
27
28
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 26

def color
  @color
end

#item_classification ⇒ Object

Classification type associated with the Amazon catalog item.



29
30
31
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 29

def item_classification
  @item_classification
end

#item_name ⇒ Object

Name, or title, associated with an Amazon catalog item.



32
33
34
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 32

def item_name
  @item_name
end

#manufacturer ⇒ Object

Name of the manufacturer associated with an Amazon catalog item.



35
36
37
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 35

def manufacturer
  @manufacturer
end

#marketplace_id ⇒ Object

Amazon marketplace identifier.



18
19
20
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 18

def marketplace_id
  @marketplace_id
end

#model_number ⇒ Object

Model number associated with an Amazon catalog item.



38
39
40
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 38

def model_number
  @model_number
end

#package_quantity ⇒ Object

Quantity of an Amazon catalog item in one package.



41
42
43
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 41

def package_quantity
  @package_quantity
end

#part_number ⇒ Object

Part number associated with an Amazon catalog item.



44
45
46
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 44

def part_number
  @part_number
end

#size ⇒ Object

Name of the size associated with an Amazon catalog item.



47
48
49
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 47

def size
  @size
end

#style ⇒ Object

Name of the style associated with an Amazon catalog item.



50
51
52
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 50

def style
  @style
end

#website_display_group ⇒ Object

Identifier of the website display group associated with an Amazon catalog item.



53
54
55
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 53

def website_display_group
  @website_display_group
end

#website_display_group_name ⇒ Object

Display name of the website display group associated with an Amazon catalog item.



56
57
58
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 56

def website_display_group_name
  @website_display_group_name
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 81

def self.attribute_map
  {
    :'marketplace_id' => :'marketplaceId',
    :'brand' => :'brand',
    :'browse_classification' => :'browseClassification',
    :'color' => :'color',
    :'item_classification' => :'itemClassification',
    :'item_name' => :'itemName',
    :'manufacturer' => :'manufacturer',
    :'model_number' => :'modelNumber',
    :'package_quantity' => :'packageQuantity',
    :'part_number' => :'partNumber',
    :'size' => :'size',
    :'style' => :'style',
    :'website_display_group' => :'websiteDisplayGroup',
    :'website_display_group_name' => :'websiteDisplayGroupName'
  }
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



264
265
266
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 101

def self.openapi_types
  {
    :'marketplace_id' => :'Object',
    :'brand' => :'Object',
    :'browse_classification' => :'Object',
    :'color' => :'Object',
    :'item_classification' => :'Object',
    :'item_name' => :'Object',
    :'manufacturer' => :'Object',
    :'model_number' => :'Object',
    :'package_quantity' => :'Object',
    :'part_number' => :'Object',
    :'size' => :'Object',
    :'style' => :'Object',
    :'website_display_group' => :'Object',
    :'website_display_group_name' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      marketplace_id == o.marketplace_id &&
      brand == o.brand &&
      browse_classification == o.browse_classification &&
      color == o.color &&
      item_classification == o.item_classification &&
      item_name == o.item_name &&
      manufacturer == o.manufacturer &&
      model_number == o.model_number &&
      package_quantity == o.package_quantity &&
      part_number == o.part_number &&
      size == o.size &&
      style == o.style &&
      website_display_group == o.website_display_group &&
      website_display_group_name == o.website_display_group_name
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 294

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
    AmzSpApi::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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 363

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 271

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 257

def hash
  [marketplace_id, brand, browse_classification, color, item_classification, item_name, manufacturer, model_number, package_quantity, part_number, size, style, website_display_group, website_display_group_name].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



200
201
202
203
204
205
206
207
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 200

def list_invalid_properties
  invalid_properties = Array.new
  if @marketplace_id.nil?
    invalid_properties.push('invalid value for "marketplace_id", marketplace_id cannot be nil.')
  end

  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



339
340
341
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 345

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



333
334
335
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 333

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



211
212
213
214
215
216
 
# File 'lib/catalog-items-api-model/models/item_summary_by_marketplace.rb', line 211

def valid?
  return false if @marketplace_id.nil?
  item_classification_validator = EnumAttributeValidator.new('Object', ['BASE_PRODUCT', 'OTHER', 'PRODUCT_BUNDLE', 'VARIATION_PARENT'])
  return false unless item_classification_validator.valid?(@item_classification)
  true
end