Class: AmznSpApi::ShipmentInvoicingApiModel::ShipmentDetail

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

Overview

The information required by a selling partner to issue a shipment invoice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 91

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

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:shipment_items)

  self.shipment_items = attributes[:shipment_items]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

The Amazon-defined identifier for the order.



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

def amazon_order_id
  @amazon_order_id
end

#amazon_shipment_id ⇒ Object

The Amazon-defined identifier for the shipment.



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

def amazon_shipment_id
  @amazon_shipment_id
end

#buyer_county ⇒ Object

The county of the buyer.



39
40
41
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 39

def buyer_county
  @buyer_county
end

#buyer_name ⇒ Object

The name of the buyer.



36
37
38
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 36

def buyer_name
  @buyer_name
end

#buyer_tax_info ⇒ Object

Returns the value of attribute buyer_tax_info.



27
28
29
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 27

def buyer_tax_info
  @buyer_tax_info
end

#marketplace_id ⇒ Object

The identifier for the marketplace where the order was placed.



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

def marketplace_id
  @marketplace_id
end

#marketplace_tax_info ⇒ Object

Returns the value of attribute marketplace_tax_info.



27
28
29
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 27

def marketplace_tax_info
  @marketplace_tax_info
end

#payment_method_details ⇒ Object

Returns the value of attribute payment_method_details.



27
28
29
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 27

def payment_method_details
  @payment_method_details
end

#purchase_date ⇒ Object

The date and time when the order was created.



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

def purchase_date
  @purchase_date
end

#seller_display_name ⇒ Object

The seller’s friendly name registered in the marketplace.



42
43
44
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 42

def seller_display_name
  @seller_display_name
end

#seller_id ⇒ Object

The seller identifier.



33
34
35
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 33

def seller_id
  @seller_id
end

#shipment_items ⇒ Object

Returns the value of attribute shipment_items.



27
28
29
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 27

def shipment_items
  @shipment_items
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



27
28
29
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 27

def shipping_address
  @shipping_address
end

#warehouse_id ⇒ Object

The Amazon-defined identifier for the warehouse.



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

def warehouse_id
  @warehouse_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    'warehouse_id': :WarehouseId,
    'amazon_order_id': :AmazonOrderId,
    'amazon_shipment_id': :AmazonShipmentId,
    'purchase_date': :PurchaseDate,
    'shipping_address': :ShippingAddress,
    'payment_method_details': :PaymentMethodDetails,
    'marketplace_id': :MarketplaceId,
    'seller_id': :SellerId,
    'buyer_name': :BuyerName,
    'buyer_county': :BuyerCounty,
    'buyer_tax_info': :BuyerTaxInfo,
    'marketplace_tax_info': :MarketplaceTaxInfo,
    'seller_display_name': :SellerDisplayName,
    'shipment_items': :ShipmentItems
  }
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



181
182
183
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 65

def self.openapi_types
  {
    'warehouse_id': :Object,
    'amazon_order_id': :Object,
    'amazon_shipment_id': :Object,
    'purchase_date': :Object,
    'shipping_address': :Object,
    'payment_method_details': :Object,
    'marketplace_id': :Object,
    'seller_id': :Object,
    'buyer_name': :Object,
    'buyer_county': :Object,
    'buyer_tax_info': :Object,
    'marketplace_tax_info': :Object,
    'seller_display_name': :Object,
    'shipment_items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 146

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

  self.class == other.class &&
    warehouse_id == other.warehouse_id &&
    amazon_order_id == other.amazon_order_id &&
    amazon_shipment_id == other.amazon_shipment_id &&
    purchase_date == other.purchase_date &&
    shipping_address == other.shipping_address &&
    payment_method_details == other.payment_method_details &&
    marketplace_id == other.marketplace_id &&
    seller_id == other.seller_id &&
    buyer_name == other.buyer_name &&
    buyer_county == other.buyer_county &&
    buyer_tax_info == other.buyer_tax_info &&
    marketplace_tax_info == other.marketplace_tax_info &&
    seller_display_name == other.seller_display_name &&
    shipment_items == other.shipment_items
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 210

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 279

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 188

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


168
169
170
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 174

def hash
  [warehouse_id, amazon_order_id, amazon_shipment_id, purchase_date, shipping_address, payment_method_details, marketplace_id, seller_id, buyer_name, buyer_county, buyer_tax_info, marketplace_tax_info, seller_display_name, shipment_items].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



134
135
136
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 134

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



255
256
257
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 255

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 261

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



249
250
251
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 249

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



140
141
142
 
# File 'lib/shipment_invoicing_api_model/models/shipment_detail.rb', line 140

def valid?
  true
end