@chrt-inc/typescript-sdk 1.304.0 → 1.305.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.
- package/README.md +585 -0
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/drivers/client/Client.d.ts +10 -10
- package/dist/cjs/api/resources/drivers/client/Client.js +10 -10
- package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/offChrtShipperOrg/client/Client.js +5 -5
- package/dist/cjs/api/resources/orderDrafts/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/orderDrafts/client/Client.js +6 -6
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/orderDrafts/resources/cargo/client/Client.js +4 -4
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/orderDrafts/resources/task/client/Client.js +3 -3
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/orderDrafts/resources/taskArtifact/client/Client.js +2 -2
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +2 -2
- package/dist/cjs/api/resources/orders/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orders/client/Client.js +1 -1
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/orders/resources/expanded/client/Client.js +2 -2
- package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/orders/resources/expandedList/client/Client.js +2 -2
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +10 -0
- package/dist/cjs/api/resources/orgs/client/Client.js +53 -2
- package/dist/cjs/api/resources/shipperContactInfo/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/shipperContactInfo/client/Client.js +9 -9
- package/dist/cjs/api/resources/taskArtifacts/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/taskArtifacts/client/Client.js +3 -3
- package/dist/cjs/api/resources/taskArtifacts/resources/blurhash/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/blurhash/client/Client.js +1 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/images/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/taskArtifacts/resources/images/client/Client.js +3 -3
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/taskGroups/client/Client.js +3 -3
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/taskGroups/resources/expanded/client/Client.js +3 -3
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/taskGroups/resources/expandedList/client/Client.js +2 -2
- package/dist/cjs/api/resources/users/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/users/client/Client.js +5 -5
- package/dist/cjs/api/types/OrgPublicData1.d.ts +1 -1
- package/dist/cjs/api/types/UserPublicData1.d.ts +1 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/drivers/client/Client.d.mts +10 -10
- package/dist/esm/api/resources/drivers/client/Client.mjs +10 -10
- package/dist/esm/api/resources/offChrtShipperOrg/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/offChrtShipperOrg/client/Client.mjs +5 -5
- package/dist/esm/api/resources/orderDrafts/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/orderDrafts/client/Client.mjs +6 -6
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/orderDrafts/resources/cargo/client/Client.mjs +4 -4
- package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/orderDrafts/resources/task/client/Client.mjs +3 -3
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/orderDrafts/resources/taskArtifact/client/Client.mjs +2 -2
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +2 -2
- package/dist/esm/api/resources/orders/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orders/client/Client.mjs +1 -1
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/orders/resources/expanded/client/Client.mjs +2 -2
- package/dist/esm/api/resources/orders/resources/expandedList/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/orders/resources/expandedList/client/Client.mjs +2 -2
- package/dist/esm/api/resources/orgs/client/Client.d.mts +10 -0
- package/dist/esm/api/resources/orgs/client/Client.mjs +53 -2
- package/dist/esm/api/resources/shipperContactInfo/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/shipperContactInfo/client/Client.mjs +9 -9
- package/dist/esm/api/resources/taskArtifacts/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/taskArtifacts/client/Client.mjs +3 -3
- package/dist/esm/api/resources/taskArtifacts/resources/blurhash/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/blurhash/client/Client.mjs +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/images/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/taskArtifacts/resources/images/client/Client.mjs +3 -3
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +3 -3
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/taskGroups/resources/expanded/client/Client.mjs +3 -3
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/taskGroups/resources/expandedList/client/Client.mjs +2 -2
- package/dist/esm/api/resources/users/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/users/client/Client.mjs +5 -5
- package/dist/esm/api/types/OrgPublicData1.d.mts +1 -1
- package/dist/esm/api/types/UserPublicData1.d.mts +1 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +119 -64
|
@@ -56,7 +56,7 @@ class Drivers {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Lists all organization members paired with their driver information if they are drivers.
|
|
59
|
+
* Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
|
|
60
60
|
*
|
|
61
61
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
62
62
|
*
|
|
@@ -107,7 +107,7 @@ class Drivers {
|
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* Lists all drivers belonging to the authenticated organization.
|
|
110
|
+
* Lists all drivers belonging to the authenticated organization. | () -> (list[Driver1])
|
|
111
111
|
*
|
|
112
112
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
113
|
*
|
|
@@ -158,7 +158,7 @@ class Drivers {
|
|
|
158
158
|
});
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
* Creates a new driver profile for an organization member with optional vehicle type assignments.
|
|
161
|
+
* Creates a new driver profile for an organization member with optional vehicle type assignments. | (DriverCreateReq) -> (PydanticObjectId)
|
|
162
162
|
*
|
|
163
163
|
* @param {Chrt.DriverCreateReq} request
|
|
164
164
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -225,7 +225,7 @@ class Drivers {
|
|
|
225
225
|
});
|
|
226
226
|
}
|
|
227
227
|
/**
|
|
228
|
-
* Retrieves driver information for the authenticated user within their organization.
|
|
228
|
+
* Retrieves driver information for the authenticated user within their organization. | () -> (Driver1)
|
|
229
229
|
*
|
|
230
230
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
231
231
|
*
|
|
@@ -276,7 +276,7 @@ class Drivers {
|
|
|
276
276
|
});
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* Retrieves detailed driver information by driver ID within the organization.
|
|
279
|
+
* Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
|
|
280
280
|
*
|
|
281
281
|
* @param {string} driverId
|
|
282
282
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -335,7 +335,7 @@ class Drivers {
|
|
|
335
335
|
});
|
|
336
336
|
}
|
|
337
337
|
/**
|
|
338
|
-
* Deletes a driver from the organization and removes them from associated rate sheets.
|
|
338
|
+
* Deletes a driver from the organization and removes them from associated rate sheets. | () -> (bool)
|
|
339
339
|
*
|
|
340
340
|
* @param {string} driverId
|
|
341
341
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -394,7 +394,7 @@ class Drivers {
|
|
|
394
394
|
});
|
|
395
395
|
}
|
|
396
396
|
/**
|
|
397
|
-
* Sets the activation status of a driver (active/inactive) within the organization.
|
|
397
|
+
* Sets the activation status of a driver (active/inactive) within the organization. | (SetDriverActivationReq) -> (bool)
|
|
398
398
|
*
|
|
399
399
|
* @param {Chrt.SetDriverActivationReq} request
|
|
400
400
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -459,7 +459,7 @@ class Drivers {
|
|
|
459
459
|
});
|
|
460
460
|
}
|
|
461
461
|
/**
|
|
462
|
-
* Updates the driver's last known location and timestamp for tracking purposes.
|
|
462
|
+
* Updates the driver's last known location and timestamp for tracking purposes. | (DriverLastSeenReq) -> (bool)
|
|
463
463
|
*
|
|
464
464
|
* @param {Chrt.DriverLastSeenReq} request
|
|
465
465
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -532,7 +532,7 @@ class Drivers {
|
|
|
532
532
|
});
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
535
|
-
* Clears the driver's last known location and timestamp.
|
|
535
|
+
* Clears the driver's last known location and timestamp. | () -> (bool)
|
|
536
536
|
*
|
|
537
537
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
538
538
|
*
|
|
@@ -583,7 +583,7 @@ class Drivers {
|
|
|
583
583
|
});
|
|
584
584
|
}
|
|
585
585
|
/**
|
|
586
|
-
* Updates driver contact details and vehicle type assignments within the organization.
|
|
586
|
+
* Updates driver contact details and vehicle type assignments within the organization. | (UpdateDriverDetailsReq) -> (bool)
|
|
587
587
|
*
|
|
588
588
|
* @param {Chrt.UpdateDriverDetailsReq} request
|
|
589
589
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class OffChrtShipperOrg {
|
|
|
31
31
|
protected readonly _options: OffChrtShipperOrg.Options;
|
|
32
32
|
constructor(_options?: OffChrtShipperOrg.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Creates an off-platform shipper organization record.
|
|
34
|
+
* Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.OffChrtShipperOrgClientCreate1} request
|
|
37
37
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class OffChrtShipperOrg {
|
|
|
47
47
|
createV1(request: Chrt.OffChrtShipperOrgClientCreate1, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
48
|
private __createV1;
|
|
49
49
|
/**
|
|
50
|
-
* Lists all off-platform shipper organizations created by the authenticated organization.
|
|
50
|
+
* Lists all off-platform shipper organizations created by the authenticated organization. | () -> (list[OffChrtShipperOrg1])
|
|
51
51
|
*
|
|
52
52
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
53
53
|
*
|
|
@@ -57,7 +57,7 @@ export declare class OffChrtShipperOrg {
|
|
|
57
57
|
listV1(requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<Chrt.OffChrtShipperOrg1[]>;
|
|
58
58
|
private __listV1;
|
|
59
59
|
/**
|
|
60
|
-
* Retrieves specific off-platform shipper organization by ID.
|
|
60
|
+
* Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)
|
|
61
61
|
*
|
|
62
62
|
* @param {string} id
|
|
63
63
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -70,7 +70,7 @@ export declare class OffChrtShipperOrg {
|
|
|
70
70
|
getByIdV1(id: string, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<Chrt.OffChrtShipperOrg1>;
|
|
71
71
|
private __getByIdV1;
|
|
72
72
|
/**
|
|
73
|
-
* Deletes off-platform shipper organization owned by the authenticated organization.
|
|
73
|
+
* Deletes off-platform shipper organization owned by the authenticated organization. | () -> (bool)
|
|
74
74
|
*
|
|
75
75
|
* @param {string} id
|
|
76
76
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -83,7 +83,7 @@ export declare class OffChrtShipperOrg {
|
|
|
83
83
|
deleteByIdV1(id: string, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
84
84
|
private __deleteByIdV1;
|
|
85
85
|
/**
|
|
86
|
-
* Updates existing off-platform shipper organization owned by the authenticated organization.
|
|
86
|
+
* Updates existing off-platform shipper organization owned by the authenticated organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
|
|
87
87
|
*
|
|
88
88
|
* @param {string} id
|
|
89
89
|
* @param {Chrt.OffChrtShipperOrgClientUpdate1} request
|
|
@@ -56,7 +56,7 @@ class OffChrtShipperOrg {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Creates an off-platform shipper organization record.
|
|
59
|
+
* Creates an off-platform shipper organization record. | (OffChrtShipperOrgClientCreate1) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.OffChrtShipperOrgClientCreate1} request
|
|
62
62
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -121,7 +121,7 @@ class OffChrtShipperOrg {
|
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* Lists all off-platform shipper organizations created by the authenticated organization.
|
|
124
|
+
* Lists all off-platform shipper organizations created by the authenticated organization. | () -> (list[OffChrtShipperOrg1])
|
|
125
125
|
*
|
|
126
126
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
127
127
|
*
|
|
@@ -172,7 +172,7 @@ class OffChrtShipperOrg {
|
|
|
172
172
|
});
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
|
-
* Retrieves specific off-platform shipper organization by ID.
|
|
175
|
+
* Retrieves specific off-platform shipper organization by ID. | () -> (OffChrtShipperOrg1)
|
|
176
176
|
*
|
|
177
177
|
* @param {string} id
|
|
178
178
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -231,7 +231,7 @@ class OffChrtShipperOrg {
|
|
|
231
231
|
});
|
|
232
232
|
}
|
|
233
233
|
/**
|
|
234
|
-
* Deletes off-platform shipper organization owned by the authenticated organization.
|
|
234
|
+
* Deletes off-platform shipper organization owned by the authenticated organization. | () -> (bool)
|
|
235
235
|
*
|
|
236
236
|
* @param {string} id
|
|
237
237
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -290,7 +290,7 @@ class OffChrtShipperOrg {
|
|
|
290
290
|
});
|
|
291
291
|
}
|
|
292
292
|
/**
|
|
293
|
-
* Updates existing off-platform shipper organization owned by the authenticated organization.
|
|
293
|
+
* Updates existing off-platform shipper organization owned by the authenticated organization. | (OffChrtShipperOrgClientUpdate1) -> (bool)
|
|
294
294
|
*
|
|
295
295
|
* @param {string} id
|
|
296
296
|
* @param {Chrt.OffChrtShipperOrgClientUpdate1} request
|
|
@@ -43,7 +43,7 @@ export declare class OrderDrafts {
|
|
|
43
43
|
get taskArtifact(): TaskArtifact;
|
|
44
44
|
get cargo(): Cargo;
|
|
45
45
|
/**
|
|
46
|
-
* Creates a new draft order with org assignments based on caller's organization type.
|
|
46
|
+
* Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
47
47
|
*
|
|
48
48
|
* @param {Chrt.OrdersNewDraftReq} request
|
|
49
49
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ export declare class OrderDrafts {
|
|
|
56
56
|
newV1(request?: Chrt.OrdersNewDraftReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersNewDraftRes>;
|
|
57
57
|
private __newV1;
|
|
58
58
|
/**
|
|
59
|
-
* Updates forwarder and/or shipper org assignments for a draft order
|
|
59
|
+
* Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.OrdersDraftUpdateReq} request
|
|
62
62
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -71,7 +71,7 @@ export declare class OrderDrafts {
|
|
|
71
71
|
updateV1(request: Chrt.OrdersDraftUpdateReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftUpdateRes>;
|
|
72
72
|
private __updateV1;
|
|
73
73
|
/**
|
|
74
|
-
* Deletes a draft order and all associated entities
|
|
74
|
+
* Deletes a draft order and all associated entities. | () -> (bool)
|
|
75
75
|
*
|
|
76
76
|
* @param {string} orderId
|
|
77
77
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -84,7 +84,7 @@ export declare class OrderDrafts {
|
|
|
84
84
|
deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
85
85
|
private __deleteV1;
|
|
86
86
|
/**
|
|
87
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
|
|
87
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
|
|
88
88
|
*
|
|
89
89
|
* @param {string} orderIdOrShortId
|
|
90
90
|
* @param {Chrt.OrderDraftExpandedReq} request
|
|
@@ -98,7 +98,7 @@ export declare class OrderDrafts {
|
|
|
98
98
|
expandedV1(orderIdOrShortId: string, request?: Chrt.OrderDraftExpandedReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedRes>;
|
|
99
99
|
private __expandedV1;
|
|
100
100
|
/**
|
|
101
|
-
* Lists all draft orders created by the authenticated user with optional expanded related data.
|
|
101
|
+
* Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
|
|
102
102
|
*
|
|
103
103
|
* @param {Chrt.OrderDraftExpandedListReq} request
|
|
104
104
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -111,7 +111,7 @@ export declare class OrderDrafts {
|
|
|
111
111
|
expandedListV1(request?: Chrt.OrderDraftExpandedListReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpandedListRes>;
|
|
112
112
|
private __expandedListV1;
|
|
113
113
|
/**
|
|
114
|
-
* Checks whether the draft order satisfies all requirements to move into staging.
|
|
114
|
+
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
115
115
|
*
|
|
116
116
|
* @param {string} orderId
|
|
117
117
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -76,7 +76,7 @@ class OrderDrafts {
|
|
|
76
76
|
return ((_a = this._cargo) !== null && _a !== void 0 ? _a : (this._cargo = new Client_js_4.Cargo(this._options)));
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
-
* Creates a new draft order with org assignments based on caller's organization type.
|
|
79
|
+
* Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
80
80
|
*
|
|
81
81
|
* @param {Chrt.OrdersNewDraftReq} request
|
|
82
82
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -138,7 +138,7 @@ class OrderDrafts {
|
|
|
138
138
|
});
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
141
|
-
* Updates forwarder and/or shipper org assignments for a draft order
|
|
141
|
+
* Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
142
142
|
*
|
|
143
143
|
* @param {Chrt.OrdersDraftUpdateReq} request
|
|
144
144
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -202,7 +202,7 @@ class OrderDrafts {
|
|
|
202
202
|
});
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
|
-
* Deletes a draft order and all associated entities
|
|
205
|
+
* Deletes a draft order and all associated entities. | () -> (bool)
|
|
206
206
|
*
|
|
207
207
|
* @param {string} orderId
|
|
208
208
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -261,7 +261,7 @@ class OrderDrafts {
|
|
|
261
261
|
});
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
|
-
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it.
|
|
264
|
+
* Fetches a single draft order with optional expanded related data. Only the creator of the draft order can access it. | (OrderDraftExpandedReq) -> (OrderDraftExpandedRes)
|
|
265
265
|
*
|
|
266
266
|
* @param {string} orderIdOrShortId
|
|
267
267
|
* @param {Chrt.OrderDraftExpandedReq} request
|
|
@@ -324,7 +324,7 @@ class OrderDrafts {
|
|
|
324
324
|
});
|
|
325
325
|
}
|
|
326
326
|
/**
|
|
327
|
-
* Lists all draft orders created by the authenticated user with optional expanded related data.
|
|
327
|
+
* Lists all draft orders created by the authenticated user with optional expanded related data. | (OrderDraftExpandedListReq) -> (OrderDraftExpandedListRes)
|
|
328
328
|
*
|
|
329
329
|
* @param {Chrt.OrderDraftExpandedListReq} request
|
|
330
330
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -386,7 +386,7 @@ class OrderDrafts {
|
|
|
386
386
|
});
|
|
387
387
|
}
|
|
388
388
|
/**
|
|
389
|
-
* Checks whether the draft order satisfies all requirements to move into staging.
|
|
389
|
+
* Checks whether the draft order satisfies all requirements to move into staging. | () -> (bool)
|
|
390
390
|
*
|
|
391
391
|
* @param {string} orderId
|
|
392
392
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class Cargo {
|
|
|
31
31
|
protected readonly _options: Cargo.Options;
|
|
32
32
|
constructor(_options?: Cargo.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
34
|
+
* Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orderDrafts.OrderDraftAddCargoReq} request
|
|
37
37
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -50,7 +50,7 @@ export declare class Cargo {
|
|
|
50
50
|
addV1(request: Chrt.orderDrafts.OrderDraftAddCargoReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<string>;
|
|
51
51
|
private __addV1;
|
|
52
52
|
/**
|
|
53
|
-
* Associates existing cargo with a task in a draft order.
|
|
53
|
+
* Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
|
|
54
54
|
*
|
|
55
55
|
* @param {Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq} request
|
|
56
56
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -67,7 +67,7 @@ export declare class Cargo {
|
|
|
67
67
|
associateWithTaskV1(request: Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
68
68
|
private __associateWithTaskV1;
|
|
69
69
|
/**
|
|
70
|
-
* Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
70
|
+
* Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
|
|
71
71
|
*
|
|
72
72
|
* @param {Chrt.orderDrafts.OrderDraftUpdateCargoReq} request
|
|
73
73
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -83,7 +83,7 @@ export declare class Cargo {
|
|
|
83
83
|
updateV1(request: Chrt.orderDrafts.OrderDraftUpdateCargoReq, requestOptions?: Cargo.RequestOptions): core.HttpResponsePromise<string>;
|
|
84
84
|
private __updateV1;
|
|
85
85
|
/**
|
|
86
|
-
* Deletes a cargo item from a draft order and removes references from associated tasks
|
|
86
|
+
* Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
|
|
87
87
|
*
|
|
88
88
|
* @param {string} cargoId
|
|
89
89
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class Cargo {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
59
|
+
* Adds a cargo item to an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddCargoReq) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.orderDrafts.OrderDraftAddCargoReq} request
|
|
62
62
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -124,7 +124,7 @@ class Cargo {
|
|
|
124
124
|
});
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
|
-
* Associates existing cargo with a task in a draft order.
|
|
127
|
+
* Associates existing cargo with a task in a draft order. | (OrderDraftAssociateCargoWithTaskReq) -> (bool)
|
|
128
128
|
*
|
|
129
129
|
* @param {Chrt.orderDrafts.OrderDraftAssociateCargoWithTaskReq} request
|
|
130
130
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -190,7 +190,7 @@ class Cargo {
|
|
|
190
190
|
});
|
|
191
191
|
}
|
|
192
192
|
/**
|
|
193
|
-
* Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller.
|
|
193
|
+
* Updates a cargo item in an existing draft order. Validates order is in DRAFT status and owned by caller. | (OrderDraftUpdateCargoReq) -> (PydanticObjectId)
|
|
194
194
|
*
|
|
195
195
|
* @param {Chrt.orderDrafts.OrderDraftUpdateCargoReq} request
|
|
196
196
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -255,7 +255,7 @@ class Cargo {
|
|
|
255
255
|
});
|
|
256
256
|
}
|
|
257
257
|
/**
|
|
258
|
-
* Deletes a cargo item from a draft order and removes references from associated tasks
|
|
258
|
+
* Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
|
|
259
259
|
*
|
|
260
260
|
* @param {string} cargoId
|
|
261
261
|
* @param {Cargo.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class Task {
|
|
|
31
31
|
protected readonly _options: Task.Options;
|
|
32
32
|
constructor(_options?: Task.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type.
|
|
34
|
+
* Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type. | (OrderDraftAddTaskReqV1) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskReqV1} request
|
|
37
37
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -49,7 +49,7 @@ export declare class Task {
|
|
|
49
49
|
addV1(request: Chrt.orderDrafts.OrderDraftAddTaskReqV1, requestOptions?: Task.RequestOptions): core.HttpResponsePromise<string>;
|
|
50
50
|
private __addV1;
|
|
51
51
|
/**
|
|
52
|
-
* Updates a task in an existing draft order
|
|
52
|
+
* Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
|
|
53
53
|
*
|
|
54
54
|
* @param {Chrt.orderDrafts.OrderDraftUpdateTaskReq} request
|
|
55
55
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -65,7 +65,7 @@ export declare class Task {
|
|
|
65
65
|
updateV1(request: Chrt.orderDrafts.OrderDraftUpdateTaskReq, requestOptions?: Task.RequestOptions): core.HttpResponsePromise<string>;
|
|
66
66
|
private __updateV1;
|
|
67
67
|
/**
|
|
68
|
-
* Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group.
|
|
68
|
+
* Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
|
|
69
69
|
*
|
|
70
70
|
* @param {string} taskId
|
|
71
71
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class Task {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type.
|
|
59
|
+
* Adds a task to an existing task group in a draft order. Validates order is in DRAFT status and task action type matches task group type. | (OrderDraftAddTaskReqV1) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskReqV1} request
|
|
62
62
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -123,7 +123,7 @@ class Task {
|
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* Updates a task in an existing draft order
|
|
126
|
+
* Updates a task in an existing draft order. | (OrderDraftUpdateTaskReq) -> (PydanticObjectId)
|
|
127
127
|
*
|
|
128
128
|
* @param {Chrt.orderDrafts.OrderDraftUpdateTaskReq} request
|
|
129
129
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -188,7 +188,7 @@ class Task {
|
|
|
188
188
|
});
|
|
189
189
|
}
|
|
190
190
|
/**
|
|
191
|
-
* Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group.
|
|
191
|
+
* Deletes a task from a draft order, including all task artifacts. Cargo is preserved. Task is removed from task group. | () -> (bool)
|
|
192
192
|
*
|
|
193
193
|
* @param {string} taskId
|
|
194
194
|
* @param {Task.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class TaskArtifact {
|
|
|
31
31
|
protected readonly _options: TaskArtifact.Options;
|
|
32
32
|
constructor(_options?: TaskArtifact.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Adds a task artifact to an existing task in a draft order.
|
|
34
|
+
* Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskArtifactReq) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskArtifactReq} request
|
|
37
37
|
* @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class TaskArtifact {
|
|
|
47
47
|
addV1(request: Chrt.orderDrafts.OrderDraftAddTaskArtifactReq, requestOptions?: TaskArtifact.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
48
|
private __addV1;
|
|
49
49
|
/**
|
|
50
|
-
* Deletes a task artifact from a draft order and removes it from the associated task.
|
|
50
|
+
* Deletes a task artifact from a draft order and removes it from the associated task. | () -> (bool)
|
|
51
51
|
*
|
|
52
52
|
* @param {string} taskArtifactId
|
|
53
53
|
* @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class TaskArtifact {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Adds a task artifact to an existing task in a draft order.
|
|
59
|
+
* Adds a task artifact to an existing task in a draft order. | (OrderDraftAddTaskArtifactReq) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskArtifactReq} request
|
|
62
62
|
* @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -121,7 +121,7 @@ class TaskArtifact {
|
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* Deletes a task artifact from a draft order and removes it from the associated task.
|
|
124
|
+
* Deletes a task artifact from a draft order and removes it from the associated task. | () -> (bool)
|
|
125
125
|
*
|
|
126
126
|
* @param {string} taskArtifactId
|
|
127
127
|
* @param {TaskArtifact.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class TaskGroup {
|
|
|
31
31
|
protected readonly _options: TaskGroup.Options;
|
|
32
32
|
constructor(_options?: TaskGroup.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller.
|
|
34
|
+
* Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskGroupReq} request
|
|
37
37
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -47,7 +47,7 @@ export declare class TaskGroup {
|
|
|
47
47
|
addV1(request: Chrt.orderDrafts.OrderDraftAddTaskGroupReq, requestOptions?: TaskGroup.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
48
|
private __addV1;
|
|
49
49
|
/**
|
|
50
|
-
* Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order.
|
|
50
|
+
* Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
|
|
51
51
|
*
|
|
52
52
|
* @param {string} taskGroupId
|
|
53
53
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class TaskGroup {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller.
|
|
59
|
+
* Adds a task group to an existing order draft. Validates order is in DRAFT status and owned by caller. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.orderDrafts.OrderDraftAddTaskGroupReq} request
|
|
62
62
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -121,7 +121,7 @@ class TaskGroup {
|
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order.
|
|
124
|
+
* Deletes a task group and all associated entities (tasks, task artifacts, S3 metadata). The task group must belong to a DRAFT order. | () -> (bool)
|
|
125
125
|
*
|
|
126
126
|
* @param {string} taskGroupId
|
|
127
127
|
* @param {TaskGroup.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -36,7 +36,7 @@ export declare class Orders {
|
|
|
36
36
|
get expanded(): Expanded;
|
|
37
37
|
get expandedList(): ExpandedList;
|
|
38
38
|
/**
|
|
39
|
-
* Validates a draft order and stages all related entities in a transaction.
|
|
39
|
+
* Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
40
40
|
*
|
|
41
41
|
* @param {string} orderId
|
|
42
42
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -66,7 +66,7 @@ class Orders {
|
|
|
66
66
|
return ((_a = this._expandedList) !== null && _a !== void 0 ? _a : (this._expandedList = new Client_js_2.ExpandedList(this._options)));
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
|
-
* Validates a draft order and stages all related entities in a transaction.
|
|
69
|
+
* Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
70
70
|
*
|
|
71
71
|
* @param {string} orderId
|
|
72
72
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -31,7 +31,7 @@ export declare class Expanded {
|
|
|
31
31
|
protected readonly _options: Expanded.Options;
|
|
32
32
|
constructor(_options?: Expanded.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Fetches a single order for the shipper organization with optional expanded related data.
|
|
34
|
+
* Fetches a single order for the shipper organization with optional expanded related data. | (OrderExpandedForShipperReq) -> (OrderExpandedForShipper)
|
|
35
35
|
*
|
|
36
36
|
* @param {string} orderIdOrShortId
|
|
37
37
|
* @param {Chrt.OrderExpandedForShipperReq} request
|
|
@@ -45,7 +45,7 @@ export declare class Expanded {
|
|
|
45
45
|
postForShipperByOrderIdV1(orderIdOrShortId: string, request: Chrt.OrderExpandedForShipperReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpandedForShipper>;
|
|
46
46
|
private __postForShipperByOrderIdV1;
|
|
47
47
|
/**
|
|
48
|
-
* Fetches a single order for the organization that created it with optional expanded related data.
|
|
48
|
+
* Fetches a single order for the organization that created it with optional expanded related data. | (OrderExpandedForOrderCreatorReq) -> (OrderExpandedForOrderCreator)
|
|
49
49
|
*
|
|
50
50
|
* @param {string} orderIdOrShortId
|
|
51
51
|
* @param {Chrt.OrderExpandedForOrderCreatorReq} request
|
|
@@ -56,7 +56,7 @@ class Expanded {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Fetches a single order for the shipper organization with optional expanded related data.
|
|
59
|
+
* Fetches a single order for the shipper organization with optional expanded related data. | (OrderExpandedForShipperReq) -> (OrderExpandedForShipper)
|
|
60
60
|
*
|
|
61
61
|
* @param {string} orderIdOrShortId
|
|
62
62
|
* @param {Chrt.OrderExpandedForShipperReq} request
|
|
@@ -119,7 +119,7 @@ class Expanded {
|
|
|
119
119
|
});
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Fetches a single order for the organization that created it with optional expanded related data.
|
|
122
|
+
* Fetches a single order for the organization that created it with optional expanded related data. | (OrderExpandedForOrderCreatorReq) -> (OrderExpandedForOrderCreator)
|
|
123
123
|
*
|
|
124
124
|
* @param {string} orderIdOrShortId
|
|
125
125
|
* @param {Chrt.OrderExpandedForOrderCreatorReq} request
|
|
@@ -31,7 +31,7 @@ export declare class ExpandedList {
|
|
|
31
31
|
protected readonly _options: ExpandedList.Options;
|
|
32
32
|
constructor(_options?: ExpandedList.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves orders expanded list for the shipper organization with optional filters and related data.
|
|
34
|
+
* Retrieves orders expanded list for the shipper organization with optional filters and related data. | (OrderExpandedForShipperReq) -> (OrdersExpandedForShipperRes)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orders.ExpandedListPostShipperExpandedListV1Request} request
|
|
37
37
|
* @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -53,7 +53,7 @@ export declare class ExpandedList {
|
|
|
53
53
|
postShipperExpandedListV1(request: Chrt.orders.ExpandedListPostShipperExpandedListV1Request, requestOptions?: ExpandedList.RequestOptions): core.HttpResponsePromise<Chrt.OrdersExpandedForShipperRes>;
|
|
54
54
|
private __postShipperExpandedListV1;
|
|
55
55
|
/**
|
|
56
|
-
* Retrieves orders expanded list for order creator org with optional filters, shipper includes, and exclusions.
|
|
56
|
+
* Retrieves orders expanded list for order creator org with optional filters, shipper includes, and exclusions. | (OrderExpandedForOrderCreatorReq) -> (OrdersExpandedForOrderCreatorRes)
|
|
57
57
|
*
|
|
58
58
|
* @param {Chrt.orders.ExpandedListPostOrderCreatorExpandedListV1Request} request
|
|
59
59
|
* @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,7 +56,7 @@ class ExpandedList {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Retrieves orders expanded list for the shipper organization with optional filters and related data.
|
|
59
|
+
* Retrieves orders expanded list for the shipper organization with optional filters and related data. | (OrderExpandedForShipperReq) -> (OrdersExpandedForShipperRes)
|
|
60
60
|
*
|
|
61
61
|
* @param {Chrt.orders.ExpandedListPostShipperExpandedListV1Request} request
|
|
62
62
|
* @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -158,7 +158,7 @@ class ExpandedList {
|
|
|
158
158
|
});
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
* Retrieves orders expanded list for order creator org with optional filters, shipper includes, and exclusions.
|
|
161
|
+
* Retrieves orders expanded list for order creator org with optional filters, shipper includes, and exclusions. | (OrderExpandedForOrderCreatorReq) -> (OrdersExpandedForOrderCreatorRes)
|
|
162
162
|
*
|
|
163
163
|
* @param {Chrt.orders.ExpandedListPostOrderCreatorExpandedListV1Request} request
|
|
164
164
|
* @param {ExpandedList.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -114,5 +114,15 @@ export declare class Orgs {
|
|
|
114
114
|
*/
|
|
115
115
|
getOrgPublicDataHandleAvailabilityV1(handle: string, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
116
116
|
private __getOrgPublicDataHandleAvailabilityV1;
|
|
117
|
+
/**
|
|
118
|
+
* Retrieves the Stripe Connect account ID for the authenticated organization. Returns 404 if not set. | () -> (str)
|
|
119
|
+
*
|
|
120
|
+
* @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
|
|
121
|
+
*
|
|
122
|
+
* @example
|
|
123
|
+
* await client.orgs.getStripeConnectAccountIdV1()
|
|
124
|
+
*/
|
|
125
|
+
getStripeConnectAccountIdV1(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<string>;
|
|
126
|
+
private __getStripeConnectAccountIdV1;
|
|
117
127
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
118
128
|
}
|