aftership-tracking-sdk 8.0.0 → 9.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/README.md +4 -3
  4. data/lib/aftership-tracking-sdk/api/courier.rb +6 -6
  5. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +4 -4
  6. data/lib/aftership-tracking-sdk/api/tracking.rb +23 -389
  7. data/lib/aftership-tracking-sdk/api_client.rb +2 -2
  8. data/lib/aftership-tracking-sdk/configuration.rb +108 -108
  9. data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb +1 -1
  10. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb +2 -0
  11. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb +2 -0
  12. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb +2 -0
  13. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +2 -0
  14. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_id_response.rb +2 -0
  15. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_tracking.rb +2 -0
  16. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_id_response.rb +2 -0
  17. data/lib/aftership-tracking-sdk/models/carbon_emissions_create_tracking_response.rb +2 -0
  18. data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_id_response.rb +2 -0
  19. data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_id_response.rb +2 -0
  20. data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_id_response.rb +2 -0
  21. data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_id_response.rb +2 -0
  22. data/lib/aftership-tracking-sdk/models/carbon_emissions_tracking.rb +2 -0
  23. data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_id_response.rb +2 -0
  24. data/lib/aftership-tracking-sdk/models/checkpoint.rb +2 -0
  25. data/lib/aftership-tracking-sdk/models/coordinate_checkpoint.rb +2 -0
  26. data/lib/aftership-tracking-sdk/models/courier.rb +2 -0
  27. data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_create_tracking_response.rb} +7 -15
  28. data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_delete_tracking_by_id_response.rb} +7 -15
  29. data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_get_tracking_by_id_response.rb} +7 -15
  30. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +173 -0
  31. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_retrack_tracking_by_id_response.rb +173 -0
  32. data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb → courier_estimated_delivery_date_tracking.rb} +7 -15
  33. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_update_tracking_by_id_response.rb +173 -0
  34. data/lib/aftership-tracking-sdk/models/courier_response_v1.rb +2 -0
  35. data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +2 -0
  36. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +29 -7
  37. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb +2 -0
  38. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb +2 -0
  39. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb +2 -0
  40. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +2 -0
  41. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb +2 -0
  42. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb +2 -0
  43. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb +2 -0
  44. data/lib/aftership-tracking-sdk/models/data_courier_response_v1.rb +2 -0
  45. data/lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb +8 -126
  46. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +29 -7
  47. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +2 -0
  48. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +2 -0
  49. data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +2 -0
  50. data/lib/aftership-tracking-sdk/models/detect_courier_response.rb +2 -0
  51. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb +2 -0
  52. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +2 -0
  53. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb +2 -0
  54. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb +2 -0
  55. data/lib/aftership-tracking-sdk/models/events_checkpoint.rb +2 -0
  56. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb +2 -0
  57. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb +2 -0
  58. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb +2 -0
  59. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_id_response.rb +2 -0
  60. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb +2 -0
  61. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_tracking.rb +2 -0
  62. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb +2 -0
  63. data/lib/aftership-tracking-sdk/models/get_all_couriers_response.rb +2 -0
  64. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +29 -7
  65. data/lib/aftership-tracking-sdk/models/get_trackings_response.rb +5 -3
  66. data/lib/aftership-tracking-sdk/models/get_user_couriers_response.rb +2 -0
  67. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +2 -0
  68. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +2 -0
  69. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +2 -0
  70. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +2 -0
  71. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +2 -0
  72. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb +2 -0
  73. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +2 -0
  74. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +2 -0
  75. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +29 -7
  76. data/lib/aftership-tracking-sdk/models/meta_v1.rb +2 -0
  77. data/lib/aftership-tracking-sdk/models/next_couriers_create_tracking_request.rb +2 -0
  78. data/lib/aftership-tracking-sdk/models/next_couriers_create_tracking_response.rb +22 -0
  79. data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_id_response.rb +22 -0
  80. data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_id_response.rb +22 -0
  81. data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_id_response.rb +22 -0
  82. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +22 -0
  83. data/lib/aftership-tracking-sdk/models/next_couriers_tracking.rb +22 -0
  84. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +22 -0
  85. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb +2 -0
  86. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb +2 -0
  87. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +2 -0
  88. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +2 -0
  89. data/lib/aftership-tracking-sdk/models/pagination.rb +14 -6
  90. data/lib/aftership-tracking-sdk/models/{next_couriers_get_tracking_by_slug_tracking_number_response.rb → pagination_data_tracking_response_get_multiple_v1.rb} +25 -23
  91. data/lib/aftership-tracking-sdk/models/{next_couriers_delete_tracking_by_slug_tracking_number_response.rb → pagination_get_trackings_response.rb} +25 -23
  92. data/lib/aftership-tracking-sdk/models/predict_batch_request.rb +2 -0
  93. data/lib/aftership-tracking-sdk/models/predict_batch_response.rb +2 -0
  94. data/lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb +2 -0
  95. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +29 -7
  96. data/lib/aftership-tracking-sdk/models/shipment_weight_create_tracking_response.rb +2 -0
  97. data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_id_response.rb +2 -0
  98. data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_id_response.rb +2 -0
  99. data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_id_response.rb +2 -0
  100. data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb +2 -0
  101. data/lib/aftership-tracking-sdk/models/shipment_weight_tracking.rb +2 -0
  102. data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb +2 -0
  103. data/lib/aftership-tracking-sdk/models/slug_group_v1.rb +1 -1
  104. data/lib/aftership-tracking-sdk/models/tag_v1.rb +1 -1
  105. data/lib/aftership-tracking-sdk/models/tracking.rb +29 -7
  106. data/lib/aftership-tracking-sdk/models/tracking_response_get_multiple_v1.rb +2 -0
  107. data/lib/aftership-tracking-sdk/models/tracking_response_v1.rb +2 -0
  108. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +2 -0
  109. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +29 -7
  110. data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb +2 -0
  111. data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb +2 -0
  112. data/lib/aftership-tracking-sdk/version.rb +1 -1
  113. metadata +11 -45
  114. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +0 -181
  115. data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_slug_tracking_number_response.rb +0 -161
  116. data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_slug_tracking_number_response.rb +0 -161
  117. data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -161
  118. data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_slug_tracking_number_response.rb +0 -161
  119. data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_slug_tracking_number_response.rb +0 -161
  120. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb +0 -181
  121. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +0 -181
  122. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -181
  123. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +0 -181
  124. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +0 -181
  125. data/lib/aftership-tracking-sdk/models/custom_fields_update_tracking_by_slug_tracking_number_request.rb +0 -139
  126. data/lib/aftership-tracking-sdk/models/delete_tracking_by_slug_tracking_number_response.rb +0 -931
  127. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +0 -191
  128. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +0 -191
  129. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -191
  130. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +0 -191
  131. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +0 -191
  132. data/lib/aftership-tracking-sdk/models/get_tracking_by_slug_tracking_number_response.rb +0 -931
  133. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +0 -191
  134. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +0 -191
  135. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -191
  136. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +0 -191
  137. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +0 -191
  138. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_request.rb +0 -151
  139. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_response.rb +0 -931
  140. data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -171
  141. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_slug_tracking_number_response.rb +0 -171
  142. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_slug_tracking_number_response.rb +0 -171
  143. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_slug_tracking_number_response.rb +0 -931
  144. data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_slug_tracking_number_response.rb +0 -161
  145. data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_slug_tracking_number_response.rb +0 -161
  146. data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_slug_tracking_number_response.rb +0 -161
  147. data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_slug_tracking_number_response.rb +0 -161
  148. data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_slug_tracking_number_response.rb +0 -161
  149. data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_request.rb +0 -391
  150. data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_response.rb +0 -931
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class FirstEstimatedDeliveryTracking
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class FirstEstimatedDeliveryUpdateTrackingByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class GetAllCouriersResponse
5
+
5
6
  # Total count of courier objects
6
7
  # total?: Integer;
7
8
  attr_accessor :total
@@ -159,3 +160,4 @@ module AftershipAPI::Model
159
160
  end
160
161
  end
161
162
  end
163
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class GetTrackingByIdResponse
5
+
5
6
  # Tracking ID.
6
7
  # id?: String;
7
8
  attr_accessor :id
@@ -94,9 +95,9 @@ module AftershipAPI::Model
94
95
  # emails?: String[];
95
96
  attr_accessor :emails
96
97
 
97
- # The estimated delivery date provided by the carrier. It uses the shipment recipient’s timezone and the format may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
98
- # expected_delivery?: String;
99
- attr_accessor :expected_delivery
98
+ # The field contains the estimated delivery date provided by the carrier.
99
+ # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateGetTrackingByIdResponse;
100
+ attr_accessor :courier_estimated_delivery_date
100
101
 
101
102
  # Text field for the note.
102
103
  # note?: String;
@@ -318,6 +319,14 @@ module AftershipAPI::Model
318
319
  # delivery_location_type?: String;
319
320
  attr_accessor :delivery_location_type
320
321
 
322
+ # The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
323
+ # aftership_tracking_url?: String;
324
+ attr_accessor :aftership_tracking_url
325
+
326
+ # The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
327
+ # aftership_tracking_order_url?: String;
328
+ attr_accessor :aftership_tracking_order_url
329
+
321
330
  # Initializes the object
322
331
  # @param [Hash] attributes Model attributes in the form of hash
323
332
  def initialize(attributes = {})
@@ -421,8 +430,8 @@ module AftershipAPI::Model
421
430
  self.emails = attributes[:'emails']
422
431
  end
423
432
 
424
- if attributes.key?(:'expected_delivery')
425
- self.expected_delivery = attributes[:'expected_delivery']
433
+ if attributes.key?(:'courier_estimated_delivery_date')
434
+ self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
426
435
  end
427
436
 
428
437
  if attributes.key?(:'note')
@@ -644,6 +653,14 @@ module AftershipAPI::Model
644
653
  if attributes.key?(:'delivery_location_type')
645
654
  self.delivery_location_type = attributes[:'delivery_location_type']
646
655
  end
656
+
657
+ if attributes.key?(:'aftership_tracking_url')
658
+ self.aftership_tracking_url = attributes[:'aftership_tracking_url']
659
+ end
660
+
661
+ if attributes.key?(:'aftership_tracking_order_url')
662
+ self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
663
+ end
647
664
  end
648
665
 
649
666
  # Attribute type mapping.
@@ -672,7 +689,7 @@ module AftershipAPI::Model
672
689
  :'destination_raw_location' => :'String',
673
690
  :'courier_destination_country_iso3' => :'String',
674
691
  :'emails' => :'Array<String>',
675
- :'expected_delivery' => :'String',
692
+ :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateGetTrackingByIdResponse',
676
693
  :'note' => :'String',
677
694
  :'order_id' => :'String',
678
695
  :'order_id_path' => :'String',
@@ -728,6 +745,8 @@ module AftershipAPI::Model
728
745
  :'failed_delivery_attempts' => :'Integer',
729
746
  :'signature_requirement' => :'String',
730
747
  :'delivery_location_type' => :'String',
748
+ :'aftership_tracking_url' => :'String',
749
+ :'aftership_tracking_order_url' => :'String',
731
750
  }
732
751
  end
733
752
 
@@ -757,7 +776,7 @@ module AftershipAPI::Model
757
776
  :'destination_raw_location' => :'destination_raw_location',
758
777
  :'courier_destination_country_iso3' => :'courier_destination_country_iso3',
759
778
  :'emails' => :'emails',
760
- :'expected_delivery' => :'expected_delivery',
779
+ :'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
761
780
  :'note' => :'note',
762
781
  :'order_id' => :'order_id',
763
782
  :'order_id_path' => :'order_id_path',
@@ -813,6 +832,8 @@ module AftershipAPI::Model
813
832
  :'failed_delivery_attempts' => :'failed_delivery_attempts',
814
833
  :'signature_requirement' => :'signature_requirement',
815
834
  :'delivery_location_type' => :'delivery_location_type',
835
+ :'aftership_tracking_url' => :'aftership_tracking_url',
836
+ :'aftership_tracking_order_url' => :'aftership_tracking_order_url',
816
837
  }
817
838
  end
818
839
 
@@ -929,3 +950,4 @@ module AftershipAPI::Model
929
950
  end
930
951
  end
931
952
  end
953
+
@@ -2,8 +2,9 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class GetTrackingsResponse
5
- #
6
- # pagination: Pagination;
5
+
6
+ # The Pagination holds the information for the pagination when the response contains multiple objects.
7
+ # pagination?: PaginationGetTrackingsResponse;
7
8
  attr_accessor :pagination
8
9
 
9
10
  # Array of
@@ -33,7 +34,7 @@ module AftershipAPI::Model
33
34
  # Attribute type mapping.
34
35
  def self.openapi_types
35
36
  {
36
- :'pagination' => :'Pagination',
37
+ :'pagination' => :'PaginationGetTrackingsResponse',
37
38
  :'trackings' => :'Array<Tracking>',
38
39
  }
39
40
  end
@@ -159,3 +160,4 @@ module AftershipAPI::Model
159
160
  end
160
161
  end
161
162
  end
163
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class GetUserCouriersResponse
5
+
5
6
  # Total count of courier objects
6
7
  # total?: Integer;
7
8
  attr_accessor :total
@@ -159,3 +160,4 @@ module AftershipAPI::Model
159
160
  end
160
161
  end
161
162
  end
163
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryCreateTrackingResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryDeleteTrackingByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryGetTrackingByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryMarkTrackingCompletedByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryRetrackTrackingByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryTracking
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class LatestEstimatedDeliveryUpdateTrackingByIdResponse
5
+
5
6
  # The format of the EDD. Either a single date or a date range.
6
7
  # type?: String;
7
8
  attr_accessor :type
@@ -189,3 +190,4 @@ module AftershipAPI::Model
189
190
  end
190
191
  end
191
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class MarkTrackingCompletedByIdRequest
5
+
5
6
  # One of `DELIVERED`, `LOST` or `RETURNED_TO_SENDER`.- Mark the tracking as completed with `DELIVERED`. The tag of the tracking will be updated to `Delivered` and the subtag will be updated to `Delivered_001`.- Mark the tracking as completed with `LOST`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_013`.- Mark the tracking as completed with `RETURNED_TO_SENDER`. The tag of the tracking will be updated to `Exception` and the subtag will be updated to `Exception_011`.
6
7
  # reason: String;
7
8
  attr_accessor :reason
@@ -149,3 +150,4 @@ module AftershipAPI::Model
149
150
  end
150
151
  end
151
152
  end
153
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class MarkTrackingCompletedByIdResponse
5
+
5
6
  # Tracking ID.
6
7
  # id?: String;
7
8
  attr_accessor :id
@@ -94,9 +95,9 @@ module AftershipAPI::Model
94
95
  # emails?: String[];
95
96
  attr_accessor :emails
96
97
 
97
- # The estimated delivery date provided by the carrier. It uses the shipment recipient’s timezone and the format may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
98
- # expected_delivery?: String;
99
- attr_accessor :expected_delivery
98
+ # The field contains the estimated delivery date provided by the carrier.
99
+ # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateMarkTrackingCompletedByIdResponse;
100
+ attr_accessor :courier_estimated_delivery_date
100
101
 
101
102
  # Text field for the note.
102
103
  # note?: String;
@@ -318,6 +319,14 @@ module AftershipAPI::Model
318
319
  # delivery_location_type?: String;
319
320
  attr_accessor :delivery_location_type
320
321
 
322
+ # The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
323
+ # aftership_tracking_url?: String;
324
+ attr_accessor :aftership_tracking_url
325
+
326
+ # The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
327
+ # aftership_tracking_order_url?: String;
328
+ attr_accessor :aftership_tracking_order_url
329
+
321
330
  # Initializes the object
322
331
  # @param [Hash] attributes Model attributes in the form of hash
323
332
  def initialize(attributes = {})
@@ -421,8 +430,8 @@ module AftershipAPI::Model
421
430
  self.emails = attributes[:'emails']
422
431
  end
423
432
 
424
- if attributes.key?(:'expected_delivery')
425
- self.expected_delivery = attributes[:'expected_delivery']
433
+ if attributes.key?(:'courier_estimated_delivery_date')
434
+ self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
426
435
  end
427
436
 
428
437
  if attributes.key?(:'note')
@@ -644,6 +653,14 @@ module AftershipAPI::Model
644
653
  if attributes.key?(:'delivery_location_type')
645
654
  self.delivery_location_type = attributes[:'delivery_location_type']
646
655
  end
656
+
657
+ if attributes.key?(:'aftership_tracking_url')
658
+ self.aftership_tracking_url = attributes[:'aftership_tracking_url']
659
+ end
660
+
661
+ if attributes.key?(:'aftership_tracking_order_url')
662
+ self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
663
+ end
647
664
  end
648
665
 
649
666
  # Attribute type mapping.
@@ -672,7 +689,7 @@ module AftershipAPI::Model
672
689
  :'destination_raw_location' => :'String',
673
690
  :'courier_destination_country_iso3' => :'String',
674
691
  :'emails' => :'Array<String>',
675
- :'expected_delivery' => :'String',
692
+ :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateMarkTrackingCompletedByIdResponse',
676
693
  :'note' => :'String',
677
694
  :'order_id' => :'String',
678
695
  :'order_id_path' => :'String',
@@ -728,6 +745,8 @@ module AftershipAPI::Model
728
745
  :'failed_delivery_attempts' => :'Integer',
729
746
  :'signature_requirement' => :'String',
730
747
  :'delivery_location_type' => :'String',
748
+ :'aftership_tracking_url' => :'String',
749
+ :'aftership_tracking_order_url' => :'String',
731
750
  }
732
751
  end
733
752
 
@@ -757,7 +776,7 @@ module AftershipAPI::Model
757
776
  :'destination_raw_location' => :'destination_raw_location',
758
777
  :'courier_destination_country_iso3' => :'courier_destination_country_iso3',
759
778
  :'emails' => :'emails',
760
- :'expected_delivery' => :'expected_delivery',
779
+ :'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
761
780
  :'note' => :'note',
762
781
  :'order_id' => :'order_id',
763
782
  :'order_id_path' => :'order_id_path',
@@ -813,6 +832,8 @@ module AftershipAPI::Model
813
832
  :'failed_delivery_attempts' => :'failed_delivery_attempts',
814
833
  :'signature_requirement' => :'signature_requirement',
815
834
  :'delivery_location_type' => :'delivery_location_type',
835
+ :'aftership_tracking_url' => :'aftership_tracking_url',
836
+ :'aftership_tracking_order_url' => :'aftership_tracking_order_url',
816
837
  }
817
838
  end
818
839
 
@@ -929,3 +950,4 @@ module AftershipAPI::Model
929
950
  end
930
951
  end
931
952
  end
953
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class MetaV1
5
+
5
6
  # meta code
6
7
  # code: Integer;
7
8
  attr_accessor :code
@@ -169,3 +170,4 @@ module AftershipAPI::Model
169
170
  end
170
171
  end
171
172
  end
173
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class NextCouriersCreateTrackingRequest
5
+
5
6
  #
6
7
  # slug: String;
7
8
  attr_accessor :slug
@@ -159,3 +160,4 @@ module AftershipAPI::Model
159
160
  end
160
161
  end
161
162
  end
163
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class NextCouriersCreateTrackingResponse
5
+
5
6
  # Unique code of courier. Get courier
6
7
  # slug: String;
7
8
  attr_accessor :slug
@@ -14,6 +15,14 @@ module AftershipAPI::Model
14
15
  # source?: String;
15
16
  attr_accessor :source
16
17
 
18
+ # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
+ # courier_tracking_link?: String;
20
+ attr_accessor :courier_tracking_link
21
+
22
+ # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
+ # courier_redirect_link?: String;
24
+ attr_accessor :courier_redirect_link
25
+
17
26
  # Initializes the object
18
27
  # @param [Hash] attributes Model attributes in the form of hash
19
28
  def initialize(attributes = {})
@@ -36,6 +45,14 @@ module AftershipAPI::Model
36
45
  if attributes.key?(:'source')
37
46
  self.source = attributes[:'source']
38
47
  end
48
+
49
+ if attributes.key?(:'courier_tracking_link')
50
+ self.courier_tracking_link = attributes[:'courier_tracking_link']
51
+ end
52
+
53
+ if attributes.key?(:'courier_redirect_link')
54
+ self.courier_redirect_link = attributes[:'courier_redirect_link']
55
+ end
39
56
  end
40
57
 
41
58
  # Attribute type mapping.
@@ -44,6 +61,8 @@ module AftershipAPI::Model
44
61
  :'slug' => :'String',
45
62
  :'tracking_number' => :'String',
46
63
  :'source' => :'String',
64
+ :'courier_tracking_link' => :'String',
65
+ :'courier_redirect_link' => :'String',
47
66
  }
48
67
  end
49
68
 
@@ -53,6 +72,8 @@ module AftershipAPI::Model
53
72
  :'slug' => :'slug',
54
73
  :'tracking_number' => :'tracking_number',
55
74
  :'source' => :'source',
75
+ :'courier_tracking_link' => :'courier_tracking_link',
76
+ :'courier_redirect_link' => :'courier_redirect_link',
56
77
  }
57
78
  end
58
79
 
@@ -169,3 +190,4 @@ module AftershipAPI::Model
169
190
  end
170
191
  end
171
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class NextCouriersDeleteTrackingByIdResponse
5
+
5
6
  # Unique code of courier. Get courier
6
7
  # slug: String;
7
8
  attr_accessor :slug
@@ -14,6 +15,14 @@ module AftershipAPI::Model
14
15
  # source?: String;
15
16
  attr_accessor :source
16
17
 
18
+ # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
+ # courier_tracking_link?: String;
20
+ attr_accessor :courier_tracking_link
21
+
22
+ # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
+ # courier_redirect_link?: String;
24
+ attr_accessor :courier_redirect_link
25
+
17
26
  # Initializes the object
18
27
  # @param [Hash] attributes Model attributes in the form of hash
19
28
  def initialize(attributes = {})
@@ -36,6 +45,14 @@ module AftershipAPI::Model
36
45
  if attributes.key?(:'source')
37
46
  self.source = attributes[:'source']
38
47
  end
48
+
49
+ if attributes.key?(:'courier_tracking_link')
50
+ self.courier_tracking_link = attributes[:'courier_tracking_link']
51
+ end
52
+
53
+ if attributes.key?(:'courier_redirect_link')
54
+ self.courier_redirect_link = attributes[:'courier_redirect_link']
55
+ end
39
56
  end
40
57
 
41
58
  # Attribute type mapping.
@@ -44,6 +61,8 @@ module AftershipAPI::Model
44
61
  :'slug' => :'String',
45
62
  :'tracking_number' => :'String',
46
63
  :'source' => :'String',
64
+ :'courier_tracking_link' => :'String',
65
+ :'courier_redirect_link' => :'String',
47
66
  }
48
67
  end
49
68
 
@@ -53,6 +72,8 @@ module AftershipAPI::Model
53
72
  :'slug' => :'slug',
54
73
  :'tracking_number' => :'tracking_number',
55
74
  :'source' => :'source',
75
+ :'courier_tracking_link' => :'courier_tracking_link',
76
+ :'courier_redirect_link' => :'courier_redirect_link',
56
77
  }
57
78
  end
58
79
 
@@ -169,3 +190,4 @@ module AftershipAPI::Model
169
190
  end
170
191
  end
171
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class NextCouriersGetTrackingByIdResponse
5
+
5
6
  # Unique code of courier. Get courier
6
7
  # slug: String;
7
8
  attr_accessor :slug
@@ -14,6 +15,14 @@ module AftershipAPI::Model
14
15
  # source?: String;
15
16
  attr_accessor :source
16
17
 
18
+ # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
+ # courier_tracking_link?: String;
20
+ attr_accessor :courier_tracking_link
21
+
22
+ # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
+ # courier_redirect_link?: String;
24
+ attr_accessor :courier_redirect_link
25
+
17
26
  # Initializes the object
18
27
  # @param [Hash] attributes Model attributes in the form of hash
19
28
  def initialize(attributes = {})
@@ -36,6 +45,14 @@ module AftershipAPI::Model
36
45
  if attributes.key?(:'source')
37
46
  self.source = attributes[:'source']
38
47
  end
48
+
49
+ if attributes.key?(:'courier_tracking_link')
50
+ self.courier_tracking_link = attributes[:'courier_tracking_link']
51
+ end
52
+
53
+ if attributes.key?(:'courier_redirect_link')
54
+ self.courier_redirect_link = attributes[:'courier_redirect_link']
55
+ end
39
56
  end
40
57
 
41
58
  # Attribute type mapping.
@@ -44,6 +61,8 @@ module AftershipAPI::Model
44
61
  :'slug' => :'String',
45
62
  :'tracking_number' => :'String',
46
63
  :'source' => :'String',
64
+ :'courier_tracking_link' => :'String',
65
+ :'courier_redirect_link' => :'String',
47
66
  }
48
67
  end
49
68
 
@@ -53,6 +72,8 @@ module AftershipAPI::Model
53
72
  :'slug' => :'slug',
54
73
  :'tracking_number' => :'tracking_number',
55
74
  :'source' => :'source',
75
+ :'courier_tracking_link' => :'courier_tracking_link',
76
+ :'courier_redirect_link' => :'courier_redirect_link',
56
77
  }
57
78
  end
58
79
 
@@ -169,3 +190,4 @@ module AftershipAPI::Model
169
190
  end
170
191
  end
171
192
  end
193
+
@@ -2,6 +2,7 @@
2
2
  # Do not edit the class manually.
3
3
  module AftershipAPI::Model
4
4
  class NextCouriersMarkTrackingCompletedByIdResponse
5
+
5
6
  # Unique code of courier. Get courier
6
7
  # slug: String;
7
8
  attr_accessor :slug
@@ -14,6 +15,14 @@ module AftershipAPI::Model
14
15
  # source?: String;
15
16
  attr_accessor :source
16
17
 
18
+ # The field contains the official tracking URL of the next courier, if available. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
19
+ # courier_tracking_link?: String;
20
+ attr_accessor :courier_tracking_link
21
+
22
+ # The field provides the link for modifying delivery instructions (such as delivery date and shipping address) if supported by the next carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the data related to the destination country/region and the shipment's language is unavailable, AfterShip will default the language parameter of the link to "US".
23
+ # courier_redirect_link?: String;
24
+ attr_accessor :courier_redirect_link
25
+
17
26
  # Initializes the object
18
27
  # @param [Hash] attributes Model attributes in the form of hash
19
28
  def initialize(attributes = {})
@@ -36,6 +45,14 @@ module AftershipAPI::Model
36
45
  if attributes.key?(:'source')
37
46
  self.source = attributes[:'source']
38
47
  end
48
+
49
+ if attributes.key?(:'courier_tracking_link')
50
+ self.courier_tracking_link = attributes[:'courier_tracking_link']
51
+ end
52
+
53
+ if attributes.key?(:'courier_redirect_link')
54
+ self.courier_redirect_link = attributes[:'courier_redirect_link']
55
+ end
39
56
  end
40
57
 
41
58
  # Attribute type mapping.
@@ -44,6 +61,8 @@ module AftershipAPI::Model
44
61
  :'slug' => :'String',
45
62
  :'tracking_number' => :'String',
46
63
  :'source' => :'String',
64
+ :'courier_tracking_link' => :'String',
65
+ :'courier_redirect_link' => :'String',
47
66
  }
48
67
  end
49
68
 
@@ -53,6 +72,8 @@ module AftershipAPI::Model
53
72
  :'slug' => :'slug',
54
73
  :'tracking_number' => :'tracking_number',
55
74
  :'source' => :'source',
75
+ :'courier_tracking_link' => :'courier_tracking_link',
76
+ :'courier_redirect_link' => :'courier_redirect_link',
56
77
  }
57
78
  end
58
79
 
@@ -169,3 +190,4 @@ module AftershipAPI::Model
169
190
  end
170
191
  end
171
192
  end
193
+