Class: AftershipAPI::Model::TrackingLastMile

Inherits:
Object
  • Object
show all
Defined in:
lib/aftership-tracking-sdk/models/tracking_last_mile.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrackingLastMile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 31

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingLastMile` initialize method"
  end

  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

Instance Attribute Details

The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the last-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to “US”. courier_redirect_link?: String;



23
24
25
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 23

def courier_redirect_link
  @courier_redirect_link
end

#courier_tracking_link ⇒ Object

The field contains the official tracking URL of the last-mile carrier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to “US”. courier_tracking_link?: String;



19
20
21
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 19

def courier_tracking_link
  @courier_tracking_link
end

#slug ⇒ Object

The unique code of the carrier responsible for the last-mile of the shipment. Find all the courier slugs . slug?: String;



11
12
13
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 11

def slug
  @slug
end

#source ⇒ Object

The field indicates the source of last-mile carrier. source?: TrackingLastMileSource;



27
28
29
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 27

def source
  @source
end

#tracking_number ⇒ Object

The tracking number of the last-mile carrier. tracking_number?: String;



7
8
9
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 7

def tracking_number
  @tracking_number
end

#transit_time ⇒ Object

The transit time for the last-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or the received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the last-mile transit time.- Last mile transit time (in days)= Delivered date - Handover date transit_time?: Integer;



15
16
17
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 15

def transit_time
  @transit_time
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (String) —

    Data type

  • value (String) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 116

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    klass = AftershipAPI::Model.const_get(type)
    klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 78

def self.attribute_map
  {
    :'tracking_number' => :'tracking_number',
    :'slug' => :'slug',
    :'transit_time' => :'transit_time',
    :'courier_tracking_link' => :'courier_tracking_link',
    :'courier_redirect_link' => :'courier_redirect_link',
    :'source' => :'source',
  }
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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 92

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(key) && attributes[key].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[key].is_a?(Array)
        transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[key].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[key])
    end
  end
  new(transformed_hash)
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 66

def self.openapi_types
  {
    :'tracking_number' => :'String',
    :'slug' => :'String',
    :'transit_time' => :'Integer',
    :'courier_tracking_link' => :'String',
    :'courier_redirect_link' => :'String',
    :'source' => :'TrackingLastMileSource',
  }
end

Instance Method Details

#_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



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 183

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 162

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



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 168

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_json(*a) ⇒ Object 



197
198
199
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 197

def to_json(*a)
  to_hash.to_json(*a)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



156
157
158
 
# File 'lib/aftership-tracking-sdk/models/tracking_last_mile.rb', line 156

def to_s
  to_hash.to_s
end