Class: AmzSpApi::VendorDirectFulfillmentOrdersApiModel::OrderItem

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 80

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#buyer_product_identifier ⇒ Object

Buyer’s standard identification number (ASIN) of an item.



20
21
22
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 20

def buyer_product_identifier
  @buyer_product_identifier
end

#gift_details ⇒ Object

Returns the value of attribute gift_details.



32
33
34
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 32

def gift_details
  @gift_details
end

#item_sequence_number ⇒ Object

Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.



17
18
19
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 17

def item_sequence_number
  @item_sequence_number
end

#net_price ⇒ Object

Returns the value of attribute net_price.



34
35
36
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 34

def net_price
  @net_price
end

#ordered_quantity ⇒ Object

Returns the value of attribute ordered_quantity.



28
29
30
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 28

def ordered_quantity
  @ordered_quantity
end

#scheduled_delivery_shipment ⇒ Object

Returns the value of attribute scheduled_delivery_shipment.



30
31
32
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 30

def scheduled_delivery_shipment
  @scheduled_delivery_shipment
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



36
37
38
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 36

def tax_details
  @tax_details
end

#title ⇒ Object

Title for the item.



26
27
28
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 26

def title
  @title
end

#total_price ⇒ Object

Returns the value of attribute total_price.



38
39
40
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 38

def total_price
  @total_price
end

#vendor_product_identifier ⇒ Object

The vendor selected product identification of the item.



23
24
25
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 23

def vendor_product_identifier
  @vendor_product_identifier
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 41

def self.attribute_map
  {
    :'item_sequence_number' => :'itemSequenceNumber',
    :'buyer_product_identifier' => :'buyerProductIdentifier',
    :'vendor_product_identifier' => :'vendorProductIdentifier',
    :'title' => :'title',
    :'ordered_quantity' => :'orderedQuantity',
    :'scheduled_delivery_shipment' => :'scheduledDeliveryShipment',
    :'gift_details' => :'giftDetails',
    :'net_price' => :'netPrice',
    :'tax_details' => :'taxDetails',
    :'total_price' => :'totalPrice'
  }
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



194
195
196
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 194

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 57

def self.openapi_types
  {
    :'item_sequence_number' => :'Object',
    :'buyer_product_identifier' => :'Object',
    :'vendor_product_identifier' => :'Object',
    :'title' => :'Object',
    :'ordered_quantity' => :'Object',
    :'scheduled_delivery_shipment' => :'Object',
    :'gift_details' => :'Object',
    :'net_price' => :'Object',
    :'tax_details' => :'Object',
    :'total_price' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_sequence_number == o.item_sequence_number &&
      buyer_product_identifier == o.buyer_product_identifier &&
      vendor_product_identifier == o.vendor_product_identifier &&
      title == o.title &&
      ordered_quantity == o.ordered_quantity &&
      scheduled_delivery_shipment == o.scheduled_delivery_shipment &&
      gift_details == o.gift_details &&
      net_price == o.net_price &&
      tax_details == o.tax_details &&
      total_price == o.total_price
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 224

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 293

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 201

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


181
182
183
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 187

def hash
  [item_sequence_number, buyer_product_identifier, vendor_product_identifier, title, ordered_quantity, scheduled_delivery_shipment, gift_details, net_price, tax_details, total_price].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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 136

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

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

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



269
270
271
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 275

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



263
264
265
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 263

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



155
156
157
158
159
160
 
# File 'lib/vendor-direct-fulfillment-orders-api-model/models/order_item.rb', line 155

def valid?
  return false if @item_sequence_number.nil?
  return false if @ordered_quantity.nil?
  return false if @net_price.nil?
  true
end