Class: AmznSpApi::MerchantFulfillmentApiModel::Shipment

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/shipment.rb

Overview

The details of a shipment, including the shipment status.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Shipment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
105
106
107
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 66

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

  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.item_list = attributes[:item_list] if attributes.key?(:item_list)

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:last_updated_date)

  self.last_updated_date = attributes[:last_updated_date]
end

Instance Attribute Details

#amazon_order_id ⇒ Object

Returns the value of attribute amazon_order_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def amazon_order_id
  @amazon_order_id
end

#created_date ⇒ Object

Returns the value of attribute created_date.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def created_date
  @created_date
end

#insurance ⇒ Object

Returns the value of attribute insurance.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def insurance
  @insurance
end

#item_list ⇒ Object

Returns the value of attribute item_list.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def item_list
  @item_list
end

#label ⇒ Object

Returns the value of attribute label.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def label
  @label
end

#last_updated_date ⇒ Object

Returns the value of attribute last_updated_date.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def last_updated_date
  @last_updated_date
end

#package_dimensions ⇒ Object

Returns the value of attribute package_dimensions.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def package_dimensions
  @package_dimensions
end

#seller_order_id ⇒ Object

Returns the value of attribute seller_order_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def seller_order_id
  @seller_order_id
end

#ship_from_address ⇒ Object

Returns the value of attribute ship_from_address.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def ship_from_address
  @ship_from_address
end

#ship_to_address ⇒ Object

Returns the value of attribute ship_to_address.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def ship_to_address
  @ship_to_address
end

#shipment_id ⇒ Object

Returns the value of attribute shipment_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def shipment_id
  @shipment_id
end

#shipping_service ⇒ Object

Returns the value of attribute shipping_service.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def shipping_service
  @shipping_service
end

#status ⇒ Object

Returns the value of attribute status.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def status
  @status
end

#tracking_id ⇒ Object

Returns the value of attribute tracking_id.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def tracking_id
  @tracking_id
end

#weight ⇒ Object

Returns the value of attribute weight.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 15

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 18

def self.attribute_map
  {
    'shipment_id': :ShipmentId,
    'amazon_order_id': :AmazonOrderId,
    'seller_order_id': :SellerOrderId,
    'item_list': :ItemList,
    'ship_from_address': :ShipFromAddress,
    'ship_to_address': :ShipToAddress,
    'package_dimensions': :PackageDimensions,
    'weight': :Weight,
    'insurance': :Insurance,
    'shipping_service': :ShippingService,
    'label': :Label,
    'status': :Status,
    'tracking_id': :TrackingId,
    'created_date': :CreatedDate,
    'last_updated_date': :LastUpdatedDate
  }
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



197
198
199
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 197

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 39

def self.openapi_types
  {
    'shipment_id': :Object,
    'amazon_order_id': :Object,
    'seller_order_id': :Object,
    'item_list': :Object,
    'ship_from_address': :Object,
    'ship_to_address': :Object,
    'package_dimensions': :Object,
    'weight': :Object,
    'insurance': :Object,
    'shipping_service': :Object,
    'label': :Object,
    'status': :Object,
    'tracking_id': :Object,
    'created_date': :Object,
    'last_updated_date': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 161

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

  self.class == other.class &&
    shipment_id == other.shipment_id &&
    amazon_order_id == other.amazon_order_id &&
    seller_order_id == other.seller_order_id &&
    item_list == other.item_list &&
    ship_from_address == other.ship_from_address &&
    ship_to_address == other.ship_to_address &&
    package_dimensions == other.package_dimensions &&
    weight == other.weight &&
    insurance == other.insurance &&
    shipping_service == other.shipping_service &&
    label == other.label &&
    status == other.status &&
    tracking_id == other.tracking_id &&
    created_date == other.created_date &&
    last_updated_date == other.last_updated_date
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



226
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
259
260
261
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 226

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 295

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 204

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


184
185
186
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 184

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 190

def hash
  [shipment_id, amazon_order_id, seller_order_id, item_list, ship_from_address, ship_to_address, package_dimensions, weight, insurance, shipping_service, label, status, tracking_id, created_date, last_updated_date].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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 111

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "shipment_id", shipment_id cannot be nil.') if @shipment_id.nil?

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

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

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

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

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

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

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

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

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

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

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

  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



271
272
273
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 271

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 277

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



265
266
267
 
# File 'lib/merchant_fulfillment_api_model/models/shipment.rb', line 265

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



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

def valid?
  return false if @shipment_id.nil?
  return false if @amazon_order_id.nil?
  return false if @item_list.nil?
  return false if @ship_from_address.nil?
  return false if @ship_to_address.nil?
  return false if @package_dimensions.nil?
  return false if @weight.nil?
  return false if @insurance.nil?
  return false if @shipping_service.nil?
  return false if @label.nil?
  return false if @status.nil?
  return false if @created_date.nil?

  true
end