Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentOrderItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb

Overview

Item information for a fulfillment order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentOrderItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 82

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

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:per_unit_declared_value)

  self.per_unit_declared_value = attributes[:per_unit_declared_value]
end

Instance Attribute Details

#cancelled_quantity ⇒ Object

Returns the value of attribute cancelled_quantity.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def cancelled_quantity
  @cancelled_quantity
end

#displayable_comment ⇒ Object

Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 27

def displayable_comment
  @displayable_comment
end

#estimated_arrival_date ⇒ Object

Returns the value of attribute estimated_arrival_date.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def estimated_arrival_date
  @estimated_arrival_date
end

#estimated_ship_date ⇒ Object

Returns the value of attribute estimated_ship_date.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def estimated_ship_date
  @estimated_ship_date
end

#fulfillment_network_sku ⇒ Object

Amazon’s fulfillment network SKU of the item.



30
31
32
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 30

def fulfillment_network_sku
  @fulfillment_network_sku
end

#gift_message ⇒ Object

A message to the gift recipient, if applicable.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 24

def gift_message
  @gift_message
end

#order_item_disposition ⇒ Object

Indicates whether the item is sellable or unsellable.



33
34
35
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 33

def order_item_disposition
  @order_item_disposition
end

#per_unit_declared_value ⇒ Object

Returns the value of attribute per_unit_declared_value.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def per_unit_declared_value
  @per_unit_declared_value
end

#per_unit_price ⇒ Object

Returns the value of attribute per_unit_price.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def per_unit_price
  @per_unit_price
end

#per_unit_tax ⇒ Object

Returns the value of attribute per_unit_tax.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def per_unit_tax
  @per_unit_tax
end

#quantity ⇒ Object

Returns the value of attribute quantity.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def quantity
  @quantity
end

#seller_fulfillment_order_item_id ⇒ Object

A fulfillment order item identifier submitted with a call to the createFulfillmentOrder operation.



19
20
21
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 19

def seller_fulfillment_order_item_id
  @seller_fulfillment_order_item_id
end

#seller_sku ⇒ Object

The seller SKU of the item.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 16

def seller_sku
  @seller_sku
end

#unfulfillable_quantity ⇒ Object

Returns the value of attribute unfulfillable_quantity.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 21

def unfulfillable_quantity
  @unfulfillable_quantity
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 36

def self.attribute_map
  {
    'seller_sku': :sellerSku,
    'seller_fulfillment_order_item_id': :sellerFulfillmentOrderItemId,
    'quantity': :quantity,
    'gift_message': :giftMessage,
    'displayable_comment': :displayableComment,
    'fulfillment_network_sku': :fulfillmentNetworkSku,
    'order_item_disposition': :orderItemDisposition,
    'cancelled_quantity': :cancelledQuantity,
    'unfulfillable_quantity': :unfulfillableQuantity,
    'estimated_ship_date': :estimatedShipDate,
    'estimated_arrival_date': :estimatedArrivalDate,
    'per_unit_price': :perUnitPrice,
    'per_unit_tax': :perUnitTax,
    'per_unit_declared_value': :perUnitDeclaredValue
  }
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



189
190
191
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 189

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 56

def self.openapi_types
  {
    'seller_sku': :Object,
    'seller_fulfillment_order_item_id': :Object,
    'quantity': :Object,
    'gift_message': :Object,
    'displayable_comment': :Object,
    'fulfillment_network_sku': :Object,
    'order_item_disposition': :Object,
    'cancelled_quantity': :Object,
    'unfulfillable_quantity': :Object,
    'estimated_ship_date': :Object,
    'estimated_arrival_date': :Object,
    'per_unit_price': :Object,
    'per_unit_tax': :Object,
    'per_unit_declared_value': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 154

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

  self.class == other.class &&
    seller_sku == other.seller_sku &&
    seller_fulfillment_order_item_id == other.seller_fulfillment_order_item_id &&
    quantity == other.quantity &&
    gift_message == other.gift_message &&
    displayable_comment == other.displayable_comment &&
    fulfillment_network_sku == other.fulfillment_network_sku &&
    order_item_disposition == other.order_item_disposition &&
    cancelled_quantity == other.cancelled_quantity &&
    unfulfillable_quantity == other.unfulfillable_quantity &&
    estimated_ship_date == other.estimated_ship_date &&
    estimated_arrival_date == other.estimated_arrival_date &&
    per_unit_price == other.per_unit_price &&
    per_unit_tax == other.per_unit_tax &&
    per_unit_declared_value == other.per_unit_declared_value
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



218
219
220
221
222
223
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
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 218

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 287

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 196

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


176
177
178
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 176

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 182

def hash
  [seller_sku, seller_fulfillment_order_item_id, quantity, gift_message, displayable_comment, fulfillment_network_sku, order_item_disposition, cancelled_quantity, unfulfillable_quantity, estimated_ship_date, estimated_arrival_date, per_unit_price, per_unit_tax, per_unit_declared_value].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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 125

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

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

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

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

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



263
264
265
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 263

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 269

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



257
258
259
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 257

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



142
143
144
145
146
147
148
149
150
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_order_item.rb', line 142

def valid?
  return false if @seller_sku.nil?
  return false if @seller_fulfillment_order_item_id.nil?
  return false if @quantity.nil?
  return false if @cancelled_quantity.nil?
  return false if @unfulfillable_quantity.nil?

  true
end