aftership-tracking-sdk 10.0.0 → 11.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.
- checksums.yaml +4 -4
- data/README.md +8 -12
- data/lib/aftership-tracking-sdk/api/courier.rb +16 -60
- data/lib/aftership-tracking-sdk/api/courier_connection.rb +283 -0
- data/lib/aftership-tracking-sdk/api/estimated_delivery_date.rb +2 -2
- data/lib/aftership-tracking-sdk/api/tracking.rb +9 -9
- data/lib/aftership-tracking-sdk/models/{additional_fields_v1.rb → additional_fields.rb} +9 -9
- data/lib/aftership-tracking-sdk/models/checkpoint.rb +2 -2
- data/lib/aftership-tracking-sdk/models/courier.rb +10 -0
- data/lib/aftership-tracking-sdk/models/courier_connection.rb +193 -0
- data/lib/aftership-tracking-sdk/models/courier_connection_response_for_get_courier_connections.rb +163 -0
- data/lib/aftership-tracking-sdk/models/{courier_response_v1.rb → courier_response.rb} +6 -6
- data/lib/aftership-tracking-sdk/models/create_tracking_request.rb +22 -52
- data/lib/aftership-tracking-sdk/models/create_tracking_response.rb +4 -44
- data/lib/aftership-tracking-sdk/models/credential_field.rb +173 -0
- data/lib/aftership-tracking-sdk/models/{get_user_couriers_response.rb → credentials_courier.rb} +9 -19
- data/lib/aftership-tracking-sdk/models/data_courier_connection_response_for_get_courier_connections.rb +163 -0
- data/lib/aftership-tracking-sdk/models/{data_courier_response_v1.rb → data_courier_response.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/{data_tracking_response_get_multiple_v1.rb → data_tracking_response_for_get_trackings.rb} +4 -4
- data/lib/aftership-tracking-sdk/models/delete_courier_connections_by_id_response.rb +193 -0
- data/lib/aftership-tracking-sdk/models/delete_tracking_by_id_response.rb +4 -44
- data/lib/aftership-tracking-sdk/models/detect_courier_request.rb +14 -34
- data/lib/aftership-tracking-sdk/models/first_mile_create_tracking_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_delete_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_get_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_mark_tracking_completed_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_retrack_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_tracking.rb +2 -2
- data/lib/aftership-tracking-sdk/models/first_mile_update_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/get_courier_connections_by_id_response.rb +193 -0
- data/lib/aftership-tracking-sdk/models/get_courier_connections_response.rb +163 -0
- data/lib/aftership-tracking-sdk/models/{get_all_couriers_response.rb → get_couriers_response.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/get_tracking_by_id_response.rb +4 -44
- data/lib/aftership-tracking-sdk/models/last_mile_create_tracking_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_delete_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_get_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_mark_tracking_completed_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_retrack_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_tracking.rb +2 -2
- data/lib/aftership-tracking-sdk/models/last_mile_update_tracking_by_id_response.rb +2 -2
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_create_tracking_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_delete_tracking_by_id_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_get_tracking_by_id_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_mark_tracking_completed_by_id_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_retrack_tracking_by_id_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb +10 -0
- data/lib/aftership-tracking-sdk/models/latest_estimated_delivery_update_tracking_by_id_response.rb +10 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb +10 -0
- data/lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_response.rb +4 -44
- data/lib/aftership-tracking-sdk/models/{meta_v1.rb → meta.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/pagination_data_courier_connection_response_for_get_courier_connections.rb +173 -0
- data/lib/aftership-tracking-sdk/models/{pagination_data_tracking_response_get_multiple_v1.rb → pagination_data_tracking_response_for_get_trackings.rb} +2 -2
- data/lib/aftership-tracking-sdk/models/pagination_get_courier_connections_response.rb +173 -0
- data/lib/aftership-tracking-sdk/models/post_courier_connections_request.rb +163 -0
- data/lib/aftership-tracking-sdk/models/post_courier_connections_response.rb +193 -0
- data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_request.rb +153 -0
- data/lib/aftership-tracking-sdk/models/put_courier_connections_by_id_response.rb +193 -0
- data/lib/aftership-tracking-sdk/models/retrack_tracking_by_id_response.rb +4 -44
- data/lib/aftership-tracking-sdk/models/{slug_group_v1.rb → slug_group.rb} +3 -3
- data/lib/aftership-tracking-sdk/models/{tag_v1.rb → tag.rb} +3 -3
- data/lib/aftership-tracking-sdk/models/tracking.rb +4 -44
- data/lib/aftership-tracking-sdk/models/{tracking_response_v1.rb → tracking_response.rb} +4 -4
- data/lib/aftership-tracking-sdk/models/{tracking_response_get_multiple_v1.rb → tracking_response_for_get_trackings.rb} +6 -6
- data/lib/aftership-tracking-sdk/models/update_tracking_by_id_request.rb +0 -40
- data/lib/aftership-tracking-sdk/models/update_tracking_by_id_response.rb +4 -44
- data/lib/aftership-tracking-sdk/version.rb +1 -1
- metadata +28 -14
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c11231862a642bdf39c9bce127c906651e22fbed9b6834bf2e2add0c71a407be
|
4
|
+
data.tar.gz: 61372547049616b2d9b77b4f5f0580e25ef9adca5ad86d5348fd504b568177bc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ad2f7e3e4d85a563c9a3560243a19e72cfce5e88ba15edd684029221feddb815a95ae55b029fd82d004c0ff2f49ed3cd4456d9c57140d1c654d24a9e9d11997f
|
7
|
+
data.tar.gz: a991670c1be7810678d13b3c31a80d7b64ff1f9bfb769aaf14c4d3ed43415bf7c77a7f2953e5e9e3817572defa6cbcc2ca6f0df7ccac5992dc11546a95c13253
|
data/README.md
CHANGED
@@ -22,6 +22,7 @@ If you need support using AfterShip products, please contact support@aftership.c
|
|
22
22
|
- [Endpoints](#endpoints)
|
23
23
|
- [/trackings](#trackings)
|
24
24
|
- [/couriers](#couriers)
|
25
|
+
- [/courier-connections](#courier-connections)
|
25
26
|
- [/estimated-delivery-date](#estimated-delivery-date)
|
26
27
|
- [Help](#help)
|
27
28
|
- [License](#license)
|
@@ -42,6 +43,7 @@ Each SDK version is designed to work with a specific API version. Please refer t
|
|
42
43
|
|
43
44
|
| SDK Version | Supported API Version | Branch |
|
44
45
|
| ----------- | --------------------- | ----------------------------------------------------------- |
|
46
|
+
| 11.x.x | 2025-04 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2025-04 |
|
45
47
|
| 10.x.x | 2025-01 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2025-01 |
|
46
48
|
| 9.x.x | 2024-10 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-10 |
|
47
49
|
| 8.x.x | 2024-07 | https://github.com/AfterShip/tracking-sdk-ruby/tree/2024-07 |
|
@@ -58,7 +60,7 @@ gem install aftership-tracking-sdk
|
|
58
60
|
Or add a line to your Gemfile
|
59
61
|
|
60
62
|
```bash
|
61
|
-
gem 'aftership-tracking-sdk', '~>
|
63
|
+
gem 'aftership-tracking-sdk', '~> 11.0.0'
|
62
64
|
```
|
63
65
|
|
64
66
|
## Constructor
|
@@ -95,7 +97,7 @@ end
|
|
95
97
|
|
96
98
|
## Rate Limiter
|
97
99
|
|
98
|
-
See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-
|
100
|
+
See the [Rate Limit](https://www.aftership.com/docs/tracking/2025-04/quickstart/rate-limit) to understand the AfterShip rate limit policy.
|
99
101
|
|
100
102
|
## Error Handling
|
101
103
|
|
@@ -143,6 +145,7 @@ The AfterShip instance has the following properties which are exactly the same a
|
|
143
145
|
|
144
146
|
- courier - Get a list of our supported couriers.
|
145
147
|
- tracking - Create trackings, update trackings, and get tracking results.
|
148
|
+
- courier-connection - Create courier connections, update courier connections, and get courier connections results.
|
146
149
|
- estimated-delivery-date - Get estimated delivery date for your order.
|
147
150
|
|
148
151
|
|
@@ -213,14 +216,7 @@ p resp.to_json
|
|
213
216
|
**GET** /couriers
|
214
217
|
|
215
218
|
```ruby
|
216
|
-
resp = AftershipAPI::Courier.
|
217
|
-
p resp.to_json
|
218
|
-
```
|
219
|
-
|
220
|
-
**GET** /couriers/all
|
221
|
-
|
222
|
-
```ruby
|
223
|
-
resp = AftershipAPI::Courier.get_all_couriers()
|
219
|
+
resp = AftershipAPI::Courier.get_couriers()
|
224
220
|
p resp.to_json
|
225
221
|
```
|
226
222
|
|
@@ -242,11 +238,11 @@ edd = AftershipAPI::Model::EstimatedDeliveryDateRequest.new
|
|
242
238
|
edd.slug = "<slug>"
|
243
239
|
edd.pickup_time = "2024-08-01 06:42:30"
|
244
240
|
origin = AftershipAPI::Model::OriginAddressEstimatedDeliveryDateRequest.new
|
245
|
-
origin.
|
241
|
+
origin.country = "<ISO 3166-1 country/region code>"
|
246
242
|
origin.state = "<ISO 3166-1 country/region code>"
|
247
243
|
|
248
244
|
dest = AftershipAPI::Model::DestinationAddressEstimatedDeliveryDateRequest.new
|
249
|
-
dest.
|
245
|
+
dest.country = "<ISO 3166-1 country/region code>"
|
250
246
|
dest.state = "<ISO 3166-1 country/region code>"
|
251
247
|
|
252
248
|
edd.origin_address = origin
|
@@ -33,7 +33,7 @@ module AftershipAPI
|
|
33
33
|
|
34
34
|
|
35
35
|
# resource path
|
36
|
-
local_var_path = "/tracking/2025-
|
36
|
+
local_var_path = "/tracking/2025-04/couriers/detect"
|
37
37
|
method = :'POST'
|
38
38
|
|
39
39
|
# query parameters
|
@@ -64,28 +64,32 @@ module AftershipAPI
|
|
64
64
|
return data, status_code, headers
|
65
65
|
end
|
66
66
|
|
67
|
-
#
|
68
|
-
# Return a list of
|
67
|
+
# get_couriers
|
68
|
+
# Return a list of couriers.
|
69
69
|
# @param [Hash] opts the optional parameters
|
70
|
-
# @
|
71
|
-
|
72
|
-
|
70
|
+
# @option opts [Boolean] :active get user activated couriers
|
71
|
+
# @option opts [String] :slug Unique courier code Use comma for multiple values. (Example: dhl,ups,usps)
|
72
|
+
# @return [Model::GetCouriersResponse]
|
73
|
+
def get_couriers(opts: {})
|
74
|
+
data, _status_code, _headers = get_couriers_with_http_info(opts: opts)
|
73
75
|
data
|
74
76
|
end
|
75
77
|
|
76
|
-
def
|
78
|
+
def get_couriers_with_http_info(opts: {})
|
77
79
|
if @api_client.config.debugging
|
78
|
-
@api_client.config.logger.debug 'Calling API: CourierApi.
|
80
|
+
@api_client.config.logger.debug 'Calling API: CourierApi.get_couriers ...'
|
79
81
|
end
|
80
82
|
|
81
83
|
|
82
84
|
|
83
85
|
# resource path
|
84
|
-
local_var_path = "/tracking/2025-
|
86
|
+
local_var_path = "/tracking/2025-04/couriers"
|
85
87
|
method = :'GET'
|
86
88
|
|
87
89
|
# query parameters
|
88
90
|
query_params = opts[:query_params] || {}
|
91
|
+
query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
|
92
|
+
query_params[:'slug'] = opts[:'slug'] if !opts[:'slug'].nil?
|
89
93
|
# header parameters
|
90
94
|
header_params = opts[:header_params] || {}
|
91
95
|
|
@@ -93,10 +97,10 @@ module AftershipAPI
|
|
93
97
|
post_body = opts[:body]
|
94
98
|
|
95
99
|
# return_type
|
96
|
-
return_type = '
|
100
|
+
return_type = 'GetCouriersResponse'
|
97
101
|
|
98
102
|
new_options = opts.merge(
|
99
|
-
:operation => :"CourierApi.
|
103
|
+
:operation => :"CourierApi.get_couriers",
|
100
104
|
:header_params => header_params,
|
101
105
|
:query_params => query_params,
|
102
106
|
:body => post_body,
|
@@ -107,55 +111,7 @@ module AftershipAPI
|
|
107
111
|
|
108
112
|
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
109
113
|
if @api_client.config.debugging
|
110
|
-
@api_client.config.logger.debug "API called: CourierApi#
|
111
|
-
end
|
112
|
-
return data, status_code, headers
|
113
|
-
end
|
114
|
-
|
115
|
-
# get_user_couriers
|
116
|
-
# Return a list of .
|
117
|
-
# @param [Hash] opts the optional parameters
|
118
|
-
# @return [Model::GetUserCouriersResponse]
|
119
|
-
def get_user_couriers(opts: {})
|
120
|
-
data, _status_code, _headers = get_user_couriers_with_http_info(opts: opts)
|
121
|
-
data
|
122
|
-
end
|
123
|
-
|
124
|
-
def get_user_couriers_with_http_info(opts: {})
|
125
|
-
if @api_client.config.debugging
|
126
|
-
@api_client.config.logger.debug 'Calling API: CourierApi.get_user_couriers ...'
|
127
|
-
end
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
# resource path
|
132
|
-
local_var_path = "/tracking/2025-01/couriers"
|
133
|
-
method = :'GET'
|
134
|
-
|
135
|
-
# query parameters
|
136
|
-
query_params = opts[:query_params] || {}
|
137
|
-
# header parameters
|
138
|
-
header_params = opts[:header_params] || {}
|
139
|
-
|
140
|
-
# http body (model)
|
141
|
-
post_body = opts[:body]
|
142
|
-
|
143
|
-
# return_type
|
144
|
-
return_type = 'GetUserCouriersResponse'
|
145
|
-
|
146
|
-
new_options = opts.merge(
|
147
|
-
:operation => :"CourierApi.get_user_couriers",
|
148
|
-
:header_params => header_params,
|
149
|
-
:query_params => query_params,
|
150
|
-
:body => post_body,
|
151
|
-
:return_type => return_type,
|
152
|
-
:response_legacy_tag => "",
|
153
|
-
:is_paging => false
|
154
|
-
)
|
155
|
-
|
156
|
-
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
157
|
-
if @api_client.config.debugging
|
158
|
-
@api_client.config.logger.debug "API called: CourierApi#get_user_couriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
114
|
+
@api_client.config.logger.debug "API called: CourierApi#get_couriers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
159
115
|
end
|
160
116
|
return data, status_code, headers
|
161
117
|
end
|
@@ -0,0 +1,283 @@
|
|
1
|
+
# This code was auto generated by AfterShip SDK Generator.
|
2
|
+
# Do not edit the class manually.
|
3
|
+
require 'cgi'
|
4
|
+
|
5
|
+
module AftershipAPI
|
6
|
+
class CourierConnectionApi
|
7
|
+
attr_accessor :api_client
|
8
|
+
|
9
|
+
def initialize(api_client = ApiClient.default)
|
10
|
+
@api_client = api_client
|
11
|
+
end
|
12
|
+
|
13
|
+
# delete_courier_connections_by_id
|
14
|
+
# Delete a courier connection.
|
15
|
+
# @param id [String]
|
16
|
+
# @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: {})
|
24
|
+
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"
|
30
|
+
end
|
31
|
+
|
32
|
+
|
33
|
+
# resource path
|
34
|
+
local_var_path = "/tracking/2025-04/courier-connections/#{id}"
|
35
|
+
method = :'DELETE'
|
36
|
+
|
37
|
+
# query parameters
|
38
|
+
query_params = opts[:query_params] || {}
|
39
|
+
# header parameters
|
40
|
+
header_params = opts[:header_params] || {}
|
41
|
+
|
42
|
+
# http body (model)
|
43
|
+
post_body = opts[:body]
|
44
|
+
|
45
|
+
# return_type
|
46
|
+
return_type = 'DeleteCourierConnectionsByIdResponse'
|
47
|
+
|
48
|
+
new_options = opts.merge(
|
49
|
+
:operation => :"CourierConnectionApi.delete_courier_connections_by_id",
|
50
|
+
:header_params => header_params,
|
51
|
+
:query_params => query_params,
|
52
|
+
:body => post_body,
|
53
|
+
:return_type => return_type,
|
54
|
+
:response_legacy_tag => "",
|
55
|
+
:is_paging => false
|
56
|
+
)
|
57
|
+
|
58
|
+
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
59
|
+
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}"
|
61
|
+
end
|
62
|
+
return data, status_code, headers
|
63
|
+
end
|
64
|
+
|
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
|
75
|
+
end
|
76
|
+
|
77
|
+
def get_courier_connections_with_http_info(opts: {})
|
78
|
+
if @api_client.config.debugging
|
79
|
+
@api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections ...'
|
80
|
+
end
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
# resource path
|
85
|
+
local_var_path = "/tracking/2025-04/courier-connections"
|
86
|
+
method = :'GET'
|
87
|
+
|
88
|
+
# query parameters
|
89
|
+
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
|
+
# header parameters
|
94
|
+
header_params = opts[:header_params] || {}
|
95
|
+
|
96
|
+
# http body (model)
|
97
|
+
post_body = opts[:body]
|
98
|
+
|
99
|
+
# return_type
|
100
|
+
return_type = 'GetCourierConnectionsResponse'
|
101
|
+
|
102
|
+
new_options = opts.merge(
|
103
|
+
:operation => :"CourierConnectionApi.get_courier_connections",
|
104
|
+
:header_params => header_params,
|
105
|
+
:query_params => query_params,
|
106
|
+
:body => post_body,
|
107
|
+
:return_type => return_type,
|
108
|
+
:response_legacy_tag => "courier_connections",
|
109
|
+
:is_paging => true
|
110
|
+
)
|
111
|
+
|
112
|
+
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
113
|
+
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}"
|
115
|
+
end
|
116
|
+
return data, status_code, headers
|
117
|
+
end
|
118
|
+
|
119
|
+
# get_courier_connections_by_id
|
120
|
+
# Get courier connection results of a single courier connection.
|
121
|
+
# @param id [String]
|
122
|
+
# @param [Hash] opts the optional parameters
|
123
|
+
# @return [Model::GetCourierConnectionsByIdResponse]
|
124
|
+
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
|
+
if @api_client.config.debugging
|
131
|
+
@api_client.config.logger.debug 'Calling API: CourierConnectionApi.get_courier_connections_by_id ...'
|
132
|
+
end
|
133
|
+
|
134
|
+
if id.nil? or id.to_s == ''
|
135
|
+
raise InvalidParamError.new "id cannot be nil or empty"
|
136
|
+
end
|
137
|
+
|
138
|
+
|
139
|
+
# resource path
|
140
|
+
local_var_path = "/tracking/2025-04/courier-connections/#{id}"
|
141
|
+
method = :'GET'
|
142
|
+
|
143
|
+
# query parameters
|
144
|
+
query_params = opts[:query_params] || {}
|
145
|
+
# header parameters
|
146
|
+
header_params = opts[:header_params] || {}
|
147
|
+
|
148
|
+
# http body (model)
|
149
|
+
post_body = opts[:body]
|
150
|
+
|
151
|
+
# return_type
|
152
|
+
return_type = 'GetCourierConnectionsByIdResponse'
|
153
|
+
|
154
|
+
new_options = opts.merge(
|
155
|
+
:operation => :"CourierConnectionApi.get_courier_connections_by_id",
|
156
|
+
:header_params => header_params,
|
157
|
+
:query_params => query_params,
|
158
|
+
:body => post_body,
|
159
|
+
:return_type => return_type,
|
160
|
+
:response_legacy_tag => "",
|
161
|
+
:is_paging => false
|
162
|
+
)
|
163
|
+
|
164
|
+
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
165
|
+
if @api_client.config.debugging
|
166
|
+
@api_client.config.logger.debug "API called: CourierConnectionApi#get_courier_connections_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
167
|
+
end
|
168
|
+
return data, status_code, headers
|
169
|
+
end
|
170
|
+
|
171
|
+
# post_courier_connections
|
172
|
+
#
|
173
|
+
|
174
|
+
# @param body [Model::PostCourierConnectionsRequest]
|
175
|
+
# @param [Hash] opts the optional parameters
|
176
|
+
# @return [Model::PostCourierConnectionsResponse]
|
177
|
+
def post_courier_connections(body:,opts: {})
|
178
|
+
if "" != ""
|
179
|
+
body = {:'' => body}
|
180
|
+
end
|
181
|
+
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
|
+
if @api_client.config.debugging
|
188
|
+
@api_client.config.logger.debug 'Calling API: CourierConnectionApi.post_courier_connections ...'
|
189
|
+
end
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
# resource path
|
194
|
+
local_var_path = "/tracking/2025-04/courier-connections"
|
195
|
+
method = :'POST'
|
196
|
+
|
197
|
+
# query parameters
|
198
|
+
query_params = opts[:query_params] || {}
|
199
|
+
# header parameters
|
200
|
+
header_params = opts[:header_params] || {}
|
201
|
+
|
202
|
+
# http body (model)
|
203
|
+
post_body = opts[:body]
|
204
|
+
|
205
|
+
# return_type
|
206
|
+
return_type = 'PostCourierConnectionsResponse'
|
207
|
+
|
208
|
+
new_options = opts.merge(
|
209
|
+
:operation => :"CourierConnectionApi.post_courier_connections",
|
210
|
+
:header_params => header_params,
|
211
|
+
:query_params => query_params,
|
212
|
+
:body => post_body,
|
213
|
+
:return_type => return_type,
|
214
|
+
:response_legacy_tag => "",
|
215
|
+
:is_paging => false
|
216
|
+
)
|
217
|
+
|
218
|
+
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
219
|
+
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}"
|
221
|
+
end
|
222
|
+
return data, status_code, headers
|
223
|
+
end
|
224
|
+
|
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
|
239
|
+
end
|
240
|
+
|
241
|
+
def put_courier_connections_by_id_with_http_info(id:, opts: {})
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug 'Calling API: CourierConnectionApi.put_courier_connections_by_id ...'
|
244
|
+
end
|
245
|
+
|
246
|
+
if id.nil? or id.to_s == ''
|
247
|
+
raise InvalidParamError.new "id cannot be nil or empty"
|
248
|
+
end
|
249
|
+
|
250
|
+
|
251
|
+
# resource path
|
252
|
+
local_var_path = "/tracking/2025-04/courier-connections/#{id}"
|
253
|
+
method = :'PATCH'
|
254
|
+
|
255
|
+
# query parameters
|
256
|
+
query_params = opts[:query_params] || {}
|
257
|
+
# header parameters
|
258
|
+
header_params = opts[:header_params] || {}
|
259
|
+
|
260
|
+
# http body (model)
|
261
|
+
post_body = opts[:body]
|
262
|
+
|
263
|
+
# return_type
|
264
|
+
return_type = 'PutCourierConnectionsByIdResponse'
|
265
|
+
|
266
|
+
new_options = opts.merge(
|
267
|
+
:operation => :"CourierConnectionApi.put_courier_connections_by_id",
|
268
|
+
:header_params => header_params,
|
269
|
+
:query_params => query_params,
|
270
|
+
:body => post_body,
|
271
|
+
:return_type => return_type,
|
272
|
+
:response_legacy_tag => "",
|
273
|
+
:is_paging => false
|
274
|
+
)
|
275
|
+
|
276
|
+
data, status_code, headers = @api_client.call_api(method, local_var_path, new_options)
|
277
|
+
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}"
|
279
|
+
end
|
280
|
+
return data, status_code, headers
|
281
|
+
end
|
282
|
+
end
|
283
|
+
end
|
@@ -33,7 +33,7 @@ module AftershipAPI
|
|
33
33
|
|
34
34
|
|
35
35
|
# resource path
|
36
|
-
local_var_path = "/tracking/2025-
|
36
|
+
local_var_path = "/tracking/2025-04/estimated-delivery-date/predict"
|
37
37
|
method = :'POST'
|
38
38
|
|
39
39
|
# query parameters
|
@@ -87,7 +87,7 @@ module AftershipAPI
|
|
87
87
|
|
88
88
|
|
89
89
|
# resource path
|
90
|
-
local_var_path = "/tracking/2025-
|
90
|
+
local_var_path = "/tracking/2025-04/estimated-delivery-date/predict-batch"
|
91
91
|
method = :'POST'
|
92
92
|
|
93
93
|
# query parameters
|
@@ -33,7 +33,7 @@ module AftershipAPI
|
|
33
33
|
|
34
34
|
|
35
35
|
# resource path
|
36
|
-
local_var_path = "/tracking/2025-
|
36
|
+
local_var_path = "/tracking/2025-04/trackings"
|
37
37
|
method = :'POST'
|
38
38
|
|
39
39
|
# query parameters
|
@@ -85,7 +85,7 @@ module AftershipAPI
|
|
85
85
|
|
86
86
|
|
87
87
|
# resource path
|
88
|
-
local_var_path = "/tracking/2025-
|
88
|
+
local_var_path = "/tracking/2025-04/trackings/#{id}"
|
89
89
|
method = :'DELETE'
|
90
90
|
|
91
91
|
# query parameters
|
@@ -120,7 +120,7 @@ module AftershipAPI
|
|
120
120
|
# Get tracking results of a single tracking.
|
121
121
|
# @param id [String] tracking ID
|
122
122
|
# @param [Hash] opts the optional parameters
|
123
|
-
# @option opts [String] :fields List of fields to include in the response. Use comma for multiple values. Fields to include: `
|
123
|
+
# @option opts [String] :fields List of fields to include in the response. Use comma for multiple values. Fields to include: `destination_postal_code`, `tracking_ship_date`, `tracking_account_number`, `tracking_key`, `origin_country_region`, `destination_country_region`, `destination_state`, `title`, `order_id`, `tag`, `checkpoints`
|
124
124
|
# @option opts [String] :lang Translate checkpoint messages from the carrier’s provided language to the target language. Supported target languages include:</br> - English (en)</br> - French (fr)</br> - French Canadian (fr-CA)</br> - Arabic (ar)</br> - Bulgarian (bg)</br> - Catalan (ca)</br> - Croatian (hr)</br> - Czech (cs)</br> - Danish (da)</br> - Dutch (nl)</br> - Estonian (et)</br> - Filipino (tl)</br> - Finnish (fi)</br> - German (de)</br> - Greek (el)</br> - Hebrew (he)</br> - Hindi (hi)</br> - Hungarian (hu)</br> - Indonesian (id)</br> - Italian (it)</br> - Japanese (ja)</br> - Korean (ko)</br> - Latvian (lv)</br> - Lithuanian (lt)</br> - Malay (ms)</br> - Polish (pl)</br> - Portuguese (pt)</br> - Romanian (ro)</br> - Russian (ru)</br> - Serbian (sr)</br> - Slovak (sk)</br> - Slovenian (sl)</br> - Spanish (es)</br> - Swedish (sv)</br> - Thai (th)</br> - Turkish (tr)</br> - Ukrainian (uk)</br> - Vietnamese (vi)</br> - Simplified Chinese (zh-Hans)</br> - Traditional Chinese (zh-Hant)</br> - Norwegian (nb)</br>
|
125
125
|
# @return [Model::GetTrackingByIdResponse]
|
126
126
|
def get_tracking_by_id(id:, opts: {})
|
@@ -139,7 +139,7 @@ module AftershipAPI
|
|
139
139
|
|
140
140
|
|
141
141
|
# resource path
|
142
|
-
local_var_path = "/tracking/2025-
|
142
|
+
local_var_path = "/tracking/2025-04/trackings/#{id}"
|
143
143
|
method = :'GET'
|
144
144
|
|
145
145
|
# query parameters
|
@@ -207,7 +207,7 @@ module AftershipAPI
|
|
207
207
|
|
208
208
|
|
209
209
|
# resource path
|
210
|
-
local_var_path = "/tracking/2025-
|
210
|
+
local_var_path = "/tracking/2025-04/trackings"
|
211
211
|
method = :'GET'
|
212
212
|
|
213
213
|
# query parameters
|
@@ -245,7 +245,7 @@ module AftershipAPI
|
|
245
245
|
:query_params => query_params,
|
246
246
|
:body => post_body,
|
247
247
|
:return_type => return_type,
|
248
|
-
:response_legacy_tag => "",
|
248
|
+
:response_legacy_tag => "trackings",
|
249
249
|
:is_paging => true
|
250
250
|
)
|
251
251
|
|
@@ -283,7 +283,7 @@ module AftershipAPI
|
|
283
283
|
|
284
284
|
|
285
285
|
# resource path
|
286
|
-
local_var_path = "/tracking/2025-
|
286
|
+
local_var_path = "/tracking/2025-04/trackings/#{id}/mark-as-completed"
|
287
287
|
method = :'POST'
|
288
288
|
|
289
289
|
# query parameters
|
@@ -335,7 +335,7 @@ module AftershipAPI
|
|
335
335
|
|
336
336
|
|
337
337
|
# resource path
|
338
|
-
local_var_path = "/tracking/2025-
|
338
|
+
local_var_path = "/tracking/2025-04/trackings/#{id}/retrack"
|
339
339
|
method = :'POST'
|
340
340
|
|
341
341
|
# query parameters
|
@@ -393,7 +393,7 @@ module AftershipAPI
|
|
393
393
|
|
394
394
|
|
395
395
|
# resource path
|
396
|
-
local_var_path = "/tracking/2025-
|
396
|
+
local_var_path = "/tracking/2025-04/trackings/#{id}"
|
397
397
|
method = :'PUT'
|
398
398
|
|
399
399
|
# query parameters
|
@@ -2,16 +2,16 @@
|
|
2
2
|
# Do not edit the class manually.
|
3
3
|
|
4
4
|
module AftershipAPI::Model
|
5
|
-
class
|
5
|
+
class AdditionalFields
|
6
6
|
TRACKING_ACCOUNT_NUMBER = "tracking_account_number".freeze
|
7
|
-
|
8
|
-
|
7
|
+
DESTINATION_POSTAL_CODE = "destination_postal_code".freeze
|
8
|
+
DESTINATION_STATE = "destination_state".freeze
|
9
9
|
TRACKING_KEY = "tracking_key".freeze
|
10
|
-
|
11
|
-
|
12
|
-
|
10
|
+
ORIGIN_COUNTRY_REGION = "origin_country_region".freeze
|
11
|
+
DESTINATION_COUNTRY_REGION = "destination_country_region".freeze
|
12
|
+
TRACKING_SHIP_DATE = "tracking_ship_date".freeze
|
13
13
|
def self.all_vars
|
14
|
-
@all_vars ||= [TRACKING_ACCOUNT_NUMBER,
|
14
|
+
@all_vars ||= [TRACKING_ACCOUNT_NUMBER,DESTINATION_POSTAL_CODE,DESTINATION_STATE,TRACKING_KEY,ORIGIN_COUNTRY_REGION,DESTINATION_COUNTRY_REGION,TRACKING_SHIP_DATE,].freeze
|
15
15
|
end
|
16
16
|
|
17
17
|
# Builds the enum from string
|
@@ -25,8 +25,8 @@ module AftershipAPI::Model
|
|
25
25
|
# @param value [String] The enum value in the form of the string
|
26
26
|
# @return [String] The enum value
|
27
27
|
def build_from_hash(value)
|
28
|
-
return value if
|
29
|
-
raise "Invalid ENUM value #{value} for class #
|
28
|
+
return value if AdditionalFields.all_vars.include?(value)
|
29
|
+
raise "Invalid ENUM value #{value} for class #AdditionalFields"
|
30
30
|
end
|
31
31
|
end
|
32
32
|
end
|
@@ -48,7 +48,7 @@ module AftershipAPI::Model
|
|
48
48
|
attr_accessor :message
|
49
49
|
|
50
50
|
# Current status of tracking. (
|
51
|
-
# tag?:
|
51
|
+
# tag?: Tag;
|
52
52
|
attr_accessor :tag
|
53
53
|
|
54
54
|
# Current subtag of checkpoint. (
|
@@ -165,7 +165,7 @@ module AftershipAPI::Model
|
|
165
165
|
:'country_region' => :'String',
|
166
166
|
:'country_region_name' => :'String',
|
167
167
|
:'message' => :'String',
|
168
|
-
:'tag' => :'
|
168
|
+
:'tag' => :'Tag',
|
169
169
|
:'subtag' => :'String',
|
170
170
|
:'subtag_message' => :'String',
|
171
171
|
:'raw_tag' => :'String',
|
@@ -43,6 +43,10 @@ module AftershipAPI::Model
|
|
43
43
|
# service_from_country_regions?: String[];
|
44
44
|
attr_accessor :service_from_country_regions
|
45
45
|
|
46
|
+
# Refers to the authentication details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to create a carrier connection. The content varies by carrier.
|
47
|
+
# credentials?: CredentialsCourier;
|
48
|
+
attr_accessor :credentials
|
49
|
+
|
46
50
|
# Initializes the object
|
47
51
|
# @param [Hash] attributes Model attributes in the form of hash
|
48
52
|
def initialize(attributes = {})
|
@@ -93,6 +97,10 @@ module AftershipAPI::Model
|
|
93
97
|
if attributes.key?(:'service_from_country_regions')
|
94
98
|
self.service_from_country_regions = attributes[:'service_from_country_regions']
|
95
99
|
end
|
100
|
+
|
101
|
+
if attributes.key?(:'credentials')
|
102
|
+
self.credentials = attributes[:'credentials']
|
103
|
+
end
|
96
104
|
end
|
97
105
|
|
98
106
|
# Attribute type mapping.
|
@@ -108,6 +116,7 @@ module AftershipAPI::Model
|
|
108
116
|
:'default_language' => :'String',
|
109
117
|
:'support_languages' => :'Array<String>',
|
110
118
|
:'service_from_country_regions' => :'Array<String>',
|
119
|
+
:'credentials' => :'CredentialsCourier',
|
111
120
|
}
|
112
121
|
end
|
113
122
|
|
@@ -124,6 +133,7 @@ module AftershipAPI::Model
|
|
124
133
|
:'default_language' => :'default_language',
|
125
134
|
:'support_languages' => :'support_languages',
|
126
135
|
:'service_from_country_regions' => :'service_from_country_regions',
|
136
|
+
:'credentials' => :'credentials',
|
127
137
|
}
|
128
138
|
end
|
129
139
|
|