Class: AmzSpApi::VendorDirectFulfillmentShippingApiModel::Container

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Container

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#carrier ⇒ Object

Carrier required for EU VOC vendors only.



38
39
40
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 38

def carrier
  @carrier
end

#container_identifier ⇒ Object

The container identifier.



20
21
22
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 20

def container_identifier
  @container_identifier
end

#container_sequence_number ⇒ Object

An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.



41
42
43
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 41

def container_sequence_number
  @container_sequence_number
end

#container_type ⇒ Object

The type of container.



17
18
19
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 17

def container_type
  @container_type
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



43
44
45
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 43

def dimensions
  @dimensions
end

#manifest_date ⇒ Object

The date of the manifest.



29
30
31
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 29

def manifest_date
  @manifest_date
end

#manifest_id ⇒ Object

The manifest identifier.



26
27
28
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 26

def manifest_id
  @manifest_id
end

#packed_items ⇒ Object

A list of packed items.



48
49
50
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 48

def packed_items
  @packed_items
end

#scac_code ⇒ Object

SCAC code required for NA VOC vendors only.



35
36
37
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 35

def scac_code
  @scac_code
end

#ship_method ⇒ Object

The shipment method.



32
33
34
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 32

def ship_method
  @ship_method
end

#tracking_number ⇒ Object

The tracking number.



23
24
25
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 23

def tracking_number
  @tracking_number
end

#weight ⇒ Object

Returns the value of attribute weight.



45
46
47
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 45

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 73

def self.attribute_map
  {
    :'container_type' => :'containerType',
    :'container_identifier' => :'containerIdentifier',
    :'tracking_number' => :'trackingNumber',
    :'manifest_id' => :'manifestId',
    :'manifest_date' => :'manifestDate',
    :'ship_method' => :'shipMethod',
    :'scac_code' => :'scacCode',
    :'carrier' => :'carrier',
    :'container_sequence_number' => :'containerSequenceNumber',
    :'dimensions' => :'dimensions',
    :'weight' => :'weight',
    :'packed_items' => :'packedItems'
  }
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



254
255
256
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



109
110
111
112
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 91

def self.openapi_types
  {
    :'container_type' => :'Object',
    :'container_identifier' => :'Object',
    :'tracking_number' => :'Object',
    :'manifest_id' => :'Object',
    :'manifest_date' => :'Object',
    :'ship_method' => :'Object',
    :'scac_code' => :'Object',
    :'carrier' => :'Object',
    :'container_sequence_number' => :'Object',
    :'dimensions' => :'Object',
    :'weight' => :'Object',
    :'packed_items' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      container_type == o.container_type &&
      container_identifier == o.container_identifier &&
      tracking_number == o.tracking_number &&
      manifest_id == o.manifest_id &&
      manifest_date == o.manifest_date &&
      ship_method == o.ship_method &&
      scac_code == o.scac_code &&
      carrier == o.carrier &&
      container_sequence_number == o.container_sequence_number &&
      dimensions == o.dimensions &&
      weight == o.weight &&
      packed_items == o.packed_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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 284

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 353

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 261

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


241
242
243
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 247

def hash
  [container_type, container_identifier, tracking_number, manifest_id, manifest_date, ship_method, scac_code, carrier, container_sequence_number, dimensions, weight, packed_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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 182

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

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

  if @packed_items.nil?
    invalid_properties.push('invalid value for "packed_items", packed_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



329
330
331
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 335

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



323
324
325
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 323

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



201
202
203
204
205
206
207
208
 
# File 'lib/vendor-direct-fulfillment-shipping-api-model/models/container.rb', line 201

def valid?
  return false if @container_type.nil?
  container_type_validator = EnumAttributeValidator.new('Object', ['Carton', 'Pallet'])
  return false unless container_type_validator.valid?(@container_type)
  return false if @container_identifier.nil?
  return false if @packed_items.nil?
  true
end