aftership-tracking-sdk 7.0.0 → 8.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +66 -82
  3. data/lib/aftership-tracking-sdk/api/courier.rb +6 -6
  4. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +1 -1
  5. data/lib/aftership-tracking-sdk/api/tracking.rb +74 -74
  6. data/lib/aftership-tracking-sdk/configuration.rb +1 -1
  7. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb +181 -0
  8. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb +181 -0
  9. data/lib/aftership-tracking-sdk/models/{get_checkpoint_by_tracking_id_response.rb → aftership_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb} +30 -60
  10. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb +181 -0
  11. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +181 -0
  12. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +181 -0
  13. data/lib/aftership-tracking-sdk/models/{get_checkpoint_by_slug_tracking_number_response.rb → aftership_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb} +30 -60
  14. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_id_response.rb +181 -0
  15. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +181 -0
  16. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_id_response.rb +181 -0
  17. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +181 -0
  18. data/lib/aftership-tracking-sdk/models/carbon_emissions_create_tracking_response.rb +161 -0
  19. data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_id_response.rb +161 -0
  20. data/lib/aftership-tracking-sdk/models/carbon_emissions_delete_tracking_by_slug_tracking_number_response.rb +161 -0
  21. data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_id_response.rb +161 -0
  22. data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_slug_tracking_number_response.rb +161 -0
  23. data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_id_response.rb +161 -0
  24. data/lib/aftership-tracking-sdk/models/carbon_emissions_mark_tracking_completed_by_slug_tracking_number_response.rb +161 -0
  25. data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_id_response.rb +161 -0
  26. data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_slug_tracking_number_response.rb +161 -0
  27. data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_id_response.rb +161 -0
  28. data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_slug_tracking_number_response.rb +161 -0
  29. data/lib/aftership-tracking-sdk/models/{tracking_create_tracking_request.rb → create_tracking_request.rb} +7 -7
  30. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +931 -0
  31. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_create_tracking_response.rb +181 -0
  32. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb +181 -0
  33. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_slug_tracking_number_response.rb +181 -0
  34. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb +181 -0
  35. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_slug_tracking_number_response.rb +181 -0
  36. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +181 -0
  37. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_slug_tracking_number_response.rb +181 -0
  38. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb +181 -0
  39. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_slug_tracking_number_response.rb +181 -0
  40. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb +181 -0
  41. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_slug_tracking_number_response.rb +181 -0
  42. data/lib/aftership-tracking-sdk/models/{custom_fields_tracking_update_tracking_by_slug_tracking_number_request.rb → custom_fields_update_tracking_by_slug_tracking_number_request.rb} +2 -2
  43. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +931 -0
  44. data/lib/aftership-tracking-sdk/models/delete_tracking_by_slug_tracking_number_response.rb +931 -0
  45. data/lib/aftership-tracking-sdk/models/{tracking_detect_courier_request.rb → detect_courier_request.rb} +3 -3
  46. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +10 -0
  47. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb +191 -0
  48. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb +191 -0
  49. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +191 -0
  50. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb +191 -0
  51. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +191 -0
  52. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_id_response.rb +191 -0
  53. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +191 -0
  54. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb +191 -0
  55. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +191 -0
  56. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb +191 -0
  57. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +191 -0
  58. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +931 -0
  59. data/lib/aftership-tracking-sdk/models/get_tracking_by_slug_tracking_number_response.rb +931 -0
  60. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +191 -0
  61. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +191 -0
  62. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_slug_tracking_number_response.rb +191 -0
  63. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +191 -0
  64. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_slug_tracking_number_response.rb +191 -0
  65. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +191 -0
  66. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_slug_tracking_number_response.rb +191 -0
  67. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +191 -0
  68. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_slug_tracking_number_response.rb +191 -0
  69. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +191 -0
  70. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_slug_tracking_number_response.rb +191 -0
  71. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +931 -0
  72. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_response.rb +931 -0
  73. data/lib/aftership-tracking-sdk/models/{next_couriers_tracking_create_tracking_request.rb → next_couriers_create_tracking_request.rb} +2 -2
  74. data/lib/aftership-tracking-sdk/models/{notification_request_v1.rb → next_couriers_create_tracking_response.rb} +26 -16
  75. data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_id_response.rb +171 -0
  76. data/lib/aftership-tracking-sdk/models/next_couriers_delete_tracking_by_slug_tracking_number_response.rb +171 -0
  77. data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_id_response.rb +171 -0
  78. data/lib/aftership-tracking-sdk/models/next_couriers_get_tracking_by_slug_tracking_number_response.rb +171 -0
  79. data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_id_response.rb +171 -0
  80. data/lib/aftership-tracking-sdk/models/next_couriers_mark_tracking_completed_by_slug_tracking_number_response.rb +171 -0
  81. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_id_response.rb +171 -0
  82. data/lib/aftership-tracking-sdk/models/next_couriers_retrack_tracking_by_slug_tracking_number_response.rb +171 -0
  83. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_id_response.rb +171 -0
  84. data/lib/aftership-tracking-sdk/models/next_couriers_update_tracking_by_slug_tracking_number_response.rb +171 -0
  85. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +931 -0
  86. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_slug_tracking_number_response.rb +931 -0
  87. data/lib/aftership-tracking-sdk/models/{tracking_delete_response_v1.rb → shipment_weight_create_tracking_response.rb} +16 -16
  88. data/lib/aftership-tracking-sdk/models/{data_notification_response_v1.rb → shipment_weight_delete_tracking_by_id_response.rb} +19 -9
  89. data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_slug_tracking_number_response.rb +161 -0
  90. data/lib/aftership-tracking-sdk/models/{notification.rb → shipment_weight_get_tracking_by_id_response.rb} +16 -16
  91. data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_slug_tracking_number_response.rb +161 -0
  92. data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_id_response.rb +161 -0
  93. data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_slug_tracking_number_response.rb +161 -0
  94. data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb +161 -0
  95. data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_slug_tracking_number_response.rb +161 -0
  96. data/lib/aftership-tracking-sdk/models/{notification_response_v1.rb → shipment_weight_tracking.rb} +16 -16
  97. data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb +161 -0
  98. data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_slug_tracking_number_response.rb +161 -0
  99. data/lib/aftership-tracking-sdk/models/tracking.rb +27 -17
  100. data/lib/aftership-tracking-sdk/models/tracking_response_v1.rb +3 -3
  101. data/lib/aftership-tracking-sdk/models/{tracking_update_tracking_by_id_request.rb → update_tracking_by_id_request.rb} +3 -3
  102. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +931 -0
  103. data/lib/aftership-tracking-sdk/models/{tracking_update_tracking_by_slug_tracking_number_request.rb → update_tracking_by_slug_tracking_number_request.rb} +5 -5
  104. data/lib/aftership-tracking-sdk/models/update_tracking_by_slug_tracking_number_response.rb +931 -0
  105. data/lib/aftership-tracking-sdk/version.rb +1 -1
  106. metadata +97 -21
  107. data/lib/aftership-tracking-sdk/api/last_checkpoint.rb +0 -143
  108. data/lib/aftership-tracking-sdk/api/notification.rb +0 -403
  109. data/lib/aftership-tracking-sdk/models/data_tracking_delete_response_v1.rb +0 -151
  110. data/lib/aftership-tracking-sdk/models/data_tracking_response_v1.rb +0 -151
  111. data/lib/aftership-tracking-sdk/models/partial_delete_tracking.rb +0 -241
  112. data/lib/aftership-tracking-sdk/models/partial_update_tracking.rb +0 -251
@@ -13,12 +13,12 @@ module AftershipAPI
13
13
  # create_tracking
14
14
  # Create a tracking.<div style="visibility:hidden; height: 0"></div>
15
15
 
16
- # @param body [Model::TrackingCreateTrackingRequest]
16
+ # @param body [Model::CreateTrackingRequest]
17
17
  # @param [Hash] opts the optional parameters
18
- # @return [Model::Tracking]
18
+ # @return [Model::CreateTrackingResponse]
19
19
  def create_tracking(body:, opts: {})
20
- if "tracking" != ""
21
- body = { :'tracking' => body }
20
+ if "" != ""
21
+ body = { :'' => body }
22
22
  end
23
23
  opts[:body] = body
24
24
  data, _status_code, _headers = create_tracking_with_http_info(opts: opts)
@@ -33,7 +33,7 @@ module AftershipAPI
33
33
 
34
34
 
35
35
  # resource path
36
- local_var_path = "/tracking/2024-04/trackings"
36
+ local_var_path = "/tracking/2024-07/trackings"
37
37
  method = :'POST'
38
38
 
39
39
  # query parameters
@@ -45,7 +45,7 @@ module AftershipAPI
45
45
  post_body = opts[:body]
46
46
 
47
47
  # return_type
48
- return_type = 'Tracking'
48
+ return_type = 'CreateTrackingResponse'
49
49
 
50
50
  new_options = opts.merge(
51
51
  :operation => :"TrackingApi.create_tracking",
@@ -53,7 +53,7 @@ module AftershipAPI
53
53
  :query_params => query_params,
54
54
  :body => post_body,
55
55
  :return_type => return_type,
56
- :response_legacy_tag => "tracking",
56
+ :response_legacy_tag => "",
57
57
  :is_paging => false
58
58
  )
59
59
 
@@ -68,7 +68,7 @@ module AftershipAPI
68
68
  # Delete a tracking.
69
69
  # @param id [String] tracking ID
70
70
  # @param [Hash] opts the optional parameters
71
- # @return [Model::PartialDeleteTracking]
71
+ # @return [Model::DeleteTrackingByIdResponse]
72
72
  def delete_tracking_by_id(id:, opts: {})
73
73
  data, _status_code, _headers = delete_tracking_by_id_with_http_info(id: id, opts: opts)
74
74
  data
@@ -79,13 +79,13 @@ module AftershipAPI
79
79
  @api_client.config.logger.debug 'Calling API: TrackingApi.delete_tracking_by_id ...'
80
80
  end
81
81
 
82
- if id.nil? || (id.to_s == '')
82
+ if id.nil? or id.to_s == ''
83
83
  raise InvalidParamError.new "id cannot be nil or empty"
84
84
  end
85
85
 
86
86
 
87
87
  # resource path
88
- local_var_path = "/tracking/2024-04/trackings/#{id}"
88
+ local_var_path = "/tracking/2024-07/trackings/#{id}"
89
89
  method = :'DELETE'
90
90
 
91
91
  # query parameters
@@ -97,7 +97,7 @@ module AftershipAPI
97
97
  post_body = opts[:body]
98
98
 
99
99
  # return_type
100
- return_type = 'PartialDeleteTracking'
100
+ return_type = 'DeleteTrackingByIdResponse'
101
101
 
102
102
  new_options = opts.merge(
103
103
  :operation => :"TrackingApi.delete_tracking_by_id",
@@ -105,7 +105,7 @@ module AftershipAPI
105
105
  :query_params => query_params,
106
106
  :body => post_body,
107
107
  :return_type => return_type,
108
- :response_legacy_tag => "tracking",
108
+ :response_legacy_tag => "",
109
109
  :is_paging => false
110
110
  )
111
111
 
@@ -117,7 +117,7 @@ module AftershipAPI
117
117
  end
118
118
 
119
119
  # delete_tracking_by_slug_tracking_number
120
- # Delete a tracking.
120
+ # Delete a tracking.<b style="color:#FF0000">(This endpoint will be deprecated in version 2024-10)</b>
121
121
  # @param slug [String] Tracking slug
122
122
  # @param tracking_number [String] Tracking number
123
123
  # @param [Hash] opts the optional parameters
@@ -128,7 +128,7 @@ module AftershipAPI
128
128
  # @option opts [String] :tracking_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.
129
129
  # @option opts [String] :tracking_ship_date 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.
130
130
  # @option opts [String] :tracking_state 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.
131
- # @return [Model::PartialDeleteTracking]
131
+ # @return [Model::DeleteTrackingBySlugTrackingNumberResponse]
132
132
  def delete_tracking_by_slug_tracking_number(slug:, tracking_number:, opts: {})
133
133
  data, _status_code, _headers = delete_tracking_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
134
134
  data
@@ -139,16 +139,16 @@ module AftershipAPI
139
139
  @api_client.config.logger.debug 'Calling API: TrackingApi.delete_tracking_by_slug_tracking_number ...'
140
140
  end
141
141
 
142
- if slug.nil? || (slug.to_s == '')
142
+ if slug.nil? or slug.to_s == ''
143
143
  raise InvalidParamError.new "slug cannot be nil or empty"
144
144
  end
145
- if tracking_number.nil? || (tracking_number.to_s == '')
145
+ if tracking_number.nil? or tracking_number.to_s == ''
146
146
  raise InvalidParamError.new "tracking_number cannot be nil or empty"
147
147
  end
148
148
 
149
149
 
150
150
  # resource path
151
- local_var_path = "/tracking/2024-04/trackings/#{slug}/#{tracking_number}"
151
+ local_var_path = "/tracking/2024-07/trackings/#{slug}/#{tracking_number}"
152
152
  method = :'DELETE'
153
153
 
154
154
  # query parameters
@@ -167,7 +167,7 @@ module AftershipAPI
167
167
  post_body = opts[:body]
168
168
 
169
169
  # return_type
170
- return_type = 'PartialDeleteTracking'
170
+ return_type = 'DeleteTrackingBySlugTrackingNumberResponse'
171
171
 
172
172
  new_options = opts.merge(
173
173
  :operation => :"TrackingApi.delete_tracking_by_slug_tracking_number",
@@ -175,7 +175,7 @@ module AftershipAPI
175
175
  :query_params => query_params,
176
176
  :body => post_body,
177
177
  :return_type => return_type,
178
- :response_legacy_tag => "tracking",
178
+ :response_legacy_tag => "",
179
179
  :is_paging => false
180
180
  )
181
181
 
@@ -192,7 +192,7 @@ module AftershipAPI
192
192
  # @param [Hash] opts the optional parameters
193
193
  # @option opts [String] :fields List of fields to include in the response. Use comma for multiple values. Fields to include: `tracking_postal_code`, `tracking_ship_date`, `tracking_account_number`, `tracking_key`, `tracking_origin_country`, `tracking_destination_country`, `tracking_state`, `title`, `order_id`, `tag`, `checkpoints`
194
194
  # @option opts [String] :lang Translate checkpoint messages from the carrier’s provided language to the target language. Supported target languages include:</br>&nbsp;&nbsp;&nbsp;&nbsp;- English (en)</br>&nbsp;&nbsp;&nbsp;&nbsp;- French (fr)</br>&nbsp;&nbsp;&nbsp;&nbsp;- French Canadian (fr-CA)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Arabic (ar)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Bulgarian (bg)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Catalan (ca)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Croatian (hr)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Czech (cs)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Danish (da)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Dutch (nl)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Estonian (et)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Filipino (tl)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Finnish (fi)</br>&nbsp;&nbsp;&nbsp;&nbsp;- German (de)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Greek (el)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Hebrew (he)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Hindi (hi)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Hungarian (hu)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Indonesian (id)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Italian (it)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Japanese (ja)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Korean (ko)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Latvian (lv)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Lithuanian (lt)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Malay (ms)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Polish (pl)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Portuguese (pt)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Romanian (ro)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Russian (ru)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Serbian (sr)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Slovak (sk)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Slovenian (sl)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Spanish (es)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Swedish (sv)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Thai (th)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Turkish (tr)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Ukrainian (uk)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Vietnamese (vi)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Simplified Chinese (zh-Hans)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Traditional Chinese (zh-Hant)</br>&nbsp;&nbsp;&nbsp;&nbsp;- Norwegian (nb)</br>
195
- # @return [Model::Tracking]
195
+ # @return [Model::GetTrackingByIdResponse]
196
196
  def get_tracking_by_id(id:, opts: {})
197
197
  data, _status_code, _headers = get_tracking_by_id_with_http_info(id: id, opts: opts)
198
198
  data
@@ -203,13 +203,13 @@ module AftershipAPI
203
203
  @api_client.config.logger.debug 'Calling API: TrackingApi.get_tracking_by_id ...'
204
204
  end
205
205
 
206
- if id.nil? || (id.to_s == '')
206
+ if id.nil? or id.to_s == ''
207
207
  raise InvalidParamError.new "id cannot be nil or empty"
208
208
  end
209
209
 
210
210
 
211
211
  # resource path
212
- local_var_path = "/tracking/2024-04/trackings/#{id}"
212
+ local_var_path = "/tracking/2024-07/trackings/#{id}"
213
213
  method = :'GET'
214
214
 
215
215
  # query parameters
@@ -223,7 +223,7 @@ module AftershipAPI
223
223
  post_body = opts[:body]
224
224
 
225
225
  # return_type
226
- return_type = 'Tracking'
226
+ return_type = 'GetTrackingByIdResponse'
227
227
 
228
228
  new_options = opts.merge(
229
229
  :operation => :"TrackingApi.get_tracking_by_id",
@@ -231,7 +231,7 @@ module AftershipAPI
231
231
  :query_params => query_params,
232
232
  :body => post_body,
233
233
  :return_type => return_type,
234
- :response_legacy_tag => "tracking",
234
+ :response_legacy_tag => "",
235
235
  :is_paging => false
236
236
  )
237
237
 
@@ -243,7 +243,7 @@ module AftershipAPI
243
243
  end
244
244
 
245
245
  # get_tracking_by_slug_tracking_number
246
- # Get tracking results of a single tracking.
246
+ # Get tracking results of a single tracking.<b style="color:#FF0000">(This endpoint will be deprecated in version 2024-10)</b>
247
247
  # @param slug [String] Tracking slug
248
248
  # @param tracking_number [String] Tracking number
249
249
  # @param [Hash] opts the optional parameters
@@ -256,7 +256,7 @@ module AftershipAPI
256
256
  # @option opts [String] :tracking_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.
257
257
  # @option opts [String] :tracking_ship_date 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.
258
258
  # @option opts [String] :tracking_state 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.
259
- # @return [Model::Tracking]
259
+ # @return [Model::GetTrackingBySlugTrackingNumberResponse]
260
260
  def get_tracking_by_slug_tracking_number(slug:, tracking_number:, opts: {})
261
261
  data, _status_code, _headers = get_tracking_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
262
262
  data
@@ -267,16 +267,16 @@ module AftershipAPI
267
267
  @api_client.config.logger.debug 'Calling API: TrackingApi.get_tracking_by_slug_tracking_number ...'
268
268
  end
269
269
 
270
- if slug.nil? || (slug.to_s == '')
270
+ if slug.nil? or slug.to_s == ''
271
271
  raise InvalidParamError.new "slug cannot be nil or empty"
272
272
  end
273
- if tracking_number.nil? || (tracking_number.to_s == '')
273
+ if tracking_number.nil? or tracking_number.to_s == ''
274
274
  raise InvalidParamError.new "tracking_number cannot be nil or empty"
275
275
  end
276
276
 
277
277
 
278
278
  # resource path
279
- local_var_path = "/tracking/2024-04/trackings/#{slug}/#{tracking_number}"
279
+ local_var_path = "/tracking/2024-07/trackings/#{slug}/#{tracking_number}"
280
280
  method = :'GET'
281
281
 
282
282
  # query parameters
@@ -297,7 +297,7 @@ module AftershipAPI
297
297
  post_body = opts[:body]
298
298
 
299
299
  # return_type
300
- return_type = 'Tracking'
300
+ return_type = 'GetTrackingBySlugTrackingNumberResponse'
301
301
 
302
302
  new_options = opts.merge(
303
303
  :operation => :"TrackingApi.get_tracking_by_slug_tracking_number",
@@ -305,7 +305,7 @@ module AftershipAPI
305
305
  :query_params => query_params,
306
306
  :body => post_body,
307
307
  :return_type => return_type,
308
- :response_legacy_tag => "tracking",
308
+ :response_legacy_tag => "",
309
309
  :is_paging => false
310
310
  )
311
311
 
@@ -351,7 +351,7 @@ module AftershipAPI
351
351
 
352
352
 
353
353
  # resource path
354
- local_var_path = "/tracking/2024-04/trackings"
354
+ local_var_path = "/tracking/2024-07/trackings"
355
355
  method = :'GET'
356
356
 
357
357
  # query parameters
@@ -406,7 +406,7 @@ module AftershipAPI
406
406
 
407
407
  # @param body [Model::MarkTrackingCompletedByIdRequest]
408
408
  # @param [Hash] opts the optional parameters
409
- # @return [Model::Tracking]
409
+ # @return [Model::MarkTrackingCompletedByIdResponse]
410
410
  def mark_tracking_completed_by_id(id:, body:, opts: {})
411
411
  if "" != ""
412
412
  body = { :'' => body }
@@ -421,13 +421,13 @@ module AftershipAPI
421
421
  @api_client.config.logger.debug 'Calling API: TrackingApi.mark_tracking_completed_by_id ...'
422
422
  end
423
423
 
424
- if id.nil? || (id.to_s == '')
424
+ if id.nil? or id.to_s == ''
425
425
  raise InvalidParamError.new "id cannot be nil or empty"
426
426
  end
427
427
 
428
428
 
429
429
  # resource path
430
- local_var_path = "/tracking/2024-04/trackings/#{id}/mark-as-completed"
430
+ local_var_path = "/tracking/2024-07/trackings/#{id}/mark-as-completed"
431
431
  method = :'POST'
432
432
 
433
433
  # query parameters
@@ -439,7 +439,7 @@ module AftershipAPI
439
439
  post_body = opts[:body]
440
440
 
441
441
  # return_type
442
- return_type = 'Tracking'
442
+ return_type = 'MarkTrackingCompletedByIdResponse'
443
443
 
444
444
  new_options = opts.merge(
445
445
  :operation => :"TrackingApi.mark_tracking_completed_by_id",
@@ -447,7 +447,7 @@ module AftershipAPI
447
447
  :query_params => query_params,
448
448
  :body => post_body,
449
449
  :return_type => return_type,
450
- :response_legacy_tag => "tracking",
450
+ :response_legacy_tag => "",
451
451
  :is_paging => false
452
452
  )
453
453
 
@@ -459,7 +459,7 @@ module AftershipAPI
459
459
  end
460
460
 
461
461
  # mark_tracking_completed_by_slug_tracking_number
462
- # Mark a tracking as completed. The tracking won't auto update until retrack it.
462
+ # Mark a tracking as completed. The tracking won't auto update until retrack it.<b style="color:#FF0000">(This endpoint will be deprecated in version 2024-10)</b>
463
463
  # @param slug [String] Tracking slug
464
464
  # @param tracking_number [String] Tracking number
465
465
 
@@ -472,7 +472,7 @@ module AftershipAPI
472
472
  # @option opts [String] :tracking_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.
473
473
  # @option opts [String] :tracking_ship_date 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.
474
474
  # @option opts [String] :tracking_state 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.
475
- # @return [Model::Tracking]
475
+ # @return [Model::MarkTrackingCompletedBySlugTrackingNumberResponse]
476
476
  def mark_tracking_completed_by_slug_tracking_number(slug:, tracking_number:, body:, opts: {})
477
477
  if "" != ""
478
478
  body = { :'' => body }
@@ -487,16 +487,16 @@ module AftershipAPI
487
487
  @api_client.config.logger.debug 'Calling API: TrackingApi.mark_tracking_completed_by_slug_tracking_number ...'
488
488
  end
489
489
 
490
- if slug.nil? || (slug.to_s == '')
490
+ if slug.nil? or slug.to_s == ''
491
491
  raise InvalidParamError.new "slug cannot be nil or empty"
492
492
  end
493
- if tracking_number.nil? || (tracking_number.to_s == '')
493
+ if tracking_number.nil? or tracking_number.to_s == ''
494
494
  raise InvalidParamError.new "tracking_number cannot be nil or empty"
495
495
  end
496
496
 
497
497
 
498
498
  # resource path
499
- local_var_path = "/tracking/2024-04/trackings/#{slug}/#{tracking_number}/mark-as-completed"
499
+ local_var_path = "/tracking/2024-07/trackings/#{slug}/#{tracking_number}/mark-as-completed"
500
500
  method = :'POST'
501
501
 
502
502
  # query parameters
@@ -515,7 +515,7 @@ module AftershipAPI
515
515
  post_body = opts[:body]
516
516
 
517
517
  # return_type
518
- return_type = 'Tracking'
518
+ return_type = 'MarkTrackingCompletedBySlugTrackingNumberResponse'
519
519
 
520
520
  new_options = opts.merge(
521
521
  :operation => :"TrackingApi.mark_tracking_completed_by_slug_tracking_number",
@@ -523,7 +523,7 @@ module AftershipAPI
523
523
  :query_params => query_params,
524
524
  :body => post_body,
525
525
  :return_type => return_type,
526
- :response_legacy_tag => "tracking",
526
+ :response_legacy_tag => "",
527
527
  :is_paging => false
528
528
  )
529
529
 
@@ -538,7 +538,7 @@ module AftershipAPI
538
538
  # Retrack an expired tracking. Max 3 times per tracking.
539
539
  # @param id [String] tracking id
540
540
  # @param [Hash] opts the optional parameters
541
- # @return [Model::PartialUpdateTracking]
541
+ # @return [Model::RetrackTrackingByIdResponse]
542
542
  def retrack_tracking_by_id(id:, opts: {})
543
543
  data, _status_code, _headers = retrack_tracking_by_id_with_http_info(id: id, opts: opts)
544
544
  data
@@ -549,13 +549,13 @@ module AftershipAPI
549
549
  @api_client.config.logger.debug 'Calling API: TrackingApi.retrack_tracking_by_id ...'
550
550
  end
551
551
 
552
- if id.nil? || (id.to_s == '')
552
+ if id.nil? or id.to_s == ''
553
553
  raise InvalidParamError.new "id cannot be nil or empty"
554
554
  end
555
555
 
556
556
 
557
557
  # resource path
558
- local_var_path = "/tracking/2024-04/trackings/#{id}/retrack"
558
+ local_var_path = "/tracking/2024-07/trackings/#{id}/retrack"
559
559
  method = :'POST'
560
560
 
561
561
  # query parameters
@@ -567,7 +567,7 @@ module AftershipAPI
567
567
  post_body = opts[:body]
568
568
 
569
569
  # return_type
570
- return_type = 'PartialUpdateTracking'
570
+ return_type = 'RetrackTrackingByIdResponse'
571
571
 
572
572
  new_options = opts.merge(
573
573
  :operation => :"TrackingApi.retrack_tracking_by_id",
@@ -575,7 +575,7 @@ module AftershipAPI
575
575
  :query_params => query_params,
576
576
  :body => post_body,
577
577
  :return_type => return_type,
578
- :response_legacy_tag => "tracking",
578
+ :response_legacy_tag => "",
579
579
  :is_paging => false
580
580
  )
581
581
 
@@ -587,7 +587,7 @@ module AftershipAPI
587
587
  end
588
588
 
589
589
  # retrack_tracking_by_slug_tracking_number
590
- # Retrack an expired tracking. Max 3 times per tracking.
590
+ # Retrack an expired tracking. Max 3 times per tracking.<b style="color:#FF0000">(This endpoint will be deprecated in version 2024-10)</b>
591
591
  # @param slug [String] Tracking slug
592
592
  # @param tracking_number [String] Tracking number
593
593
  # @param [Hash] opts the optional parameters
@@ -598,7 +598,7 @@ module AftershipAPI
598
598
  # @option opts [String] :tracking_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.
599
599
  # @option opts [String] :tracking_ship_date 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.
600
600
  # @option opts [String] :tracking_state 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.
601
- # @return [Model::PartialUpdateTracking]
601
+ # @return [Model::RetrackTrackingBySlugTrackingNumberResponse]
602
602
  def retrack_tracking_by_slug_tracking_number(slug:, tracking_number:, opts: {})
603
603
  data, _status_code, _headers = retrack_tracking_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
604
604
  data
@@ -609,16 +609,16 @@ module AftershipAPI
609
609
  @api_client.config.logger.debug 'Calling API: TrackingApi.retrack_tracking_by_slug_tracking_number ...'
610
610
  end
611
611
 
612
- if slug.nil? || (slug.to_s == '')
612
+ if slug.nil? or slug.to_s == ''
613
613
  raise InvalidParamError.new "slug cannot be nil or empty"
614
614
  end
615
- if tracking_number.nil? || (tracking_number.to_s == '')
615
+ if tracking_number.nil? or tracking_number.to_s == ''
616
616
  raise InvalidParamError.new "tracking_number cannot be nil or empty"
617
617
  end
618
618
 
619
619
 
620
620
  # resource path
621
- local_var_path = "/tracking/2024-04/trackings/#{slug}/#{tracking_number}/retrack"
621
+ local_var_path = "/tracking/2024-07/trackings/#{slug}/#{tracking_number}/retrack"
622
622
  method = :'POST'
623
623
 
624
624
  # query parameters
@@ -637,7 +637,7 @@ module AftershipAPI
637
637
  post_body = opts[:body]
638
638
 
639
639
  # return_type
640
- return_type = 'PartialUpdateTracking'
640
+ return_type = 'RetrackTrackingBySlugTrackingNumberResponse'
641
641
 
642
642
  new_options = opts.merge(
643
643
  :operation => :"TrackingApi.retrack_tracking_by_slug_tracking_number",
@@ -645,7 +645,7 @@ module AftershipAPI
645
645
  :query_params => query_params,
646
646
  :body => post_body,
647
647
  :return_type => return_type,
648
- :response_legacy_tag => "tracking",
648
+ :response_legacy_tag => "",
649
649
  :is_paging => false
650
650
  )
651
651
 
@@ -660,12 +660,12 @@ module AftershipAPI
660
660
  # Update a tracking.
661
661
  # @param id [String] tracking ID
662
662
 
663
- # @param body [Model::TrackingUpdateTrackingByIdRequest]
663
+ # @param body [Model::UpdateTrackingByIdRequest]
664
664
  # @param [Hash] opts the optional parameters
665
- # @return [Model::Tracking]
665
+ # @return [Model::UpdateTrackingByIdResponse]
666
666
  def update_tracking_by_id(id:, body:, opts: {})
667
- if "tracking" != ""
668
- body = { :'tracking' => body }
667
+ if "" != ""
668
+ body = { :'' => body }
669
669
  end
670
670
  opts[:body] = body
671
671
  data, _status_code, _headers = update_tracking_by_id_with_http_info(id: id, opts: opts)
@@ -677,13 +677,13 @@ module AftershipAPI
677
677
  @api_client.config.logger.debug 'Calling API: TrackingApi.update_tracking_by_id ...'
678
678
  end
679
679
 
680
- if id.nil? || (id.to_s == '')
680
+ if id.nil? or id.to_s == ''
681
681
  raise InvalidParamError.new "id cannot be nil or empty"
682
682
  end
683
683
 
684
684
 
685
685
  # resource path
686
- local_var_path = "/tracking/2024-04/trackings/#{id}"
686
+ local_var_path = "/tracking/2024-07/trackings/#{id}"
687
687
  method = :'PUT'
688
688
 
689
689
  # query parameters
@@ -695,7 +695,7 @@ module AftershipAPI
695
695
  post_body = opts[:body]
696
696
 
697
697
  # return_type
698
- return_type = 'Tracking'
698
+ return_type = 'UpdateTrackingByIdResponse'
699
699
 
700
700
  new_options = opts.merge(
701
701
  :operation => :"TrackingApi.update_tracking_by_id",
@@ -703,7 +703,7 @@ module AftershipAPI
703
703
  :query_params => query_params,
704
704
  :body => post_body,
705
705
  :return_type => return_type,
706
- :response_legacy_tag => "tracking",
706
+ :response_legacy_tag => "",
707
707
  :is_paging => false
708
708
  )
709
709
 
@@ -715,11 +715,11 @@ module AftershipAPI
715
715
  end
716
716
 
717
717
  # update_tracking_by_slug_tracking_number
718
- # Update a tracking.
718
+ # Update a tracking.<b style="color:#FF0000">(This endpoint will be deprecated in version 2024-10)</b>
719
719
  # @param slug [String] Tracking slug
720
720
  # @param tracking_number [String] Tracking number
721
721
 
722
- # @param body [Model::TrackingUpdateTrackingBySlugTrackingNumberRequest]
722
+ # @param body [Model::UpdateTrackingBySlugTrackingNumberRequest]
723
723
  # @param [Hash] opts the optional parameters
724
724
  # @option opts [String] :tracking_account_number 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.
725
725
  # @option opts [String] :tracking_origin_country 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.
@@ -728,10 +728,10 @@ module AftershipAPI
728
728
  # @option opts [String] :tracking_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.
729
729
  # @option opts [String] :tracking_ship_date 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.
730
730
  # @option opts [String] :tracking_state 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.
731
- # @return [Model::Tracking]
731
+ # @return [Model::UpdateTrackingBySlugTrackingNumberResponse]
732
732
  def update_tracking_by_slug_tracking_number(slug:, tracking_number:, body:, opts: {})
733
- if "tracking" != ""
734
- body = { :'tracking' => body }
733
+ if "" != ""
734
+ body = { :'' => body }
735
735
  end
736
736
  opts[:body] = body
737
737
  data, _status_code, _headers = update_tracking_by_slug_tracking_number_with_http_info(slug: slug, tracking_number: tracking_number, opts: opts)
@@ -743,16 +743,16 @@ module AftershipAPI
743
743
  @api_client.config.logger.debug 'Calling API: TrackingApi.update_tracking_by_slug_tracking_number ...'
744
744
  end
745
745
 
746
- if slug.nil? || (slug.to_s == '')
746
+ if slug.nil? or slug.to_s == ''
747
747
  raise InvalidParamError.new "slug cannot be nil or empty"
748
748
  end
749
- if tracking_number.nil? || (tracking_number.to_s == '')
749
+ if tracking_number.nil? or tracking_number.to_s == ''
750
750
  raise InvalidParamError.new "tracking_number cannot be nil or empty"
751
751
  end
752
752
 
753
753
 
754
754
  # resource path
755
- local_var_path = "/tracking/2024-04/trackings/#{slug}/#{tracking_number}"
755
+ local_var_path = "/tracking/2024-07/trackings/#{slug}/#{tracking_number}"
756
756
  method = :'PUT'
757
757
 
758
758
  # query parameters
@@ -771,7 +771,7 @@ module AftershipAPI
771
771
  post_body = opts[:body]
772
772
 
773
773
  # return_type
774
- return_type = 'Tracking'
774
+ return_type = 'UpdateTrackingBySlugTrackingNumberResponse'
775
775
 
776
776
  new_options = opts.merge(
777
777
  :operation => :"TrackingApi.update_tracking_by_slug_tracking_number",
@@ -779,7 +779,7 @@ module AftershipAPI
779
779
  :query_params => query_params,
780
780
  :body => post_body,
781
781
  :return_type => return_type,
782
- :response_legacy_tag => "tracking",
782
+ :response_legacy_tag => "",
783
783
  :is_paging => false
784
784
  )
785
785
 
@@ -107,7 +107,7 @@ module AftershipAPI
107
107
  fail InvalidOptionError.new("Invalid base URL: #{domain}") unless valid_url?(domain)
108
108
  fail InvalidOptionError.new("authentication type must not be API_KEY if as_api_secret is set") if as_api_secret.to_s.size > 0 && authentication_type == AUTHENTICATION_TYPE_API_KEY
109
109
  fail InvalidOptionError.new("timeout cannot be negative, value #{timeout}") unless timeout.to_i >= 0
110
- fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless (max_retry.to_i >= 0) && (max_retry.to_i <= 10)
110
+ fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless max_retry.to_i >= 0 and max_retry.to_i <= 10
111
111
  fail InvalidOptionError.new("max_retry cannot be negative, value #{max_retry}") unless max_retry.to_i >= 0
112
112
  end
113
113