@chrt-inc/typescript-sdk 1.917.0 → 1.920.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/orderTemplatesNew/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplateNewClientCreate1.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplateNewClientUpdate1.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/taskGroups/client/requests/OrderTemplateNewTaskGroupClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/taskGroups/client/requests/OrderTemplateNewTaskGroupClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +19 -5
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +71 -8
- package/dist/{esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateDepartmentAndLabelReq.d.mts → cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateDepartmentReq.d.ts} +1 -3
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateLabelReq.d.ts +11 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.d.ts +2 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.ts +3 -4
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/Client.js +8 -9
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersCreateDraftFromOrderTemplateNewReq.d.ts +3 -0
- package/dist/cjs/api/types/OrderTemplateNew1.d.ts +2 -0
- package/dist/cjs/api/{resources/shipping/resources/orderTemplatesNew/client/requests → types}/OrderTemplateNewCore1.d.ts +3 -7
- package/dist/cjs/api/types/OrderTemplateNewCore1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateNewTaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- 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/orderTemplatesNew/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplateNewClientCreate1.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/OrderTemplateNewClientUpdate1.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/taskGroups/client/requests/OrderTemplateNewTaskGroupClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/taskGroups/client/requests/OrderTemplateNewTaskGroupClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +19 -5
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +71 -8
- package/dist/{cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateDepartmentAndLabelReq.d.ts → esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateDepartmentReq.d.mts} +1 -3
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateLabelReq.d.mts +11 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.d.mts +2 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.mts +3 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.mjs +8 -9
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersCreateDraftFromOrderTemplateNewReq.d.mts +3 -0
- package/dist/esm/api/types/OrderTemplateNew1.d.mts +2 -0
- package/dist/esm/api/{resources/shipping/resources/orderTemplatesNew/client/requests → types}/OrderTemplateNewCore1.d.mts +3 -7
- package/dist/esm/api/types/OrderTemplateNewCore1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateNewTaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +79 -16
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplatesNew/client/requests/OrderTemplateNewCore1.js → orders/client/requests/OrdersUpdateDepartmentReq.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orders/client/requests/{OrdersUpdateDepartmentAndLabelReq.js → OrdersUpdateLabelReq.js} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplatesNew/client/requests/OrderTemplateNewCore1.mjs → orders/client/requests/OrdersUpdateDepartmentReq.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orders/client/requests/{OrdersUpdateDepartmentAndLabelReq.mjs → OrdersUpdateLabelReq.mjs} +0 -0
package/dist/cjs/Client.js
CHANGED
|
@@ -58,8 +58,8 @@ class ChrtClient {
|
|
|
58
58
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
59
59
|
"X-Fern-Language": "JavaScript",
|
|
60
60
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
61
|
-
"X-Fern-SDK-Version": "1.
|
|
62
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
61
|
+
"X-Fern-SDK-Version": "1.920.0",
|
|
62
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.920.0",
|
|
63
63
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
64
64
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
65
65
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -59,7 +59,7 @@ export declare class OrderTemplatesNew {
|
|
|
59
59
|
* Atomically replaces an active order template core. | authz: min_org_role=operator | (OrderTemplateNewCore1) -> (OrderTemplateNew1)
|
|
60
60
|
*
|
|
61
61
|
* @param {string} orderTemplateId
|
|
62
|
-
* @param {Chrt.
|
|
62
|
+
* @param {Chrt.OrderTemplateNewCore1} request
|
|
63
63
|
* @param {OrderTemplatesNew.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -69,7 +69,7 @@ export declare class OrderTemplatesNew {
|
|
|
69
69
|
* schema_version: 1
|
|
70
70
|
* })
|
|
71
71
|
*/
|
|
72
|
-
putReplaceCoreV1(orderTemplateId: string, request: Chrt.
|
|
72
|
+
putReplaceCoreV1(orderTemplateId: string, request: Chrt.OrderTemplateNewCore1, requestOptions?: OrderTemplatesNew.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateNew1>;
|
|
73
73
|
private __putReplaceCoreV1;
|
|
74
74
|
/**
|
|
75
75
|
* Validates a natural-language date string and resolves it to a UTC timestamp. | authz: min_org_role=operator | (OrderTemplateNewDateparserResolveReq) -> (OrderTemplateNewDateparserResolveRes)
|
|
@@ -138,7 +138,7 @@ class OrderTemplatesNew {
|
|
|
138
138
|
* Atomically replaces an active order template core. | authz: min_org_role=operator | (OrderTemplateNewCore1) -> (OrderTemplateNew1)
|
|
139
139
|
*
|
|
140
140
|
* @param {string} orderTemplateId
|
|
141
|
-
* @param {Chrt.
|
|
141
|
+
* @param {Chrt.OrderTemplateNewCore1} request
|
|
142
142
|
* @param {OrderTemplatesNew.RequestOptions} requestOptions - Request-specific configuration.
|
|
143
143
|
*
|
|
144
144
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
11
11
|
*/
|
|
12
12
|
export interface OrderTemplateNewClientCreate1 {
|
|
13
13
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
14
|
+
coordinator_assigned_user_ids?: string[];
|
|
14
15
|
coordinator_department_id?: string | null;
|
|
15
16
|
coordinator_label?: string | null;
|
|
16
17
|
/** Must be a string starting with `org_` */
|
|
@@ -21,6 +22,7 @@ export interface OrderTemplateNewClientCreate1 {
|
|
|
21
22
|
off_chrt_reference_id?: string | null;
|
|
22
23
|
off_chrt_shipper_org_data_id?: string | null;
|
|
23
24
|
schema_version: number;
|
|
25
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
24
26
|
/** Must be a string starting with `org_` */
|
|
25
27
|
shipper_org_id?: string | null;
|
|
26
28
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -7,6 +7,7 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
7
7
|
* {}
|
|
8
8
|
*/
|
|
9
9
|
export interface OrderTemplateNewClientUpdate1 {
|
|
10
|
+
coordinator_assigned_user_ids?: string[];
|
|
10
11
|
coordinator_department_id?: string | null;
|
|
11
12
|
coordinator_department_id__set_to_None?: boolean;
|
|
12
13
|
coordinator_label?: string | null;
|
|
@@ -22,6 +23,7 @@ export interface OrderTemplateNewClientUpdate1 {
|
|
|
22
23
|
off_chrt_reference_id__set_to_None?: boolean;
|
|
23
24
|
off_chrt_shipper_org_data_id?: string | null;
|
|
24
25
|
off_chrt_shipper_org_data_id__set_to_None?: boolean;
|
|
26
|
+
service_line?: Chrt.ServiceLineEnum | null;
|
|
25
27
|
/** Must be a string starting with `org_` */
|
|
26
28
|
shipper_org_id?: string | null;
|
|
27
29
|
shipper_org_id__set_to_None?: boolean;
|
package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/client/requests/index.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export { type OrderTemplateNewCore1 } from "./OrderTemplateNewCore1.js";
|
|
2
1
|
export { type OrderTemplateNewDateparserResolveReq } from "./OrderTemplateNewDateparserResolveReq.js";
|
|
3
2
|
export { type OrderTemplatesNewListV1Request } from "./OrderTemplatesNewListV1Request.js";
|
|
4
3
|
export { type OrderTemplateNewClientUpdate1 } from "./OrderTemplateNewClientUpdate1.js";
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../../../index.js";
|
|
|
11
11
|
export interface OrderTemplateNewTaskGroupClientCreate1 {
|
|
12
12
|
coordinator_setup_notes?: string | null;
|
|
13
13
|
driver_id?: string | null;
|
|
14
|
+
executor_assigned_user_ids?: string[];
|
|
14
15
|
/** Must be a string starting with `org_` */
|
|
15
16
|
executor_org_id?: string | null;
|
|
16
17
|
off_chrt_executor_org_data_id?: string | null;
|
|
@@ -11,6 +11,7 @@ export interface OrderTemplateNewTaskGroupClientUpdate1 {
|
|
|
11
11
|
coordinator_setup_notes__set_to_None?: boolean;
|
|
12
12
|
driver_id?: string | null;
|
|
13
13
|
driver_id__set_to_None?: boolean;
|
|
14
|
+
executor_assigned_user_ids?: string[];
|
|
14
15
|
/** Must be a string starting with `org_` */
|
|
15
16
|
executor_org_id?: string | null;
|
|
16
17
|
executor_org_id__set_to_None?: boolean;
|
|
@@ -155,19 +155,33 @@ export declare class Orders {
|
|
|
155
155
|
unassignV1(orderId: string, request: Chrt.shipping.OrdersUnassignReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
156
156
|
private __unassignV1;
|
|
157
157
|
/**
|
|
158
|
-
* Updates department_id
|
|
158
|
+
* Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
159
159
|
*
|
|
160
160
|
* @param {string} orderId
|
|
161
|
-
* @param {Chrt.shipping.
|
|
161
|
+
* @param {Chrt.shipping.OrdersUpdateDepartmentReq} request
|
|
162
162
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
163
163
|
*
|
|
164
164
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
165
165
|
*
|
|
166
166
|
* @example
|
|
167
|
-
* await client.shipping.orders.
|
|
167
|
+
* await client.shipping.orders.updateDepartmentV1("order_id")
|
|
168
168
|
*/
|
|
169
|
-
|
|
170
|
-
private
|
|
169
|
+
updateDepartmentV1(orderId: string, request?: Chrt.shipping.OrdersUpdateDepartmentReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
170
|
+
private __updateDepartmentV1;
|
|
171
|
+
/**
|
|
172
|
+
* Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
173
|
+
*
|
|
174
|
+
* @param {string} orderId
|
|
175
|
+
* @param {Chrt.shipping.OrdersUpdateLabelReq} request
|
|
176
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
177
|
+
*
|
|
178
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* await client.shipping.orders.updateLabelV1("order_id")
|
|
182
|
+
*/
|
|
183
|
+
updateLabelV1(orderId: string, request?: Chrt.shipping.OrdersUpdateLabelReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
184
|
+
private __updateLabelV1;
|
|
171
185
|
/**
|
|
172
186
|
* Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
173
187
|
*
|
|
@@ -573,26 +573,26 @@ class Orders {
|
|
|
573
573
|
});
|
|
574
574
|
}
|
|
575
575
|
/**
|
|
576
|
-
* Updates department_id
|
|
576
|
+
* Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
577
577
|
*
|
|
578
578
|
* @param {string} orderId
|
|
579
|
-
* @param {Chrt.shipping.
|
|
579
|
+
* @param {Chrt.shipping.OrdersUpdateDepartmentReq} request
|
|
580
580
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
581
581
|
*
|
|
582
582
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
583
583
|
*
|
|
584
584
|
* @example
|
|
585
|
-
* await client.shipping.orders.
|
|
585
|
+
* await client.shipping.orders.updateDepartmentV1("order_id")
|
|
586
586
|
*/
|
|
587
|
-
|
|
588
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
587
|
+
updateDepartmentV1(orderId, request = {}, requestOptions) {
|
|
588
|
+
return core.HttpResponsePromise.fromPromise(this.__updateDepartmentV1(orderId, request, requestOptions));
|
|
589
589
|
}
|
|
590
|
-
|
|
590
|
+
__updateDepartmentV1(orderId_1) {
|
|
591
591
|
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
592
592
|
var _a, _b, _c, _d;
|
|
593
593
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
594
594
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
595
|
-
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/orders/
|
|
595
|
+
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/orders/update_department/v1/${encodeURIComponent(orderId)}`),
|
|
596
596
|
method: "PATCH",
|
|
597
597
|
headers: _headers,
|
|
598
598
|
contentType: "application/json",
|
|
@@ -626,7 +626,70 @@ class Orders {
|
|
|
626
626
|
rawResponse: _response.rawResponse,
|
|
627
627
|
});
|
|
628
628
|
case "timeout":
|
|
629
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/
|
|
629
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/update_department/v1/{order_id}.");
|
|
630
|
+
case "unknown":
|
|
631
|
+
throw new errors.ChrtError({
|
|
632
|
+
message: _response.error.errorMessage,
|
|
633
|
+
rawResponse: _response.rawResponse,
|
|
634
|
+
});
|
|
635
|
+
}
|
|
636
|
+
});
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
640
|
+
*
|
|
641
|
+
* @param {string} orderId
|
|
642
|
+
* @param {Chrt.shipping.OrdersUpdateLabelReq} request
|
|
643
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
644
|
+
*
|
|
645
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
646
|
+
*
|
|
647
|
+
* @example
|
|
648
|
+
* await client.shipping.orders.updateLabelV1("order_id")
|
|
649
|
+
*/
|
|
650
|
+
updateLabelV1(orderId, request = {}, requestOptions) {
|
|
651
|
+
return core.HttpResponsePromise.fromPromise(this.__updateLabelV1(orderId, request, requestOptions));
|
|
652
|
+
}
|
|
653
|
+
__updateLabelV1(orderId_1) {
|
|
654
|
+
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
655
|
+
var _a, _b, _c, _d;
|
|
656
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
657
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
658
|
+
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/orders/update_label/v1/${encodeURIComponent(orderId)}`),
|
|
659
|
+
method: "PATCH",
|
|
660
|
+
headers: _headers,
|
|
661
|
+
contentType: "application/json",
|
|
662
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
663
|
+
requestType: "json",
|
|
664
|
+
body: request,
|
|
665
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
666
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
667
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
668
|
+
});
|
|
669
|
+
if (_response.ok) {
|
|
670
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
671
|
+
}
|
|
672
|
+
if (_response.error.reason === "status-code") {
|
|
673
|
+
switch (_response.error.statusCode) {
|
|
674
|
+
case 422:
|
|
675
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
676
|
+
default:
|
|
677
|
+
throw new errors.ChrtError({
|
|
678
|
+
statusCode: _response.error.statusCode,
|
|
679
|
+
body: _response.error.body,
|
|
680
|
+
rawResponse: _response.rawResponse,
|
|
681
|
+
});
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
switch (_response.error.reason) {
|
|
685
|
+
case "non-json":
|
|
686
|
+
throw new errors.ChrtError({
|
|
687
|
+
statusCode: _response.error.statusCode,
|
|
688
|
+
body: _response.error.rawBody,
|
|
689
|
+
rawResponse: _response.rawResponse,
|
|
690
|
+
});
|
|
691
|
+
case "timeout":
|
|
692
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/update_label/v1/{order_id}.");
|
|
630
693
|
case "unknown":
|
|
631
694
|
throw new errors.ChrtError({
|
|
632
695
|
message: _response.error.errorMessage,
|
|
@@ -5,9 +5,7 @@
|
|
|
5
5
|
* @example
|
|
6
6
|
* {}
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface OrdersUpdateDepartmentReq {
|
|
9
9
|
department_id?: string | null;
|
|
10
10
|
department_id__set_to_None?: boolean;
|
|
11
|
-
label?: string | null;
|
|
12
|
-
label__set_to_None?: boolean;
|
|
13
11
|
}
|
|
@@ -3,5 +3,6 @@ export { type OrdersCancelManyReq } from "./OrdersCancelManyReq.js";
|
|
|
3
3
|
export { type OrdersTypeaheadLabelV1Request } from "./OrdersTypeaheadLabelV1Request.js";
|
|
4
4
|
export { type OrdersTypeaheadV1Request } from "./OrdersTypeaheadV1Request.js";
|
|
5
5
|
export { type OrdersUnassignReq } from "./OrdersUnassignReq.js";
|
|
6
|
-
export { type
|
|
6
|
+
export { type OrdersUpdateDepartmentReq } from "./OrdersUpdateDepartmentReq.js";
|
|
7
|
+
export { type OrdersUpdateLabelReq } from "./OrdersUpdateLabelReq.js";
|
|
7
8
|
export { type OrdersUpdateOffChrtReferenceIdReq } from "./OrdersUpdateOffChrtReferenceIdReq.js";
|
package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.ts
CHANGED
|
@@ -109,18 +109,17 @@ export declare class Drafts {
|
|
|
109
109
|
removeCoordinatorTaskListToApplyAtOrderStagingV1(orderId: string, taskListId: string, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
110
110
|
private __removeCoordinatorTaskListToApplyAtOrderStagingV1;
|
|
111
111
|
/**
|
|
112
|
-
* Creates a draft Order and
|
|
112
|
+
* Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
113
113
|
*
|
|
114
|
-
* @param {string} orderTemplateId
|
|
115
114
|
* @param {Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq} request
|
|
116
115
|
* @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
117
116
|
*
|
|
118
117
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
119
118
|
*
|
|
120
119
|
* @example
|
|
121
|
-
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1(
|
|
120
|
+
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1()
|
|
122
121
|
*/
|
|
123
|
-
createFromOrderTemplateNewV1(
|
|
122
|
+
createFromOrderTemplateNewV1(request?: Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersOpenDraftRes>;
|
|
124
123
|
private __createFromOrderTemplateNewV1;
|
|
125
124
|
/**
|
|
126
125
|
* Deletes a draft order and all associated entities. | authz_personas=[draft_creator_org_operator] | () -> (bool)
|
|
@@ -403,26 +403,25 @@ class Drafts {
|
|
|
403
403
|
});
|
|
404
404
|
}
|
|
405
405
|
/**
|
|
406
|
-
* Creates a draft Order and
|
|
406
|
+
* Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
407
407
|
*
|
|
408
|
-
* @param {string} orderTemplateId
|
|
409
408
|
* @param {Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq} request
|
|
410
409
|
* @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
411
410
|
*
|
|
412
411
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
413
412
|
*
|
|
414
413
|
* @example
|
|
415
|
-
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1(
|
|
414
|
+
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1()
|
|
416
415
|
*/
|
|
417
|
-
createFromOrderTemplateNewV1(
|
|
418
|
-
return core.HttpResponsePromise.fromPromise(this.__createFromOrderTemplateNewV1(
|
|
416
|
+
createFromOrderTemplateNewV1(request = {}, requestOptions) {
|
|
417
|
+
return core.HttpResponsePromise.fromPromise(this.__createFromOrderTemplateNewV1(request, requestOptions));
|
|
419
418
|
}
|
|
420
|
-
__createFromOrderTemplateNewV1(
|
|
421
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
419
|
+
__createFromOrderTemplateNewV1() {
|
|
420
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
422
421
|
var _a, _b, _c, _d;
|
|
423
422
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
424
423
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
425
|
-
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,
|
|
424
|
+
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/orders/drafts/create_from_order_template_new/v1"),
|
|
426
425
|
method: "POST",
|
|
427
426
|
headers: _headers,
|
|
428
427
|
contentType: "application/json",
|
|
@@ -456,7 +455,7 @@ class Drafts {
|
|
|
456
455
|
rawResponse: _response.rawResponse,
|
|
457
456
|
});
|
|
458
457
|
case "timeout":
|
|
459
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/drafts/create_from_order_template_new/v1
|
|
458
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/drafts/create_from_order_template_new/v1.");
|
|
460
459
|
case "unknown":
|
|
461
460
|
throw new errors.ChrtError({
|
|
462
461
|
message: _response.error.errorMessage,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as Chrt from "../../../../../../../../index.js";
|
|
4
5
|
/**
|
|
5
6
|
* @example
|
|
6
7
|
* {}
|
|
@@ -8,4 +9,6 @@
|
|
|
8
9
|
export interface OrdersCreateDraftFromOrderTemplateNewReq {
|
|
9
10
|
anchor_timestamp?: string | null;
|
|
10
11
|
creation_idempotency_key?: string | null;
|
|
12
|
+
order_template_new_core?: Chrt.OrderTemplateNewCore1 | null;
|
|
13
|
+
order_template_new_id?: string | null;
|
|
11
14
|
}
|
|
@@ -6,6 +6,7 @@ export interface OrderTemplateNew1 {
|
|
|
6
6
|
_id: string;
|
|
7
7
|
archived_at_timestamp?: string | null;
|
|
8
8
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
9
|
+
coordinator_assigned_user_ids?: string[];
|
|
9
10
|
coordinator_department_id?: string | null;
|
|
10
11
|
coordinator_label?: string | null;
|
|
11
12
|
/** Must be a string starting with `org_` */
|
|
@@ -23,6 +24,7 @@ export interface OrderTemplateNew1 {
|
|
|
23
24
|
/** Must be a string starting with `user_` */
|
|
24
25
|
owned_by_user_id: string;
|
|
25
26
|
schema_version: number;
|
|
27
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
26
28
|
/** Must be a string starting with `org_` */
|
|
27
29
|
shipper_org_id?: string | null;
|
|
28
30
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Chrt from "
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {
|
|
8
|
-
* schema_version: 1
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
4
|
+
import * as Chrt from "../index.js";
|
|
11
5
|
export interface OrderTemplateNewCore1 {
|
|
12
6
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
7
|
+
coordinator_assigned_user_ids?: string[];
|
|
13
8
|
coordinator_department_id?: string | null;
|
|
14
9
|
coordinator_label?: string | null;
|
|
15
10
|
/** Must be a string starting with `org_` */
|
|
@@ -18,6 +13,7 @@ export interface OrderTemplateNewCore1 {
|
|
|
18
13
|
off_chrt_reference_id?: string | null;
|
|
19
14
|
off_chrt_shipper_org_data_id?: string | null;
|
|
20
15
|
schema_version: number;
|
|
16
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
21
17
|
/** Must be a string starting with `org_` */
|
|
22
18
|
shipper_org_id?: string | null;
|
|
23
19
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -5,6 +5,7 @@ import * as Chrt from "../index.js";
|
|
|
5
5
|
export interface OrderTemplateNewTaskGroup1 {
|
|
6
6
|
coordinator_setup_notes?: string | null;
|
|
7
7
|
driver_id?: string | null;
|
|
8
|
+
executor_assigned_user_ids?: string[];
|
|
8
9
|
/** Must be a string starting with `org_` */
|
|
9
10
|
executor_org_id?: string | null;
|
|
10
11
|
off_chrt_executor_org_data_id?: string | null;
|
|
@@ -358,6 +358,7 @@ export * from "./OrderTemplateExpanded1.js";
|
|
|
358
358
|
export * from "./OrderTemplateListRes.js";
|
|
359
359
|
export * from "./OrderTemplateNew1.js";
|
|
360
360
|
export * from "./OrderTemplateNewCargo1.js";
|
|
361
|
+
export * from "./OrderTemplateNewCore1.js";
|
|
361
362
|
export * from "./OrderTemplateNewDateTimeWindow1.js";
|
|
362
363
|
export * from "./OrderTemplateNewDateparserResolveRes.js";
|
|
363
364
|
export * from "./OrderTemplateNewListRes.js";
|
|
@@ -374,6 +374,7 @@ __exportStar(require("./OrderTemplateExpanded1.js"), exports);
|
|
|
374
374
|
__exportStar(require("./OrderTemplateListRes.js"), exports);
|
|
375
375
|
__exportStar(require("./OrderTemplateNew1.js"), exports);
|
|
376
376
|
__exportStar(require("./OrderTemplateNewCargo1.js"), exports);
|
|
377
|
+
__exportStar(require("./OrderTemplateNewCore1.js"), exports);
|
|
377
378
|
__exportStar(require("./OrderTemplateNewDateTimeWindow1.js"), exports);
|
|
378
379
|
__exportStar(require("./OrderTemplateNewDateparserResolveRes.js"), exports);
|
|
379
380
|
__exportStar(require("./OrderTemplateNewListRes.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.920.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -22,8 +22,8 @@ export class ChrtClient {
|
|
|
22
22
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
23
23
|
"X-Fern-Language": "JavaScript",
|
|
24
24
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
25
|
-
"X-Fern-SDK-Version": "1.
|
|
26
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
25
|
+
"X-Fern-SDK-Version": "1.920.0",
|
|
26
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.920.0",
|
|
27
27
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
28
28
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
29
29
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -59,7 +59,7 @@ export declare class OrderTemplatesNew {
|
|
|
59
59
|
* Atomically replaces an active order template core. | authz: min_org_role=operator | (OrderTemplateNewCore1) -> (OrderTemplateNew1)
|
|
60
60
|
*
|
|
61
61
|
* @param {string} orderTemplateId
|
|
62
|
-
* @param {Chrt.
|
|
62
|
+
* @param {Chrt.OrderTemplateNewCore1} request
|
|
63
63
|
* @param {OrderTemplatesNew.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -69,7 +69,7 @@ export declare class OrderTemplatesNew {
|
|
|
69
69
|
* schema_version: 1
|
|
70
70
|
* })
|
|
71
71
|
*/
|
|
72
|
-
putReplaceCoreV1(orderTemplateId: string, request: Chrt.
|
|
72
|
+
putReplaceCoreV1(orderTemplateId: string, request: Chrt.OrderTemplateNewCore1, requestOptions?: OrderTemplatesNew.RequestOptions): core.HttpResponsePromise<Chrt.OrderTemplateNew1>;
|
|
73
73
|
private __putReplaceCoreV1;
|
|
74
74
|
/**
|
|
75
75
|
* Validates a natural-language date string and resolves it to a UTC timestamp. | authz: min_org_role=operator | (OrderTemplateNewDateparserResolveReq) -> (OrderTemplateNewDateparserResolveRes)
|
|
@@ -102,7 +102,7 @@ export class OrderTemplatesNew {
|
|
|
102
102
|
* Atomically replaces an active order template core. | authz: min_org_role=operator | (OrderTemplateNewCore1) -> (OrderTemplateNew1)
|
|
103
103
|
*
|
|
104
104
|
* @param {string} orderTemplateId
|
|
105
|
-
* @param {Chrt.
|
|
105
|
+
* @param {Chrt.OrderTemplateNewCore1} request
|
|
106
106
|
* @param {OrderTemplatesNew.RequestOptions} requestOptions - Request-specific configuration.
|
|
107
107
|
*
|
|
108
108
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
11
11
|
*/
|
|
12
12
|
export interface OrderTemplateNewClientCreate1 {
|
|
13
13
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
14
|
+
coordinator_assigned_user_ids?: string[];
|
|
14
15
|
coordinator_department_id?: string | null;
|
|
15
16
|
coordinator_label?: string | null;
|
|
16
17
|
/** Must be a string starting with `org_` */
|
|
@@ -21,6 +22,7 @@ export interface OrderTemplateNewClientCreate1 {
|
|
|
21
22
|
off_chrt_reference_id?: string | null;
|
|
22
23
|
off_chrt_shipper_org_data_id?: string | null;
|
|
23
24
|
schema_version: number;
|
|
25
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
24
26
|
/** Must be a string starting with `org_` */
|
|
25
27
|
shipper_org_id?: string | null;
|
|
26
28
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -7,6 +7,7 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
7
7
|
* {}
|
|
8
8
|
*/
|
|
9
9
|
export interface OrderTemplateNewClientUpdate1 {
|
|
10
|
+
coordinator_assigned_user_ids?: string[];
|
|
10
11
|
coordinator_department_id?: string | null;
|
|
11
12
|
coordinator_department_id__set_to_None?: boolean;
|
|
12
13
|
coordinator_label?: string | null;
|
|
@@ -22,6 +23,7 @@ export interface OrderTemplateNewClientUpdate1 {
|
|
|
22
23
|
off_chrt_reference_id__set_to_None?: boolean;
|
|
23
24
|
off_chrt_shipper_org_data_id?: string | null;
|
|
24
25
|
off_chrt_shipper_org_data_id__set_to_None?: boolean;
|
|
26
|
+
service_line?: Chrt.ServiceLineEnum | null;
|
|
25
27
|
/** Must be a string starting with `org_` */
|
|
26
28
|
shipper_org_id?: string | null;
|
|
27
29
|
shipper_org_id__set_to_None?: boolean;
|
package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/client/requests/index.d.mts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
export { type OrderTemplateNewCore1 } from "./OrderTemplateNewCore1.mjs";
|
|
2
1
|
export { type OrderTemplateNewDateparserResolveReq } from "./OrderTemplateNewDateparserResolveReq.mjs";
|
|
3
2
|
export { type OrderTemplatesNewListV1Request } from "./OrderTemplatesNewListV1Request.mjs";
|
|
4
3
|
export { type OrderTemplateNewClientUpdate1 } from "./OrderTemplateNewClientUpdate1.mjs";
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../../../index.mjs";
|
|
|
11
11
|
export interface OrderTemplateNewTaskGroupClientCreate1 {
|
|
12
12
|
coordinator_setup_notes?: string | null;
|
|
13
13
|
driver_id?: string | null;
|
|
14
|
+
executor_assigned_user_ids?: string[];
|
|
14
15
|
/** Must be a string starting with `org_` */
|
|
15
16
|
executor_org_id?: string | null;
|
|
16
17
|
off_chrt_executor_org_data_id?: string | null;
|
|
@@ -11,6 +11,7 @@ export interface OrderTemplateNewTaskGroupClientUpdate1 {
|
|
|
11
11
|
coordinator_setup_notes__set_to_None?: boolean;
|
|
12
12
|
driver_id?: string | null;
|
|
13
13
|
driver_id__set_to_None?: boolean;
|
|
14
|
+
executor_assigned_user_ids?: string[];
|
|
14
15
|
/** Must be a string starting with `org_` */
|
|
15
16
|
executor_org_id?: string | null;
|
|
16
17
|
executor_org_id__set_to_None?: boolean;
|
|
@@ -155,19 +155,33 @@ export declare class Orders {
|
|
|
155
155
|
unassignV1(orderId: string, request: Chrt.shipping.OrdersUnassignReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
156
156
|
private __unassignV1;
|
|
157
157
|
/**
|
|
158
|
-
* Updates department_id
|
|
158
|
+
* Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
159
159
|
*
|
|
160
160
|
* @param {string} orderId
|
|
161
|
-
* @param {Chrt.shipping.
|
|
161
|
+
* @param {Chrt.shipping.OrdersUpdateDepartmentReq} request
|
|
162
162
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
163
163
|
*
|
|
164
164
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
165
165
|
*
|
|
166
166
|
* @example
|
|
167
|
-
* await client.shipping.orders.
|
|
167
|
+
* await client.shipping.orders.updateDepartmentV1("order_id")
|
|
168
168
|
*/
|
|
169
|
-
|
|
170
|
-
private
|
|
169
|
+
updateDepartmentV1(orderId: string, request?: Chrt.shipping.OrdersUpdateDepartmentReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
170
|
+
private __updateDepartmentV1;
|
|
171
|
+
/**
|
|
172
|
+
* Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
173
|
+
*
|
|
174
|
+
* @param {string} orderId
|
|
175
|
+
* @param {Chrt.shipping.OrdersUpdateLabelReq} request
|
|
176
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
177
|
+
*
|
|
178
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* await client.shipping.orders.updateLabelV1("order_id")
|
|
182
|
+
*/
|
|
183
|
+
updateLabelV1(orderId: string, request?: Chrt.shipping.OrdersUpdateLabelReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
184
|
+
private __updateLabelV1;
|
|
171
185
|
/**
|
|
172
186
|
* Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
173
187
|
*
|
|
@@ -537,26 +537,26 @@ export class Orders {
|
|
|
537
537
|
});
|
|
538
538
|
}
|
|
539
539
|
/**
|
|
540
|
-
* Updates department_id
|
|
540
|
+
* Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
541
541
|
*
|
|
542
542
|
* @param {string} orderId
|
|
543
|
-
* @param {Chrt.shipping.
|
|
543
|
+
* @param {Chrt.shipping.OrdersUpdateDepartmentReq} request
|
|
544
544
|
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
545
545
|
*
|
|
546
546
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
547
547
|
*
|
|
548
548
|
* @example
|
|
549
|
-
* await client.shipping.orders.
|
|
549
|
+
* await client.shipping.orders.updateDepartmentV1("order_id")
|
|
550
550
|
*/
|
|
551
|
-
|
|
552
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
551
|
+
updateDepartmentV1(orderId, request = {}, requestOptions) {
|
|
552
|
+
return core.HttpResponsePromise.fromPromise(this.__updateDepartmentV1(orderId, request, requestOptions));
|
|
553
553
|
}
|
|
554
|
-
|
|
554
|
+
__updateDepartmentV1(orderId_1) {
|
|
555
555
|
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
556
556
|
var _a, _b, _c, _d;
|
|
557
557
|
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);
|
|
558
558
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
559
|
-
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/orders/
|
|
559
|
+
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/orders/update_department/v1/${encodeURIComponent(orderId)}`),
|
|
560
560
|
method: "PATCH",
|
|
561
561
|
headers: _headers,
|
|
562
562
|
contentType: "application/json",
|
|
@@ -590,7 +590,70 @@ export class Orders {
|
|
|
590
590
|
rawResponse: _response.rawResponse,
|
|
591
591
|
});
|
|
592
592
|
case "timeout":
|
|
593
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/
|
|
593
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/update_department/v1/{order_id}.");
|
|
594
|
+
case "unknown":
|
|
595
|
+
throw new errors.ChrtError({
|
|
596
|
+
message: _response.error.errorMessage,
|
|
597
|
+
rawResponse: _response.rawResponse,
|
|
598
|
+
});
|
|
599
|
+
}
|
|
600
|
+
});
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
604
|
+
*
|
|
605
|
+
* @param {string} orderId
|
|
606
|
+
* @param {Chrt.shipping.OrdersUpdateLabelReq} request
|
|
607
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
608
|
+
*
|
|
609
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
610
|
+
*
|
|
611
|
+
* @example
|
|
612
|
+
* await client.shipping.orders.updateLabelV1("order_id")
|
|
613
|
+
*/
|
|
614
|
+
updateLabelV1(orderId, request = {}, requestOptions) {
|
|
615
|
+
return core.HttpResponsePromise.fromPromise(this.__updateLabelV1(orderId, request, requestOptions));
|
|
616
|
+
}
|
|
617
|
+
__updateLabelV1(orderId_1) {
|
|
618
|
+
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
619
|
+
var _a, _b, _c, _d;
|
|
620
|
+
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);
|
|
621
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
622
|
+
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/orders/update_label/v1/${encodeURIComponent(orderId)}`),
|
|
623
|
+
method: "PATCH",
|
|
624
|
+
headers: _headers,
|
|
625
|
+
contentType: "application/json",
|
|
626
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
627
|
+
requestType: "json",
|
|
628
|
+
body: request,
|
|
629
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
630
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
631
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
632
|
+
});
|
|
633
|
+
if (_response.ok) {
|
|
634
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
635
|
+
}
|
|
636
|
+
if (_response.error.reason === "status-code") {
|
|
637
|
+
switch (_response.error.statusCode) {
|
|
638
|
+
case 422:
|
|
639
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
640
|
+
default:
|
|
641
|
+
throw new errors.ChrtError({
|
|
642
|
+
statusCode: _response.error.statusCode,
|
|
643
|
+
body: _response.error.body,
|
|
644
|
+
rawResponse: _response.rawResponse,
|
|
645
|
+
});
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
switch (_response.error.reason) {
|
|
649
|
+
case "non-json":
|
|
650
|
+
throw new errors.ChrtError({
|
|
651
|
+
statusCode: _response.error.statusCode,
|
|
652
|
+
body: _response.error.rawBody,
|
|
653
|
+
rawResponse: _response.rawResponse,
|
|
654
|
+
});
|
|
655
|
+
case "timeout":
|
|
656
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/update_label/v1/{order_id}.");
|
|
594
657
|
case "unknown":
|
|
595
658
|
throw new errors.ChrtError({
|
|
596
659
|
message: _response.error.errorMessage,
|
|
@@ -5,9 +5,7 @@
|
|
|
5
5
|
* @example
|
|
6
6
|
* {}
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface OrdersUpdateDepartmentReq {
|
|
9
9
|
department_id?: string | null;
|
|
10
10
|
department_id__set_to_None?: boolean;
|
|
11
|
-
label?: string | null;
|
|
12
|
-
label__set_to_None?: boolean;
|
|
13
11
|
}
|
|
@@ -3,5 +3,6 @@ export { type OrdersCancelManyReq } from "./OrdersCancelManyReq.mjs";
|
|
|
3
3
|
export { type OrdersTypeaheadLabelV1Request } from "./OrdersTypeaheadLabelV1Request.mjs";
|
|
4
4
|
export { type OrdersTypeaheadV1Request } from "./OrdersTypeaheadV1Request.mjs";
|
|
5
5
|
export { type OrdersUnassignReq } from "./OrdersUnassignReq.mjs";
|
|
6
|
-
export { type
|
|
6
|
+
export { type OrdersUpdateDepartmentReq } from "./OrdersUpdateDepartmentReq.mjs";
|
|
7
|
+
export { type OrdersUpdateLabelReq } from "./OrdersUpdateLabelReq.mjs";
|
|
7
8
|
export { type OrdersUpdateOffChrtReferenceIdReq } from "./OrdersUpdateOffChrtReferenceIdReq.mjs";
|
package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.mts
CHANGED
|
@@ -109,18 +109,17 @@ export declare class Drafts {
|
|
|
109
109
|
removeCoordinatorTaskListToApplyAtOrderStagingV1(orderId: string, taskListId: string, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
110
110
|
private __removeCoordinatorTaskListToApplyAtOrderStagingV1;
|
|
111
111
|
/**
|
|
112
|
-
* Creates a draft Order and
|
|
112
|
+
* Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
113
113
|
*
|
|
114
|
-
* @param {string} orderTemplateId
|
|
115
114
|
* @param {Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq} request
|
|
116
115
|
* @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
117
116
|
*
|
|
118
117
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
119
118
|
*
|
|
120
119
|
* @example
|
|
121
|
-
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1(
|
|
120
|
+
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1()
|
|
122
121
|
*/
|
|
123
|
-
createFromOrderTemplateNewV1(
|
|
122
|
+
createFromOrderTemplateNewV1(request?: Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq, requestOptions?: Drafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersOpenDraftRes>;
|
|
124
123
|
private __createFromOrderTemplateNewV1;
|
|
125
124
|
/**
|
|
126
125
|
* Deletes a draft order and all associated entities. | authz_personas=[draft_creator_org_operator] | () -> (bool)
|
|
@@ -367,26 +367,25 @@ export class Drafts {
|
|
|
367
367
|
});
|
|
368
368
|
}
|
|
369
369
|
/**
|
|
370
|
-
* Creates a draft Order and
|
|
370
|
+
* Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
371
371
|
*
|
|
372
|
-
* @param {string} orderTemplateId
|
|
373
372
|
* @param {Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq} request
|
|
374
373
|
* @param {Drafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
375
374
|
*
|
|
376
375
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
377
376
|
*
|
|
378
377
|
* @example
|
|
379
|
-
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1(
|
|
378
|
+
* await client.shipping.orders.drafts.createFromOrderTemplateNewV1()
|
|
380
379
|
*/
|
|
381
|
-
createFromOrderTemplateNewV1(
|
|
382
|
-
return core.HttpResponsePromise.fromPromise(this.__createFromOrderTemplateNewV1(
|
|
380
|
+
createFromOrderTemplateNewV1(request = {}, requestOptions) {
|
|
381
|
+
return core.HttpResponsePromise.fromPromise(this.__createFromOrderTemplateNewV1(request, requestOptions));
|
|
383
382
|
}
|
|
384
|
-
__createFromOrderTemplateNewV1(
|
|
385
|
-
return __awaiter(this, arguments, void 0, function* (
|
|
383
|
+
__createFromOrderTemplateNewV1() {
|
|
384
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
386
385
|
var _a, _b, _c, _d;
|
|
387
386
|
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);
|
|
388
387
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
389
|
-
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,
|
|
388
|
+
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/orders/drafts/create_from_order_template_new/v1"),
|
|
390
389
|
method: "POST",
|
|
391
390
|
headers: _headers,
|
|
392
391
|
contentType: "application/json",
|
|
@@ -420,7 +419,7 @@ export class Drafts {
|
|
|
420
419
|
rawResponse: _response.rawResponse,
|
|
421
420
|
});
|
|
422
421
|
case "timeout":
|
|
423
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/drafts/create_from_order_template_new/v1
|
|
422
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/drafts/create_from_order_template_new/v1.");
|
|
424
423
|
case "unknown":
|
|
425
424
|
throw new errors.ChrtError({
|
|
426
425
|
message: _response.error.errorMessage,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as Chrt from "../../../../../../../../index.mjs";
|
|
4
5
|
/**
|
|
5
6
|
* @example
|
|
6
7
|
* {}
|
|
@@ -8,4 +9,6 @@
|
|
|
8
9
|
export interface OrdersCreateDraftFromOrderTemplateNewReq {
|
|
9
10
|
anchor_timestamp?: string | null;
|
|
10
11
|
creation_idempotency_key?: string | null;
|
|
12
|
+
order_template_new_core?: Chrt.OrderTemplateNewCore1 | null;
|
|
13
|
+
order_template_new_id?: string | null;
|
|
11
14
|
}
|
|
@@ -6,6 +6,7 @@ export interface OrderTemplateNew1 {
|
|
|
6
6
|
_id: string;
|
|
7
7
|
archived_at_timestamp?: string | null;
|
|
8
8
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
9
|
+
coordinator_assigned_user_ids?: string[];
|
|
9
10
|
coordinator_department_id?: string | null;
|
|
10
11
|
coordinator_label?: string | null;
|
|
11
12
|
/** Must be a string starting with `org_` */
|
|
@@ -23,6 +24,7 @@ export interface OrderTemplateNew1 {
|
|
|
23
24
|
/** Must be a string starting with `user_` */
|
|
24
25
|
owned_by_user_id: string;
|
|
25
26
|
schema_version: number;
|
|
27
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
26
28
|
/** Must be a string starting with `org_` */
|
|
27
29
|
shipper_org_id?: string | null;
|
|
28
30
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -1,15 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Chrt from "
|
|
5
|
-
/**
|
|
6
|
-
* @example
|
|
7
|
-
* {
|
|
8
|
-
* schema_version: 1
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
11
5
|
export interface OrderTemplateNewCore1 {
|
|
12
6
|
cargos?: Chrt.OrderTemplateNewCargo1[];
|
|
7
|
+
coordinator_assigned_user_ids?: string[];
|
|
13
8
|
coordinator_department_id?: string | null;
|
|
14
9
|
coordinator_label?: string | null;
|
|
15
10
|
/** Must be a string starting with `org_` */
|
|
@@ -18,6 +13,7 @@ export interface OrderTemplateNewCore1 {
|
|
|
18
13
|
off_chrt_reference_id?: string | null;
|
|
19
14
|
off_chrt_shipper_org_data_id?: string | null;
|
|
20
15
|
schema_version: number;
|
|
16
|
+
service_line?: Chrt.ServiceLineEnum;
|
|
21
17
|
/** Must be a string starting with `org_` */
|
|
22
18
|
shipper_org_id?: string | null;
|
|
23
19
|
task_groups?: Chrt.OrderTemplateNewTaskGroup1[];
|
|
@@ -5,6 +5,7 @@ import * as Chrt from "../index.mjs";
|
|
|
5
5
|
export interface OrderTemplateNewTaskGroup1 {
|
|
6
6
|
coordinator_setup_notes?: string | null;
|
|
7
7
|
driver_id?: string | null;
|
|
8
|
+
executor_assigned_user_ids?: string[];
|
|
8
9
|
/** Must be a string starting with `org_` */
|
|
9
10
|
executor_org_id?: string | null;
|
|
10
11
|
off_chrt_executor_org_data_id?: string | null;
|
|
@@ -358,6 +358,7 @@ export * from "./OrderTemplateExpanded1.mjs";
|
|
|
358
358
|
export * from "./OrderTemplateListRes.mjs";
|
|
359
359
|
export * from "./OrderTemplateNew1.mjs";
|
|
360
360
|
export * from "./OrderTemplateNewCargo1.mjs";
|
|
361
|
+
export * from "./OrderTemplateNewCore1.mjs";
|
|
361
362
|
export * from "./OrderTemplateNewDateTimeWindow1.mjs";
|
|
362
363
|
export * from "./OrderTemplateNewDateparserResolveRes.mjs";
|
|
363
364
|
export * from "./OrderTemplateNewListRes.mjs";
|
|
@@ -358,6 +358,7 @@ export * from "./OrderTemplateExpanded1.mjs";
|
|
|
358
358
|
export * from "./OrderTemplateListRes.mjs";
|
|
359
359
|
export * from "./OrderTemplateNew1.mjs";
|
|
360
360
|
export * from "./OrderTemplateNewCargo1.mjs";
|
|
361
|
+
export * from "./OrderTemplateNewCore1.mjs";
|
|
361
362
|
export * from "./OrderTemplateNewDateTimeWindow1.mjs";
|
|
362
363
|
export * from "./OrderTemplateNewDateparserResolveRes.mjs";
|
|
363
364
|
export * from "./OrderTemplateNewListRes.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.920.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.920.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -22630,7 +22630,7 @@ await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
|
22630
22630
|
<dl>
|
|
22631
22631
|
<dd>
|
|
22632
22632
|
|
|
22633
|
-
**request:** `Chrt.
|
|
22633
|
+
**request:** `Chrt.OrderTemplateNewCore1`
|
|
22634
22634
|
|
|
22635
22635
|
</dd>
|
|
22636
22636
|
</dl>
|
|
@@ -23651,7 +23651,7 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
23651
23651
|
</dl>
|
|
23652
23652
|
</details>
|
|
23653
23653
|
|
|
23654
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
23654
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDepartmentV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
23655
23655
|
<dl>
|
|
23656
23656
|
<dd>
|
|
23657
23657
|
|
|
@@ -23663,7 +23663,7 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
23663
23663
|
<dl>
|
|
23664
23664
|
<dd>
|
|
23665
23665
|
|
|
23666
|
-
Updates
|
|
23666
|
+
Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
23667
23667
|
|
|
23668
23668
|
</dd>
|
|
23669
23669
|
</dl>
|
|
@@ -23679,7 +23679,7 @@ Updates department*id and/or label for the caller's role on the order. Coordinat
|
|
|
23679
23679
|
<dd>
|
|
23680
23680
|
|
|
23681
23681
|
```typescript
|
|
23682
|
-
await client.shipping.orders.
|
|
23682
|
+
await client.shipping.orders.updateDepartmentV1("order_id");
|
|
23683
23683
|
```
|
|
23684
23684
|
|
|
23685
23685
|
</dd>
|
|
@@ -23703,7 +23703,78 @@ await client.shipping.orders.updateDepartmentAndLabelV1("order_id");
|
|
|
23703
23703
|
<dl>
|
|
23704
23704
|
<dd>
|
|
23705
23705
|
|
|
23706
|
-
**request:** `Chrt.shipping.
|
|
23706
|
+
**request:** `Chrt.shipping.OrdersUpdateDepartmentReq`
|
|
23707
|
+
|
|
23708
|
+
</dd>
|
|
23709
|
+
</dl>
|
|
23710
|
+
|
|
23711
|
+
<dl>
|
|
23712
|
+
<dd>
|
|
23713
|
+
|
|
23714
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
23715
|
+
|
|
23716
|
+
</dd>
|
|
23717
|
+
</dl>
|
|
23718
|
+
</dd>
|
|
23719
|
+
</dl>
|
|
23720
|
+
|
|
23721
|
+
</dd>
|
|
23722
|
+
</dl>
|
|
23723
|
+
</details>
|
|
23724
|
+
|
|
23725
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateLabelV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
23726
|
+
<dl>
|
|
23727
|
+
<dd>
|
|
23728
|
+
|
|
23729
|
+
#### 📝 Description
|
|
23730
|
+
|
|
23731
|
+
<dl>
|
|
23732
|
+
<dd>
|
|
23733
|
+
|
|
23734
|
+
<dl>
|
|
23735
|
+
<dd>
|
|
23736
|
+
|
|
23737
|
+
Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
23738
|
+
|
|
23739
|
+
</dd>
|
|
23740
|
+
</dl>
|
|
23741
|
+
</dd>
|
|
23742
|
+
</dl>
|
|
23743
|
+
|
|
23744
|
+
#### 🔌 Usage
|
|
23745
|
+
|
|
23746
|
+
<dl>
|
|
23747
|
+
<dd>
|
|
23748
|
+
|
|
23749
|
+
<dl>
|
|
23750
|
+
<dd>
|
|
23751
|
+
|
|
23752
|
+
```typescript
|
|
23753
|
+
await client.shipping.orders.updateLabelV1("order_id");
|
|
23754
|
+
```
|
|
23755
|
+
|
|
23756
|
+
</dd>
|
|
23757
|
+
</dl>
|
|
23758
|
+
</dd>
|
|
23759
|
+
</dl>
|
|
23760
|
+
|
|
23761
|
+
#### ⚙️ Parameters
|
|
23762
|
+
|
|
23763
|
+
<dl>
|
|
23764
|
+
<dd>
|
|
23765
|
+
|
|
23766
|
+
<dl>
|
|
23767
|
+
<dd>
|
|
23768
|
+
|
|
23769
|
+
**orderId:** `string`
|
|
23770
|
+
|
|
23771
|
+
</dd>
|
|
23772
|
+
</dl>
|
|
23773
|
+
|
|
23774
|
+
<dl>
|
|
23775
|
+
<dd>
|
|
23776
|
+
|
|
23777
|
+
**request:** `Chrt.shipping.OrdersUpdateLabelReq`
|
|
23707
23778
|
|
|
23708
23779
|
</dd>
|
|
23709
23780
|
</dl>
|
|
@@ -29147,7 +29218,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
29147
29218
|
</dl>
|
|
29148
29219
|
</details>
|
|
29149
29220
|
|
|
29150
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">createFromOrderTemplateNewV1</a>(
|
|
29221
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">createFromOrderTemplateNewV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
29151
29222
|
<dl>
|
|
29152
29223
|
<dd>
|
|
29153
29224
|
|
|
@@ -29159,7 +29230,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
29159
29230
|
<dl>
|
|
29160
29231
|
<dd>
|
|
29161
29232
|
|
|
29162
|
-
Creates a draft Order and
|
|
29233
|
+
Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
29163
29234
|
|
|
29164
29235
|
</dd>
|
|
29165
29236
|
</dl>
|
|
@@ -29175,7 +29246,7 @@ Creates a draft Order and its related records from an active OrderTemplateNew. |
|
|
|
29175
29246
|
<dd>
|
|
29176
29247
|
|
|
29177
29248
|
```typescript
|
|
29178
|
-
await client.shipping.orders.drafts.createFromOrderTemplateNewV1(
|
|
29249
|
+
await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
29179
29250
|
```
|
|
29180
29251
|
|
|
29181
29252
|
</dd>
|
|
@@ -29191,14 +29262,6 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1("order_template
|
|
|
29191
29262
|
<dl>
|
|
29192
29263
|
<dd>
|
|
29193
29264
|
|
|
29194
|
-
**orderTemplateId:** `string`
|
|
29195
|
-
|
|
29196
|
-
</dd>
|
|
29197
|
-
</dl>
|
|
29198
|
-
|
|
29199
|
-
<dl>
|
|
29200
|
-
<dd>
|
|
29201
|
-
|
|
29202
29265
|
**request:** `Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq`
|
|
29203
29266
|
|
|
29204
29267
|
</dd>
|
|
File without changes
|
|
File without changes
|
|
File without changes
|