Class: AmznSpApi::FulfillmentOutboundApiModel::PackageTrackingDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PackageTrackingDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
122
123
124
125
126
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 87

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:tracking_events)

  self.tracking_events = attributes[:tracking_events]
end

Instance Attribute Details

#additional_location_info ⇒ Object

Returns the value of attribute additional_location_info.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def additional_location_info
  @additional_location_info
end

#carrier_code ⇒ Object

The name of the carrier.



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

def carrier_code
  @carrier_code
end

#carrier_phone_number ⇒ Object

The phone number of the carrier.



27
28
29
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 27

def carrier_phone_number
  @carrier_phone_number
end

#carrier_url ⇒ Object

The URL of the carrier’s website.



30
31
32
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 30

def carrier_url
  @carrier_url
end

#current_status ⇒ Object

Returns the value of attribute current_status.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def current_status
  @current_status
end

#current_status_description ⇒ Object

Description corresponding to the CurrentStatus value.



35
36
37
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 35

def current_status_description
  @current_status_description
end

#customer_tracking_link ⇒ Object

Link on swiship.com that allows customers to track the package.



21
22
23
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 21

def customer_tracking_link
  @customer_tracking_link
end

#estimated_arrival_date ⇒ Object

Returns the value of attribute estimated_arrival_date.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def estimated_arrival_date
  @estimated_arrival_date
end

#package_number ⇒ Object

The package identifier.



15
16
17
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 15

def package_number
  @package_number
end

#ship_date ⇒ Object

Returns the value of attribute ship_date.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def ship_date
  @ship_date
end

#ship_to_address ⇒ Object

Returns the value of attribute ship_to_address.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def ship_to_address
  @ship_to_address
end

#signed_for_by ⇒ Object

The name of the person who signed for the package.



38
39
40
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 38

def signed_for_by
  @signed_for_by
end

#tracking_events ⇒ Object

Returns the value of attribute tracking_events.



32
33
34
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 32

def tracking_events
  @tracking_events
end

#tracking_number ⇒ Object

The tracking number for the package.



18
19
20
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 18

def tracking_number
  @tracking_number
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 41

def self.attribute_map
  {
    'package_number': :packageNumber,
    'tracking_number': :trackingNumber,
    'customer_tracking_link': :customerTrackingLink,
    'carrier_code': :carrierCode,
    'carrier_phone_number': :carrierPhoneNumber,
    'carrier_url': :carrierURL,
    'ship_date': :shipDate,
    'estimated_arrival_date': :estimatedArrivalDate,
    'ship_to_address': :shipToAddress,
    'current_status': :currentStatus,
    'current_status_description': :currentStatusDescription,
    'signed_for_by': :signedForBy,
    'additional_location_info': :additionalLocationInfo,
    'tracking_events': :trackingEvents
  }
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



182
183
184
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 182

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 61

def self.openapi_types
  {
    'package_number': :Object,
    'tracking_number': :Object,
    'customer_tracking_link': :Object,
    'carrier_code': :Object,
    'carrier_phone_number': :Object,
    'carrier_url': :Object,
    'ship_date': :Object,
    'estimated_arrival_date': :Object,
    'ship_to_address': :Object,
    'current_status': :Object,
    'current_status_description': :Object,
    'signed_for_by': :Object,
    'additional_location_info': :Object,
    'tracking_events': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 147

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

  self.class == other.class &&
    package_number == other.package_number &&
    tracking_number == other.tracking_number &&
    customer_tracking_link == other.customer_tracking_link &&
    carrier_code == other.carrier_code &&
    carrier_phone_number == other.carrier_phone_number &&
    carrier_url == other.carrier_url &&
    ship_date == other.ship_date &&
    estimated_arrival_date == other.estimated_arrival_date &&
    ship_to_address == other.ship_to_address &&
    current_status == other.current_status &&
    current_status_description == other.current_status_description &&
    signed_for_by == other.signed_for_by &&
    additional_location_info == other.additional_location_info &&
    tracking_events == other.tracking_events
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



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
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 211

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 280

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 189

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


169
170
171
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 169

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 175

def hash
  [package_number, tracking_number, customer_tracking_link, carrier_code, carrier_phone_number, carrier_url, ship_date, estimated_arrival_date, ship_to_address, current_status, current_status_description, signed_for_by, additional_location_info, tracking_events].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



130
131
132
133
134
135
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 130

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
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 262

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



250
251
252
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 250

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



139
140
141
142
143
 
# File 'lib/fulfillment_outbound_api_model/models/package_tracking_details.rb', line 139

def valid?
  return false if @package_number.nil?

  true
end