Class: AmznSpApi::ListingsItemsApiModel::ItemSummaryByMarketplace

Inherits:
Object
  • Object
show all
Defined in:
lib/listings_items_api_model/models/item_summary_by_marketplace.rb

Overview

Summary details of a listings item for an 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

Raises:

  • (ArgumentError) 


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 104

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ListingsItemsApiModel::ItemSummaryByMarketplace` 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::ListingsItemsApiModel::ItemSummaryByMarketplace`. 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.marketplace_id = attributes[:marketplace_id] if attributes.key?(:marketplace_id)

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

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

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

  if attributes.key?(:status) && (value = attributes[:status]).is_a?(Array)
    self.status = value
  end

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

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

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

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

  return unless attributes.key?(:main_image)

  self.main_image = attributes[:main_image]
end

Instance Attribute Details

#asin ⇒ Object

Amazon Standard Identification Number (ASIN) of the listings item.



19
20
21
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 19

def asin
  @asin
end

#condition_type ⇒ Object

Identifies the condition of the listings item.



25
26
27
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 25

def condition_type
  @condition_type
end

#created_date ⇒ Object

Date the listings item was created, in ISO 8601 format.



37
38
39
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 37

def created_date
  @created_date
end

#fn_sku ⇒ Object

Fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item.



31
32
33
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 31

def fn_sku
  @fn_sku
end

#item_name ⇒ Object

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



34
35
36
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 34

def item_name
  @item_name
end

#last_updated_date ⇒ Object

Date the listings item was last updated, in ISO 8601 format.



40
41
42
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 40

def last_updated_date
  @last_updated_date
end

#main_image ⇒ Object

Returns the value of attribute main_image.



42
43
44
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 42

def main_image
  @main_image
end

#marketplace_id ⇒ Object

A marketplace identifier. Identifies the Amazon marketplace for the listings item.



16
17
18
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 16

def marketplace_id
  @marketplace_id
end

#product_type ⇒ Object

The Amazon product type of the listings item.



22
23
24
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 22

def product_type
  @product_type
end

#status ⇒ Object

Statuses that apply to the listings item.



28
29
30
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 28

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 66

def self.attribute_map
  {
    'marketplace_id': :marketplaceId,
    'asin': :asin,
    'product_type': :productType,
    'condition_type': :conditionType,
    'status': :status,
    'fn_sku': :fnSku,
    'item_name': :itemName,
    'created_date': :createdDate,
    'last_updated_date': :lastUpdatedDate,
    'main_image': :mainImage
  }
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



219
220
221
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 219

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 82

def self.openapi_types
  {
    'marketplace_id': :Object,
    'asin': :Object,
    'product_type': :Object,
    'condition_type': :Object,
    'status': :Object,
    'fn_sku': :Object,
    'item_name': :Object,
    'created_date': :Object,
    'last_updated_date': :Object,
    'main_image': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 188

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

  self.class == other.class &&
    marketplace_id == other.marketplace_id &&
    asin == other.asin &&
    product_type == other.product_type &&
    condition_type == other.condition_type &&
    status == other.status &&
    fn_sku == other.fn_sku &&
    item_name == other.item_name &&
    created_date == other.created_date &&
    last_updated_date == other.last_updated_date &&
    main_image == other.main_image
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 248

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::ListingsItemsApiModel.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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 317

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 226

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


206
207
208
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 206

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 212

def hash
  [marketplace_id, asin, product_type, condition_type, status, fn_sku, item_name, created_date, last_updated_date, main_image].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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 141

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

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

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

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

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

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

  invalid_properties.push('invalid value for "last_updated_date", last_updated_date cannot be nil.') if @last_updated_date.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



293
294
295
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 299

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



287
288
289
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 287

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/listings_items_api_model/models/item_summary_by_marketplace.rb', line 162

def valid?
  return false if @marketplace_id.nil?
  return false if @asin.nil?
  return false if @product_type.nil?

  condition_type_validator = EnumAttributeValidator.new('Object', %w[new_new new_open_box new_oem refurbished_refurbished used_like_new used_very_good used_good used_acceptable collectible_like_new collectible_very_good collectible_good collectible_acceptable club_club])
  return false unless condition_type_validator.valid?(@condition_type)
  return false if @status.nil?
  return false if @item_name.nil?
  return false if @created_date.nil?
  return false if @last_updated_date.nil?

  true
end