Class: AmznSpApi::FinancesApiModel::ShipmentItem

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

Overview

An item of a shipment, refund, guarantee claim, or chargeback.

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) 


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
109
110
111
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 74

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:cost_of_points_returned)

  self.cost_of_points_returned = attributes[:cost_of_points_returned]
end

Instance Attribute Details

#cost_of_points_granted ⇒ Object

Returns the value of attribute cost_of_points_granted.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def cost_of_points_granted
  @cost_of_points_granted
end

#cost_of_points_returned ⇒ Object

Returns the value of attribute cost_of_points_returned.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def cost_of_points_returned
  @cost_of_points_returned
end

#item_charge_adjustment_list ⇒ Object

Returns the value of attribute item_charge_adjustment_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def item_charge_adjustment_list
  @item_charge_adjustment_list
end

#item_charge_list ⇒ Object

Returns the value of attribute item_charge_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def item_charge_list
  @item_charge_list
end

#item_fee_adjustment_list ⇒ Object

Returns the value of attribute item_fee_adjustment_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def item_fee_adjustment_list
  @item_fee_adjustment_list
end

#item_fee_list ⇒ Object

Returns the value of attribute item_fee_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def item_fee_list
  @item_fee_list
end

#item_tax_withheld_list ⇒ Object

Returns the value of attribute item_tax_withheld_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def item_tax_withheld_list
  @item_tax_withheld_list
end

#order_adjustment_item_id ⇒ Object

An Amazon-defined order adjustment identifier defined for refunds, guarantee claims, and chargeback events.



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

def order_adjustment_item_id
  @order_adjustment_item_id
end

#order_item_id ⇒ Object

An Amazon-defined order item identifier.



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

def order_item_id
  @order_item_id
end

#promotion_adjustment_list ⇒ Object

Returns the value of attribute promotion_adjustment_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def promotion_adjustment_list
  @promotion_adjustment_list
end

#promotion_list ⇒ Object

Returns the value of attribute promotion_list.



27
28
29
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 27

def promotion_list
  @promotion_list
end

#quantity_shipped ⇒ Object

The number of items shipped.



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

def quantity_shipped
  @quantity_shipped
end

#seller_sku ⇒ Object

The seller SKU of the item. The seller SKU is qualified by the seller’s seller ID, which is included with every call to the Selling Partner API.



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

def seller_sku
  @seller_sku
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    'seller_sku': :SellerSKU,
    'order_item_id': :OrderItemId,
    'order_adjustment_item_id': :OrderAdjustmentItemId,
    'quantity_shipped': :QuantityShipped,
    'item_charge_list': :ItemChargeList,
    'item_charge_adjustment_list': :ItemChargeAdjustmentList,
    'item_fee_list': :ItemFeeList,
    'item_fee_adjustment_list': :ItemFeeAdjustmentList,
    'item_tax_withheld_list': :ItemTaxWithheldList,
    'promotion_list': :PromotionList,
    'promotion_adjustment_list': :PromotionAdjustmentList,
    'cost_of_points_granted': :CostOfPointsGranted,
    'cost_of_points_returned': :CostOfPointsReturned
  }
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
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 161

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 68

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    'seller_sku': :Object,
    'order_item_id': :Object,
    'order_adjustment_item_id': :Object,
    'quantity_shipped': :Object,
    'item_charge_list': :Object,
    'item_charge_adjustment_list': :Object,
    'item_fee_list': :Object,
    'item_fee_adjustment_list': :Object,
    'item_tax_withheld_list': :Object,
    'promotion_list': :Object,
    'promotion_adjustment_list': :Object,
    'cost_of_points_granted': :Object,
    'cost_of_points_returned': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 127

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

  self.class == other.class &&
    seller_sku == other.seller_sku &&
    order_item_id == other.order_item_id &&
    order_adjustment_item_id == other.order_adjustment_item_id &&
    quantity_shipped == other.quantity_shipped &&
    item_charge_list == other.item_charge_list &&
    item_charge_adjustment_list == other.item_charge_adjustment_list &&
    item_fee_list == other.item_fee_list &&
    item_fee_adjustment_list == other.item_fee_adjustment_list &&
    item_tax_withheld_list == other.item_tax_withheld_list &&
    promotion_list == other.promotion_list &&
    promotion_adjustment_list == other.promotion_adjustment_list &&
    cost_of_points_granted == other.cost_of_points_granted &&
    cost_of_points_returned == other.cost_of_points_returned
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



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
219
220
221
222
223
224
225
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 190

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 259

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 168

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


148
149
150
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [seller_sku, order_item_id, order_adjustment_item_id, quantity_shipped, item_charge_list, item_charge_adjustment_list, item_fee_list, item_fee_adjustment_list, item_tax_withheld_list, promotion_list, promotion_adjustment_list, cost_of_points_granted, cost_of_points_returned].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



115
116
117
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 115

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



235
236
237
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 241

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



229
230
231
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 229

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



121
122
123
 
# File 'lib/finances_api_model/models/shipment_item.rb', line 121

def valid?
  true
end