Class: AmzSpApi::EasyShipModel::Package

Inherits:
Object
  • Object
show all
Defined in:
lib/easy-ship-model/models/package.rb

Overview

A package. This object contains all the details of the scheduled Easy Ship package including the package identifier, physical attributes such as dimensions and weight, selected time slot to handover the package to carrier, status of the package, and tracking/invoice details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Package

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/easy-ship-model/models/package.rb', line 73

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#invoice ⇒ Object

Returns the value of attribute invoice.



29
30
31
 
# File 'lib/easy-ship-model/models/package.rb', line 29

def invoice
  @invoice
end

#package_dimensions ⇒ Object

Returns the value of attribute package_dimensions.



19
20
21
 
# File 'lib/easy-ship-model/models/package.rb', line 19

def package_dimensions
  @package_dimensions
end

#package_identifier ⇒ Object

Returns the value of attribute package_identifier.



27
28
29
 
# File 'lib/easy-ship-model/models/package.rb', line 27

def package_identifier
  @package_identifier
end

#package_items ⇒ Object

Returns the value of attribute package_items.



23
24
25
 
# File 'lib/easy-ship-model/models/package.rb', line 23

def package_items
  @package_items
end

#package_status ⇒ Object

Returns the value of attribute package_status.



31
32
33
 
# File 'lib/easy-ship-model/models/package.rb', line 31

def package_status
  @package_status
end

#package_time_slot ⇒ Object

Returns the value of attribute package_time_slot.



25
26
27
 
# File 'lib/easy-ship-model/models/package.rb', line 25

def package_time_slot
  @package_time_slot
end

#package_weight ⇒ Object

Returns the value of attribute package_weight.



21
22
23
 
# File 'lib/easy-ship-model/models/package.rb', line 21

def package_weight
  @package_weight
end

#scheduled_package_id ⇒ Object

Returns the value of attribute scheduled_package_id.



17
18
19
 
# File 'lib/easy-ship-model/models/package.rb', line 17

def scheduled_package_id
  @scheduled_package_id
end

#tracking_details ⇒ Object

Returns the value of attribute tracking_details.



33
34
35
 
# File 'lib/easy-ship-model/models/package.rb', line 33

def tracking_details
  @tracking_details
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/easy-ship-model/models/package.rb', line 36

def self.attribute_map
  {
    :'scheduled_package_id' => :'scheduledPackageId',
    :'package_dimensions' => :'packageDimensions',
    :'package_weight' => :'packageWeight',
    :'package_items' => :'packageItems',
    :'package_time_slot' => :'packageTimeSlot',
    :'package_identifier' => :'packageIdentifier',
    :'invoice' => :'invoice',
    :'package_status' => :'packageStatus',
    :'tracking_details' => :'trackingDetails'
  }
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



187
188
189
 
# File 'lib/easy-ship-model/models/package.rb', line 187

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/easy-ship-model/models/package.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/easy-ship-model/models/package.rb', line 51

def self.openapi_types
  {
    :'scheduled_package_id' => :'Object',
    :'package_dimensions' => :'Object',
    :'package_weight' => :'Object',
    :'package_items' => :'Object',
    :'package_time_slot' => :'Object',
    :'package_identifier' => :'Object',
    :'invoice' => :'Object',
    :'package_status' => :'Object',
    :'tracking_details' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/easy-ship-model/models/package.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      scheduled_package_id == o.scheduled_package_id &&
      package_dimensions == o.package_dimensions &&
      package_weight == o.package_weight &&
      package_items == o.package_items &&
      package_time_slot == o.package_time_slot &&
      package_identifier == o.package_identifier &&
      invoice == o.invoice &&
      package_status == o.package_status &&
      tracking_details == o.tracking_details
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



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
246
247
248
249
250
251
252
 
# File 'lib/easy-ship-model/models/package.rb', line 217

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



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/easy-ship-model/models/package.rb', line 286

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/easy-ship-model/models/package.rb', line 194

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


174
175
176
 
# File 'lib/easy-ship-model/models/package.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/easy-ship-model/models/package.rb', line 180

def hash
  [scheduled_package_id, package_dimensions, package_weight, package_items, package_time_slot, package_identifier, invoice, package_status, tracking_details].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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/easy-ship-model/models/package.rb', line 125

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

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

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

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



262
263
264
 
# File 'lib/easy-ship-model/models/package.rb', line 262

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/easy-ship-model/models/package.rb', line 268

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



256
257
258
 
# File 'lib/easy-ship-model/models/package.rb', line 256

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



148
149
150
151
152
153
154
 
# File 'lib/easy-ship-model/models/package.rb', line 148

def valid?
  return false if @scheduled_package_id.nil?
  return false if @package_dimensions.nil?
  return false if @package_weight.nil?
  return false if @package_time_slot.nil?
  true
end