Class: AmznSpApi::FinancesApiModel::AdjustmentItem

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

Overview

An item in an adjustment to the seller’s account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdjustmentItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 65

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

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

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

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

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

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

  return unless attributes.key?(:asin)

  self.asin = attributes[:asin]
end

Instance Attribute Details

#asin ⇒ Object

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



30
31
32
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 30

def asin
  @asin
end

#fn_sku ⇒ Object

A unique identifier assigned to products stored in and fulfilled from a fulfillment center.



24
25
26
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 24

def fn_sku
  @fn_sku
end

#per_unit_amount ⇒ Object

Returns the value of attribute per_unit_amount.



18
19
20
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 18

def per_unit_amount
  @per_unit_amount
end

#product_description ⇒ Object

A short description of the item.



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

def product_description
  @product_description
end

#quantity ⇒ Object

Represents the number of units in the seller’s inventory when the AdustmentType is FBAInventoryReimbursement.



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

def quantity
  @quantity
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.



21
22
23
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 21

def seller_sku
  @seller_sku
end

#total_amount ⇒ Object

Returns the value of attribute total_amount.



18
19
20
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 18

def total_amount
  @total_amount
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
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 33

def self.attribute_map
  {
    'quantity': :Quantity,
    'per_unit_amount': :PerUnitAmount,
    'total_amount': :TotalAmount,
    'seller_sku': :SellerSKU,
    'fn_sku': :FnSKU,
    'product_description': :ProductDescription,
    'asin': :ASIN
  }
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



134
135
136
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 134

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 59

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 46

def self.openapi_types
  {
    'quantity': :Object,
    'per_unit_amount': :Object,
    'total_amount': :Object,
    'seller_sku': :Object,
    'fn_sku': :Object,
    'product_description': :Object,
    'asin': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 106

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

  self.class == other.class &&
    quantity == other.quantity &&
    per_unit_amount == other.per_unit_amount &&
    total_amount == other.total_amount &&
    seller_sku == other.seller_sku &&
    fn_sku == other.fn_sku &&
    product_description == other.product_description &&
    asin == other.asin
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 163

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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 232

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 141

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


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

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 127

def hash
  [quantity, per_unit_amount, total_amount, seller_sku, fn_sku, product_description, asin].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



94
95
96
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 94

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



208
209
210
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 208

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 214

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



202
203
204
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 202

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



100
101
102
 
# File 'lib/finances_api_model/models/adjustment_item.rb', line 100

def valid?
  true
end