Class: AmznSpApi::ShipmentInvoicingApiModel::ShipmentItem

Inherits:
Object
  • Object
show all
Defined in:
lib/shipment_invoicing_api_model/models/shipment_item.rb

Overview

The shipment item information required by a seller to issue a shipment invoice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 73

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:serial_numbers)

  self.serial_numbers = attributes[:serial_numbers]
end

Instance Attribute Details

#asin ⇒ Object

The Amazon Standard Identification Number (ASIN) of the item.



16
17
18
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 16

def asin
  @asin
end

#gift_wrap_price ⇒ Object

Returns the value of attribute gift_wrap_price.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def gift_wrap_price
  @gift_wrap_price
end

#item_price ⇒ Object

Returns the value of attribute item_price.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def item_price
  @item_price
end

#order_item_id ⇒ Object

The Amazon-defined identifier for the order item.



22
23
24
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 22

def order_item_id
  @order_item_id
end

#promotion_discount ⇒ Object

Returns the value of attribute promotion_discount.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def promotion_discount
  @promotion_discount
end

#quantity_ordered ⇒ Object

The number of items ordered.



28
29
30
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 28

def quantity_ordered
  @quantity_ordered
end

#seller_sku ⇒ Object

The seller SKU of the item.



19
20
21
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 19

def seller_sku
  @seller_sku
end

#serial_numbers ⇒ Object

Returns the value of attribute serial_numbers.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def serial_numbers
  @serial_numbers
end

#shipping_discount ⇒ Object

Returns the value of attribute shipping_discount.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def shipping_discount
  @shipping_discount
end

#shipping_price ⇒ Object

Returns the value of attribute shipping_price.



30
31
32
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 30

def shipping_price
  @shipping_price
end

#title ⇒ Object

The name of the item.



25
26
27
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 25

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 33

def self.attribute_map
  {
    'asin': :ASIN,
    'seller_sku': :SellerSKU,
    'order_item_id': :OrderItemId,
    'title': :Title,
    'quantity_ordered': :QuantityOrdered,
    'item_price': :ItemPrice,
    'shipping_price': :ShippingPrice,
    'gift_wrap_price': :GiftWrapPrice,
    'shipping_discount': :ShippingDiscount,
    'promotion_discount': :PromotionDiscount,
    'serial_numbers': :SerialNumbers
  }
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



154
155
156
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 154

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 50

def self.openapi_types
  {
    'asin': :Object,
    'seller_sku': :Object,
    'order_item_id': :Object,
    'title': :Object,
    'quantity_ordered': :Object,
    'item_price': :Object,
    'shipping_price': :Object,
    'gift_wrap_price': :Object,
    'shipping_discount': :Object,
    'promotion_discount': :Object,
    'serial_numbers': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 122

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

  self.class == other.class &&
    asin == other.asin &&
    seller_sku == other.seller_sku &&
    order_item_id == other.order_item_id &&
    title == other.title &&
    quantity_ordered == other.quantity_ordered &&
    item_price == other.item_price &&
    shipping_price == other.shipping_price &&
    gift_wrap_price == other.gift_wrap_price &&
    shipping_discount == other.shipping_discount &&
    promotion_discount == other.promotion_discount &&
    serial_numbers == other.serial_numbers
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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 183

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 252

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 161

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


141
142
143
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 147

def hash
  [asin, seller_sku, order_item_id, title, quantity_ordered, item_price, shipping_price, gift_wrap_price, shipping_discount, promotion_discount, serial_numbers].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



110
111
112
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 110

def list_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



228
229
230
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 228

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 234

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



222
223
224
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 222

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



116
117
118
 
# File 'lib/shipment_invoicing_api_model/models/shipment_item.rb', line 116

def valid?
  true
end