Class: AmznSpApi::OrdersApiModel::PackageDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/orders_api_model/models/package_detail.rb

Overview

Properties of packages

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PackageDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/orders_api_model/models/package_detail.rb', line 70

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

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

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

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

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

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

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

  return unless attributes.key?(:order_items)

  self.order_items = attributes[:order_items]
end

Instance Attribute Details

#carrier_code ⇒ Object

Identifies the carrier that will deliver the package. This field is required for all marketplaces, see [reference](developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces).



18
19
20
 
# File 'lib/orders_api_model/models/package_detail.rb', line 18

def carrier_code
  @carrier_code
end

#carrier_name ⇒ Object

Carrier Name that will deliver the package. Required when carrierCode is "Others"



21
22
23
 
# File 'lib/orders_api_model/models/package_detail.rb', line 21

def carrier_name
  @carrier_name
end

#order_items ⇒ Object

Returns the value of attribute order_items.



15
16
17
 
# File 'lib/orders_api_model/models/package_detail.rb', line 15

def order_items
  @order_items
end

#package_reference_id ⇒ Object

Returns the value of attribute package_reference_id.



15
16
17
 
# File 'lib/orders_api_model/models/package_detail.rb', line 15

def package_reference_id
  @package_reference_id
end

#ship_date ⇒ Object

The shipping date for the package. Must be in ISO-8601 date/time format.



30
31
32
 
# File 'lib/orders_api_model/models/package_detail.rb', line 30

def ship_date
  @ship_date
end

#ship_from_supply_source_id ⇒ Object

The unique identifier of the supply source.



33
34
35
 
# File 'lib/orders_api_model/models/package_detail.rb', line 33

def ship_from_supply_source_id
  @ship_from_supply_source_id
end

#shipping_method ⇒ Object

Ship method to be used for shipping the order.



24
25
26
 
# File 'lib/orders_api_model/models/package_detail.rb', line 24

def shipping_method
  @shipping_method
end

#tracking_number ⇒ Object

The tracking number used to obtain tracking and delivery information.



27
28
29
 
# File 'lib/orders_api_model/models/package_detail.rb', line 27

def tracking_number
  @tracking_number
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
 
# File 'lib/orders_api_model/models/package_detail.rb', line 36

def self.attribute_map
  {
    'package_reference_id': :packageReferenceId,
    'carrier_code': :carrierCode,
    'carrier_name': :carrierName,
    'shipping_method': :shippingMethod,
    'tracking_number': :trackingNumber,
    'ship_date': :shipDate,
    'ship_from_supply_source_id': :shipFromSupplySourceId,
    'order_items': :orderItems
  }
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



159
160
161
 
# File 'lib/orders_api_model/models/package_detail.rb', line 159

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
 
# File 'lib/orders_api_model/models/package_detail.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/orders_api_model/models/package_detail.rb', line 50

def self.openapi_types
  {
    'package_reference_id': :Object,
    'carrier_code': :Object,
    'carrier_name': :Object,
    'shipping_method': :Object,
    'tracking_number': :Object,
    'ship_date': :Object,
    'ship_from_supply_source_id': :Object,
    'order_items': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/orders_api_model/models/package_detail.rb', line 130

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

  self.class == other.class &&
    package_reference_id == other.package_reference_id &&
    carrier_code == other.carrier_code &&
    carrier_name == other.carrier_name &&
    shipping_method == other.shipping_method &&
    tracking_number == other.tracking_number &&
    ship_date == other.ship_date &&
    ship_from_supply_source_id == other.ship_from_supply_source_id &&
    order_items == other.order_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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/orders_api_model/models/package_detail.rb', line 188

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/orders_api_model/models/package_detail.rb', line 257

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/orders_api_model/models/package_detail.rb', line 166

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


146
147
148
 
# File 'lib/orders_api_model/models/package_detail.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/orders_api_model/models/package_detail.rb', line 152

def hash
  [package_reference_id, carrier_code, carrier_name, shipping_method, tracking_number, ship_date, ship_from_supply_source_id, order_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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/orders_api_model/models/package_detail.rb', line 101

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

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

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

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

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



233
234
235
 
# File 'lib/orders_api_model/models/package_detail.rb', line 233

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/orders_api_model/models/package_detail.rb', line 239

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



227
228
229
 
# File 'lib/orders_api_model/models/package_detail.rb', line 227

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/orders_api_model/models/package_detail.rb', line 118

def valid?
  return false if @package_reference_id.nil?
  return false if @carrier_code.nil?
  return false if @tracking_number.nil?
  return false if @ship_date.nil?
  return false if @order_items.nil?

  true
end