Class: AmzSpApi::ListingsItemsApiModel::ItemOfferByMarketplace

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

Overview

Offer 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 = {}) ⇒ ItemOfferByMarketplace

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 77

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::ListingsItemsApiModel::ItemOfferByMarketplace` 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::ListingsItemsApiModel::ItemOfferByMarketplace`. 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?(:'offer_type')
    self.offer_type = attributes[:'offer_type']
  end

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

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

Instance Attribute Details

#marketplace_id ⇒ Object

Amazon marketplace identifier.



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

def marketplace_id
  @marketplace_id
end

#offer_type ⇒ Object

Type of offer for the listings item.



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

def offer_type
  @offer_type
end

#points ⇒ Object

Returns the value of attribute points.



25
26
27
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 25

def points
  @points
end

#price ⇒ Object

Returns the value of attribute price.



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

def price
  @price
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 50

def self.attribute_map
  {
    :'marketplace_id' => :'marketplaceId',
    :'offer_type' => :'offerType',
    :'price' => :'price',
    :'points' => :'points'
  }
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



173
174
175
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 173

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 60

def self.openapi_types
  {
    :'marketplace_id' => :'Object',
    :'offer_type' => :'Object',
    :'price' => :'Object',
    :'points' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      marketplace_id == o.marketplace_id &&
      offer_type == o.offer_type &&
      price == o.price &&
      points == o.points
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 203

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 272

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 180

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


160
161
162
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



166
167
168
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 166

def hash
  [marketplace_id, offer_type, price, points].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 109

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

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

  if @price.nil?
    invalid_properties.push('invalid value for "price", price 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



248
249
250
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 248

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 254

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



242
243
244
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 242

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



128
129
130
131
132
133
134
135
 
# File 'lib/listings-items-api-model/models/item_offer_by_marketplace.rb', line 128

def valid?
  return false if @marketplace_id.nil?
  return false if @offer_type.nil?
  offer_type_validator = EnumAttributeValidator.new('Object', ['B2C', 'B2B'])
  return false unless offer_type_validator.valid?(@offer_type)
  return false if @price.nil?
  true
end