Class: AmzSpApi::VendorOrdersApiModel::OrderItem

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-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



68
69
70
71
72
73
74
75
76
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
106
107
108
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 68

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

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

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

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

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

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

Instance Attribute Details

#amazon_product_identifier ⇒ Object

Amazon Standard Identification Number (ASIN) of an item.



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

def amazon_product_identifier
  @amazon_product_identifier
end

#is_back_order_allowed ⇒ Object

When true, we will accept backorder confirmations for this item.



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

def is_back_order_allowed
  @is_back_order_allowed
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-orders-api-model/models/order_item.rb', line 17

def item_sequence_number
  @item_sequence_number
end

#list_price ⇒ Object

Returns the value of attribute list_price.



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

def list_price
  @list_price
end

#net_cost ⇒ Object

Returns the value of attribute net_cost.



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

def net_cost
  @net_cost
end

#ordered_quantity ⇒ Object

Returns the value of attribute ordered_quantity.



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

def ordered_quantity
  @ordered_quantity
end

#vendor_product_identifier ⇒ Object

The vendor selected product identification of the item.



23
24
25
 
# File 'lib/vendor-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.



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 35

def self.attribute_map
  {
    :'item_sequence_number' => :'itemSequenceNumber',
    :'amazon_product_identifier' => :'amazonProductIdentifier',
    :'vendor_product_identifier' => :'vendorProductIdentifier',
    :'ordered_quantity' => :'orderedQuantity',
    :'is_back_order_allowed' => :'isBackOrderAllowed',
    :'net_cost' => :'netCost',
    :'list_price' => :'listPrice'
  }
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



167
168
169
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 167

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 48

def self.openapi_types
  {
    :'item_sequence_number' => :'Object',
    :'amazon_product_identifier' => :'Object',
    :'vendor_product_identifier' => :'Object',
    :'ordered_quantity' => :'Object',
    :'is_back_order_allowed' => :'Object',
    :'net_cost' => :'Object',
    :'list_price' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_sequence_number == o.item_sequence_number &&
      amazon_product_identifier == o.amazon_product_identifier &&
      vendor_product_identifier == o.vendor_product_identifier &&
      ordered_quantity == o.ordered_quantity &&
      is_back_order_allowed == o.is_back_order_allowed &&
      net_cost == o.net_cost &&
      list_price == o.list_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



197
198
199
200
201
202
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
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 197

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 266

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 174

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


154
155
156
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 160

def hash
  [item_sequence_number, amazon_product_identifier, vendor_product_identifier, ordered_quantity, is_back_order_allowed, net_cost, list_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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 112

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



242
243
244
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 242

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 248

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



236
237
238
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 236

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



131
132
133
134
135
136
 
# File 'lib/vendor-orders-api-model/models/order_item.rb', line 131

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