Skip to content

Commit c45d00c

Browse files
author
Watson Zuo
committed
update slug group to string
1 parent b32ec9f commit c45d00c

File tree

6 files changed

+92
-124
lines changed

6 files changed

+92
-124
lines changed

README.md

Lines changed: 83 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ If you need support using AfterShip products, please contact [email protected]
2020
- [Error Handling](#error-handling)
2121
- [Error List](#error-list)
2222
- [Endpoints](#endpoints)
23-
- [/trackings](#trackings)
24-
- [/couriers](#couriers)
2523
- [/courier-connections](#courier-connections)
2624
- [/estimated-delivery-date](#estimated-delivery-date)
25+
- [/trackings](#trackings)
26+
- [/couriers](#couriers)
2727
- [Help](#help)
2828
- [License](#license)
2929

@@ -145,6 +145,15 @@ The SDK will return an error object when there is any error during the request,
145145

146146
The AfterShip instance has the following properties which are exactly the same as the API endpoints:
147147

148+
- courier_connection
149+
- Get courier connections
150+
- Create courier connections
151+
- Get courier connection by id
152+
- Update courier connection by id
153+
- Delete courier connection by id
154+
- estimated_delivery_date
155+
- Prediction for the Estimated Delivery Date
156+
- Batch prediction for the Estimated Delivery Date
148157
- tracking
149158
- Get trackings
150159
- Create a tracking
@@ -156,247 +165,238 @@ The AfterShip instance has the following properties which are exactly the same a
156165
- courier
157166
- Get couriers
158167
- Detect courier
159-
- courier_connection
160-
- Get courier connections
161-
- Create courier connections
162-
- Get courier connection by id
163-
- Update courier connection by id
164-
- Delete courier connection by id
165-
- estimated_delivery_date
166-
- Prediction for the Estimated Delivery Date
167-
- Batch prediction for the Estimated Delivery Date
168168

169-
### /trackings
170-
**GET** /trackings
169+
### /courier-connections
170+
**GET** /courier-connections
171171

172172
```python
173173

174-
result = sdk.tracking.get_trackings(
174+
result = sdk.courier_connection.get_courier_connections(
175175

176176

177177

178178
)
179179
print(result)
180180
```
181181

182-
**POST** /trackings
182+
**POST** /courier-connections
183183

184184
```python
185-
req = tracking.CreateTrackingRequest()
185+
req = tracking.PostCourierConnectionsRequest()
186186

187187

188-
req.tracking_number = 'valid_value'
188+
req.courier_slug = 'valid_value'
189189

190190

191-
result = sdk.tracking.create_tracking(
191+
req.credentials = {}
192+
193+
194+
result = sdk.courier_connection.post_courier_connections(
192195

193196
req,
194197

195198
)
196199
print(result)
197200
```
198201

199-
**GET** /trackings/{id}
202+
**GET** /courier-connections/{id}
200203

201204
```python
202205

203-
result = sdk.tracking.get_tracking_by_id(
206+
result = sdk.courier_connection.get_courier_connections_by_id(
204207
'valid_value',
205208

206209

207210
)
208211
print(result)
209212
```
210213

211-
**PUT** /trackings/{id}
214+
**PATCH** /courier-connections/{id}
212215

213216
```python
214-
req = tracking.UpdateTrackingByIdRequest()
217+
req = tracking.PutCourierConnectionsByIdRequest()
215218

216219

217-
result = sdk.tracking.update_tracking_by_id(
220+
req.credentials = {}
221+
222+
223+
result = sdk.courier_connection.put_courier_connections_by_id(
218224
'valid_value',
219225
req,
220226

221227
)
222228
print(result)
223229
```
224230

225-
**DELETE** /trackings/{id}
231+
**DELETE** /courier-connections/{id}
226232

227233
```python
228234

229-
result = sdk.tracking.delete_tracking_by_id(
235+
result = sdk.courier_connection.delete_courier_connections_by_id(
230236
'valid_value',
231237

232238

233239
)
234240
print(result)
235241
```
236242

237-
**POST** /trackings/{id}/retrack
243+
### /estimated-delivery-date
244+
**POST** /estimated-delivery-date/predict
238245

239246
```python
247+
req = tracking.EstimatedDeliveryDateRequest()
240248

241-
result = sdk.tracking.retrack_tracking_by_id(
242-
'valid_value',
249+
250+
req.slug = 'valid_value'
251+
252+
253+
req.origin_address = tracking.EstimatedDeliveryDateRequestOriginAddress()
254+
255+
256+
req.destination_address = tracking.EstimatedDeliveryDateRequestDestinationAddress()
257+
258+
259+
result = sdk.estimated_delivery_date.predict(
243260

261+
req,
244262

245263
)
246264
print(result)
247265
```
248266

249-
**POST** /trackings/{id}/mark-as-completed
267+
**POST** /estimated-delivery-date/predict-batch
250268

251269
```python
252-
req = tracking.MarkTrackingCompletedByIdRequest()
270+
req = tracking.PredictBatchRequest()
253271

254272

255273

256-
result = sdk.tracking.mark_tracking_completed_by_id(
257-
'valid_value',
274+
result = sdk.estimated_delivery_date.predict_batch(
275+
258276
req,
259277

260278
)
261279
print(result)
262280
```
263281

264-
### /couriers
265-
**GET** /couriers
282+
### /trackings
283+
**GET** /trackings
266284

267285
```python
268286

269-
result = sdk.courier.get_couriers(
287+
result = sdk.tracking.get_trackings(
270288

271289

272290

273291
)
274292
print(result)
275293
```
276294

277-
**POST** /couriers/detect
295+
**POST** /trackings
278296

279297
```python
280-
req = tracking.DetectCourierRequest()
298+
req = tracking.CreateTrackingRequest()
281299

282300

283301
req.tracking_number = 'valid_value'
284302

285303

286-
result = sdk.courier.detect_courier(
304+
result = sdk.tracking.create_tracking(
287305

288306
req,
289307

290308
)
291309
print(result)
292310
```
293311

294-
### /courier-connections
295-
**GET** /courier-connections
312+
**GET** /trackings/{id}
296313

297314
```python
298315

299-
result = sdk.courier_connection.get_courier_connections(
300-
316+
result = sdk.tracking.get_tracking_by_id(
317+
'valid_value',
301318

302319

303320
)
304321
print(result)
305322
```
306323

307-
**POST** /courier-connections
324+
**PUT** /trackings/{id}
308325

309326
```python
310-
req = tracking.PostCourierConnectionsRequest()
311-
312-
313-
req.courier_slug = 'valid_value'
314-
315-
316-
req.credentials = {}
327+
req = tracking.UpdateTrackingByIdRequest()
317328

318329

319-
result = sdk.courier_connection.post_courier_connections(
320-
330+
result = sdk.tracking.update_tracking_by_id(
331+
'valid_value',
321332
req,
322333

323334
)
324335
print(result)
325336
```
326337

327-
**GET** /courier-connections/{id}
338+
**DELETE** /trackings/{id}
328339

329340
```python
330341

331-
result = sdk.courier_connection.get_courier_connections_by_id(
342+
result = sdk.tracking.delete_tracking_by_id(
332343
'valid_value',
333344

334345

335346
)
336347
print(result)
337348
```
338349

339-
**PATCH** /courier-connections/{id}
350+
**POST** /trackings/{id}/retrack
340351

341352
```python
342-
req = tracking.PutCourierConnectionsByIdRequest()
343-
344-
345-
req.credentials = {}
346353

347-
348-
result = sdk.courier_connection.put_courier_connections_by_id(
354+
result = sdk.tracking.retrack_tracking_by_id(
349355
'valid_value',
350-
req,
356+
351357

352358
)
353359
print(result)
354360
```
355361

356-
**DELETE** /courier-connections/{id}
362+
**POST** /trackings/{id}/mark-as-completed
357363

358364
```python
365+
req = tracking.MarkTrackingCompletedByIdRequest()
359366

360-
result = sdk.courier_connection.delete_courier_connections_by_id(
367+
368+
369+
result = sdk.tracking.mark_tracking_completed_by_id(
361370
'valid_value',
362-
371+
req,
363372

364373
)
365374
print(result)
366375
```
367376

368-
### /estimated-delivery-date
369-
**POST** /estimated-delivery-date/predict
377+
### /couriers
378+
**GET** /couriers
370379

371380
```python
372-
req = tracking.EstimatedDeliveryDateRequest()
373381

374-
375-
req.slug = 'valid_value'
376-
377-
378-
req.origin_address = tracking.EstimatedDeliveryDateRequestOriginAddress()
379-
380-
381-
req.destination_address = tracking.EstimatedDeliveryDateRequestDestinationAddress()
382-
383-
384-
result = sdk.estimated_delivery_date.predict(
382+
result = sdk.courier.get_couriers(
383+
385384

386-
req,
387385

388386
)
389387
print(result)
390388
```
391389

392-
**POST** /estimated-delivery-date/predict-batch
390+
**POST** /couriers/detect
393391

394392
```python
395-
req = tracking.PredictBatchRequest()
393+
req = tracking.DetectCourierRequest()
396394

397395

396+
req.tracking_number = 'valid_value'
398397

399-
result = sdk.estimated_delivery_date.predict_batch(
398+
399+
result = sdk.courier.detect_courier(
400400

401401
req,
402402

tracking/api/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
# Do not edit the class manually.
55

66
__all__ = [
7-
"TrackingApi",
8-
"CourierApi",
97
"CourierConnectionApi",
108
"EstimatedDeliveryDateApi",
9+
"TrackingApi",
10+
"CourierApi",
1111
]
1212

13-
from .tracking import TrackingApi
14-
from .courier import CourierApi
1513
from .courier_connection import CourierConnectionApi
1614
from .estimated_delivery_date import EstimatedDeliveryDateApi
15+
from .tracking import TrackingApi
16+
from .courier import CourierApi

tracking/client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@
88
from typing import Optional
99

1010
from .configuration import Configuration
11-
from .api import TrackingApi
12-
from .api import CourierApi
1311
from .api import CourierConnectionApi
1412
from .api import EstimatedDeliveryDateApi
13+
from .api import TrackingApi
14+
from .api import CourierApi
1515

1616

1717
class Client:
1818
def __init__(self, configuration: Optional[Configuration] = None) -> None:
1919
if configuration is None:
2020
configuration = Configuration()
2121

22-
self.tracking = TrackingApi(configuration)
23-
self.courier = CourierApi(configuration)
2422
self.courier_connection = CourierConnectionApi(configuration)
2523
self.estimated_delivery_date = EstimatedDeliveryDateApi(configuration)
24+
self.tracking = TrackingApi(configuration)
25+
self.courier = CourierApi(configuration)

0 commit comments

Comments
 (0)