aftership-tracking-sdk 9.0.0 → 10.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +14 -13
  4. data/lib/aftership-tracking-sdk/api/courier.rb +3 -3
  5. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +55 -1
  6. data/lib/aftership-tracking-sdk/api/tracking.rb +16 -16
  7. data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb +3 -3
  8. data/lib/aftership-tracking-sdk/models/checkpoint.rb +22 -12
  9. data/lib/aftership-tracking-sdk/models/courier.rb +7 -7
  10. data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +47 -67
  11. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +63 -83
  12. data/lib/aftership-tracking-sdk/models/{next_couriers_tracking.rb → customers_create_tracking_request.rb} +37 -37
  13. data/lib/aftership-tracking-sdk/models/customers_create_tracking_response.rb +193 -0
  14. data/lib/aftership-tracking-sdk/models/customers_delete_tracking_by_id_response.rb +193 -0
  15. data/lib/aftership-tracking-sdk/models/customers_get_tracking_by_id_response.rb +193 -0
  16. data/lib/aftership-tracking-sdk/models/customers_mark_tracking_completed_by_id_response.rb +193 -0
  17. data/lib/aftership-tracking-sdk/models/customers_retrack_tracking_by_id_response.rb +193 -0
  18. data/lib/aftership-tracking-sdk/models/customers_tracking.rb +193 -0
  19. data/lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_request.rb +193 -0
  20. data/lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_response.rb +193 -0
  21. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +63 -83
  22. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +6 -6
  23. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +6 -6
  24. data/lib/aftership-tracking-sdk/models/destination_address_predict_request.rb +193 -0
  25. data/lib/aftership-tracking-sdk/models/destination_address_predict_response.rb +193 -0
  26. data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +24 -24
  27. data/lib/aftership-tracking-sdk/models/estimated_pickup_predict_request.rb +183 -0
  28. data/lib/aftership-tracking-sdk/models/estimated_pickup_predict_response.rb +193 -0
  29. data/lib/aftership-tracking-sdk/models/{next_couriers_delete_tracking_by_id_response.rb → first_mile_create_tracking_response.rb} +29 -29
  30. data/lib/aftership-tracking-sdk/models/{next_couriers_get_tracking_by_id_response.rb → first_mile_delete_tracking_by_id_response.rb} +29 -29
  31. data/lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb +193 -0
  32. data/lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb +193 -0
  33. data/lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb +193 -0
  34. data/lib/aftership-tracking-sdk/models/{next_couriers_mark_tracking_completed_by_id_response.rb → first_mile_tracking.rb} +29 -29
  35. data/lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb +193 -0
  36. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +63 -83
  37. data/lib/aftership-tracking-sdk/models/{next_couriers_create_tracking_request.rb → last_mile_create_tracking_request.rb} +13 -13
  38. data/lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb +203 -0
  39. data/lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb +203 -0
  40. data/lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb +203 -0
  41. data/lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb +203 -0
  42. data/lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb +203 -0
  43. data/lib/aftership-tracking-sdk/models/{next_couriers_create_tracking_response.rb → last_mile_tracking.rb} +33 -23
  44. data/lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb +203 -0
  45. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +63 -83
  46. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_request.rb +163 -0
  47. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_predict_response.rb +163 -0
  48. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +6 -6
  49. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +6 -6
  50. data/lib/aftership-tracking-sdk/models/origin_address_predict_request.rb +193 -0
  51. data/lib/aftership-tracking-sdk/models/origin_address_predict_response.rb +193 -0
  52. data/lib/aftership-tracking-sdk/models/predict_request.rb +223 -0
  53. data/lib/aftership-tracking-sdk/models/predict_response.rb +273 -0
  54. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +63 -83
  55. data/lib/aftership-tracking-sdk/models/tracking.rb +63 -83
  56. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +37 -57
  57. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +63 -83
  58. data/lib/aftership-tracking-sdk/models/weight_predict_request.rb +163 -0
  59. data/lib/aftership-tracking-sdk/models/weight_predict_response.rb +163 -0
  60. data/lib/aftership-tracking-sdk/version.rb +1 -1
  61. metadata +41 -13
  62. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +0 -193
  63. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +0 -193
@@ -19,10 +19,6 @@ module AftershipAPI::Model
19
19
  # updated_at?: String;
20
20
  attr_accessor :updated_at
21
21
 
22
- # (Legacy) The date and time the shipment was updated. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
23
- # last_updated_at?: String;
24
- attr_accessor :last_updated_at
25
-
26
22
  # Tracking number.
27
23
  # tracking_number?: String;
28
24
  attr_accessor :tracking_number
@@ -39,17 +35,13 @@ module AftershipAPI::Model
39
35
  # custom_fields?: Object;
40
36
  attr_accessor :custom_fields
41
37
 
42
- # Customer name of the tracking.
43
- # customer_name?: String;
44
- attr_accessor :customer_name
45
-
46
38
  # Total transit time in days.- For delivered shipments: Transit time (in days) = Delivered date - Pick-up date- For undelivered shipments: Transit time (in days) = Current date - Pick-up dateValue as `null` for the shipment without pick-up date.
47
39
  # transit_time?: Integer;
48
40
  attr_accessor :transit_time
49
41
 
50
42
  # The for the origin country/region. E.g. USA for the United States.
51
- # origin_country_iso3?: String;
52
- attr_accessor :origin_country_iso3
43
+ # origin_country_region?: String;
44
+ attr_accessor :origin_country_region
53
45
 
54
46
  # The state of the sender’s address.
55
47
  # origin_state?: String;
@@ -68,8 +60,8 @@ module AftershipAPI::Model
68
60
  attr_accessor :origin_raw_location
69
61
 
70
62
  # The for the destination country/region. E.g. USA for the United States.
71
- # destination_country_iso3?: String;
72
- attr_accessor :destination_country_iso3
63
+ # destination_country_region?: String;
64
+ attr_accessor :destination_country_region
73
65
 
74
66
  # The state of the recipient’s address.
75
67
  # destination_state?: String;
@@ -88,12 +80,8 @@ module AftershipAPI::Model
88
80
  attr_accessor :destination_raw_location
89
81
 
90
82
  # Destination country/region of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be `null` if the courier doesn't provide the destination country.
91
- # courier_destination_country_iso3?: String;
92
- attr_accessor :courier_destination_country_iso3
93
-
94
- # Email address(es) to receive email notifications.
95
- # emails?: String[];
96
- attr_accessor :emails
83
+ # courier_destination_country_region?: String;
84
+ attr_accessor :courier_destination_country_region
97
85
 
98
86
  # The field contains the estimated delivery date provided by the carrier.
99
87
  # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateTracking;
@@ -139,10 +127,6 @@ module AftershipAPI::Model
139
127
  # signed_by?: String;
140
128
  attr_accessor :signed_by
141
129
 
142
- # The phone number(s) to receive sms notifications. Phone number should begin with `+` and `Area Code` before phone number.
143
- # smses?: String[];
144
- attr_accessor :smses
145
-
146
130
  # Source of how this tracking is added.
147
131
  # source?: String;
148
132
  attr_accessor :source
@@ -231,7 +215,7 @@ module AftershipAPI::Model
231
215
  # tracking_key?: String;
232
216
  attr_accessor :tracking_key
233
217
 
234
- # Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on for more details.
218
+ # 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.
235
219
  # tracking_ship_date?: String;
236
220
  attr_accessor :tracking_ship_date
237
221
 
@@ -275,17 +259,13 @@ module AftershipAPI::Model
275
259
  # courier_connection_id?: String;
276
260
  attr_accessor :courier_connection_id
277
261
 
278
- # The next couriers get the second carrier information from user or AfterShip.
279
- # next_couriers?: NextCouriersTracking[];
280
- attr_accessor :next_couriers
281
-
282
- # (Legacy) Replaced by `origin_country_iso3`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
283
- # tracking_origin_country?: String;
284
- attr_accessor :tracking_origin_country
262
+ # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
263
+ # tracking_origin_country_region?: String;
264
+ attr_accessor :tracking_origin_country_region
285
265
 
286
- # (Legacy) Replaced by `destination_country_iso3`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
287
- # tracking_destination_country?: String;
288
- attr_accessor :tracking_destination_country
266
+ # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
267
+ # tracking_destination_country_region?: String;
268
+ attr_accessor :tracking_destination_country_region
289
269
 
290
270
  # (Legacy) Replaced by `destination_postal_code`. 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.
291
271
  # tracking_postal_code?: String;
@@ -327,6 +307,18 @@ module AftershipAPI::Model
327
307
  # aftership_tracking_order_url?: String;
328
308
  attr_accessor :aftership_tracking_order_url
329
309
 
310
+ # The field contains information about the first leg of the shipping starting from the carrier picking up the shipment from the shipper to the point where they hand it over to the last-mile carrier. Once AfterShip detects the shipment is multi-leg, we will populate the first-mile information under this object.
311
+ # first_mile?: FirstMileTracking;
312
+ attr_accessor :first_mile
313
+
314
+ # This field contains information about the last leg of the shipment, starting from the carrier who hands it over to the last-mile carrier, all the way to delivery. Once AfterShip detects that the shipment involves multiple legs and identifies the last-mile carrier, we will populate the last-mile carrier information in this object. Alternatively, the user can provide this information in this field to specify the last-mile carrier, which is helpful if AfterShip is unable to detect it automatically.
315
+ # last_mile?: LastMileTracking;
316
+ attr_accessor :last_mile
317
+
318
+ # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
319
+ # customers?: CustomersTracking[];
320
+ attr_accessor :customers
321
+
330
322
  # Initializes the object
331
323
  # @param [Hash] attributes Model attributes in the form of hash
332
324
  def initialize(attributes = {})
@@ -354,10 +346,6 @@ module AftershipAPI::Model
354
346
  self.updated_at = attributes[:'updated_at']
355
347
  end
356
348
 
357
- if attributes.key?(:'last_updated_at')
358
- self.last_updated_at = attributes[:'last_updated_at']
359
- end
360
-
361
349
  if attributes.key?(:'tracking_number')
362
350
  self.tracking_number = attributes[:'tracking_number']
363
351
  end
@@ -374,16 +362,12 @@ module AftershipAPI::Model
374
362
  self.custom_fields = attributes[:'custom_fields']
375
363
  end
376
364
 
377
- if attributes.key?(:'customer_name')
378
- self.customer_name = attributes[:'customer_name']
379
- end
380
-
381
365
  if attributes.key?(:'transit_time')
382
366
  self.transit_time = attributes[:'transit_time']
383
367
  end
384
368
 
385
- if attributes.key?(:'origin_country_iso3')
386
- self.origin_country_iso3 = attributes[:'origin_country_iso3']
369
+ if attributes.key?(:'origin_country_region')
370
+ self.origin_country_region = attributes[:'origin_country_region']
387
371
  end
388
372
 
389
373
  if attributes.key?(:'origin_state')
@@ -402,8 +386,8 @@ module AftershipAPI::Model
402
386
  self.origin_raw_location = attributes[:'origin_raw_location']
403
387
  end
404
388
 
405
- if attributes.key?(:'destination_country_iso3')
406
- self.destination_country_iso3 = attributes[:'destination_country_iso3']
389
+ if attributes.key?(:'destination_country_region')
390
+ self.destination_country_region = attributes[:'destination_country_region']
407
391
  end
408
392
 
409
393
  if attributes.key?(:'destination_state')
@@ -422,12 +406,8 @@ module AftershipAPI::Model
422
406
  self.destination_raw_location = attributes[:'destination_raw_location']
423
407
  end
424
408
 
425
- if attributes.key?(:'courier_destination_country_iso3')
426
- self.courier_destination_country_iso3 = attributes[:'courier_destination_country_iso3']
427
- end
428
-
429
- if attributes.key?(:'emails')
430
- self.emails = attributes[:'emails']
409
+ if attributes.key?(:'courier_destination_country_region')
410
+ self.courier_destination_country_region = attributes[:'courier_destination_country_region']
431
411
  end
432
412
 
433
413
  if attributes.key?(:'courier_estimated_delivery_date')
@@ -474,10 +454,6 @@ module AftershipAPI::Model
474
454
  self.signed_by = attributes[:'signed_by']
475
455
  end
476
456
 
477
- if attributes.key?(:'smses')
478
- self.smses = attributes[:'smses']
479
- end
480
-
481
457
  if attributes.key?(:'source')
482
458
  self.source = attributes[:'source']
483
459
  end
@@ -610,16 +586,12 @@ module AftershipAPI::Model
610
586
  self.courier_connection_id = attributes[:'courier_connection_id']
611
587
  end
612
588
 
613
- if attributes.key?(:'next_couriers')
614
- self.next_couriers = attributes[:'next_couriers']
615
- end
616
-
617
- if attributes.key?(:'tracking_origin_country')
618
- self.tracking_origin_country = attributes[:'tracking_origin_country']
589
+ if attributes.key?(:'tracking_origin_country_region')
590
+ self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
619
591
  end
620
592
 
621
- if attributes.key?(:'tracking_destination_country')
622
- self.tracking_destination_country = attributes[:'tracking_destination_country']
593
+ if attributes.key?(:'tracking_destination_country_region')
594
+ self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
623
595
  end
624
596
 
625
597
  if attributes.key?(:'tracking_postal_code')
@@ -661,6 +633,18 @@ module AftershipAPI::Model
661
633
  if attributes.key?(:'aftership_tracking_order_url')
662
634
  self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
663
635
  end
636
+
637
+ if attributes.key?(:'first_mile')
638
+ self.first_mile = attributes[:'first_mile']
639
+ end
640
+
641
+ if attributes.key?(:'last_mile')
642
+ self.last_mile = attributes[:'last_mile']
643
+ end
644
+
645
+ if attributes.key?(:'customers')
646
+ self.customers = attributes[:'customers']
647
+ end
664
648
  end
665
649
 
666
650
  # Attribute type mapping.
@@ -670,25 +654,22 @@ module AftershipAPI::Model
670
654
  :'legacy_id' => :'String',
671
655
  :'created_at' => :'String',
672
656
  :'updated_at' => :'String',
673
- :'last_updated_at' => :'String',
674
657
  :'tracking_number' => :'String',
675
658
  :'slug' => :'String',
676
659
  :'active' => :'Boolean',
677
660
  :'custom_fields' => :'Object',
678
- :'customer_name' => :'String',
679
661
  :'transit_time' => :'Integer',
680
- :'origin_country_iso3' => :'String',
662
+ :'origin_country_region' => :'String',
681
663
  :'origin_state' => :'String',
682
664
  :'origin_city' => :'String',
683
665
  :'origin_postal_code' => :'String',
684
666
  :'origin_raw_location' => :'String',
685
- :'destination_country_iso3' => :'String',
667
+ :'destination_country_region' => :'String',
686
668
  :'destination_state' => :'String',
687
669
  :'destination_city' => :'String',
688
670
  :'destination_postal_code' => :'String',
689
671
  :'destination_raw_location' => :'String',
690
- :'courier_destination_country_iso3' => :'String',
691
- :'emails' => :'Array<String>',
672
+ :'courier_destination_country_region' => :'String',
692
673
  :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateTracking',
693
674
  :'note' => :'String',
694
675
  :'order_id' => :'String',
@@ -700,7 +681,6 @@ module AftershipAPI::Model
700
681
  :'shipment_type' => :'String',
701
682
  :'shipment_weight' => :'ShipmentWeightTracking',
702
683
  :'signed_by' => :'String',
703
- :'smses' => :'Array<String>',
704
684
  :'source' => :'String',
705
685
  :'tag' => :'TagV1',
706
686
  :'subtag' => :'String',
@@ -734,9 +714,8 @@ module AftershipAPI::Model
734
714
  :'latest_estimated_delivery' => :'LatestEstimatedDeliveryTracking',
735
715
  :'shipment_tags' => :'Array<String>',
736
716
  :'courier_connection_id' => :'String',
737
- :'next_couriers' => :'Array<NextCouriersTracking>',
738
- :'tracking_origin_country' => :'String',
739
- :'tracking_destination_country' => :'String',
717
+ :'tracking_origin_country_region' => :'String',
718
+ :'tracking_destination_country_region' => :'String',
740
719
  :'tracking_postal_code' => :'String',
741
720
  :'tracking_state' => :'String',
742
721
  :'carbon_emissions' => :'CarbonEmissionsTracking',
@@ -747,6 +726,9 @@ module AftershipAPI::Model
747
726
  :'delivery_location_type' => :'String',
748
727
  :'aftership_tracking_url' => :'String',
749
728
  :'aftership_tracking_order_url' => :'String',
729
+ :'first_mile' => :'FirstMileTracking',
730
+ :'last_mile' => :'LastMileTracking',
731
+ :'customers' => :'Array<CustomersTracking>',
750
732
  }
751
733
  end
752
734
 
@@ -757,25 +739,22 @@ module AftershipAPI::Model
757
739
  :'legacy_id' => :'legacy_id',
758
740
  :'created_at' => :'created_at',
759
741
  :'updated_at' => :'updated_at',
760
- :'last_updated_at' => :'last_updated_at',
761
742
  :'tracking_number' => :'tracking_number',
762
743
  :'slug' => :'slug',
763
744
  :'active' => :'active',
764
745
  :'custom_fields' => :'custom_fields',
765
- :'customer_name' => :'customer_name',
766
746
  :'transit_time' => :'transit_time',
767
- :'origin_country_iso3' => :'origin_country_iso3',
747
+ :'origin_country_region' => :'origin_country_region',
768
748
  :'origin_state' => :'origin_state',
769
749
  :'origin_city' => :'origin_city',
770
750
  :'origin_postal_code' => :'origin_postal_code',
771
751
  :'origin_raw_location' => :'origin_raw_location',
772
- :'destination_country_iso3' => :'destination_country_iso3',
752
+ :'destination_country_region' => :'destination_country_region',
773
753
  :'destination_state' => :'destination_state',
774
754
  :'destination_city' => :'destination_city',
775
755
  :'destination_postal_code' => :'destination_postal_code',
776
756
  :'destination_raw_location' => :'destination_raw_location',
777
- :'courier_destination_country_iso3' => :'courier_destination_country_iso3',
778
- :'emails' => :'emails',
757
+ :'courier_destination_country_region' => :'courier_destination_country_region',
779
758
  :'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
780
759
  :'note' => :'note',
781
760
  :'order_id' => :'order_id',
@@ -787,7 +766,6 @@ module AftershipAPI::Model
787
766
  :'shipment_type' => :'shipment_type',
788
767
  :'shipment_weight' => :'shipment_weight',
789
768
  :'signed_by' => :'signed_by',
790
- :'smses' => :'smses',
791
769
  :'source' => :'source',
792
770
  :'tag' => :'tag',
793
771
  :'subtag' => :'subtag',
@@ -821,9 +799,8 @@ module AftershipAPI::Model
821
799
  :'latest_estimated_delivery' => :'latest_estimated_delivery',
822
800
  :'shipment_tags' => :'shipment_tags',
823
801
  :'courier_connection_id' => :'courier_connection_id',
824
- :'next_couriers' => :'next_couriers',
825
- :'tracking_origin_country' => :'tracking_origin_country',
826
- :'tracking_destination_country' => :'tracking_destination_country',
802
+ :'tracking_origin_country_region' => :'tracking_origin_country_region',
803
+ :'tracking_destination_country_region' => :'tracking_destination_country_region',
827
804
  :'tracking_postal_code' => :'tracking_postal_code',
828
805
  :'tracking_state' => :'tracking_state',
829
806
  :'carbon_emissions' => :'carbon_emissions',
@@ -834,6 +811,9 @@ module AftershipAPI::Model
834
811
  :'delivery_location_type' => :'delivery_location_type',
835
812
  :'aftership_tracking_url' => :'aftership_tracking_url',
836
813
  :'aftership_tracking_order_url' => :'aftership_tracking_order_url',
814
+ :'first_mile' => :'first_mile',
815
+ :'last_mile' => :'last_mile',
816
+ :'customers' => :'customers',
837
817
  }
838
818
  end
839
819
 
@@ -3,22 +3,10 @@
3
3
  module AftershipAPI::Model
4
4
  class UpdateTrackingByIdRequest
5
5
 
6
- # The phone number(s) to receive sms notifications. Input `[]` to clear the value of this field. Supports up to 3 phone numbers.
7
- # smses?: String[];
8
- attr_accessor :smses
9
-
10
- # Email address(es) to receive email notifications. Input `[]` to clear the value of this field. Supports up to 3 email addresses.
11
- # emails?: String[];
12
- attr_accessor :emails
13
-
14
6
  # By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number).
15
7
  # title?: String;
16
8
  attr_accessor :title
17
9
 
18
- # Customer name of the tracking.
19
- # customer_name?: String;
20
- attr_accessor :customer_name
21
-
22
10
  # A globally-unique identifier for the order.
23
11
  # order_id?: String;
24
12
  attr_accessor :order_id
@@ -67,7 +55,7 @@ module AftershipAPI::Model
67
55
  # tracking_key?: String;
68
56
  attr_accessor :tracking_key
69
57
 
70
- # Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on for more details.
58
+ # 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.
71
59
  # tracking_ship_date?: String;
72
60
  attr_accessor :tracking_ship_date
73
61
 
@@ -84,8 +72,8 @@ module AftershipAPI::Model
84
72
  attr_accessor :shipment_type
85
73
 
86
74
  # The for more details.
87
- # origin_country_iso3?: String;
88
- attr_accessor :origin_country_iso3
75
+ # origin_country_region?: String;
76
+ attr_accessor :origin_country_region
89
77
 
90
78
  # 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.
91
79
  # origin_state?: String;
@@ -104,8 +92,8 @@ module AftershipAPI::Model
104
92
  attr_accessor :origin_raw_location
105
93
 
106
94
  # The for more details.
107
- # destination_country_iso3?: String;
108
- attr_accessor :destination_country_iso3
95
+ # destination_country_region?: String;
96
+ attr_accessor :destination_country_region
109
97
 
110
98
  # 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.
111
99
  # destination_state?: String;
@@ -123,13 +111,13 @@ module AftershipAPI::Model
123
111
  # destination_raw_location?: String;
124
112
  attr_accessor :destination_raw_location
125
113
 
126
- # (Legacy) Replaced by `origin_country_iso3`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
127
- # tracking_origin_country?: String;
128
- attr_accessor :tracking_origin_country
114
+ # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on for more details.
115
+ # tracking_origin_country_region?: String;
116
+ attr_accessor :tracking_origin_country_region
129
117
 
130
- # (Legacy) Replaced by `destination_country_iso3`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
131
- # tracking_destination_country?: String;
132
- attr_accessor :tracking_destination_country
118
+ # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on for more details.
119
+ # tracking_destination_country_region?: String;
120
+ attr_accessor :tracking_destination_country_region
133
121
 
134
122
  # (Legacy) Replaced by `destination_postal_code`. 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.
135
123
  # tracking_postal_code?: String;
@@ -147,6 +135,10 @@ module AftershipAPI::Model
147
135
  # shipping_method?: String;
148
136
  attr_accessor :shipping_method
149
137
 
138
+ # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
139
+ # customers?: CustomersUpdateTrackingByIdRequest[];
140
+ attr_accessor :customers
141
+
150
142
  # Initializes the object
151
143
  # @param [Hash] attributes Model attributes in the form of hash
152
144
  def initialize(attributes = {})
@@ -158,22 +150,10 @@ module AftershipAPI::Model
158
150
  h[k.to_sym] = v
159
151
  }
160
152
 
161
- if attributes.key?(:'smses')
162
- self.smses = attributes[:'smses']
163
- end
164
-
165
- if attributes.key?(:'emails')
166
- self.emails = attributes[:'emails']
167
- end
168
-
169
153
  if attributes.key?(:'title')
170
154
  self.title = attributes[:'title']
171
155
  end
172
156
 
173
- if attributes.key?(:'customer_name')
174
- self.customer_name = attributes[:'customer_name']
175
- end
176
-
177
157
  if attributes.key?(:'order_id')
178
158
  self.order_id = attributes[:'order_id']
179
159
  end
@@ -238,8 +218,8 @@ module AftershipAPI::Model
238
218
  self.shipment_type = attributes[:'shipment_type']
239
219
  end
240
220
 
241
- if attributes.key?(:'origin_country_iso3')
242
- self.origin_country_iso3 = attributes[:'origin_country_iso3']
221
+ if attributes.key?(:'origin_country_region')
222
+ self.origin_country_region = attributes[:'origin_country_region']
243
223
  end
244
224
 
245
225
  if attributes.key?(:'origin_state')
@@ -258,8 +238,8 @@ module AftershipAPI::Model
258
238
  self.origin_raw_location = attributes[:'origin_raw_location']
259
239
  end
260
240
 
261
- if attributes.key?(:'destination_country_iso3')
262
- self.destination_country_iso3 = attributes[:'destination_country_iso3']
241
+ if attributes.key?(:'destination_country_region')
242
+ self.destination_country_region = attributes[:'destination_country_region']
263
243
  end
264
244
 
265
245
  if attributes.key?(:'destination_state')
@@ -278,12 +258,12 @@ module AftershipAPI::Model
278
258
  self.destination_raw_location = attributes[:'destination_raw_location']
279
259
  end
280
260
 
281
- if attributes.key?(:'tracking_origin_country')
282
- self.tracking_origin_country = attributes[:'tracking_origin_country']
261
+ if attributes.key?(:'tracking_origin_country_region')
262
+ self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
283
263
  end
284
264
 
285
- if attributes.key?(:'tracking_destination_country')
286
- self.tracking_destination_country = attributes[:'tracking_destination_country']
265
+ if attributes.key?(:'tracking_destination_country_region')
266
+ self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
287
267
  end
288
268
 
289
269
  if attributes.key?(:'tracking_postal_code')
@@ -301,15 +281,16 @@ module AftershipAPI::Model
301
281
  if attributes.key?(:'shipping_method')
302
282
  self.shipping_method = attributes[:'shipping_method']
303
283
  end
284
+
285
+ if attributes.key?(:'customers')
286
+ self.customers = attributes[:'customers']
287
+ end
304
288
  end
305
289
 
306
290
  # Attribute type mapping.
307
291
  def self.openapi_types
308
292
  {
309
- :'smses' => :'Array<String>',
310
- :'emails' => :'Array<String>',
311
293
  :'title' => :'String',
312
- :'customer_name' => :'String',
313
294
  :'order_id' => :'String',
314
295
  :'order_id_path' => :'String',
315
296
  :'custom_fields' => :'Object',
@@ -326,32 +307,30 @@ module AftershipAPI::Model
326
307
  :'order_number' => :'String',
327
308
  :'order_date' => :'String',
328
309
  :'shipment_type' => :'String',
329
- :'origin_country_iso3' => :'String',
310
+ :'origin_country_region' => :'String',
330
311
  :'origin_state' => :'String',
331
312
  :'origin_city' => :'String',
332
313
  :'origin_postal_code' => :'String',
333
314
  :'origin_raw_location' => :'String',
334
- :'destination_country_iso3' => :'String',
315
+ :'destination_country_region' => :'String',
335
316
  :'destination_state' => :'String',
336
317
  :'destination_city' => :'String',
337
318
  :'destination_postal_code' => :'String',
338
319
  :'destination_raw_location' => :'String',
339
- :'tracking_origin_country' => :'String',
340
- :'tracking_destination_country' => :'String',
320
+ :'tracking_origin_country_region' => :'String',
321
+ :'tracking_destination_country_region' => :'String',
341
322
  :'tracking_postal_code' => :'String',
342
323
  :'tracking_state' => :'String',
343
324
  :'location_id' => :'String',
344
325
  :'shipping_method' => :'String',
326
+ :'customers' => :'Array<CustomersUpdateTrackingByIdRequest>',
345
327
  }
346
328
  end
347
329
 
348
330
  # Attribute mapping from ruby-style variable name to JSON key.
349
331
  def self.attribute_map
350
332
  {
351
- :'smses' => :'smses',
352
- :'emails' => :'emails',
353
333
  :'title' => :'title',
354
- :'customer_name' => :'customer_name',
355
334
  :'order_id' => :'order_id',
356
335
  :'order_id_path' => :'order_id_path',
357
336
  :'custom_fields' => :'custom_fields',
@@ -368,22 +347,23 @@ module AftershipAPI::Model
368
347
  :'order_number' => :'order_number',
369
348
  :'order_date' => :'order_date',
370
349
  :'shipment_type' => :'shipment_type',
371
- :'origin_country_iso3' => :'origin_country_iso3',
350
+ :'origin_country_region' => :'origin_country_region',
372
351
  :'origin_state' => :'origin_state',
373
352
  :'origin_city' => :'origin_city',
374
353
  :'origin_postal_code' => :'origin_postal_code',
375
354
  :'origin_raw_location' => :'origin_raw_location',
376
- :'destination_country_iso3' => :'destination_country_iso3',
355
+ :'destination_country_region' => :'destination_country_region',
377
356
  :'destination_state' => :'destination_state',
378
357
  :'destination_city' => :'destination_city',
379
358
  :'destination_postal_code' => :'destination_postal_code',
380
359
  :'destination_raw_location' => :'destination_raw_location',
381
- :'tracking_origin_country' => :'tracking_origin_country',
382
- :'tracking_destination_country' => :'tracking_destination_country',
360
+ :'tracking_origin_country_region' => :'tracking_origin_country_region',
361
+ :'tracking_destination_country_region' => :'tracking_destination_country_region',
383
362
  :'tracking_postal_code' => :'tracking_postal_code',
384
363
  :'tracking_state' => :'tracking_state',
385
364
  :'location_id' => :'location_id',
386
365
  :'shipping_method' => :'shipping_method',
366
+ :'customers' => :'customers',
387
367
  }
388
368
  end
389
369