Class: AftershipAPI::Model::EstimatedDeliveryDateResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EstimatedDeliveryDateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
84
85
86
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
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 59

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#confidence_code ⇒ Object

Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to . confidence_code?: Float;



47
48
49
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 47

def confidence_code
  @confidence_code
end

#destination_address ⇒ Object

The final destination of the customer where the delivery will be made. destination_address: EstimatedDeliveryDateResponseDestinationAddress;



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

def destination_address
  @destination_address
end

#estimated_delivery_date ⇒ Object

The estimated arrival date of the shipment, provided by AfterShip. estimated_delivery_date?: String;



43
44
45
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 43

def estimated_delivery_date
  @estimated_delivery_date
end

#estimated_delivery_date_max ⇒ Object

The latest estimated delivery date of the shipment, provided by AfterShip. estimated_delivery_date_max?: String;



55
56
57
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 55

def estimated_delivery_date_max
  @estimated_delivery_date_max
end

#estimated_delivery_date_min ⇒ Object

The earliest estimated delivery date of the shipment, provided by AfterShip. estimated_delivery_date_min?: String;



51
52
53
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 51

def estimated_delivery_date_min
  @estimated_delivery_date_min
end

#estimated_pickup ⇒ Object

The local pickup time of the package.Either ‘pickup_time` or `estimated_pickup` is required. estimated_pickup?: EstimatedDeliveryDateResponseEstimatedPickup;



39
40
41
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 39

def estimated_pickup
  @estimated_pickup
end

#id ⇒ Object

A string that acts as a unique identifier for the estimated delivery date value generated by AfterShip Predict API id: String;



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

def id
  @id
end

#origin_address ⇒ Object

The location from where the package is picked up by the carrier to be delivered to the final destination. origin_address: EstimatedDeliveryDateResponseOriginAddress;



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

def origin_address
  @origin_address
end

#package_count ⇒ Object

The number of packages. package_count?: Integer;



31
32
33
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 31

def package_count
  @package_count
end

#pickup_time ⇒ Object

The local pickup time in the origin address time zone of the package.Either ‘pickup_time` or `estimated_pickup` is required. pickup_time?: String;



35
36
37
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 35

def pickup_time
  @pickup_time
end

#service_type_name ⇒ Object

AfterShip’s unique code represents carrier’s shipping and delivery options. Refer to . service_type_name?: String;



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

def service_type_name
  @service_type_name
end

#slug ⇒ Object

AfterShip’s unique code of courier. Please refer to track.aftership.com/couriers/download. slug: String;



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

def slug
  @slug
end

#weight ⇒ Object

AfterShip uses this object to calculate the total weight of the order. weight?: EstimatedDeliveryDateResponseWeight;



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

def weight
  @weight
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



186
187
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
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 186

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.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 141

def self.attribute_map
  {
    :'id' => :'id',
    :'slug' => :'slug',
    :'service_type_name' => :'service_type_name',
    :'origin_address' => :'origin_address',
    :'destination_address' => :'destination_address',
    :'weight' => :'weight',
    :'package_count' => :'package_count',
    :'pickup_time' => :'pickup_time',
    :'estimated_pickup' => :'estimated_pickup',
    :'estimated_delivery_date' => :'estimated_delivery_date',
    :'confidence_code' => :'confidence_code',
    :'estimated_delivery_date_min' => :'estimated_delivery_date_min',
    :'estimated_delivery_date_max' => :'estimated_delivery_date_max',
  }
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 162

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.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 122

def self.openapi_types
  {
    :'id' => :'String',
    :'slug' => :'String',
    :'service_type_name' => :'String',
    :'origin_address' => :'EstimatedDeliveryDateResponseOriginAddress',
    :'destination_address' => :'EstimatedDeliveryDateResponseDestinationAddress',
    :'weight' => :'EstimatedDeliveryDateResponseWeight',
    :'package_count' => :'Integer',
    :'pickup_time' => :'String',
    :'estimated_pickup' => :'EstimatedDeliveryDateResponseEstimatedPickup',
    :'estimated_delivery_date' => :'String',
    :'confidence_code' => :'Float',
    :'estimated_delivery_date_min' => :'String',
    :'estimated_delivery_date_max' => :'String',
  }
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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 253

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



232
233
234
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 232

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



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 238

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 



267
268
269
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 267

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



226
227
228
 
# File 'lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb', line 226

def to_s
  to_hash.to_s
end