Class: AmznSpApi::EasyShipApiModel::Package

Inherits:
Object
  • Object
show all
Defined in:
lib/easy_ship_api_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

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/easy_ship_api_model/models/package.rb', line 54

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

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

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

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

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

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

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

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

  return unless attributes.key?(:tracking_details)

  self.tracking_details = attributes[:tracking_details]
end

Instance Attribute Details

#invoice ⇒ Object

Returns the value of attribute invoice.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def invoice
  @invoice
end

#package_dimensions ⇒ Object

Returns the value of attribute package_dimensions.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_dimensions
  @package_dimensions
end

#package_identifier ⇒ Object

Returns the value of attribute package_identifier.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_identifier
  @package_identifier
end

#package_items ⇒ Object

Returns the value of attribute package_items.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_items
  @package_items
end

#package_status ⇒ Object

Returns the value of attribute package_status.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_status
  @package_status
end

#package_time_slot ⇒ Object

Returns the value of attribute package_time_slot.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_time_slot
  @package_time_slot
end

#package_weight ⇒ Object

Returns the value of attribute package_weight.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def package_weight
  @package_weight
end

#scheduled_package_id ⇒ Object

Returns the value of attribute scheduled_package_id.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def scheduled_package_id
  @scheduled_package_id
end

#tracking_details ⇒ Object

Returns the value of attribute tracking_details.



15
16
17
 
# File 'lib/easy_ship_api_model/models/package.rb', line 15

def tracking_details
  @tracking_details
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
 
# File 'lib/easy_ship_api_model/models/package.rb', line 18

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



143
144
145
 
# File 'lib/easy_ship_api_model/models/package.rb', line 143

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
 
# File 'lib/easy_ship_api_model/models/package.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/easy_ship_api_model/models/package.rb', line 33

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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/easy_ship_api_model/models/package.rb', line 113

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

  self.class == other.class &&
    scheduled_package_id == other.scheduled_package_id &&
    package_dimensions == other.package_dimensions &&
    package_weight == other.package_weight &&
    package_items == other.package_items &&
    package_time_slot == other.package_time_slot &&
    package_identifier == other.package_identifier &&
    invoice == other.invoice &&
    package_status == other.package_status &&
    tracking_details == other.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



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
 
# File 'lib/easy_ship_api_model/models/package.rb', line 172

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/easy_ship_api_model/models/package.rb', line 241

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/easy_ship_api_model/models/package.rb', line 150

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


130
131
132
 
# File 'lib/easy_ship_api_model/models/package.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



136
137
138
 
# File 'lib/easy_ship_api_model/models/package.rb', line 136

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



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/easy_ship_api_model/models/package.rb', line 87

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

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

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

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



217
218
219
 
# File 'lib/easy_ship_api_model/models/package.rb', line 217

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



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/easy_ship_api_model/models/package.rb', line 223

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



211
212
213
 
# File 'lib/easy_ship_api_model/models/package.rb', line 211

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



102
103
104
105
106
107
108
109
 
# File 'lib/easy_ship_api_model/models/package.rb', line 102

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