aftership-tracking-sdk 12.0.0 → 13.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +0 -1
  3. data/README.md +146 -107
  4. data/aftership-tracking-sdk.gemspec +0 -1
  5. data/lib/aftership-tracking-sdk/api/courier.rb +46 -57
  6. data/lib/aftership-tracking-sdk/api/courier_connection.rb +105 -131
  7. data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +30 -44
  8. data/lib/aftership-tracking-sdk/api/tracking.rb +171 -208
  9. data/lib/aftership-tracking-sdk/api_client.rb +9 -34
  10. data/lib/aftership-tracking-sdk/configuration.rb +106 -108
  11. data/lib/aftership-tracking-sdk/error.rb +10 -18
  12. data/lib/aftership-tracking-sdk/models/additional_fields.rb +1 -2
  13. data/lib/aftership-tracking-sdk/models/checkpoint.rb +23 -25
  14. data/lib/aftership-tracking-sdk/models/{coordinate_checkpoint.rb → checkpoint_coordinate.rb} +4 -6
  15. data/lib/aftership-tracking-sdk/models/{events_checkpoint.rb → checkpoint_events.rb} +6 -8
  16. data/lib/aftership-tracking-sdk/models/{reason_events_checkpoint.rb → checkpoint_events_reason.rb} +3 -5
  17. data/lib/aftership-tracking-sdk/models/checkpoint_source.rb +26 -0
  18. data/lib/aftership-tracking-sdk/models/courier.rb +17 -19
  19. data/lib/aftership-tracking-sdk/models/courier_connection.rb +5 -7
  20. data/lib/aftership-tracking-sdk/models/courier_connection_response_for_get_courier_connections.rb +4 -6
  21. data/lib/aftership-tracking-sdk/models/{data_courier_connection_response_for_get_courier_connections.rb → courier_connection_response_for_get_courier_connections_data.rb} +6 -8
  22. data/lib/aftership-tracking-sdk/models/{pagination_data_courier_connection_response_for_get_courier_connections.rb → courier_connection_response_for_get_courier_connections_data_pagination.rb} +5 -7
  23. data/lib/aftership-tracking-sdk/models/{credentials_courier.rb → courier_credentials.rb} +3 -5
  24. data/lib/aftership-tracking-sdk/models/courier_response.rb +4 -6
  25. data/lib/aftership-tracking-sdk/models/{data_courier_response.rb → courier_response_data.rb} +4 -6
  26. data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +44 -46
  27. data/lib/aftership-tracking-sdk/models/{customers_create_tracking_request.rb → create_tracking_request_customers.rb} +7 -9
  28. data/lib/aftership-tracking-sdk/models/create_tracking_request_delivery_type.rb +27 -0
  29. data/lib/aftership-tracking-sdk/models/{last_mile_create_tracking_request.rb → create_tracking_request_last_mile.rb} +4 -6
  30. data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +3 -887
  31. data/lib/aftership-tracking-sdk/models/credential_field.rb +3 -5
  32. data/lib/aftership-tracking-sdk/models/delete_courier_connections_by_id_response.rb +3 -187
  33. data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +3 -887
  34. data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +12 -14
  35. data/lib/aftership-tracking-sdk/models/detect_courier_response.rb +3 -157
  36. data/lib/aftership-tracking-sdk/models/detect_courier_response_data.rb +161 -0
  37. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb +16 -18
  38. data/lib/aftership-tracking-sdk/models/{destination_address_predict_request.rb → estimated_delivery_date_request_destination_address.rb} +7 -9
  39. data/lib/aftership-tracking-sdk/models/{estimated_pickup_predict_request.rb → estimated_delivery_date_request_estimated_pickup.rb} +8 -10
  40. data/lib/aftership-tracking-sdk/models/{order_processing_time_estimated_pickup_predict_request.rb → estimated_delivery_date_request_estimated_pickup_order_processing_time.rb} +4 -6
  41. data/lib/aftership-tracking-sdk/models/{origin_address_predict_request.rb → estimated_delivery_date_request_origin_address.rb} +7 -9
  42. data/lib/aftership-tracking-sdk/models/{weight_estimated_delivery_date_request.rb → estimated_delivery_date_request_weight.rb} +4 -6
  43. data/lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb +21 -23
  44. data/lib/aftership-tracking-sdk/models/{destination_address_predict_response.rb → estimated_delivery_date_response_destination_address.rb} +7 -9
  45. data/lib/aftership-tracking-sdk/models/{estimated_pickup_predict_response.rb → estimated_delivery_date_response_estimated_pickup.rb} +9 -11
  46. data/lib/aftership-tracking-sdk/models/{order_processing_time_estimated_pickup_predict_response.rb → estimated_delivery_date_response_estimated_pickup_order_processing_time.rb} +4 -6
  47. data/lib/aftership-tracking-sdk/models/{origin_address_predict_response.rb → estimated_delivery_date_response_origin_address.rb} +7 -9
  48. data/lib/aftership-tracking-sdk/models/{weight_predict_response.rb → estimated_delivery_date_response_weight.rb} +4 -6
  49. data/lib/aftership-tracking-sdk/models/get_courier_connections_by_id_response.rb +3 -187
  50. data/lib/aftership-tracking-sdk/models/get_courier_connections_response.rb +3 -157
  51. data/lib/aftership-tracking-sdk/models/{carbon_emissions_mark_tracking_completed_by_id_response.rb → get_courier_connections_response_data.rb} +18 -20
  52. data/lib/aftership-tracking-sdk/models/{pagination_get_courier_connections_response.rb → get_courier_connections_response_data_pagination.rb} +5 -7
  53. data/lib/aftership-tracking-sdk/models/get_couriers_response.rb +3 -157
  54. data/lib/aftership-tracking-sdk/models/get_couriers_response_data.rb +161 -0
  55. data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +3 -887
  56. data/lib/aftership-tracking-sdk/models/get_trackings_response.rb +3 -157
  57. data/lib/aftership-tracking-sdk/models/{carbon_emissions_delete_tracking_by_id_response.rb → get_trackings_response_data.rb} +18 -20
  58. data/lib/aftership-tracking-sdk/models/{pagination_get_trackings_response.rb → get_trackings_response_data_pagination.rb} +5 -7
  59. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +4 -6
  60. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request_reason.rb +27 -0
  61. data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +3 -887
  62. data/lib/aftership-tracking-sdk/models/meta.rb +5 -7
  63. data/lib/aftership-tracking-sdk/models/meta_type.rb +30 -0
  64. data/lib/aftership-tracking-sdk/models/post_courier_connections_request.rb +2 -4
  65. data/lib/aftership-tracking-sdk/models/post_courier_connections_response.rb +3 -187
  66. data/lib/aftership-tracking-sdk/models/predict_batch_request.rb +1 -3
  67. data/lib/aftership-tracking-sdk/models/predict_batch_response.rb +3 -147
  68. data/lib/aftership-tracking-sdk/models/{weight_predict_request.rb → predict_batch_response_data.rb} +10 -22
  69. data/lib/aftership-tracking-sdk/models/predict_response.rb +3 -267
  70. data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_request.rb +1 -3
  71. data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_response.rb +3 -187
  72. data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +3 -887
  73. data/lib/aftership-tracking-sdk/models/tag.rb +6 -7
  74. data/lib/aftership-tracking-sdk/models/tracking.rb +97 -99
  75. data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_tracking.rb → tracking_aftership_estimated_delivery_date.rb} +6 -8
  76. data/lib/aftership-tracking-sdk/models/{carbon_emissions_tracking.rb → tracking_carbon_emissions.rb} +4 -6
  77. data/lib/aftership-tracking-sdk/models/{courier_estimated_delivery_date_tracking.rb → tracking_courier_estimated_delivery_date.rb} +5 -7
  78. data/lib/aftership-tracking-sdk/models/{custom_estimated_delivery_date_create_tracking_response.rb → tracking_custom_estimated_delivery_date.rb} +8 -10
  79. data/lib/aftership-tracking-sdk/models/tracking_custom_estimated_delivery_date_type.rb +26 -0
  80. data/lib/aftership-tracking-sdk/models/{customers_tracking.rb → tracking_customers.rb} +7 -9
  81. data/lib/aftership-tracking-sdk/models/{first_estimated_delivery_tracking.rb → tracking_first_estimated_delivery.rb} +11 -13
  82. data/lib/aftership-tracking-sdk/models/tracking_first_estimated_delivery_source.rb +28 -0
  83. data/lib/aftership-tracking-sdk/models/tracking_first_estimated_delivery_type.rb +26 -0
  84. data/lib/aftership-tracking-sdk/models/{first_mile_tracking.rb → tracking_first_mile.rb} +7 -9
  85. data/lib/aftership-tracking-sdk/models/{last_mile_tracking.rb → tracking_last_mile.rb} +10 -12
  86. data/lib/aftership-tracking-sdk/models/tracking_last_mile_source.rb +26 -0
  87. data/lib/aftership-tracking-sdk/models/{latest_estimated_delivery_tracking.rb → tracking_latest_estimated_delivery.rb} +12 -14
  88. data/lib/aftership-tracking-sdk/models/tracking_latest_estimated_delivery_source.rb +28 -0
  89. data/lib/aftership-tracking-sdk/models/tracking_latest_estimated_delivery_type.rb +26 -0
  90. data/lib/aftership-tracking-sdk/models/tracking_response.rb +2 -4
  91. data/lib/aftership-tracking-sdk/models/tracking_response_for_get_trackings.rb +4 -6
  92. data/lib/aftership-tracking-sdk/models/{data_tracking_response_for_get_trackings.rb → tracking_response_for_get_trackings_data.rb} +6 -8
  93. data/lib/aftership-tracking-sdk/models/{pagination_data_tracking_response_for_get_trackings.rb → tracking_response_for_get_trackings_data_pagination.rb} +5 -7
  94. data/lib/aftership-tracking-sdk/models/{shipment_weight_tracking.rb → tracking_shipment_weight.rb} +4 -6
  95. data/lib/aftership-tracking-sdk/models/tracking_signature_requirement.rb +29 -0
  96. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +34 -36
  97. data/lib/aftership-tracking-sdk/models/{customers_update_tracking_by_id_request.rb → update_tracking_by_id_request_customers.rb} +7 -9
  98. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request_delivery_type.rb +27 -0
  99. data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +3 -887
  100. data/lib/aftership-tracking-sdk/sign_string.rb +2 -2
  101. data/lib/aftership-tracking-sdk/version.rb +1 -1
  102. metadata +53 -109
  103. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb +0 -183
  104. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb +0 -183
  105. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_get_tracking_by_id_response.rb +0 -183
  106. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +0 -183
  107. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_retrack_tracking_by_id_response.rb +0 -183
  108. data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_update_tracking_by_id_response.rb +0 -183
  109. data/lib/aftership-tracking-sdk/models/carbon_emissions_create_tracking_response.rb +0 -163
  110. data/lib/aftership-tracking-sdk/models/carbon_emissions_get_tracking_by_id_response.rb +0 -163
  111. data/lib/aftership-tracking-sdk/models/carbon_emissions_retrack_tracking_by_id_response.rb +0 -163
  112. data/lib/aftership-tracking-sdk/models/carbon_emissions_update_tracking_by_id_response.rb +0 -163
  113. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_create_tracking_response.rb +0 -173
  114. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_delete_tracking_by_id_response.rb +0 -173
  115. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_get_tracking_by_id_response.rb +0 -173
  116. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +0 -173
  117. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_retrack_tracking_by_id_response.rb +0 -173
  118. data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_update_tracking_by_id_response.rb +0 -173
  119. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_delete_tracking_by_id_response.rb +0 -183
  120. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_get_tracking_by_id_response.rb +0 -183
  121. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_mark_tracking_completed_by_id_response.rb +0 -183
  122. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_retrack_tracking_by_id_response.rb +0 -183
  123. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb +0 -183
  124. data/lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_update_tracking_by_id_response.rb +0 -183
  125. data/lib/aftership-tracking-sdk/models/customers_create_tracking_response.rb +0 -193
  126. data/lib/aftership-tracking-sdk/models/customers_delete_tracking_by_id_response.rb +0 -193
  127. data/lib/aftership-tracking-sdk/models/customers_get_tracking_by_id_response.rb +0 -193
  128. data/lib/aftership-tracking-sdk/models/customers_mark_tracking_completed_by_id_response.rb +0 -193
  129. data/lib/aftership-tracking-sdk/models/customers_retrack_tracking_by_id_response.rb +0 -193
  130. data/lib/aftership-tracking-sdk/models/customers_update_tracking_by_id_response.rb +0 -193
  131. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb +0 -193
  132. data/lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb +0 -193
  133. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb +0 -183
  134. data/lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb +0 -193
  135. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_create_tracking_response.rb +0 -193
  136. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_delete_tracking_by_id_response.rb +0 -193
  137. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_get_tracking_by_id_response.rb +0 -193
  138. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_mark_tracking_completed_by_id_response.rb +0 -193
  139. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_retrack_tracking_by_id_response.rb +0 -193
  140. data/lib/aftership-tracking-sdk/models/first_estimated_delivery_update_tracking_by_id_response.rb +0 -193
  141. data/lib/aftership-tracking-sdk/models/first_mile_create_tracking_response.rb +0 -193
  142. data/lib/aftership-tracking-sdk/models/first_mile_delete_tracking_by_id_response.rb +0 -193
  143. data/lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb +0 -193
  144. data/lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb +0 -193
  145. data/lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb +0 -193
  146. data/lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb +0 -193
  147. data/lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb +0 -203
  148. data/lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb +0 -203
  149. data/lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb +0 -203
  150. data/lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb +0 -203
  151. data/lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb +0 -203
  152. data/lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb +0 -203
  153. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +0 -203
  154. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +0 -203
  155. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +0 -203
  156. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +0 -203
  157. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +0 -203
  158. data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +0 -203
  159. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb +0 -163
  160. data/lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb +0 -163
  161. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb +0 -193
  162. data/lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb +0 -193
  163. data/lib/aftership-tracking-sdk/models/pagination.rb +0 -164
  164. data/lib/aftership-tracking-sdk/models/predict_request.rb +0 -223
  165. data/lib/aftership-tracking-sdk/models/shipment_weight_create_tracking_response.rb +0 -163
  166. data/lib/aftership-tracking-sdk/models/shipment_weight_delete_tracking_by_id_response.rb +0 -163
  167. data/lib/aftership-tracking-sdk/models/shipment_weight_get_tracking_by_id_response.rb +0 -163
  168. data/lib/aftership-tracking-sdk/models/shipment_weight_mark_tracking_completed_by_id_response.rb +0 -163
  169. data/lib/aftership-tracking-sdk/models/shipment_weight_retrack_tracking_by_id_response.rb +0 -163
  170. data/lib/aftership-tracking-sdk/models/shipment_weight_update_tracking_by_id_response.rb +0 -163
  171. data/lib/aftership-tracking-sdk/models/slug_group.rb +0 -37
  172. data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb +0 -163
@@ -3,39 +3,35 @@
3
3
  require 'cgi'
4
4
 
5
5
  module AftershipAPI
6
- class CourierConnectionApi
6
+ class CourierConnectionApi
7
7
  attr_accessor :api_client
8
8
 
9
9
  def initialize(api_client = ApiClient.default)
10
10
  @api_client = api_client
11
11
  end
12
12
 
13
- # delete_courier_connections_by_id
14
- # Delete a courier connection.
15
- # @param id [String]
13
+ # get_courier_connections
14
+ # Get courier connection results of multiple courier connections.
16
15
  # @param [Hash] opts the optional parameters
17
- # @return [Model::DeleteCourierConnectionsByIdResponse]
18
- def delete_courier_connections_by_id(id:, opts: {})
19
- data, _status_code, _headers = delete_courier_connections_by_id_with_http_info(id:id, opts: opts)
20
- data
21
- end
22
-
23
- def delete_courier_connections_by_id_with_http_info(id:, opts: {})
16
+ # @option opts [String] :courier_slug Unique courier code.(Example: dhl-api)
17
+ # @option opts [String] :cursor A string representing the cursor value for the current page of results.
18
+ # @option opts [String] :limit Number of courier connections each page contain. (Default: 100, Max: 200)
19
+ # @return [Model::GetCourierConnectionsResponse]
20
+ def get_courier_connections(opts: {})
24
21
  if @api_client.config.debugging
25
- @api_client.config.logger.debug 'Calling API: CourierConnectionApi.delete_courier_connections_by_id ...'
26
- end
27
-
28
- if id.nil? or id.to_s == ''
29
- raise InvalidParamError.new "id cannot be nil or empty"
22
+ @api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections ...'
30
23
  end
31
24
 
32
25
 
33
26
  # resource path
34
- local_var_path = "/tracking/2025-07/courier-connections/#{id}"
35
- method = :'DELETE'
27
+ local_var_path = "/tracking/2025-07/courier-connections"
28
+ method = :'GET'
36
29
 
37
30
  # query parameters
38
31
  query_params = opts[:query_params] || {}
32
+ query_params[:'courier_slug'] = opts[:'courier_slug'] if !opts[:'courier_slug'].nil?
33
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
34
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
39
35
  # header parameters
40
36
  header_params = opts[:header_params] || {}
41
37
 
@@ -43,53 +39,46 @@ module AftershipAPI
43
39
  post_body = opts[:body]
44
40
 
45
41
  # return_type
46
- return_type = 'DeleteCourierConnectionsByIdResponse'
47
-
42
+ return_type = 'GetCourierConnectionsResponseData'
43
+
48
44
  new_options = opts.merge(
49
- :operation => :"CourierConnectionApi.delete_courier_connections_by_id",
45
+ :operation => :"CourierConnectionApi.get_courier_connections",
50
46
  :header_params => header_params,
51
47
  :query_params => query_params,
52
48
  :body => post_body,
53
- :return_type => return_type,
54
- :response_legacy_tag => "",
55
- :is_paging => false
49
+ :return_type => return_type
56
50
  )
57
51
 
58
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
52
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
59
53
  if @api_client.config.debugging
60
- @api_client.config.logger.debug "API called: CourierConnectionApi#delete_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
54
+ @api_client.config.logger.debug "API called: CourierConnectionApi#get_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
61
55
  end
62
- return data, status_code, headers
63
- end
64
56
 
65
- # get_courier_connections
66
- # Get courier connection results of multiple courier connections.
67
- # @param [Hash] opts the optional parameters
68
- # @option opts [String] :courier_slug Unique courier code.(Example: dhl-api)
69
- # @option opts [String] :cursor A string representing the cursor value for the current page of results.
70
- # @option opts [String] :limit Number of courier connections each page contain. (Default: 100, Max: 200)
71
- # @return [Model::GetCourierConnectionsResponse]
72
- def get_courier_connections(opts: {})
73
- data, _status_code, _headers = get_courier_connections_with_http_info(opts: opts)
74
- data
57
+ resp = Model::GetCourierConnectionsResponse.new
58
+ resp.data = data
59
+ resp.response_header = headers
60
+ resp
75
61
  end
76
62
 
77
- def get_courier_connections_with_http_info(opts: {})
63
+ # post_courier_connections
64
+ #
65
+
66
+ # @param body [Model::PostCourierConnectionsRequest]
67
+ # @param [Hash] opts the optional parameters
68
+ # @return [Model::PostCourierConnectionsResponse]
69
+ def post_courier_connections(body:, opts: {})
70
+ opts[:body] = body
78
71
  if @api_client.config.debugging
79
- @api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections ...'
72
+ @api_client.config.logger.debug 'Calling API: CourierConnectionApi.post_courier_connections ...'
80
73
  end
81
74
 
82
75
 
83
-
84
76
  # resource path
85
- local_var_path = "/tracking/2025-07/courier-connections"
86
- method = :'GET'
77
+ local_var_path = "/tracking/2025-07/courier-connections"
78
+ method = :'POST'
87
79
 
88
80
  # query parameters
89
81
  query_params = opts[:query_params] || {}
90
- query_params[:'courier_slug'] = opts[:'courier_slug'] if !opts[:'courier_slug'].nil?
91
- query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
92
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
93
82
  # header parameters
94
83
  header_params = opts[:header_params] || {}
95
84
 
@@ -97,47 +86,43 @@ module AftershipAPI
97
86
  post_body = opts[:body]
98
87
 
99
88
  # return_type
100
- return_type = 'GetCourierConnectionsResponse'
101
-
89
+ return_type = 'CourierConnection'
90
+
102
91
  new_options = opts.merge(
103
- :operation => :"CourierConnectionApi.get_courier_connections",
92
+ :operation => :"CourierConnectionApi.post_courier_connections",
104
93
  :header_params => header_params,
105
94
  :query_params => query_params,
106
95
  :body => post_body,
107
- :return_type => return_type,
108
- :response_legacy_tag => "courier_connections",
109
- :is_paging => true
96
+ :return_type => return_type
110
97
  )
111
98
 
112
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
99
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
113
100
  if @api_client.config.debugging
114
- @api_client.config.logger.debug "API called: CourierConnectionApi#get_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
101
+ @api_client.config.logger.debug "API called: CourierConnectionApi#post_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
115
102
  end
116
- return data, status_code, headers
117
- end
103
+
104
+ resp = Model::PostCourierConnectionsResponse.new
105
+ resp.data = data
106
+ resp.response_header = headers
107
+ resp
108
+ end
118
109
 
119
110
  # get_courier_connections_by_id
120
111
  # Get courier connection results of a single courier connection.
121
112
  # @param id [String]
122
113
  # @param [Hash] opts the optional parameters
123
- # @return [Model::GetCourierConnectionsByIdResponse]
114
+ # @return [Model::GetCourierConnectionsByIdResponse]
124
115
  def get_courier_connections_by_id(id:, opts: {})
125
- data, _status_code, _headers = get_courier_connections_by_id_with_http_info(id:id, opts: opts)
126
- data
127
- end
128
-
129
- def get_courier_connections_by_id_with_http_info(id:, opts: {})
130
116
  if @api_client.config.debugging
131
117
  @api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections_by_id ...'
132
118
  end
133
-
134
119
  if id.nil? or id.to_s == ''
135
- raise InvalidParamError.new "id cannot be nil or empty"
120
+ raise ApiError.new(:error_code => BAD_REQUEST, :message => "id cannot be nil or empty")
136
121
  end
137
122
 
138
123
 
139
124
  # resource path
140
- local_var_path = "/tracking/2025-07/courier-connections/#{id}"
125
+ local_var_path = "/tracking/2025-07/courier-connections/#{id}"
141
126
  method = :'GET'
142
127
 
143
128
  # query parameters
@@ -149,50 +134,47 @@ module AftershipAPI
149
134
  post_body = opts[:body]
150
135
 
151
136
  # return_type
152
- return_type = 'GetCourierConnectionsByIdResponse'
153
-
137
+ return_type = 'CourierConnection'
138
+
154
139
  new_options = opts.merge(
155
140
  :operation => :"CourierConnectionApi.get_courier_connections_by_id",
156
141
  :header_params => header_params,
157
142
  :query_params => query_params,
158
143
  :body => post_body,
159
- :return_type => return_type,
160
- :response_legacy_tag => "",
161
- :is_paging => false
144
+ :return_type => return_type
162
145
  )
163
146
 
164
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
147
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
165
148
  if @api_client.config.debugging
166
149
  @api_client.config.logger.debug "API called: CourierConnectionApi#get_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
167
150
  end
168
- return data, status_code, headers
169
- end
170
151
 
171
- # post_courier_connections
172
- #
152
+ resp = Model::GetCourierConnectionsByIdResponse.new
153
+ resp.data = data
154
+ resp.response_header = headers
155
+ resp
156
+ end
157
+
158
+ # put_courier_connections_by_id
159
+ # Update a courier connection.
160
+ # @param id [String]
173
161
 
174
- # @param body [Model::PostCourierConnectionsRequest]
162
+ # @param body [Model::PutCourierConnectionsByIdRequest]
175
163
  # @param [Hash] opts the optional parameters
176
- # @return [Model::PostCourierConnectionsResponse]
177
- def post_courier_connections(body:,opts: {})
178
- if "" != ""
179
- body = {:'' => body}
180
- end
164
+ # @return [Model::PutCourierConnectionsByIdResponse]
165
+ def put_courier_connections_by_id(id:, body:, opts: {})
181
166
  opts[:body] = body
182
- data, _status_code, _headers = post_courier_connections_with_http_info(opts: opts)
183
- data
184
- end
185
-
186
- def post_courier_connections_with_http_info(opts: {})
187
167
  if @api_client.config.debugging
188
- @api_client.config.logger.debug 'Calling API: CourierConnectionApi.post_courier_connections ...'
168
+ @api_client.config.logger.debug 'Calling API: CourierConnectionApi.put_courier_connections_by_id ...'
169
+ end
170
+ if id.nil? or id.to_s == ''
171
+ raise ApiError.new(:error_code => BAD_REQUEST, :message => "id cannot be nil or empty")
189
172
  end
190
-
191
173
 
192
174
 
193
175
  # resource path
194
- local_var_path = "/tracking/2025-07/courier-connections"
195
- method = :'POST'
176
+ local_var_path = "/tracking/2025-07/courier-connections/#{id}"
177
+ method = :'PATCH'
196
178
 
197
179
  # query parameters
198
180
  query_params = opts[:query_params] || {}
@@ -203,54 +185,44 @@ module AftershipAPI
203
185
  post_body = opts[:body]
204
186
 
205
187
  # return_type
206
- return_type = 'PostCourierConnectionsResponse'
207
-
188
+ return_type = 'CourierConnection'
189
+
208
190
  new_options = opts.merge(
209
- :operation => :"CourierConnectionApi.post_courier_connections",
191
+ :operation => :"CourierConnectionApi.put_courier_connections_by_id",
210
192
  :header_params => header_params,
211
193
  :query_params => query_params,
212
194
  :body => post_body,
213
- :return_type => return_type,
214
- :response_legacy_tag => "",
215
- :is_paging => false
195
+ :return_type => return_type
216
196
  )
217
197
 
218
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
198
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
219
199
  if @api_client.config.debugging
220
- @api_client.config.logger.debug "API called: CourierConnectionApi#post_courier_connections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
200
+ @api_client.config.logger.debug "API called: CourierConnectionApi#put_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
221
201
  end
222
- return data, status_code, headers
223
- end
224
202
 
225
- # put_courier_connections_by_id
226
- # Update a courier connection.
227
- # @param id [String]
228
-
229
- # @param body [Model::PutCourierConnectionsByIdRequest]
230
- # @param [Hash] opts the optional parameters
231
- # @return [Model::PutCourierConnectionsByIdResponse]
232
- def put_courier_connections_by_id(id:, body:,opts: {})
233
- if "" != ""
234
- body = {:'' => body}
235
- end
236
- opts[:body] = body
237
- data, _status_code, _headers = put_courier_connections_by_id_with_http_info(id:id, opts: opts)
238
- data
203
+ resp = Model::PutCourierConnectionsByIdResponse.new
204
+ resp.data = data
205
+ resp.response_header = headers
206
+ resp
239
207
  end
240
208
 
241
- def put_courier_connections_by_id_with_http_info(id:, opts: {})
209
+ # delete_courier_connections_by_id
210
+ # Delete a courier connection.
211
+ # @param id [String]
212
+ # @param [Hash] opts the optional parameters
213
+ # @return [Model::DeleteCourierConnectionsByIdResponse]
214
+ def delete_courier_connections_by_id(id:, opts: {})
242
215
  if @api_client.config.debugging
243
- @api_client.config.logger.debug 'Calling API: CourierConnectionApi.put_courier_connections_by_id ...'
216
+ @api_client.config.logger.debug 'Calling API: CourierConnectionApi.delete_courier_connections_by_id ...'
244
217
  end
245
-
246
218
  if id.nil? or id.to_s == ''
247
- raise InvalidParamError.new "id cannot be nil or empty"
219
+ raise ApiError.new(:error_code => BAD_REQUEST, :message => "id cannot be nil or empty")
248
220
  end
249
221
 
250
222
 
251
223
  # resource path
252
- local_var_path = "/tracking/2025-07/courier-connections/#{id}"
253
- method = :'PATCH'
224
+ local_var_path = "/tracking/2025-07/courier-connections/#{id}"
225
+ method = :'DELETE'
254
226
 
255
227
  # query parameters
256
228
  query_params = opts[:query_params] || {}
@@ -261,23 +233,25 @@ module AftershipAPI
261
233
  post_body = opts[:body]
262
234
 
263
235
  # return_type
264
- return_type = 'PutCourierConnectionsByIdResponse'
265
-
236
+ return_type = 'CourierConnection'
237
+
266
238
  new_options = opts.merge(
267
- :operation => :"CourierConnectionApi.put_courier_connections_by_id",
239
+ :operation => :"CourierConnectionApi.delete_courier_connections_by_id",
268
240
  :header_params => header_params,
269
241
  :query_params => query_params,
270
242
  :body => post_body,
271
- :return_type => return_type,
272
- :response_legacy_tag => "",
273
- :is_paging => false
243
+ :return_type => return_type
274
244
  )
275
245
 
276
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
246
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
277
247
  if @api_client.config.debugging
278
- @api_client.config.logger.debug "API called: CourierConnectionApi#put_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
+ @api_client.config.logger.debug "API called: CourierConnectionApi#delete_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
279
249
  end
280
- return data, status_code, headers
281
- end
250
+
251
+ resp = Model::DeleteCourierConnectionsByIdResponse.new
252
+ resp.data = data
253
+ resp.response_header = headers
254
+ resp
255
+ end
282
256
  end
283
- end
257
+ end
@@ -3,7 +3,7 @@
3
3
  require 'cgi'
4
4
 
5
5
  module AftershipAPI
6
- class EstimatedDeliveryDateApi
6
+ class EstimatedDeliveryDateApi
7
7
  attr_accessor :api_client
8
8
 
9
9
  def initialize(api_client = ApiClient.default)
@@ -13,27 +13,18 @@ module AftershipAPI
13
13
  # predict
14
14
  # > The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.You can use to activate this feature.
15
15
 
16
- # @param body [Model::PredictRequest]
16
+ # @param body [Model::EstimatedDeliveryDateRequest]
17
17
  # @param [Hash] opts the optional parameters
18
- # @return [Model::PredictResponse]
19
- def predict(body:,opts: {})
20
- if "" != ""
21
- body = {:'' => body}
22
- end
18
+ # @return [Model::PredictResponse]
19
+ def predict(body:, opts: {})
23
20
  opts[:body] = body
24
- data, _status_code, _headers = predict_with_http_info(opts: opts)
25
- data
26
- end
27
-
28
- def predict_with_http_info(opts: {})
29
21
  if @api_client.config.debugging
30
22
  @api_client.config.logger.debug 'Calling API: EstimatedDeliveryDateApi.predict ...'
31
23
  end
32
24
 
33
25
 
34
-
35
26
  # resource path
36
- local_var_path = "/tracking/2025-07/estimated-delivery-date/predict"
27
+ local_var_path = "/tracking/2025-07/estimated-delivery-date/predict"
37
28
  method = :'POST'
38
29
 
39
30
  # query parameters
@@ -45,49 +36,42 @@ module AftershipAPI
45
36
  post_body = opts[:body]
46
37
 
47
38
  # return_type
48
- return_type = 'PredictResponse'
49
-
39
+ return_type = 'EstimatedDeliveryDateResponse'
40
+
50
41
  new_options = opts.merge(
51
42
  :operation => :"EstimatedDeliveryDateApi.predict",
52
43
  :header_params => header_params,
53
44
  :query_params => query_params,
54
45
  :body => post_body,
55
- :return_type => return_type,
56
- :response_legacy_tag => "",
57
- :is_paging => false
46
+ :return_type => return_type
58
47
  )
59
48
 
60
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
49
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
61
50
  if @api_client.config.debugging
62
51
  @api_client.config.logger.debug "API called: EstimatedDeliveryDateApi#predict\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
63
52
  end
64
- return data, status_code, headers
65
- end
53
+
54
+ resp = Model::PredictResponse.new
55
+ resp.data = data
56
+ resp.response_header = headers
57
+ resp
58
+ end
66
59
 
67
60
  # predict_batch
68
61
  # > The estimated delivery date is provided by AfterShip, based on its AI-predictive model. You can display the EDD on the product page, cart, and order checkout page. It indicates when a customer will receive the order.You can use to activate this feature.Supported functionalities require:1. One `EstimatedDeliveryDate` object for one prediction result.2. Maximum 5 `EstimatedDeliveryDate` objects are allowed.3. API call will fail if any of the requests `EstimatedDeliveryDate` objects do not meet the specification requirement.
69
62
 
70
- # @param body [Model::PredictBatchRequest]
63
+ # @param body [Model::PredictBatchRequest]
71
64
  # @param [Hash] opts the optional parameters
72
- # @return [Model::PredictBatchResponse]
73
- def predict_batch(body:,opts: {})
74
- if "" != ""
75
- body = {:'' => body}
76
- end
65
+ # @return [Model::PredictBatchResponse]
66
+ def predict_batch(body:, opts: {})
77
67
  opts[:body] = body
78
- data, _status_code, _headers = predict_batch_with_http_info(opts: opts)
79
- data
80
- end
81
-
82
- def predict_batch_with_http_info(opts: {})
83
68
  if @api_client.config.debugging
84
69
  @api_client.config.logger.debug 'Calling API: EstimatedDeliveryDateApi.predict_batch ...'
85
70
  end
86
71
 
87
72
 
88
-
89
73
  # resource path
90
- local_var_path = "/tracking/2025-07/estimated-delivery-date/predict-batch"
74
+ local_var_path = "/tracking/2025-07/estimated-delivery-date/predict-batch"
91
75
  method = :'POST'
92
76
 
93
77
  # query parameters
@@ -99,23 +83,25 @@ module AftershipAPI
99
83
  post_body = opts[:body]
100
84
 
101
85
  # return_type
102
- return_type = 'PredictBatchResponse'
103
-
86
+ return_type = 'PredictBatchResponseData'
87
+
104
88
  new_options = opts.merge(
105
89
  :operation => :"EstimatedDeliveryDateApi.predict_batch",
106
90
  :header_params => header_params,
107
91
  :query_params => query_params,
108
92
  :body => post_body,
109
- :return_type => return_type,
110
- :response_legacy_tag => "",
111
- :is_paging => false
93
+ :return_type => return_type
112
94
  )
113
95
 
114
- data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
96
+ data, _status_code, headers = @api_client.call_api(method, local_var_path, new_options)
115
97
  if @api_client.config.debugging
116
98
  @api_client.config.logger.debug "API called: EstimatedDeliveryDateApi#predict_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
117
99
  end
118
- return data, status_code, headers
119
- end
100
+
101
+ resp = Model::PredictBatchResponse.new
102
+ resp.data = data
103
+ resp.response_header = headers
104
+ resp
105
+ end
120
106
  end
121
- end
107
+ end