@@ -6,16 +6,16 @@ import { Request } from "../lib/request";
6
6
import { AftershipError , AfterShipErrorCodes } from "../error" ;
7
7
import { GetTrackingsQuery } from "../model/GetTrackingsQuery" ;
8
8
import { GetTrackingsResponse } from "../model/GetTrackingsResponse" ;
9
- import { RetrackTrackingByIdResponse } from "../model/RetrackTrackingByIdResponse" ;
10
9
import { DeleteTrackingByIdResponse } from "../model/DeleteTrackingByIdResponse" ;
11
- import { MarkTrackingCompletedByIdRequest } from "../model/MarkTrackingCompletedByIdRequest" ;
12
- import { MarkTrackingCompletedByIdResponse } from "../model/MarkTrackingCompletedByIdResponse" ;
13
- import { CreateTrackingRequest } from "../model/CreateTrackingRequest" ;
14
- import { CreateTrackingResponse } from "../model/CreateTrackingResponse" ;
15
10
import { GetTrackingByIdQuery } from "../model/GetTrackingByIdQuery" ;
16
11
import { GetTrackingByIdResponse } from "../model/GetTrackingByIdResponse" ;
17
12
import { UpdateTrackingByIdRequest } from "../model/UpdateTrackingByIdRequest" ;
18
13
import { UpdateTrackingByIdResponse } from "../model/UpdateTrackingByIdResponse" ;
14
+ import { RetrackTrackingByIdResponse } from "../model/RetrackTrackingByIdResponse" ;
15
+ import { MarkTrackingCompletedByIdRequest } from "../model/MarkTrackingCompletedByIdRequest" ;
16
+ import { MarkTrackingCompletedByIdResponse } from "../model/MarkTrackingCompletedByIdResponse" ;
17
+ import { CreateTrackingRequest } from "../model/CreateTrackingRequest" ;
18
+ import { CreateTrackingResponse } from "../model/CreateTrackingResponse" ;
19
19
20
20
export class TrackingApi {
21
21
private readonly request : Request ;
@@ -29,78 +29,78 @@ export class TrackingApi {
29
29
*/
30
30
public async getTrackings ( query ?: GetTrackingsQuery , headers ?: { [ key : string ] : any } ) : Promise < GetTrackingsResponse > {
31
31
32
- return this . request . makeRequest < GetTrackingsResponse > ( { url : `/tracking/2025-04/trackings` , method : "GET" , query, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : true } )
32
+ return this . request . makeRequest < GetTrackingsResponse > ( { url : `/tracking/2025-04/trackings` , method : "GET" , query, headers, request_legacy_tag : "" , response_legacy_tag : "trackings " , is_paging : true } )
33
33
}
34
34
/**
35
- * Retrack an expired tracking. Max 3 times per tracking.
35
+ * Delete a tracking.
36
36
*/
37
- public async retrackTrackingById ( id : string , headers ?: { [ key : string ] : any } ) : Promise < RetrackTrackingByIdResponse > {
37
+ public async deleteTrackingById ( id : string , headers ?: { [ key : string ] : any } ) : Promise < DeleteTrackingByIdResponse > {
38
38
if ( ! id ) {
39
39
throw new AftershipError (
40
40
"Invalid params: id" ,
41
41
AfterShipErrorCodes . VALUE_INVALID
42
42
) ;
43
43
}
44
44
45
- return this . request . makeRequest < RetrackTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } /retrack ` , method : "POST " , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
45
+ return this . request . makeRequest < DeleteTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "DELETE " , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
46
46
}
47
47
/**
48
- * Delete a tracking.
48
+ * Get tracking results of a single tracking.
49
49
*/
50
- public async deleteTrackingById ( id : string , headers ?: { [ key : string ] : any } ) : Promise < DeleteTrackingByIdResponse > {
50
+ public async getTrackingById ( id : string , query ?: GetTrackingByIdQuery , headers ?: { [ key : string ] : any } ) : Promise < GetTrackingByIdResponse > {
51
51
if ( ! id ) {
52
52
throw new AftershipError (
53
53
"Invalid params: id" ,
54
54
AfterShipErrorCodes . VALUE_INVALID
55
55
) ;
56
56
}
57
57
58
- return this . request . makeRequest < DeleteTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "DELETE" , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
58
+ return this . request . makeRequest < GetTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "GET" , query , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
59
59
}
60
60
/**
61
- * Mark a tracking as completed. The tracking won't auto update until retrack it .
61
+ * Update a tracking.
62
62
*/
63
- public async markTrackingCompletedById ( id : string , body : MarkTrackingCompletedByIdRequest , headers ?: { [ key : string ] : any } ) : Promise < MarkTrackingCompletedByIdResponse > {
63
+ public async updateTrackingById ( id : string , body : UpdateTrackingByIdRequest , headers ?: { [ key : string ] : any } ) : Promise < UpdateTrackingByIdResponse > {
64
64
if ( ! id ) {
65
65
throw new AftershipError (
66
66
"Invalid params: id" ,
67
67
AfterShipErrorCodes . VALUE_INVALID
68
68
) ;
69
69
}
70
70
71
- return this . request . makeRequest < MarkTrackingCompletedByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } /mark-as-completed` , method : "POST" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
72
- }
73
- /**
74
- * Create a tracking.<div style="visibility:hidden; height: 0"></div>
75
- */
76
- public async createTracking ( body : CreateTrackingRequest , headers ?: { [ key : string ] : any } ) : Promise < CreateTrackingResponse > {
77
-
78
- return this . request . makeRequest < CreateTrackingResponse > ( { url : `/tracking/2025-04/trackings` , method : "POST" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
71
+ return this . request . makeRequest < UpdateTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "PUT" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
79
72
}
80
73
/**
81
- * Get tracking results of a single tracking.
74
+ * Retrack an expired tracking. Max 3 times per tracking.
82
75
*/
83
- public async getTrackingById ( id : string , query ?: GetTrackingByIdQuery , headers ?: { [ key : string ] : any } ) : Promise < GetTrackingByIdResponse > {
76
+ public async retrackTrackingById ( id : string , headers ?: { [ key : string ] : any } ) : Promise < RetrackTrackingByIdResponse > {
84
77
if ( ! id ) {
85
78
throw new AftershipError (
86
79
"Invalid params: id" ,
87
80
AfterShipErrorCodes . VALUE_INVALID
88
81
) ;
89
82
}
90
83
91
- return this . request . makeRequest < GetTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "GET" , query , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
84
+ return this . request . makeRequest < RetrackTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } /retrack ` , method : "POST" , headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
92
85
}
93
86
/**
94
- * Update a tracking.
87
+ * Mark a tracking as completed. The tracking won't auto update until retrack it .
95
88
*/
96
- public async updateTrackingById ( id : string , body : UpdateTrackingByIdRequest , headers ?: { [ key : string ] : any } ) : Promise < UpdateTrackingByIdResponse > {
89
+ public async markTrackingCompletedById ( id : string , body : MarkTrackingCompletedByIdRequest , headers ?: { [ key : string ] : any } ) : Promise < MarkTrackingCompletedByIdResponse > {
97
90
if ( ! id ) {
98
91
throw new AftershipError (
99
92
"Invalid params: id" ,
100
93
AfterShipErrorCodes . VALUE_INVALID
101
94
) ;
102
95
}
103
96
104
- return this . request . makeRequest < UpdateTrackingByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } ` , method : "PUT" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
97
+ return this . request . makeRequest < MarkTrackingCompletedByIdResponse > ( { url : `/tracking/2025-04/trackings/${ id } /mark-as-completed` , method : "POST" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
98
+ }
99
+ /**
100
+ * Create a tracking.<div style="visibility:hidden; height: 0"></div>
101
+ */
102
+ public async createTracking ( body : CreateTrackingRequest , headers ?: { [ key : string ] : any } ) : Promise < CreateTrackingResponse > {
103
+
104
+ return this . request . makeRequest < CreateTrackingResponse > ( { url : `/tracking/2025-04/trackings` , method : "POST" , body, headers, request_legacy_tag : "" , response_legacy_tag : "" , is_paging : false } )
105
105
}
106
106
}
0 commit comments