Class: AmznSpApi::FulfillmentOutboundApiModel::FulfillmentShipmentPackage

Inherits:
Object
  • Object
show all
Defined in:
lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb

Overview

Package information for a shipment in a fulfillment order.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FulfillmentShipmentPackage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 53

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

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

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

  return unless attributes.key?(:estimated_arrival_date)

  self.estimated_arrival_date = attributes[:estimated_arrival_date]
end

Instance Attribute Details

#carrier_code ⇒ Object

Identifies the carrier who will deliver the shipment to the recipient.



19
20
21
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 19

def carrier_code
  @carrier_code
end

#estimated_arrival_date ⇒ Object

Returns the value of attribute estimated_arrival_date.



24
25
26
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 24

def estimated_arrival_date
  @estimated_arrival_date
end

#package_number ⇒ Object

Identifies a package in a shipment.



16
17
18
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 16

def package_number
  @package_number
end

#tracking_number ⇒ Object

The tracking number, if provided, can be used to obtain tracking and delivery information.



22
23
24
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 22

def tracking_number
  @tracking_number
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 27

def self.attribute_map
  {
    'package_number': :packageNumber,
    'carrier_code': :carrierCode,
    'tracking_number': :trackingNumber,
    'estimated_arrival_date': :estimatedArrivalDate
  }
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



121
122
123
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 121

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 47

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

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 37

def self.openapi_types
  {
    'package_number': :Object,
    'carrier_code': :Object,
    'tracking_number': :Object,
    'estimated_arrival_date': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



96
97
98
99
100
101
102
103
104
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 96

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

  self.class == other.class &&
    package_number == other.package_number &&
    carrier_code == other.carrier_code &&
    tracking_number == other.tracking_number &&
    estimated_arrival_date == other.estimated_arrival_date
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



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
179
180
181
182
183
184
185
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 150

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 219

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 128

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


108
109
110
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



114
115
116
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 114

def hash
  [package_number, carrier_code, tracking_number, estimated_arrival_date].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



76
77
78
79
80
81
82
83
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 76

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

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



195
196
197
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 195

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



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 201

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



189
190
191
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 189

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



87
88
89
90
91
92
 
# File 'lib/fulfillment_outbound_api_model/models/fulfillment_shipment_package.rb', line 87

def valid?
  return false if @package_number.nil?
  return false if @carrier_code.nil?

  true
end