Class: AmznSpApi::ShippingApiModel::Container

Inherits:
Object
  • Object
show all
Defined in:
lib/shipping_api_model/models/container.rb

Overview

Container in the shipment.

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

Raises:

  • (ArgumentError) 


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
 
# File 'lib/shipping_api_model/models/container.rb', line 75

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

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

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

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

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

  return unless attributes.key?(:weight)

  self.weight = attributes[:weight]
end

Instance Attribute Details

#container_reference_id ⇒ Object

Returns the value of attribute container_reference_id.



18
19
20
 
# File 'lib/shipping_api_model/models/container.rb', line 18

def container_reference_id
  @container_reference_id
end

#container_type ⇒ Object

The type of physical container being used. (always ‘PACKAGE’)



16
17
18
 
# File 'lib/shipping_api_model/models/container.rb', line 16

def container_type
  @container_type
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



18
19
20
 
# File 'lib/shipping_api_model/models/container.rb', line 18

def dimensions
  @dimensions
end

#items ⇒ Object

A list of the items in the container.



21
22
23
 
# File 'lib/shipping_api_model/models/container.rb', line 21

def items
  @items
end

#value ⇒ Object

Returns the value of attribute value.



18
19
20
 
# File 'lib/shipping_api_model/models/container.rb', line 18

def value
  @value
end

#weight ⇒ Object

Returns the value of attribute weight.



18
19
20
 
# File 'lib/shipping_api_model/models/container.rb', line 18

def weight
  @weight
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
 
# File 'lib/shipping_api_model/models/container.rb', line 45

def self.attribute_map
  {
    'container_type': :containerType,
    'container_reference_id': :containerReferenceId,
    'value': :value,
    'dimensions': :dimensions,
    'items': :items,
    'weight': :weight
  }
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



171
172
173
 
# File 'lib/shipping_api_model/models/container.rb', line 171

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
 
# File 'lib/shipping_api_model/models/container.rb', line 69

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/shipping_api_model/models/container.rb', line 57

def self.openapi_types
  {
    'container_type': :Object,
    'container_reference_id': :Object,
    'value': :Object,
    'dimensions': :Object,
    'items': :Object,
    'weight': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/shipping_api_model/models/container.rb', line 144

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

  self.class == other.class &&
    container_type == other.container_type &&
    container_reference_id == other.container_reference_id &&
    value == other.value &&
    dimensions == other.dimensions &&
    items == other.items &&
    weight == other.weight
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



200
201
202
203
204
205
206
207
208
209
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
 
# File 'lib/shipping_api_model/models/container.rb', line 200

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/shipping_api_model/models/container.rb', line 269

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/shipping_api_model/models/container.rb', line 178

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


158
159
160
 
# File 'lib/shipping_api_model/models/container.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



164
165
166
 
# File 'lib/shipping_api_model/models/container.rb', line 164

def hash
  [container_type, container_reference_id, value, dimensions, items, weight].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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/shipping_api_model/models/container.rb', line 104

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

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

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

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

  invalid_properties.push('invalid value for "weight", weight cannot be nil.') if @weight.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



245
246
247
 
# File 'lib/shipping_api_model/models/container.rb', line 245

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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/shipping_api_model/models/container.rb', line 251

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



239
240
241
 
# File 'lib/shipping_api_model/models/container.rb', line 239

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



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/shipping_api_model/models/container.rb', line 121

def valid?
  container_type_validator = EnumAttributeValidator.new('Object', ['PACKAGE'])
  return false unless container_type_validator.valid?(@container_type)
  return false if @container_reference_id.nil?
  return false if @value.nil?
  return false if @dimensions.nil?
  return false if @items.nil?
  return false if @weight.nil?

  true
end