Class: AftershipAPI::Model::UpdateTrackingByIdRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateTrackingByIdRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#custom_fields ⇒ Object

Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any custom_fields?: Object;



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

def custom_fields
  @custom_fields
end

#customers ⇒ Object

The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed. customers?: UpdateTrackingByIdRequestCustomers[];



123
124
125
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 123

def customers
  @customers
end

#delivery_type ⇒ Object

Shipment delivery type- ‘pickup_at_store`- `pickup_at_courier`- `door_to_door` delivery_type?: UpdateTrackingByIdRequestDeliveryType;



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

def delivery_type
  @delivery_type
end

#destination_city ⇒ Object

The city of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. destination_city?: String;



103
104
105
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 103

def destination_city
  @destination_city
end

#destination_country_region ⇒ Object

The for more details. destination_country_region?: String;



95
96
97
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 95

def destination_country_region
  @destination_country_region
end

#destination_postal_code ⇒ Object

The postal of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on for more details. destination_postal_code?: String;



107
108
109
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 107

def destination_postal_code
  @destination_postal_code
end

#destination_raw_location ⇒ Object

The shipping address that the shipment is shipping to. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. destination_raw_location?: String;



111
112
113
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 111

def destination_raw_location
  @destination_raw_location
end

#destination_state ⇒ Object

The state of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on for more details. destination_state?: String;



99
100
101
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 99

def destination_state
  @destination_state
end

#language ⇒ Object

The recipient’s language. If you set up AfterShip notifications in different languages, we use this to send the recipient tracking updates in their preferred language. Use an to specify the language. language?: String;



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

def language
  @language
end

#location_id ⇒ Object

The location_id refers to the place where you fulfilled the items. - If you provide a location_id, the system will automatically use it as the tracking’s origin address. However, passing both location_id and any origin address information simultaneously is not allowed.- Please make sure you add your locations . location_id?: String;



115
116
117
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 115

def location_id
  @location_id
end

#note ⇒ Object

Text field for the note.Input ‘“”` to clear the value of this field. note?: String;



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

def note
  @note
end

#order_date ⇒ Object

Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00 order_date?: String;



67
68
69
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 67

def order_date
  @order_date
end

#order_id ⇒ Object

A globally-unique identifier for the order. order_id?: String;



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

def order_id
  @order_id
end

#order_id_path ⇒ Object

The URL for the order in your system or store. order_id_path?: String;



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

def order_id_path
  @order_id_path
end

#order_number ⇒ Object

A unique, human-readable identifier for the order. order_number?: String;



63
64
65
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 63

def order_number
  @order_number
end

#order_promised_delivery_date ⇒ Object

The promised delivery date of the order. It uses the formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ order_promised_delivery_date?: String;



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

def order_promised_delivery_date
  @order_promised_delivery_date
end

#origin_city ⇒ Object

The city of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. origin_city?: String;



83
84
85
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 83

def origin_city
  @origin_city
end

#origin_country_region ⇒ Object

The for more details. origin_country_region?: String;



75
76
77
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 75

def origin_country_region
  @origin_country_region
end

#origin_postal_code ⇒ Object

The postal of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. origin_postal_code?: String;



87
88
89
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 87

def origin_postal_code
  @origin_postal_code
end

#origin_raw_location ⇒ Object

The sender address that the shipment is shipping from. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. origin_raw_location?: String;



91
92
93
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 91

def origin_raw_location
  @origin_raw_location
end

#origin_state ⇒ Object

The state of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. origin_state?: String;



79
80
81
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 79

def origin_state
  @origin_state
end

#pickup_location ⇒ Object

Shipment pickup location for receiver pickup_location?: String;



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

def pickup_location
  @pickup_location
end

#pickup_note ⇒ Object

Shipment pickup note for receiver pickup_note?: String;



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

def pickup_note
  @pickup_note
end

#shipment_type ⇒ Object

The carrier service type for the shipment. If you provide info for this field, AfterShip will not update it with info from the carrier. shipment_type?: String;



71
72
73
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 71

def shipment_type
  @shipment_type
end

#shipping_method ⇒ Object

The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc. shipping_method?: String;



119
120
121
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 119

def shipping_method
  @shipping_method
end

#slug ⇒ Object

Unique code of each courier. Provide a single courier.(admin.aftership.com/settings/couriers). Get a list of courier slug using slug?: String;



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

def slug
  @slug
end

#title ⇒ Object

By default this field shows the ‘tracking_number`, but you can customize it as you wish with any info (e.g. the order number). title?: String;



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

def title
  @title
end

#tracking_account_number ⇒ Object

Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on for more details. tracking_account_number?: String;



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

def 
  @tracking_account_number
end

#tracking_key ⇒ Object

Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on for more details. tracking_key?: String;



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

def tracking_key
  @tracking_key
end

#tracking_ship_date ⇒ Object

The date and time when the shipment is shipped by the merchant and ready for pickup by the carrier. The field supports the following formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZThe field serves two key purposes:- Calculate processing time metrics in the Order-to-delivery Analytics dashboard. To ensure accurate analytics, it’s recommended to include timezone information when configuring this value- Required by certain carriers to retrieve tracking information as an additional tracking field. tracking_ship_date?: String;



59
60
61
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 59

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 356

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.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 294

def self.attribute_map
  {
    :'title' => :'title',
    :'order_id' => :'order_id',
    :'order_id_path' => :'order_id_path',
    :'custom_fields' => :'custom_fields',
    :'note' => :'note',
    :'language' => :'language',
    :'order_promised_delivery_date' => :'order_promised_delivery_date',
    :'delivery_type' => :'delivery_type',
    :'pickup_location' => :'pickup_location',
    :'pickup_note' => :'pickup_note',
    :'slug' => :'slug',
    :'tracking_account_number' => :'tracking_account_number',
    :'tracking_key' => :'tracking_key',
    :'tracking_ship_date' => :'tracking_ship_date',
    :'order_number' => :'order_number',
    :'order_date' => :'order_date',
    :'shipment_type' => :'shipment_type',
    :'origin_country_region' => :'origin_country_region',
    :'origin_state' => :'origin_state',
    :'origin_city' => :'origin_city',
    :'origin_postal_code' => :'origin_postal_code',
    :'origin_raw_location' => :'origin_raw_location',
    :'destination_country_region' => :'destination_country_region',
    :'destination_state' => :'destination_state',
    :'destination_city' => :'destination_city',
    :'destination_postal_code' => :'destination_postal_code',
    :'destination_raw_location' => :'destination_raw_location',
    :'location_id' => :'location_id',
    :'shipping_method' => :'shipping_method',
    :'customers' => :'customers',
  }
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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 332

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.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 258

def self.openapi_types
  {
    :'title' => :'String',
    :'order_id' => :'String',
    :'order_id_path' => :'String',
    :'custom_fields' => :'Object',
    :'note' => :'String',
    :'language' => :'String',
    :'order_promised_delivery_date' => :'String',
    :'delivery_type' => :'UpdateTrackingByIdRequestDeliveryType',
    :'pickup_location' => :'String',
    :'pickup_note' => :'String',
    :'slug' => :'String',
    :'tracking_account_number' => :'String',
    :'tracking_key' => :'String',
    :'tracking_ship_date' => :'String',
    :'order_number' => :'String',
    :'order_date' => :'String',
    :'shipment_type' => :'String',
    :'origin_country_region' => :'String',
    :'origin_state' => :'String',
    :'origin_city' => :'String',
    :'origin_postal_code' => :'String',
    :'origin_raw_location' => :'String',
    :'destination_country_region' => :'String',
    :'destination_state' => :'String',
    :'destination_city' => :'String',
    :'destination_postal_code' => :'String',
    :'destination_raw_location' => :'String',
    :'location_id' => :'String',
    :'shipping_method' => :'String',
    :'customers' => :'Array<UpdateTrackingByIdRequestCustomers>',
  }
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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 423

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



402
403
404
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 402

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



408
409
410
411
412
413
414
415
416
417
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 408

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 



437
438
439
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 437

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



396
397
398
 
# File 'lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb', line 396

def to_s
  to_hash.to_s
end