Skip to content

Commit 4eae447

Browse files
authored
Merge pull request #27 from 1415003719/2025-04
fix tracking model
2 parents b8a15f3 + 733948a commit 4eae447

File tree

6 files changed

+66
-59
lines changed

6 files changed

+66
-59
lines changed

src/api/CourierConnection.ts

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
*/
55
import { Request } from "../lib/request";
66
import { AftershipError, AfterShipErrorCodes } from "../error";
7-
import { GetCourierConnectionsQuery } from "../model/GetCourierConnectionsQuery";
8-
import { GetCourierConnectionsResponse } from "../model/GetCourierConnectionsResponse";
9-
import { GetCourierConnectionsByIdResponse } from "../model/GetCourierConnectionsByIdResponse";
10-
import { PutCourierConnectionsByIdRequest } from "../model/PutCourierConnectionsByIdRequest";
11-
import { PutCourierConnectionsByIdResponse } from "../model/PutCourierConnectionsByIdResponse";
127
import { PostCourierConnectionsRequest } from "../model/PostCourierConnectionsRequest";
138
import { PostCourierConnectionsResponse } from "../model/PostCourierConnectionsResponse";
9+
import { PutCourierConnectionsByIdRequest } from "../model/PutCourierConnectionsByIdRequest";
10+
import { PutCourierConnectionsByIdResponse } from "../model/PutCourierConnectionsByIdResponse";
1411
import { DeleteCourierConnectionsByIdResponse } from "../model/DeleteCourierConnectionsByIdResponse";
12+
import { GetCourierConnectionsQuery } from "../model/GetCourierConnectionsQuery";
13+
import { GetCourierConnectionsResponse } from "../model/GetCourierConnectionsResponse";
14+
import { GetCourierConnectionsByIdResponse } from "../model/GetCourierConnectionsByIdResponse";
1515

1616
export class CourierConnectionApi {
1717
private readonly request: Request;
@@ -21,56 +21,56 @@ export class CourierConnectionApi {
2121
}
2222

2323
/**
24-
* Get courier connection results of multiple courier connections.
24+
*
2525
*/
26-
public async getCourierConnections(query?: GetCourierConnectionsQuery, headers?: {[key: string]: any}): Promise<GetCourierConnectionsResponse> {
26+
public async postCourierConnections(body: PostCourierConnectionsRequest, headers?: {[key: string]: any}): Promise<PostCourierConnectionsResponse> {
2727

28-
return this.request.makeRequest<GetCourierConnectionsResponse>({url: `/tracking/2025-04/courier-connections`, method: "GET", query, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: true})
28+
return this.request.makeRequest<PostCourierConnectionsResponse>({url: `/tracking/2025-04/courier-connections`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
2929
}
3030
/**
31-
* Get courier connection results of a single courier connection.
31+
* Update a courier connection.
3232
*/
33-
public async getCourierConnectionsById(id: string, headers?: {[key: string]: any}): Promise<GetCourierConnectionsByIdResponse> {
33+
public async putCourierConnectionsById(id: string, body: PutCourierConnectionsByIdRequest, headers?: {[key: string]: any}): Promise<PutCourierConnectionsByIdResponse> {
3434
if (!id) {
3535
throw new AftershipError(
3636
"Invalid params: id",
3737
AfterShipErrorCodes.VALUE_INVALID
3838
);
3939
}
4040

41-
return this.request.makeRequest<GetCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "GET", headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
41+
return this.request.makeRequest<PutCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "PATCH", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
4242
}
4343
/**
44-
* Update a courier connection.
44+
* Delete a courier connection.
4545
*/
46-
public async putCourierConnectionsById(id: string, body: PutCourierConnectionsByIdRequest, headers?: {[key: string]: any}): Promise<PutCourierConnectionsByIdResponse> {
46+
public async deleteCourierConnectionsById(id: string, headers?: {[key: string]: any}): Promise<DeleteCourierConnectionsByIdResponse> {
4747
if (!id) {
4848
throw new AftershipError(
4949
"Invalid params: id",
5050
AfterShipErrorCodes.VALUE_INVALID
5151
);
5252
}
5353

54-
return this.request.makeRequest<PutCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "PATCH", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
54+
return this.request.makeRequest<DeleteCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "DELETE", headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
5555
}
5656
/**
57-
*
57+
* Get courier connection results of multiple courier connections.
5858
*/
59-
public async postCourierConnections(body: PostCourierConnectionsRequest, headers?: {[key: string]: any}): Promise<PostCourierConnectionsResponse> {
59+
public async getCourierConnections(query?: GetCourierConnectionsQuery, headers?: {[key: string]: any}): Promise<GetCourierConnectionsResponse> {
6060

61-
return this.request.makeRequest<PostCourierConnectionsResponse>({url: `/tracking/2025-04/courier-connections`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
61+
return this.request.makeRequest<GetCourierConnectionsResponse>({url: `/tracking/2025-04/courier-connections`, method: "GET", query, headers, request_legacy_tag: "", response_legacy_tag: "courier_connections", is_paging: true})
6262
}
6363
/**
64-
* Delete a courier connection.
64+
* Get courier connection results of a single courier connection.
6565
*/
66-
public async deleteCourierConnectionsById(id: string, headers?: {[key: string]: any}): Promise<DeleteCourierConnectionsByIdResponse> {
66+
public async getCourierConnectionsById(id: string, headers?: {[key: string]: any}): Promise<GetCourierConnectionsByIdResponse> {
6767
if (!id) {
6868
throw new AftershipError(
6969
"Invalid params: id",
7070
AfterShipErrorCodes.VALUE_INVALID
7171
);
7272
}
7373

74-
return this.request.makeRequest<DeleteCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "DELETE", headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
74+
return this.request.makeRequest<GetCourierConnectionsByIdResponse>({url: `/tracking/2025-04/courier-connections/${id}`, method: "GET", headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
7575
}
7676
}

src/api/EstimatedDeliveryDate.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
*/
55
import { Request } from "../lib/request";
66
import { AftershipError, AfterShipErrorCodes } from "../error";
7-
import { PredictBatchRequest } from "../model/PredictBatchRequest";
8-
import { PredictBatchResponse } from "../model/PredictBatchResponse";
97
import { PredictRequest } from "../model/PredictRequest";
108
import { PredictResponse } from "../model/PredictResponse";
9+
import { PredictBatchRequest } from "../model/PredictBatchRequest";
10+
import { PredictBatchResponse } from "../model/PredictBatchResponse";
1111

1212
export class EstimatedDeliveryDateApi {
1313
private readonly request: Request;
@@ -17,17 +17,17 @@ export class EstimatedDeliveryDateApi {
1717
}
1818

1919
/**
20-
* &gt; 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.
20+
* &gt; 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.
2121
*/
22-
public async predictBatch(body: PredictBatchRequest, headers?: {[key: string]: any}): Promise<PredictBatchResponse> {
22+
public async predict(body: PredictRequest, headers?: {[key: string]: any}): Promise<PredictResponse> {
2323

24-
return this.request.makeRequest<PredictBatchResponse>({url: `/tracking/2025-04/estimated-delivery-date/predict-batch`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
24+
return this.request.makeRequest<PredictResponse>({url: `/tracking/2025-04/estimated-delivery-date/predict`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
2525
}
2626
/**
27-
* &gt; 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.
27+
* &gt; 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.
2828
*/
29-
public async predict(body: PredictRequest, headers?: {[key: string]: any}): Promise<PredictResponse> {
29+
public async predictBatch(body: PredictBatchRequest, headers?: {[key: string]: any}): Promise<PredictBatchResponse> {
3030

31-
return this.request.makeRequest<PredictResponse>({url: `/tracking/2025-04/estimated-delivery-date/predict`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
31+
return this.request.makeRequest<PredictBatchResponse>({url: `/tracking/2025-04/estimated-delivery-date/predict-batch`, method: "POST", body, headers, request_legacy_tag: "", response_legacy_tag: "", is_paging: false})
3232
}
3333
}

src/api/Tracking.ts

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ import { Request } from "../lib/request";
66
import { AftershipError, AfterShipErrorCodes } from "../error";
77
import { GetTrackingsQuery } from "../model/GetTrackingsQuery";
88
import { GetTrackingsResponse } from "../model/GetTrackingsResponse";
9-
import { RetrackTrackingByIdResponse } from "../model/RetrackTrackingByIdResponse";
109
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";
1510
import { GetTrackingByIdQuery } from "../model/GetTrackingByIdQuery";
1611
import { GetTrackingByIdResponse } from "../model/GetTrackingByIdResponse";
1712
import { UpdateTrackingByIdRequest } from "../model/UpdateTrackingByIdRequest";
1813
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";
1919

2020
export class TrackingApi {
2121
private readonly request: Request;
@@ -29,78 +29,78 @@ export class TrackingApi {
2929
*/
3030
public async getTrackings(query?: GetTrackingsQuery, headers?: {[key: string]: any}): Promise<GetTrackingsResponse> {
3131

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})
3333
}
3434
/**
35-
* Retrack an expired tracking. Max 3 times per tracking.
35+
* Delete a tracking.
3636
*/
37-
public async retrackTrackingById(id: string, headers?: {[key: string]: any}): Promise<RetrackTrackingByIdResponse> {
37+
public async deleteTrackingById(id: string, headers?: {[key: string]: any}): Promise<DeleteTrackingByIdResponse> {
3838
if (!id) {
3939
throw new AftershipError(
4040
"Invalid params: id",
4141
AfterShipErrorCodes.VALUE_INVALID
4242
);
4343
}
4444

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})
4646
}
4747
/**
48-
* Delete a tracking.
48+
* Get tracking results of a single tracking.
4949
*/
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> {
5151
if (!id) {
5252
throw new AftershipError(
5353
"Invalid params: id",
5454
AfterShipErrorCodes.VALUE_INVALID
5555
);
5656
}
5757

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})
5959
}
6060
/**
61-
* Mark a tracking as completed. The tracking won&#39;t auto update until retrack it.
61+
* Update a tracking.
6262
*/
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> {
6464
if (!id) {
6565
throw new AftershipError(
6666
"Invalid params: id",
6767
AfterShipErrorCodes.VALUE_INVALID
6868
);
6969
}
7070

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.&lt;div style=&#34;visibility:hidden; height: 0&#34;&gt;&lt;/div&gt;
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})
7972
}
8073
/**
81-
* Get tracking results of a single tracking.
74+
* Retrack an expired tracking. Max 3 times per tracking.
8275
*/
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> {
8477
if (!id) {
8578
throw new AftershipError(
8679
"Invalid params: id",
8780
AfterShipErrorCodes.VALUE_INVALID
8881
);
8982
}
9083

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})
9285
}
9386
/**
94-
* Update a tracking.
87+
* Mark a tracking as completed. The tracking won&#39;t auto update until retrack it.
9588
*/
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> {
9790
if (!id) {
9891
throw new AftershipError(
9992
"Invalid params: id",
10093
AfterShipErrorCodes.VALUE_INVALID
10194
);
10295
}
10396

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.&lt;div style=&#34;visibility:hidden; height: 0&#34;&gt;&lt;/div&gt;
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})
105105
}
106106
}

src/model/AdditionalFields.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,4 @@ export enum AdditionalFields {
1212
"origin_country_region" = "origin_country_region",
1313
"destination_country_region" = "destination_country_region",
1414
"tracking_ship_date" = "tracking_ship_date",
15-
"customers[x].phone_number" = "customers[x].phone_number",
1615
}

src/model/GetCourierConnectionsResponse.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
* This code was auto generated by AfterShip SDK Generator.
33
* Do not edit the class manually.
44
*/
5-
import { PaginationGetCourierConnectionsResponse } from "./PaginationGetCourierConnectionsResponse";
65
import { CourierConnection } from "./CourierConnection";
6+
import { Pagination } from "./Pagination";
77

88
export interface GetCourierConnectionsResponse {
99
/**
1010
*
1111
*/
1212
pagination: Pagination;
13+
/**
14+
*
15+
*/
16+
courier_connections?: CourierConnection[];
1317
}
1418

src/model/GetTrackingsResponse.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
* This code was auto generated by AfterShip SDK Generator.
33
* Do not edit the class manually.
44
*/
5-
import { PaginationGetTrackingsResponse } from "./PaginationGetTrackingsResponse";
65
import { Tracking } from "./Tracking";
6+
import { Pagination } from "./Pagination";
77

88
export interface GetTrackingsResponse {
99
/**
1010
*
1111
*/
1212
pagination: Pagination;
13+
/**
14+
* Array of
15+
*/
16+
trackings?: Tracking[];
1317
}
1418

0 commit comments

Comments
 (0)