Class: AmzSpApi::FulfillmentOutboundApiModel::CreateFulfillmentOrderItem

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb

Overview

Item information for creating a fulfillment order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFulfillmentOrderItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 78

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#displayable_comment ⇒ Object

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



29
30
31
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 29

def displayable_comment
  @displayable_comment
end

#fulfillment_network_sku ⇒ Object

Amazon’s fulfillment network SKU of the item.



32
33
34
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 32

def fulfillment_network_sku
  @fulfillment_network_sku
end

#gift_message ⇒ Object

A message to the gift recipient, if applicable.



26
27
28
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 26

def gift_message
  @gift_message
end

#per_unit_declared_value ⇒ Object

Returns the value of attribute per_unit_declared_value.



34
35
36
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 34

def per_unit_declared_value
  @per_unit_declared_value
end

#per_unit_price ⇒ Object

Returns the value of attribute per_unit_price.



36
37
38
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 36

def per_unit_price
  @per_unit_price
end

#per_unit_tax ⇒ Object

Returns the value of attribute per_unit_tax.



38
39
40
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 38

def per_unit_tax
  @per_unit_tax
end

#quantity ⇒ Object

Returns the value of attribute quantity.



23
24
25
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 23

def quantity
  @quantity
end

#seller_fulfillment_order_item_id ⇒ Object

A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same SellerSKU. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values.



21
22
23
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 21

def seller_fulfillment_order_item_id
  @seller_fulfillment_order_item_id
end

#seller_sku ⇒ Object

The seller SKU of the item.



18
19
20
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 18

def seller_sku
  @seller_sku
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
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 41

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',
    :'per_unit_declared_value' => :'perUnitDeclaredValue',
    :'per_unit_price' => :'perUnitPrice',
    :'per_unit_tax' => :'perUnitTax'
  }
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



187
188
189
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 187

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 71

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
 
# File 'lib/fulfillment-outbound-api-model/models/create_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',
    :'per_unit_declared_value' => :'Object',
    :'per_unit_price' => :'Object',
    :'per_unit_tax' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      seller_sku == o.seller_sku &&
      seller_fulfillment_order_item_id == o.seller_fulfillment_order_item_id &&
      quantity == o.quantity &&
      gift_message == o.gift_message &&
      displayable_comment == o.displayable_comment &&
      fulfillment_network_sku == o.fulfillment_network_sku &&
      per_unit_declared_value == o.per_unit_declared_value &&
      per_unit_price == o.per_unit_price &&
      per_unit_tax == o.per_unit_tax
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



217
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
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 217

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 286

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 194

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


174
175
176
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 180

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 130

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

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

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



262
263
264
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 262

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 268

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



256
257
258
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 256

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



149
150
151
152
153
154
 
# File 'lib/fulfillment-outbound-api-model/models/create_fulfillment_order_item.rb', line 149

def valid?
  return false if @seller_sku.nil?
  return false if @seller_fulfillment_order_item_id.nil?
  return false if @quantity.nil?
  true
end