Class: AmznSpApi::FinancesApiModel::ShipmentEvent

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

Overview

A shipment, refund, guarantee claim, or chargeback.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
105
106
107
108
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 71

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:shipment_item_adjustment_list)

  self.shipment_item_adjustment_list = attributes[:shipment_item_adjustment_list]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

An Amazon-defined identifier for an order.



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

def amazon_order_id
  @amazon_order_id
end

#direct_payment_list ⇒ Object

Returns the value of attribute direct_payment_list.



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

def direct_payment_list
  @direct_payment_list
end

#marketplace_name ⇒ Object

The name of the marketplace where the event occurred.



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

def marketplace_name
  @marketplace_name
end

#order_charge_adjustment_list ⇒ Object

Returns the value of attribute order_charge_adjustment_list.



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

def order_charge_adjustment_list
  @order_charge_adjustment_list
end

#order_charge_list ⇒ Object

Returns the value of attribute order_charge_list.



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

def order_charge_list
  @order_charge_list
end

#order_fee_adjustment_list ⇒ Object

Returns the value of attribute order_fee_adjustment_list.



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

def order_fee_adjustment_list
  @order_fee_adjustment_list
end

#order_fee_list ⇒ Object

Returns the value of attribute order_fee_list.



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

def order_fee_list
  @order_fee_list
end

#posted_date ⇒ Object

Returns the value of attribute posted_date.



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

def posted_date
  @posted_date
end

#seller_order_id ⇒ Object

A seller-defined identifier for an order.



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

def seller_order_id
  @seller_order_id
end

#shipment_fee_adjustment_list ⇒ Object

Returns the value of attribute shipment_fee_adjustment_list.



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

def shipment_fee_adjustment_list
  @shipment_fee_adjustment_list
end

#shipment_fee_list ⇒ Object

Returns the value of attribute shipment_fee_list.



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

def shipment_fee_list
  @shipment_fee_list
end

#shipment_item_adjustment_list ⇒ Object

Returns the value of attribute shipment_item_adjustment_list.



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

def shipment_item_adjustment_list
  @shipment_item_adjustment_list
end

#shipment_item_list ⇒ Object

Returns the value of attribute shipment_item_list.



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

def shipment_item_list
  @shipment_item_list
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 27

def self.attribute_map
  {
    'amazon_order_id': :AmazonOrderId,
    'seller_order_id': :SellerOrderId,
    'marketplace_name': :MarketplaceName,
    'order_charge_list': :OrderChargeList,
    'order_charge_adjustment_list': :OrderChargeAdjustmentList,
    'shipment_fee_list': :ShipmentFeeList,
    'shipment_fee_adjustment_list': :ShipmentFeeAdjustmentList,
    'order_fee_list': :OrderFeeList,
    'order_fee_adjustment_list': :OrderFeeAdjustmentList,
    'direct_payment_list': :DirectPaymentList,
    'posted_date': :PostedDate,
    'shipment_item_list': :ShipmentItemList,
    'shipment_item_adjustment_list': :ShipmentItemAdjustmentList
  }
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



158
159
160
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 158

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 46

def self.openapi_types
  {
    'amazon_order_id': :Object,
    'seller_order_id': :Object,
    'marketplace_name': :Object,
    'order_charge_list': :Object,
    'order_charge_adjustment_list': :Object,
    'shipment_fee_list': :Object,
    'shipment_fee_adjustment_list': :Object,
    'order_fee_list': :Object,
    'order_fee_adjustment_list': :Object,
    'direct_payment_list': :Object,
    'posted_date': :Object,
    'shipment_item_list': :Object,
    'shipment_item_adjustment_list': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 124

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

  self.class == other.class &&
    amazon_order_id == other.amazon_order_id &&
    seller_order_id == other.seller_order_id &&
    marketplace_name == other.marketplace_name &&
    order_charge_list == other.order_charge_list &&
    order_charge_adjustment_list == other.order_charge_adjustment_list &&
    shipment_fee_list == other.shipment_fee_list &&
    shipment_fee_adjustment_list == other.shipment_fee_adjustment_list &&
    order_fee_list == other.order_fee_list &&
    order_fee_adjustment_list == other.order_fee_adjustment_list &&
    direct_payment_list == other.direct_payment_list &&
    posted_date == other.posted_date &&
    shipment_item_list == other.shipment_item_list &&
    shipment_item_adjustment_list == other.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



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
219
220
221
222
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 187

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 256

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 165

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


145
146
147
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 151

def hash
  [amazon_order_id, seller_order_id, marketplace_name, order_charge_list, order_charge_adjustment_list, shipment_fee_list, shipment_fee_adjustment_list, order_fee_list, order_fee_adjustment_list, direct_payment_list, posted_date, shipment_item_list, 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



112
113
114
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 112

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



232
233
234
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 232

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 238

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



226
227
228
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 226

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



118
119
120
 
# File 'lib/finances_api_model/models/shipment_event.rb', line 118

def valid?
  true
end