@chrt-inc/typescript-sdk 1.746.0 → 1.749.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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +25 -41
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +51 -125
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +2 -4
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.d.ts +64 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.js +196 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.d.ts +4 -6
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.js +6 -1
- package/dist/cjs/api/types/Cargo1.d.ts +1 -3
- package/dist/cjs/api/types/CargoManifest1.d.ts +6 -0
- package/dist/cjs/api/types/OrderManifest1.d.ts +2 -2
- package/dist/cjs/api/types/OrderSchedule1.d.ts +5 -7
- package/dist/cjs/api/types/OrderScheduleAboutRes.d.ts +0 -1
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatus.d.ts +0 -1
- package/dist/cjs/api/types/OrderScheduleSortByEnum.d.ts +2 -2
- package/dist/cjs/api/types/OrderScheduleSortByEnum.js +1 -1
- package/dist/cjs/api/types/OrderScheduleSpec1.d.ts +11 -0
- package/dist/cjs/api/types/OrderScheduleSpec1.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +2 -4
- package/dist/cjs/api/types/TaskArtifact1.d.ts +1 -3
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -3
- package/dist/cjs/api/types/TaskGroupManifest1.d.ts +1 -1
- package/dist/cjs/api/types/TaskManifest1.d.ts +13 -4
- package/dist/cjs/api/types/index.d.ts +1 -1
- package/dist/cjs/api/types/index.js +1 -1
- 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/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +25 -41
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +49 -123
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +2 -4
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.d.mts +64 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.mjs +159 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.d.mts +4 -6
- package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.mjs +2 -0
- package/dist/esm/api/types/Cargo1.d.mts +1 -3
- package/dist/esm/api/types/CargoManifest1.d.mts +6 -0
- package/dist/esm/api/types/OrderManifest1.d.mts +2 -2
- package/dist/esm/api/types/OrderSchedule1.d.mts +5 -7
- package/dist/esm/api/types/OrderScheduleAboutRes.d.mts +0 -1
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatus.d.mts +0 -1
- package/dist/esm/api/types/OrderScheduleSortByEnum.d.mts +2 -2
- package/dist/esm/api/types/OrderScheduleSortByEnum.mjs +1 -1
- package/dist/esm/api/types/OrderScheduleSpec1.d.mts +11 -0
- package/dist/esm/api/types/OrderScheduleSpec1.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +2 -4
- package/dist/esm/api/types/TaskArtifact1.d.mts +1 -3
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -3
- package/dist/esm/api/types/TaskGroupManifest1.d.mts +1 -1
- package/dist/esm/api/types/TaskManifest1.d.mts +13 -4
- package/dist/esm/api/types/index.d.mts +1 -1
- package/dist/esm/api/types/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +156 -93
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.ts +0 -10
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.js +0 -12
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.mts +0 -10
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.mjs +0 -9
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.js +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.js +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.mjs +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.mjs +0 -0
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
import * as environments from "../../../../../../environments.mjs";
|
|
5
5
|
import * as core from "../../../../../../core/index.mjs";
|
|
6
6
|
import * as Chrt from "../../../../../index.mjs";
|
|
7
|
+
import { Draft } from "../resources/draft/client/Client.mjs";
|
|
7
8
|
import { OrderManifest } from "../resources/orderManifest/client/Client.mjs";
|
|
8
9
|
export declare namespace OrderSchedules {
|
|
9
10
|
interface Options {
|
|
@@ -30,8 +31,10 @@ export declare namespace OrderSchedules {
|
|
|
30
31
|
}
|
|
31
32
|
export declare class OrderSchedules {
|
|
32
33
|
protected readonly _options: OrderSchedules.Options;
|
|
34
|
+
protected _draft: Draft | undefined;
|
|
33
35
|
protected _orderManifest: OrderManifest | undefined;
|
|
34
36
|
constructor(_options?: OrderSchedules.Options);
|
|
37
|
+
get draft(): Draft;
|
|
35
38
|
get orderManifest(): OrderManifest;
|
|
36
39
|
/**
|
|
37
40
|
* Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
|
|
@@ -70,7 +73,7 @@ export declare class OrderSchedules {
|
|
|
70
73
|
getByIdV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderSchedule1>;
|
|
71
74
|
private __getByIdV1;
|
|
72
75
|
/**
|
|
73
|
-
* Retrieves
|
|
76
|
+
* Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
74
77
|
*
|
|
75
78
|
* @param {string} orderScheduleId
|
|
76
79
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -83,39 +86,20 @@ export declare class OrderSchedules {
|
|
|
83
86
|
aboutV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<Chrt.OrderScheduleAboutRes>;
|
|
84
87
|
private __aboutV1;
|
|
85
88
|
/**
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
* @param {Chrt.shipping.OrderScheduleClientCreate1} request
|
|
89
|
-
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
90
|
-
*
|
|
91
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
92
|
-
*
|
|
93
|
-
* @example
|
|
94
|
-
* await client.shipping.orderSchedules.newV1({
|
|
95
|
-
* schema_version: 1,
|
|
96
|
-
* name: "name",
|
|
97
|
-
* order_manifest: {},
|
|
98
|
-
* schedule_spec: {}
|
|
99
|
-
* })
|
|
100
|
-
*/
|
|
101
|
-
newV1(request: Chrt.shipping.OrderScheduleClientCreate1, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<string>;
|
|
102
|
-
private __newV1;
|
|
103
|
-
/**
|
|
104
|
-
* Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
89
|
+
* Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
105
90
|
*
|
|
106
91
|
* @param {string} orderScheduleId
|
|
107
|
-
* @param {Chrt.shipping.OrderScheduleClientUpdate1} request
|
|
108
92
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
109
93
|
*
|
|
110
94
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
111
95
|
*
|
|
112
96
|
* @example
|
|
113
|
-
* await client.shipping.orderSchedules.
|
|
97
|
+
* await client.shipping.orderSchedules.activateV1("order_schedule_id")
|
|
114
98
|
*/
|
|
115
|
-
|
|
116
|
-
private
|
|
99
|
+
activateV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
100
|
+
private __activateV1;
|
|
117
101
|
/**
|
|
118
|
-
*
|
|
102
|
+
* Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
119
103
|
*
|
|
120
104
|
* @param {string} orderScheduleId
|
|
121
105
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -123,12 +107,12 @@ export declare class OrderSchedules {
|
|
|
123
107
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
124
108
|
*
|
|
125
109
|
* @example
|
|
126
|
-
* await client.shipping.orderSchedules.
|
|
110
|
+
* await client.shipping.orderSchedules.triggerV1("order_schedule_id")
|
|
127
111
|
*/
|
|
128
|
-
|
|
129
|
-
private
|
|
112
|
+
triggerV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
113
|
+
private __triggerV1;
|
|
130
114
|
/**
|
|
131
|
-
*
|
|
115
|
+
* Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
132
116
|
*
|
|
133
117
|
* @param {string} orderScheduleId
|
|
134
118
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -136,10 +120,10 @@ export declare class OrderSchedules {
|
|
|
136
120
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
137
121
|
*
|
|
138
122
|
* @example
|
|
139
|
-
* await client.shipping.orderSchedules.
|
|
123
|
+
* await client.shipping.orderSchedules.pauseV1("order_schedule_id")
|
|
140
124
|
*/
|
|
141
|
-
|
|
142
|
-
private
|
|
125
|
+
pauseV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
126
|
+
private __pauseV1;
|
|
143
127
|
/**
|
|
144
128
|
* Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
145
129
|
*
|
|
@@ -154,7 +138,7 @@ export declare class OrderSchedules {
|
|
|
154
138
|
unpauseV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
155
139
|
private __unpauseV1;
|
|
156
140
|
/**
|
|
157
|
-
*
|
|
141
|
+
* Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
158
142
|
*
|
|
159
143
|
* @param {string} orderScheduleId
|
|
160
144
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -162,12 +146,12 @@ export declare class OrderSchedules {
|
|
|
162
146
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
163
147
|
*
|
|
164
148
|
* @example
|
|
165
|
-
* await client.shipping.orderSchedules.
|
|
149
|
+
* await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
|
|
166
150
|
*/
|
|
167
|
-
|
|
168
|
-
private
|
|
151
|
+
takeOwnershipV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
152
|
+
private __takeOwnershipV1;
|
|
169
153
|
/**
|
|
170
|
-
* Archives an order schedule and
|
|
154
|
+
* Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
|
|
171
155
|
*
|
|
172
156
|
* @param {string} orderScheduleId
|
|
173
157
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -180,7 +164,7 @@ export declare class OrderSchedules {
|
|
|
180
164
|
archiveV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
181
165
|
private __archiveV1;
|
|
182
166
|
/**
|
|
183
|
-
*
|
|
167
|
+
* Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
|
|
184
168
|
*
|
|
185
169
|
* @param {string} orderScheduleId
|
|
186
170
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -188,9 +172,9 @@ export declare class OrderSchedules {
|
|
|
188
172
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
189
173
|
*
|
|
190
174
|
* @example
|
|
191
|
-
* await client.shipping.orderSchedules.
|
|
175
|
+
* await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
192
176
|
*/
|
|
193
|
-
|
|
194
|
-
private
|
|
177
|
+
syncWithOrchestratorV1(orderScheduleId: string, requestOptions?: OrderSchedules.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
178
|
+
private __syncWithOrchestratorV1;
|
|
195
179
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
196
180
|
}
|
|
@@ -15,11 +15,16 @@ import * as core from "../../../../../../core/index.mjs";
|
|
|
15
15
|
import * as Chrt from "../../../../../index.mjs";
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
|
+
import { Draft } from "../resources/draft/client/Client.mjs";
|
|
18
19
|
import { OrderManifest } from "../resources/orderManifest/client/Client.mjs";
|
|
19
20
|
export class OrderSchedules {
|
|
20
21
|
constructor(_options = {}) {
|
|
21
22
|
this._options = _options;
|
|
22
23
|
}
|
|
24
|
+
get draft() {
|
|
25
|
+
var _a;
|
|
26
|
+
return ((_a = this._draft) !== null && _a !== void 0 ? _a : (this._draft = new Draft(this._options)));
|
|
27
|
+
}
|
|
23
28
|
get orderManifest() {
|
|
24
29
|
var _a;
|
|
25
30
|
return ((_a = this._orderManifest) !== null && _a !== void 0 ? _a : (this._orderManifest = new OrderManifest(this._options)));
|
|
@@ -51,7 +56,7 @@ export class OrderSchedules {
|
|
|
51
56
|
__listV1() {
|
|
52
57
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
53
58
|
var _a, _b, _c, _d, _e, _f;
|
|
54
|
-
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize,
|
|
59
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_intended_status: filterIntendedStatus, filter_owned_by_user_id: filterOwnedByUserId, filter_created_at_timestamp_gte: filterCreatedAtTimestampGte, filter_created_at_timestamp_lte: filterCreatedAtTimestampLte, filter_last_edited_at_timestamp_gte: filterLastEditedAtTimestampGte, filter_last_edited_at_timestamp_lte: filterLastEditedAtTimestampLte, } = request;
|
|
55
60
|
const _queryParams = {};
|
|
56
61
|
if (sortBy !== undefined) {
|
|
57
62
|
_queryParams["sort_by"] = sortBy;
|
|
@@ -65,20 +70,12 @@ export class OrderSchedules {
|
|
|
65
70
|
if (pageSize !== undefined) {
|
|
66
71
|
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
67
72
|
}
|
|
68
|
-
if (
|
|
69
|
-
if (Array.isArray(
|
|
70
|
-
_queryParams["
|
|
71
|
-
}
|
|
72
|
-
else {
|
|
73
|
-
_queryParams["filter_status"] = filterStatus;
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
if (filterOrchestratorScheduleStatus !== undefined) {
|
|
77
|
-
if (Array.isArray(filterOrchestratorScheduleStatus)) {
|
|
78
|
-
_queryParams["filter_orchestrator_schedule_status"] = filterOrchestratorScheduleStatus.map((item) => item);
|
|
73
|
+
if (filterIntendedStatus !== undefined) {
|
|
74
|
+
if (Array.isArray(filterIntendedStatus)) {
|
|
75
|
+
_queryParams["filter_intended_status"] = filterIntendedStatus.map((item) => item);
|
|
79
76
|
}
|
|
80
77
|
else {
|
|
81
|
-
_queryParams["
|
|
78
|
+
_queryParams["filter_intended_status"] = filterIntendedStatus;
|
|
82
79
|
}
|
|
83
80
|
}
|
|
84
81
|
if (filterOwnedByUserId !== undefined) {
|
|
@@ -198,7 +195,7 @@ export class OrderSchedules {
|
|
|
198
195
|
});
|
|
199
196
|
}
|
|
200
197
|
/**
|
|
201
|
-
* Retrieves
|
|
198
|
+
* Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
202
199
|
*
|
|
203
200
|
* @param {string} orderScheduleId
|
|
204
201
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -257,99 +254,28 @@ export class OrderSchedules {
|
|
|
257
254
|
});
|
|
258
255
|
}
|
|
259
256
|
/**
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* @param {Chrt.shipping.OrderScheduleClientCreate1} request
|
|
263
|
-
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
264
|
-
*
|
|
265
|
-
* @throws {@link Chrt.UnprocessableEntityError}
|
|
266
|
-
*
|
|
267
|
-
* @example
|
|
268
|
-
* await client.shipping.orderSchedules.newV1({
|
|
269
|
-
* schema_version: 1,
|
|
270
|
-
* name: "name",
|
|
271
|
-
* order_manifest: {},
|
|
272
|
-
* schedule_spec: {}
|
|
273
|
-
* })
|
|
274
|
-
*/
|
|
275
|
-
newV1(request, requestOptions) {
|
|
276
|
-
return core.HttpResponsePromise.fromPromise(this.__newV1(request, requestOptions));
|
|
277
|
-
}
|
|
278
|
-
__newV1(request, requestOptions) {
|
|
279
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
280
|
-
var _a, _b, _c, _d;
|
|
281
|
-
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
282
|
-
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
283
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, "shipping/order_schedules/new/v1"),
|
|
284
|
-
method: "POST",
|
|
285
|
-
headers: _headers,
|
|
286
|
-
contentType: "application/json",
|
|
287
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
288
|
-
requestType: "json",
|
|
289
|
-
body: request,
|
|
290
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
291
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
292
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
293
|
-
});
|
|
294
|
-
if (_response.ok) {
|
|
295
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
296
|
-
}
|
|
297
|
-
if (_response.error.reason === "status-code") {
|
|
298
|
-
switch (_response.error.statusCode) {
|
|
299
|
-
case 422:
|
|
300
|
-
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
301
|
-
default:
|
|
302
|
-
throw new errors.ChrtError({
|
|
303
|
-
statusCode: _response.error.statusCode,
|
|
304
|
-
body: _response.error.body,
|
|
305
|
-
rawResponse: _response.rawResponse,
|
|
306
|
-
});
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
switch (_response.error.reason) {
|
|
310
|
-
case "non-json":
|
|
311
|
-
throw new errors.ChrtError({
|
|
312
|
-
statusCode: _response.error.statusCode,
|
|
313
|
-
body: _response.error.rawBody,
|
|
314
|
-
rawResponse: _response.rawResponse,
|
|
315
|
-
});
|
|
316
|
-
case "timeout":
|
|
317
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/new/v1.");
|
|
318
|
-
case "unknown":
|
|
319
|
-
throw new errors.ChrtError({
|
|
320
|
-
message: _response.error.errorMessage,
|
|
321
|
-
rawResponse: _response.rawResponse,
|
|
322
|
-
});
|
|
323
|
-
}
|
|
324
|
-
});
|
|
325
|
-
}
|
|
326
|
-
/**
|
|
327
|
-
* Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
257
|
+
* Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
328
258
|
*
|
|
329
259
|
* @param {string} orderScheduleId
|
|
330
|
-
* @param {Chrt.shipping.OrderScheduleClientUpdate1} request
|
|
331
260
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
332
261
|
*
|
|
333
262
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
334
263
|
*
|
|
335
264
|
* @example
|
|
336
|
-
* await client.shipping.orderSchedules.
|
|
265
|
+
* await client.shipping.orderSchedules.activateV1("order_schedule_id")
|
|
337
266
|
*/
|
|
338
|
-
|
|
339
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
267
|
+
activateV1(orderScheduleId, requestOptions) {
|
|
268
|
+
return core.HttpResponsePromise.fromPromise(this.__activateV1(orderScheduleId, requestOptions));
|
|
340
269
|
}
|
|
341
|
-
|
|
342
|
-
return __awaiter(this,
|
|
270
|
+
__activateV1(orderScheduleId, requestOptions) {
|
|
271
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
343
272
|
var _a, _b, _c, _d;
|
|
344
273
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
345
274
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
346
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/
|
|
275
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/activate/v1/${encodeURIComponent(orderScheduleId)}`),
|
|
347
276
|
method: "PATCH",
|
|
348
277
|
headers: _headers,
|
|
349
|
-
contentType: "application/json",
|
|
350
278
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
351
|
-
requestType: "json",
|
|
352
|
-
body: request,
|
|
353
279
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
354
280
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
355
281
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -377,7 +303,7 @@ export class OrderSchedules {
|
|
|
377
303
|
rawResponse: _response.rawResponse,
|
|
378
304
|
});
|
|
379
305
|
case "timeout":
|
|
380
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/
|
|
306
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/activate/v1/{order_schedule_id}.");
|
|
381
307
|
case "unknown":
|
|
382
308
|
throw new errors.ChrtError({
|
|
383
309
|
message: _response.error.errorMessage,
|
|
@@ -387,7 +313,7 @@ export class OrderSchedules {
|
|
|
387
313
|
});
|
|
388
314
|
}
|
|
389
315
|
/**
|
|
390
|
-
*
|
|
316
|
+
* Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
391
317
|
*
|
|
392
318
|
* @param {string} orderScheduleId
|
|
393
319
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -395,18 +321,18 @@ export class OrderSchedules {
|
|
|
395
321
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
396
322
|
*
|
|
397
323
|
* @example
|
|
398
|
-
* await client.shipping.orderSchedules.
|
|
324
|
+
* await client.shipping.orderSchedules.triggerV1("order_schedule_id")
|
|
399
325
|
*/
|
|
400
|
-
|
|
401
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
326
|
+
triggerV1(orderScheduleId, requestOptions) {
|
|
327
|
+
return core.HttpResponsePromise.fromPromise(this.__triggerV1(orderScheduleId, requestOptions));
|
|
402
328
|
}
|
|
403
|
-
|
|
329
|
+
__triggerV1(orderScheduleId, requestOptions) {
|
|
404
330
|
return __awaiter(this, void 0, void 0, function* () {
|
|
405
331
|
var _a, _b, _c, _d;
|
|
406
332
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
407
333
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
408
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/
|
|
409
|
-
method: "
|
|
334
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/trigger/v1/${encodeURIComponent(orderScheduleId)}`),
|
|
335
|
+
method: "POST",
|
|
410
336
|
headers: _headers,
|
|
411
337
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
412
338
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -436,7 +362,7 @@ export class OrderSchedules {
|
|
|
436
362
|
rawResponse: _response.rawResponse,
|
|
437
363
|
});
|
|
438
364
|
case "timeout":
|
|
439
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling
|
|
365
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/trigger/v1/{order_schedule_id}.");
|
|
440
366
|
case "unknown":
|
|
441
367
|
throw new errors.ChrtError({
|
|
442
368
|
message: _response.error.errorMessage,
|
|
@@ -446,7 +372,7 @@ export class OrderSchedules {
|
|
|
446
372
|
});
|
|
447
373
|
}
|
|
448
374
|
/**
|
|
449
|
-
*
|
|
375
|
+
* Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
450
376
|
*
|
|
451
377
|
* @param {string} orderScheduleId
|
|
452
378
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -454,17 +380,17 @@ export class OrderSchedules {
|
|
|
454
380
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
455
381
|
*
|
|
456
382
|
* @example
|
|
457
|
-
* await client.shipping.orderSchedules.
|
|
383
|
+
* await client.shipping.orderSchedules.pauseV1("order_schedule_id")
|
|
458
384
|
*/
|
|
459
|
-
|
|
460
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
385
|
+
pauseV1(orderScheduleId, requestOptions) {
|
|
386
|
+
return core.HttpResponsePromise.fromPromise(this.__pauseV1(orderScheduleId, requestOptions));
|
|
461
387
|
}
|
|
462
|
-
|
|
388
|
+
__pauseV1(orderScheduleId, requestOptions) {
|
|
463
389
|
return __awaiter(this, void 0, void 0, function* () {
|
|
464
390
|
var _a, _b, _c, _d;
|
|
465
391
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
466
392
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
467
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/
|
|
393
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/pause/v1/${encodeURIComponent(orderScheduleId)}`),
|
|
468
394
|
method: "PATCH",
|
|
469
395
|
headers: _headers,
|
|
470
396
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -495,7 +421,7 @@ export class OrderSchedules {
|
|
|
495
421
|
rawResponse: _response.rawResponse,
|
|
496
422
|
});
|
|
497
423
|
case "timeout":
|
|
498
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/
|
|
424
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/pause/v1/{order_schedule_id}.");
|
|
499
425
|
case "unknown":
|
|
500
426
|
throw new errors.ChrtError({
|
|
501
427
|
message: _response.error.errorMessage,
|
|
@@ -564,7 +490,7 @@ export class OrderSchedules {
|
|
|
564
490
|
});
|
|
565
491
|
}
|
|
566
492
|
/**
|
|
567
|
-
*
|
|
493
|
+
* Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
568
494
|
*
|
|
569
495
|
* @param {string} orderScheduleId
|
|
570
496
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -572,17 +498,17 @@ export class OrderSchedules {
|
|
|
572
498
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
573
499
|
*
|
|
574
500
|
* @example
|
|
575
|
-
* await client.shipping.orderSchedules.
|
|
501
|
+
* await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id")
|
|
576
502
|
*/
|
|
577
|
-
|
|
578
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
503
|
+
takeOwnershipV1(orderScheduleId, requestOptions) {
|
|
504
|
+
return core.HttpResponsePromise.fromPromise(this.__takeOwnershipV1(orderScheduleId, requestOptions));
|
|
579
505
|
}
|
|
580
|
-
|
|
506
|
+
__takeOwnershipV1(orderScheduleId, requestOptions) {
|
|
581
507
|
return __awaiter(this, void 0, void 0, function* () {
|
|
582
508
|
var _a, _b, _c, _d;
|
|
583
509
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
584
510
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
585
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/
|
|
511
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/take_ownership/v1/${encodeURIComponent(orderScheduleId)}`),
|
|
586
512
|
method: "PATCH",
|
|
587
513
|
headers: _headers,
|
|
588
514
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -613,7 +539,7 @@ export class OrderSchedules {
|
|
|
613
539
|
rawResponse: _response.rawResponse,
|
|
614
540
|
});
|
|
615
541
|
case "timeout":
|
|
616
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/
|
|
542
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_schedules/take_ownership/v1/{order_schedule_id}.");
|
|
617
543
|
case "unknown":
|
|
618
544
|
throw new errors.ChrtError({
|
|
619
545
|
message: _response.error.errorMessage,
|
|
@@ -623,7 +549,7 @@ export class OrderSchedules {
|
|
|
623
549
|
});
|
|
624
550
|
}
|
|
625
551
|
/**
|
|
626
|
-
* Archives an order schedule and
|
|
552
|
+
* Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
|
|
627
553
|
*
|
|
628
554
|
* @param {string} orderScheduleId
|
|
629
555
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -682,7 +608,7 @@ export class OrderSchedules {
|
|
|
682
608
|
});
|
|
683
609
|
}
|
|
684
610
|
/**
|
|
685
|
-
*
|
|
611
|
+
* Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
|
|
686
612
|
*
|
|
687
613
|
* @param {string} orderScheduleId
|
|
688
614
|
* @param {OrderSchedules.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -690,17 +616,17 @@ export class OrderSchedules {
|
|
|
690
616
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
691
617
|
*
|
|
692
618
|
* @example
|
|
693
|
-
* await client.shipping.orderSchedules.
|
|
619
|
+
* await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
694
620
|
*/
|
|
695
|
-
|
|
696
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
621
|
+
syncWithOrchestratorV1(orderScheduleId, requestOptions) {
|
|
622
|
+
return core.HttpResponsePromise.fromPromise(this.__syncWithOrchestratorV1(orderScheduleId, requestOptions));
|
|
697
623
|
}
|
|
698
|
-
|
|
624
|
+
__syncWithOrchestratorV1(orderScheduleId, requestOptions) {
|
|
699
625
|
return __awaiter(this, void 0, void 0, function* () {
|
|
700
626
|
var _a, _b, _c, _d;
|
|
701
627
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
702
628
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
703
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/
|
|
629
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/order_schedules/sync_with_orchestrator/v1/${encodeURIComponent(orderScheduleId)}`),
|
|
704
630
|
method: "POST",
|
|
705
631
|
headers: _headers,
|
|
706
632
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -731,7 +657,7 @@ export class OrderSchedules {
|
|
|
731
657
|
rawResponse: _response.rawResponse,
|
|
732
658
|
});
|
|
733
659
|
case "timeout":
|
|
734
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/
|
|
660
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_schedules/sync_with_orchestrator/v1/{order_schedule_id}.");
|
|
735
661
|
case "unknown":
|
|
736
662
|
throw new errors.ChrtError({
|
|
737
663
|
message: _response.error.errorMessage,
|
|
@@ -23,10 +23,8 @@ export interface OrderSchedulesListV1Request {
|
|
|
23
23
|
sort_order?: Chrt.SortOrderEnum | null;
|
|
24
24
|
page?: number | null;
|
|
25
25
|
page_size?: number | null;
|
|
26
|
-
/** Filter by
|
|
27
|
-
|
|
28
|
-
/** Filter by orchestrator schedule status(es). */
|
|
29
|
-
filter_orchestrator_schedule_status?: (Chrt.OrderScheduleOrchestratorScheduleStatusEnum1 | null) | (Chrt.OrderScheduleOrchestratorScheduleStatusEnum1 | null)[];
|
|
26
|
+
/** Filter by intended status(es). */
|
|
27
|
+
filter_intended_status?: (Chrt.OrderScheduleStatusEnum1 | null) | (Chrt.OrderScheduleStatusEnum1 | null)[];
|
|
30
28
|
/** Filter by the user who owns the order schedule. */
|
|
31
29
|
filter_owned_by_user_id?: string | null;
|
|
32
30
|
/** Filter created_at_timestamp >= value (inclusive). */
|
package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.d.mts
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as environments from "../../../../../../../../environments.mjs";
|
|
5
|
+
import * as core from "../../../../../../../../core/index.mjs";
|
|
6
|
+
import * as Chrt from "../../../../../../../index.mjs";
|
|
7
|
+
export declare namespace Draft {
|
|
8
|
+
interface Options {
|
|
9
|
+
environment?: core.Supplier<environments.ChrtEnvironment | string>;
|
|
10
|
+
/** Specify a custom URL to connect the client to. */
|
|
11
|
+
baseUrl?: core.Supplier<string>;
|
|
12
|
+
token?: core.Supplier<core.BearerToken | undefined>;
|
|
13
|
+
/** Additional headers to include in requests. */
|
|
14
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
|
+
fetcher?: core.FetchFunction;
|
|
16
|
+
}
|
|
17
|
+
interface RequestOptions {
|
|
18
|
+
/** The maximum time to wait for a response in seconds. */
|
|
19
|
+
timeoutInSeconds?: number;
|
|
20
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
21
|
+
maxRetries?: number;
|
|
22
|
+
/** A hook to abort the request. */
|
|
23
|
+
abortSignal?: AbortSignal;
|
|
24
|
+
/** Additional query string parameters to include in the request. */
|
|
25
|
+
queryParams?: Record<string, unknown>;
|
|
26
|
+
/** Additional headers to include in the request. */
|
|
27
|
+
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
export declare class Draft {
|
|
31
|
+
protected readonly _options: Draft.Options;
|
|
32
|
+
constructor(_options?: Draft.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
35
|
+
*
|
|
36
|
+
* @param {Chrt.shipping.orderSchedules.OrderScheduleClientCreate1} request
|
|
37
|
+
* @param {Draft.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* await client.shipping.orderSchedules.draft.newV1({
|
|
43
|
+
* schema_version: 1,
|
|
44
|
+
* name: "name"
|
|
45
|
+
* })
|
|
46
|
+
*/
|
|
47
|
+
newV1(request: Chrt.shipping.orderSchedules.OrderScheduleClientCreate1, requestOptions?: Draft.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
|
+
private __newV1;
|
|
49
|
+
/**
|
|
50
|
+
* Updates a draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
51
|
+
*
|
|
52
|
+
* @param {string} orderScheduleId
|
|
53
|
+
* @param {Chrt.shipping.orderSchedules.OrderScheduleClientUpdate1} request
|
|
54
|
+
* @param {Draft.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* await client.shipping.orderSchedules.draft.updateV1("order_schedule_id")
|
|
60
|
+
*/
|
|
61
|
+
updateV1(orderScheduleId: string, request?: Chrt.shipping.orderSchedules.OrderScheduleClientUpdate1, requestOptions?: Draft.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
62
|
+
private __updateV1;
|
|
63
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
64
|
+
}
|