Class: AmzSpApi::FinancesApiModel::RemovalShipmentAdjustmentEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/finances-api-model/models/removal_shipment_adjustment_event.rb

Overview

A financial adjustment event for FBA liquidated inventory. A positive value indicates money owed to Amazon by the buyer (for example, when the charge was incorrectly calculated as less than it should be). A negative value indicates a full or partial refund owed to the buyer (for example, when the buyer receives damaged items or fewer items than ordered).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RemovalShipmentAdjustmentEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 66

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

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

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

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

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

  if attributes.key?(:'removal_shipment_item_adjustment_list')
    if (value = attributes[:'removal_shipment_item_adjustment_list']).is_a?(Array)
      self.removal_shipment_item_adjustment_list = value
    end
  end
end

Instance Attribute Details

#adjustment_event_id ⇒ Object

The unique identifier for the adjustment event.



20
21
22
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 20

def adjustment_event_id
  @adjustment_event_id
end

#merchant_order_id ⇒ Object

The merchant removal orderId.



23
24
25
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 23

def merchant_order_id
  @merchant_order_id
end

#order_id ⇒ Object

The orderId for shipping inventory.



26
27
28
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 26

def order_id
  @order_id
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



17
18
19
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 17

def posted_date
  @posted_date
end

#removal_shipment_item_adjustment_list ⇒ Object

A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.



32
33
34
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 32

def removal_shipment_item_adjustment_list
  @removal_shipment_item_adjustment_list
end

#transaction_type ⇒ Object

The type of removal order. Possible values: * WHOLESALE_LIQUIDATION.



29
30
31
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 29

def transaction_type
  @transaction_type
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 35

def self.attribute_map
  {
    :'posted_date' => :'PostedDate',
    :'adjustment_event_id' => :'AdjustmentEventId',
    :'merchant_order_id' => :'MerchantOrderId',
    :'order_id' => :'OrderId',
    :'transaction_type' => :'TransactionType',
    :'removal_shipment_item_adjustment_list' => :'RemovalShipmentItemAdjustmentList'
  }
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



147
148
149
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 147

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 59

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 47

def self.openapi_types
  {
    :'posted_date' => :'Object',
    :'adjustment_event_id' => :'Object',
    :'merchant_order_id' => :'Object',
    :'order_id' => :'Object',
    :'transaction_type' => :'Object',
    :'removal_shipment_item_adjustment_list' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      posted_date == o.posted_date &&
      adjustment_event_id == o.adjustment_event_id &&
      merchant_order_id == o.merchant_order_id &&
      order_id == o.order_id &&
      transaction_type == o.transaction_type &&
      removal_shipment_item_adjustment_list == o.removal_shipment_item_adjustment_list
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



177
178
179
180
181
182
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
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 177

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 246

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 154

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


134
135
136
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



140
141
142
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 140

def hash
  [posted_date, adjustment_event_id, merchant_order_id, order_id, transaction_type, removal_shipment_item_adjustment_list].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



108
109
110
111
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  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



222
223
224
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 222

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



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 228

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



216
217
218
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 216

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



115
116
117
 
# File 'lib/finances-api-model/models/removal_shipment_adjustment_event.rb', line 115

def valid?
  true
end