Class: AmzSpApi::VendorShipmentsApiModel::ShipmentConfirmation

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-shipments-api-model/models/shipment_confirmation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentConfirmation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
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
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amazon_reference_number ⇒ Object

The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments when you submit a routing request. This field is mandatory for Collect/WePay shipments.



31
32
33
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 31

def amazon_reference_number
  @amazon_reference_number
end

#cartons ⇒ Object

A list of the cartons in this shipment.



56
57
58
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 56

def cartons
  @cartons
end

#estimated_delivery_date ⇒ Object

The date and time on which the shipment is expected to reach buyer’s warehouse. It needs to be an estimate based on the average transit time between ship from location and the destination. The exact appointment time will be provided by the buyer and is potentially not known when creating the shipment confirmation.



40
41
42
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 40

def estimated_delivery_date
  @estimated_delivery_date
end

#import_details ⇒ Object

Returns the value of attribute import_details.



50
51
52
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 50

def import_details
  @import_details
end

#pallets ⇒ Object

A list of the pallets in this shipment.



59
60
61
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 59

def pallets
  @pallets
end

#selling_party ⇒ Object

Returns the value of attribute selling_party.



42
43
44
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 42

def selling_party
  @selling_party
end

#ship_from_party ⇒ Object

Returns the value of attribute ship_from_party.



44
45
46
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 44

def ship_from_party
  @ship_from_party
end

#ship_to_party ⇒ Object

Returns the value of attribute ship_to_party.



46
47
48
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 46

def ship_to_party
  @ship_to_party
end

#shipment_confirmation_date ⇒ Object

Date on which the shipment confirmation was submitted.



34
35
36
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 34

def shipment_confirmation_date
  @shipment_confirmation_date
end

#shipment_confirmation_type ⇒ Object

Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation.



20
21
22
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 20

def shipment_confirmation_type
  @shipment_confirmation_type
end

#shipment_identifier ⇒ Object

Unique shipment ID (not used over the last 365 days).



17
18
19
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 17

def shipment_identifier
  @shipment_identifier
end

#shipment_measurements ⇒ Object

Returns the value of attribute shipment_measurements.



48
49
50
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 48

def shipment_measurements
  @shipment_measurements
end

#shipment_structure ⇒ Object

Shipment hierarchical structure.



26
27
28
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 26

def shipment_structure
  @shipment_structure
end

#shipment_type ⇒ Object

The type of shipment.



23
24
25
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 23

def shipment_type
  @shipment_type
end

#shipped_date ⇒ Object

The date and time of the departure of the shipment from the vendor’s location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.



37
38
39
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 37

def shipped_date
  @shipped_date
end

#shipped_items ⇒ Object

A list of the items in this shipment and their associated details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.



53
54
55
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 53

def shipped_items
  @shipped_items
end

#transportation_details ⇒ Object

Returns the value of attribute transportation_details.



28
29
30
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 28

def transportation_details
  @transportation_details
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 84

def self.attribute_map
  {
    :'shipment_identifier' => :'shipmentIdentifier',
    :'shipment_confirmation_type' => :'shipmentConfirmationType',
    :'shipment_type' => :'shipmentType',
    :'shipment_structure' => :'shipmentStructure',
    :'transportation_details' => :'transportationDetails',
    :'amazon_reference_number' => :'amazonReferenceNumber',
    :'shipment_confirmation_date' => :'shipmentConfirmationDate',
    :'shipped_date' => :'shippedDate',
    :'estimated_delivery_date' => :'estimatedDeliveryDate',
    :'selling_party' => :'sellingParty',
    :'ship_from_party' => :'shipFromParty',
    :'ship_to_party' => :'shipToParty',
    :'shipment_measurements' => :'shipmentMeasurements',
    :'import_details' => :'importDetails',
    :'shipped_items' => :'shippedItems',
    :'cartons' => :'cartons',
    :'pallets' => :'pallets'
  }
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



348
349
350
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 348

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 107

def self.openapi_types
  {
    :'shipment_identifier' => :'Object',
    :'shipment_confirmation_type' => :'Object',
    :'shipment_type' => :'Object',
    :'shipment_structure' => :'Object',
    :'transportation_details' => :'Object',
    :'amazon_reference_number' => :'Object',
    :'shipment_confirmation_date' => :'Object',
    :'shipped_date' => :'Object',
    :'estimated_delivery_date' => :'Object',
    :'selling_party' => :'Object',
    :'ship_from_party' => :'Object',
    :'ship_to_party' => :'Object',
    :'shipment_measurements' => :'Object',
    :'import_details' => :'Object',
    :'shipped_items' => :'Object',
    :'cartons' => :'Object',
    :'pallets' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      shipment_identifier == o.shipment_identifier &&
      shipment_confirmation_type == o.shipment_confirmation_type &&
      shipment_type == o.shipment_type &&
      shipment_structure == o.shipment_structure &&
      transportation_details == o.transportation_details &&
      amazon_reference_number == o.amazon_reference_number &&
      shipment_confirmation_date == o.shipment_confirmation_date &&
      shipped_date == o.shipped_date &&
      estimated_delivery_date == o.estimated_delivery_date &&
      selling_party == o.selling_party &&
      ship_from_party == o.ship_from_party &&
      ship_to_party == o.ship_to_party &&
      shipment_measurements == o.shipment_measurements &&
      import_details == o.import_details &&
      shipped_items == o.shipped_items &&
      cartons == o.cartons &&
      pallets == o.pallets
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 378

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 447

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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 355

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


335
336
337
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 335

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



341
342
343
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 341

def hash
  [shipment_identifier, shipment_confirmation_type, shipment_type, shipment_structure, transportation_details, amazon_reference_number, shipment_confirmation_date, shipped_date, estimated_delivery_date, selling_party, ship_from_party, ship_to_party, shipment_measurements, import_details, shipped_items, cartons, pallets].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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 227

def list_invalid_properties
  invalid_properties = Array.new
  if @shipment_identifier.nil?
    invalid_properties.push('invalid value for "shipment_identifier", shipment_identifier cannot be nil.')
  end

  if @shipment_confirmation_type.nil?
    invalid_properties.push('invalid value for "shipment_confirmation_type", shipment_confirmation_type cannot be nil.')
  end

  if @shipment_confirmation_date.nil?
    invalid_properties.push('invalid value for "shipment_confirmation_date", shipment_confirmation_date cannot be nil.')
  end

  if @selling_party.nil?
    invalid_properties.push('invalid value for "selling_party", selling_party cannot be nil.')
  end

  if @ship_from_party.nil?
    invalid_properties.push('invalid value for "ship_from_party", ship_from_party cannot be nil.')
  end

  if @ship_to_party.nil?
    invalid_properties.push('invalid value for "ship_to_party", ship_to_party cannot be nil.')
  end

  if @shipped_items.nil?
    invalid_properties.push('invalid value for "shipped_items", shipped_items cannot be nil.')
  end

  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



423
424
425
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 423

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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 429

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



417
418
419
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 417

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/vendor-shipments-api-model/models/shipment_confirmation.rb', line 262

def valid?
  return false if @shipment_identifier.nil?
  return false if @shipment_confirmation_type.nil?
  shipment_confirmation_type_validator = EnumAttributeValidator.new('Object', ['Original', 'Replace'])
  return false unless shipment_confirmation_type_validator.valid?(@shipment_confirmation_type)
  shipment_type_validator = EnumAttributeValidator.new('Object', ['TruckLoad', 'LessThanTruckLoad', 'SmallParcel'])
  return false unless shipment_type_validator.valid?(@shipment_type)
  shipment_structure_validator = EnumAttributeValidator.new('Object', ['PalletizedAssortmentCase', 'LooseAssortmentCase', 'PalletOfItems', 'PalletizedStandardCase', 'LooseStandardCase', 'MasterPallet', 'MasterCase'])
  return false unless shipment_structure_validator.valid?(@shipment_structure)
  return false if @shipment_confirmation_date.nil?
  return false if @selling_party.nil?
  return false if @ship_from_party.nil?
  return false if @ship_to_party.nil?
  return false if @shipped_items.nil?
  true
end