@chrt-inc/typescript-sdk 1.540.0 → 1.562.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/billing/resources/statements/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +10 -2
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +21 -16
- package/dist/cjs/api/resources/shipping/resources/docs/client/Client.d.ts +50 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/Client.js +133 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/docs/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/docs/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +4 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +5 -6
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +9 -10
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.ts +5 -6
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +66 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.ts +11 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +1 -1
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.d.ts +18 -2
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.js +66 -1
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/types/LineItemGroup1.d.ts +1 -0
- package/dist/cjs/api/types/Order1.d.ts +1 -0
- package/dist/cjs/api/{resources/utils/resources/dev/client/requests → types}/OrderBuilderReq.d.ts +0 -7
- package/dist/cjs/api/types/OrderBuilderReq.js +5 -0
- package/dist/cjs/api/types/OrderBuilderRes.d.ts +2 -0
- package/dist/cjs/api/types/OrderDraftIssueCategoryEnum.d.ts +11 -0
- package/dist/cjs/api/types/OrderDraftIssueCategoryEnum.js +13 -0
- package/dist/cjs/api/types/OrderDraftValidationIssue.d.ts +12 -0
- package/dist/cjs/api/types/OrderDraftValidationIssue.js +5 -0
- package/dist/cjs/api/types/OrderDraftValidationResult.d.ts +8 -0
- package/dist/cjs/api/types/OrderDraftValidationResult.js +5 -0
- package/dist/cjs/api/types/OrdersDraftUpdateRes.d.ts +1 -0
- package/dist/cjs/api/types/OrdersUpdateOffChrtReferenceIdRes.d.ts +6 -0
- package/dist/cjs/api/types/OrdersUpdateOffChrtReferenceIdRes.js +5 -0
- package/dist/cjs/api/types/ShippingDocTemplateEnum.d.ts +8 -0
- package/dist/cjs/api/types/ShippingDocTemplateEnum.js +10 -0
- package/dist/cjs/api/types/Statement1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +6 -0
- package/dist/cjs/api/types/index.js +6 -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/billing/resources/statements/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +10 -2
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsExpandedListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +5 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/Client.d.mts +50 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/Client.mjs +96 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/docs/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/docs/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +3 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +5 -6
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +9 -10
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.mts +5 -6
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +66 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.mts +11 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForForwarderOperatorsV1Request.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierDriverV1Request.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForCourierOperatorsV1Request.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +1 -1
- package/dist/esm/api/resources/utils/resources/dev/client/Client.d.mts +18 -2
- package/dist/esm/api/resources/utils/resources/dev/client/Client.mjs +66 -1
- package/dist/esm/api/resources/utils/resources/dev/client/requests/index.d.mts +0 -1
- package/dist/esm/api/types/LineItemGroup1.d.mts +1 -0
- package/dist/esm/api/types/Order1.d.mts +1 -0
- package/dist/esm/api/{resources/utils/resources/dev/client/requests → types}/OrderBuilderReq.d.mts +0 -7
- package/dist/esm/api/types/OrderBuilderReq.mjs +4 -0
- package/dist/esm/api/types/OrderBuilderRes.d.mts +2 -0
- package/dist/esm/api/types/OrderDraftIssueCategoryEnum.d.mts +11 -0
- package/dist/esm/api/types/OrderDraftIssueCategoryEnum.mjs +10 -0
- package/dist/esm/api/types/OrderDraftValidationIssue.d.mts +12 -0
- package/dist/esm/api/types/OrderDraftValidationIssue.mjs +4 -0
- package/dist/esm/api/types/OrderDraftValidationResult.d.mts +8 -0
- package/dist/esm/api/types/OrderDraftValidationResult.mjs +4 -0
- package/dist/esm/api/types/OrdersDraftUpdateRes.d.mts +1 -0
- package/dist/esm/api/types/OrdersUpdateOffChrtReferenceIdRes.d.mts +6 -0
- package/dist/esm/api/types/OrdersUpdateOffChrtReferenceIdRes.mjs +4 -0
- package/dist/esm/api/types/ShippingDocTemplateEnum.d.mts +8 -0
- package/dist/esm/api/types/ShippingDocTemplateEnum.mjs +7 -0
- package/dist/esm/api/types/Statement1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +6 -0
- package/dist/esm/api/types/index.mjs +6 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +222 -9
- /package/dist/cjs/api/resources/{utils/resources/dev/client/requests/OrderBuilderReq.js → shipping/resources/docs/client/requests/GenerateShippingDocReq.js} +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev/client/requests/OrderBuilderReq.mjs → shipping/resources/docs/client/requests/GenerateShippingDocReq.mjs} +0 -0
|
@@ -87,6 +87,7 @@ export declare class Statements {
|
|
|
87
87
|
* page_size: 1,
|
|
88
88
|
* filter_settlement_type: "stripe_connect",
|
|
89
89
|
* filter_order_id: "filter_order_id",
|
|
90
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
90
91
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
91
92
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
92
93
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -119,6 +120,7 @@ export declare class Statements {
|
|
|
119
120
|
* page_size: 1,
|
|
120
121
|
* filter_settlement_type: "stripe_connect",
|
|
121
122
|
* filter_order_id: "filter_order_id",
|
|
123
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
122
124
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
123
125
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
124
126
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -217,6 +217,7 @@ export class Statements {
|
|
|
217
217
|
* page_size: 1,
|
|
218
218
|
* filter_settlement_type: "stripe_connect",
|
|
219
219
|
* filter_order_id: "filter_order_id",
|
|
220
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
220
221
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
221
222
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
222
223
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -237,7 +238,7 @@ export class Statements {
|
|
|
237
238
|
__listV1() {
|
|
238
239
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
239
240
|
var _a, _b, _c, _d, _e, _f;
|
|
240
|
-
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_status: filterStatus, filter_settlement_type: filterSettlementType, filter_order_id: filterOrderId, filter_payment_origin_org_id: filterPaymentOriginOrgId, filter_payment_origin_off_chrt_shipper_org_id: filterPaymentOriginOffChrtShipperOrgId, filter_payment_destination_org_id: filterPaymentDestinationOrgId, filter_owned_by_org_id: filterOwnedByOrgId, filter_staged_at_timestamp_gte: filterStagedAtTimestampGte, filter_staged_at_timestamp_lte: filterStagedAtTimestampLte, filter_opened_at_timestamp_gte: filterOpenedAtTimestampGte, filter_opened_at_timestamp_lte: filterOpenedAtTimestampLte, filter_paid_at_timestamp_gte: filterPaidAtTimestampGte, filter_paid_at_timestamp_lte: filterPaidAtTimestampLte, filter_uncollectible_at_timestamp_gte: filterUncollectibleAtTimestampGte, filter_uncollectible_at_timestamp_lte: filterUncollectibleAtTimestampLte, } = request;
|
|
241
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_status: filterStatus, filter_settlement_type: filterSettlementType, filter_order_id: filterOrderId, filter_order_off_chrt_reference_id: filterOrderOffChrtReferenceId, filter_payment_origin_org_id: filterPaymentOriginOrgId, filter_payment_origin_off_chrt_shipper_org_id: filterPaymentOriginOffChrtShipperOrgId, filter_payment_destination_org_id: filterPaymentDestinationOrgId, filter_owned_by_org_id: filterOwnedByOrgId, filter_staged_at_timestamp_gte: filterStagedAtTimestampGte, filter_staged_at_timestamp_lte: filterStagedAtTimestampLte, filter_opened_at_timestamp_gte: filterOpenedAtTimestampGte, filter_opened_at_timestamp_lte: filterOpenedAtTimestampLte, filter_paid_at_timestamp_gte: filterPaidAtTimestampGte, filter_paid_at_timestamp_lte: filterPaidAtTimestampLte, filter_uncollectible_at_timestamp_gte: filterUncollectibleAtTimestampGte, filter_uncollectible_at_timestamp_lte: filterUncollectibleAtTimestampLte, } = request;
|
|
241
242
|
const _queryParams = {};
|
|
242
243
|
if (sortBy !== undefined) {
|
|
243
244
|
_queryParams["sort_by"] = sortBy;
|
|
@@ -265,6 +266,9 @@ export class Statements {
|
|
|
265
266
|
if (filterOrderId !== undefined) {
|
|
266
267
|
_queryParams["filter_order_id"] = filterOrderId;
|
|
267
268
|
}
|
|
269
|
+
if (filterOrderOffChrtReferenceId !== undefined) {
|
|
270
|
+
_queryParams["filter_order_off_chrt_reference_id"] = filterOrderOffChrtReferenceId;
|
|
271
|
+
}
|
|
268
272
|
if (filterPaymentOriginOrgId !== undefined) {
|
|
269
273
|
_queryParams["filter_payment_origin_org_id"] = filterPaymentOriginOrgId;
|
|
270
274
|
}
|
|
@@ -359,6 +363,7 @@ export class Statements {
|
|
|
359
363
|
* page_size: 1,
|
|
360
364
|
* filter_settlement_type: "stripe_connect",
|
|
361
365
|
* filter_order_id: "filter_order_id",
|
|
366
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
362
367
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
363
368
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
364
369
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -379,7 +384,7 @@ export class Statements {
|
|
|
379
384
|
__expandedListV1() {
|
|
380
385
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
381
386
|
var _a, _b, _c, _d, _e, _f;
|
|
382
|
-
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_status: filterStatus, filter_settlement_type: filterSettlementType, filter_order_id: filterOrderId, filter_payment_origin_org_id: filterPaymentOriginOrgId, filter_payment_origin_off_chrt_shipper_org_id: filterPaymentOriginOffChrtShipperOrgId, filter_payment_destination_org_id: filterPaymentDestinationOrgId, filter_owned_by_org_id: filterOwnedByOrgId, filter_staged_at_timestamp_gte: filterStagedAtTimestampGte, filter_staged_at_timestamp_lte: filterStagedAtTimestampLte, filter_opened_at_timestamp_gte: filterOpenedAtTimestampGte, filter_opened_at_timestamp_lte: filterOpenedAtTimestampLte, filter_paid_at_timestamp_gte: filterPaidAtTimestampGte, filter_paid_at_timestamp_lte: filterPaidAtTimestampLte, filter_uncollectible_at_timestamp_gte: filterUncollectibleAtTimestampGte, filter_uncollectible_at_timestamp_lte: filterUncollectibleAtTimestampLte, } = request;
|
|
387
|
+
const { sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, filter_status: filterStatus, filter_settlement_type: filterSettlementType, filter_order_id: filterOrderId, filter_order_off_chrt_reference_id: filterOrderOffChrtReferenceId, filter_payment_origin_org_id: filterPaymentOriginOrgId, filter_payment_origin_off_chrt_shipper_org_id: filterPaymentOriginOffChrtShipperOrgId, filter_payment_destination_org_id: filterPaymentDestinationOrgId, filter_owned_by_org_id: filterOwnedByOrgId, filter_staged_at_timestamp_gte: filterStagedAtTimestampGte, filter_staged_at_timestamp_lte: filterStagedAtTimestampLte, filter_opened_at_timestamp_gte: filterOpenedAtTimestampGte, filter_opened_at_timestamp_lte: filterOpenedAtTimestampLte, filter_paid_at_timestamp_gte: filterPaidAtTimestampGte, filter_paid_at_timestamp_lte: filterPaidAtTimestampLte, filter_uncollectible_at_timestamp_gte: filterUncollectibleAtTimestampGte, filter_uncollectible_at_timestamp_lte: filterUncollectibleAtTimestampLte, } = request;
|
|
383
388
|
const _queryParams = {};
|
|
384
389
|
if (sortBy !== undefined) {
|
|
385
390
|
_queryParams["sort_by"] = sortBy;
|
|
@@ -407,6 +412,9 @@ export class Statements {
|
|
|
407
412
|
if (filterOrderId !== undefined) {
|
|
408
413
|
_queryParams["filter_order_id"] = filterOrderId;
|
|
409
414
|
}
|
|
415
|
+
if (filterOrderOffChrtReferenceId !== undefined) {
|
|
416
|
+
_queryParams["filter_order_off_chrt_reference_id"] = filterOrderOffChrtReferenceId;
|
|
417
|
+
}
|
|
410
418
|
if (filterPaymentOriginOrgId !== undefined) {
|
|
411
419
|
_queryParams["filter_payment_origin_org_id"] = filterPaymentOriginOrgId;
|
|
412
420
|
}
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
11
11
|
* page_size: 1,
|
|
12
12
|
* filter_settlement_type: "stripe_connect",
|
|
13
13
|
* filter_order_id: "filter_order_id",
|
|
14
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
14
15
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
15
16
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
16
17
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -38,6 +39,8 @@ export interface StatementsExpandedListV1Request {
|
|
|
38
39
|
filter_settlement_type?: Chrt.SettlementTypeEnum1 | null;
|
|
39
40
|
/** Filter by order ID (returns statements whose order_ids list contains this value) */
|
|
40
41
|
filter_order_id?: string | null;
|
|
42
|
+
/** Filter by order off-chrt reference ID (returns statements whose order_off_chrt_reference_ids list contains this value) */
|
|
43
|
+
filter_order_off_chrt_reference_id?: string | null;
|
|
41
44
|
/** Filter by payment origin org ID */
|
|
42
45
|
filter_payment_origin_org_id?: string | null;
|
|
43
46
|
/** Filter by payment origin off-chrt shipper org ID */
|
|
@@ -11,6 +11,7 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
11
11
|
* page_size: 1,
|
|
12
12
|
* filter_settlement_type: "stripe_connect",
|
|
13
13
|
* filter_order_id: "filter_order_id",
|
|
14
|
+
* filter_order_off_chrt_reference_id: "filter_order_off_chrt_reference_id",
|
|
14
15
|
* filter_payment_origin_org_id: "filter_payment_origin_org_id",
|
|
15
16
|
* filter_payment_origin_off_chrt_shipper_org_id: "filter_payment_origin_off_chrt_shipper_org_id",
|
|
16
17
|
* filter_payment_destination_org_id: "filter_payment_destination_org_id",
|
|
@@ -38,6 +39,8 @@ export interface StatementsListV1Request {
|
|
|
38
39
|
filter_settlement_type?: Chrt.SettlementTypeEnum1 | null;
|
|
39
40
|
/** Filter by order ID (returns statements whose order_ids list contains this value) */
|
|
40
41
|
filter_order_id?: string | null;
|
|
42
|
+
/** Filter by order off-chrt reference ID (returns statements whose order_off_chrt_reference_ids list contains this value) */
|
|
43
|
+
filter_order_off_chrt_reference_id?: string | null;
|
|
41
44
|
/** Filter by payment origin org ID */
|
|
42
45
|
filter_payment_origin_org_id?: string | null;
|
|
43
46
|
/** Filter by payment origin off-chrt shipper org ID */
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../environments.mjs";
|
|
5
5
|
import * as core from "../../../../core/index.mjs";
|
|
6
|
+
import { Docs } from "../resources/docs/client/Client.mjs";
|
|
6
7
|
import { Drivers } from "../resources/drivers/client/Client.mjs";
|
|
7
8
|
import { Cargos } from "../resources/cargos/client/Client.mjs";
|
|
8
9
|
import { Flights } from "../resources/flights/client/Client.mjs";
|
|
@@ -24,6 +25,7 @@ export declare namespace Shipping {
|
|
|
24
25
|
}
|
|
25
26
|
export declare class Shipping {
|
|
26
27
|
protected readonly _options: Shipping.Options;
|
|
28
|
+
protected _docs: Docs | undefined;
|
|
27
29
|
protected _drivers: Drivers | undefined;
|
|
28
30
|
protected _cargos: Cargos | undefined;
|
|
29
31
|
protected _flights: Flights | undefined;
|
|
@@ -33,6 +35,7 @@ export declare class Shipping {
|
|
|
33
35
|
protected _taskGroups: TaskGroups | undefined;
|
|
34
36
|
protected _tasks: Tasks | undefined;
|
|
35
37
|
constructor(_options?: Shipping.Options);
|
|
38
|
+
get docs(): Docs;
|
|
36
39
|
get drivers(): Drivers;
|
|
37
40
|
get cargos(): Cargos;
|
|
38
41
|
get flights(): Flights;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import { Docs } from "../resources/docs/client/Client.mjs";
|
|
4
5
|
import { Drivers } from "../resources/drivers/client/Client.mjs";
|
|
5
6
|
import { Cargos } from "../resources/cargos/client/Client.mjs";
|
|
6
7
|
import { Flights } from "../resources/flights/client/Client.mjs";
|
|
@@ -13,6 +14,10 @@ export class Shipping {
|
|
|
13
14
|
constructor(_options = {}) {
|
|
14
15
|
this._options = _options;
|
|
15
16
|
}
|
|
17
|
+
get docs() {
|
|
18
|
+
var _a;
|
|
19
|
+
return ((_a = this._docs) !== null && _a !== void 0 ? _a : (this._docs = new Docs(this._options)));
|
|
20
|
+
}
|
|
16
21
|
get drivers() {
|
|
17
22
|
var _a;
|
|
18
23
|
return ((_a = this._drivers) !== null && _a !== void 0 ? _a : (this._drivers = new Drivers(this._options)));
|
|
@@ -0,0 +1,50 @@
|
|
|
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 Docs {
|
|
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 Docs {
|
|
31
|
+
protected readonly _options: Docs.Options;
|
|
32
|
+
constructor(_options?: Docs.Options);
|
|
33
|
+
/**
|
|
34
|
+
* Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
|
|
35
|
+
*
|
|
36
|
+
* @param {Chrt.shipping.GenerateShippingDocReq} request
|
|
37
|
+
* @param {Docs.RequestOptions} requestOptions - Request-specific configuration.
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* await client.shipping.docs.postGenerateV1({
|
|
43
|
+
* order_id_or_short_id: "order_id_or_short_id",
|
|
44
|
+
* template: "pod"
|
|
45
|
+
* })
|
|
46
|
+
*/
|
|
47
|
+
postGenerateV1(request: Chrt.shipping.GenerateShippingDocReq, requestOptions?: Docs.RequestOptions): core.HttpResponsePromise<unknown>;
|
|
48
|
+
private __postGenerateV1;
|
|
49
|
+
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
50
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
5
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
6
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
7
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
8
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
9
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
10
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
11
|
+
});
|
|
12
|
+
};
|
|
13
|
+
import * as environments from "../../../../../../environments.mjs";
|
|
14
|
+
import * as core from "../../../../../../core/index.mjs";
|
|
15
|
+
import * as Chrt from "../../../../../index.mjs";
|
|
16
|
+
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
|
+
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
|
+
export class Docs {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
|
+
this._options = _options;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Generates a shipping document (BOL or POD) as a PDF for the given order. | authz_personas=[order_creator_org_operators] | (GenerateShippingDocReq) -> (PDF binary)
|
|
24
|
+
*
|
|
25
|
+
* @param {Chrt.shipping.GenerateShippingDocReq} request
|
|
26
|
+
* @param {Docs.RequestOptions} requestOptions - Request-specific configuration.
|
|
27
|
+
*
|
|
28
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* await client.shipping.docs.postGenerateV1({
|
|
32
|
+
* order_id_or_short_id: "order_id_or_short_id",
|
|
33
|
+
* template: "pod"
|
|
34
|
+
* })
|
|
35
|
+
*/
|
|
36
|
+
postGenerateV1(request, requestOptions) {
|
|
37
|
+
return core.HttpResponsePromise.fromPromise(this.__postGenerateV1(request, requestOptions));
|
|
38
|
+
}
|
|
39
|
+
__postGenerateV1(request, requestOptions) {
|
|
40
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
41
|
+
var _a, _b, _c, _d;
|
|
42
|
+
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);
|
|
43
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
44
|
+
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/docs/v1"),
|
|
45
|
+
method: "POST",
|
|
46
|
+
headers: _headers,
|
|
47
|
+
contentType: "application/json",
|
|
48
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
49
|
+
requestType: "json",
|
|
50
|
+
body: request,
|
|
51
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
52
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
53
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
54
|
+
});
|
|
55
|
+
if (_response.ok) {
|
|
56
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
57
|
+
}
|
|
58
|
+
if (_response.error.reason === "status-code") {
|
|
59
|
+
switch (_response.error.statusCode) {
|
|
60
|
+
case 422:
|
|
61
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
62
|
+
default:
|
|
63
|
+
throw new errors.ChrtError({
|
|
64
|
+
statusCode: _response.error.statusCode,
|
|
65
|
+
body: _response.error.body,
|
|
66
|
+
rawResponse: _response.rawResponse,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
switch (_response.error.reason) {
|
|
71
|
+
case "non-json":
|
|
72
|
+
throw new errors.ChrtError({
|
|
73
|
+
statusCode: _response.error.statusCode,
|
|
74
|
+
body: _response.error.rawBody,
|
|
75
|
+
rawResponse: _response.rawResponse,
|
|
76
|
+
});
|
|
77
|
+
case "timeout":
|
|
78
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/docs/v1.");
|
|
79
|
+
case "unknown":
|
|
80
|
+
throw new errors.ChrtError({
|
|
81
|
+
message: _response.error.errorMessage,
|
|
82
|
+
rawResponse: _response.rawResponse,
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
_getAuthorizationHeader() {
|
|
88
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
89
|
+
const bearer = yield core.Supplier.get(this._options.token);
|
|
90
|
+
if (bearer != null) {
|
|
91
|
+
return `Bearer ${bearer}`;
|
|
92
|
+
}
|
|
93
|
+
return undefined;
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.mjs";
|
package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* order_id_or_short_id: "order_id_or_short_id",
|
|
9
|
+
* template: "pod"
|
|
10
|
+
* }
|
|
11
|
+
*/
|
|
12
|
+
export interface GenerateShippingDocReq {
|
|
13
|
+
order_id_or_short_id: string;
|
|
14
|
+
template: Chrt.ShippingDocTemplateEnum;
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type GenerateShippingDocReq } from "./GenerateShippingDocReq.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * as docs from "./docs/index.mjs";
|
|
1
2
|
export * as drivers from "./drivers/index.mjs";
|
|
2
3
|
export * as cargos from "./cargos/index.mjs";
|
|
3
4
|
export * as flights from "./flights/index.mjs";
|
|
@@ -6,8 +7,10 @@ export * as orders from "./orders/index.mjs";
|
|
|
6
7
|
export * as orderDrafts from "./orderDrafts/index.mjs";
|
|
7
8
|
export * as taskGroups from "./taskGroups/index.mjs";
|
|
8
9
|
export * as tasks from "./tasks/index.mjs";
|
|
10
|
+
export * from "./docs/client/requests/index.mjs";
|
|
9
11
|
export * from "./drivers/client/requests/index.mjs";
|
|
10
12
|
export * from "./taskArtifacts/client/requests/index.mjs";
|
|
13
|
+
export * from "./orders/client/requests/index.mjs";
|
|
11
14
|
export * from "./orderDrafts/client/requests/index.mjs";
|
|
12
15
|
export * from "./taskGroups/client/requests/index.mjs";
|
|
13
16
|
export * from "./tasks/client/requests/index.mjs";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * as docs from "./docs/index.mjs";
|
|
1
2
|
export * as drivers from "./drivers/index.mjs";
|
|
2
3
|
export * as cargos from "./cargos/index.mjs";
|
|
3
4
|
export * as flights from "./flights/index.mjs";
|
|
@@ -6,8 +7,10 @@ export * as orders from "./orders/index.mjs";
|
|
|
6
7
|
export * as orderDrafts from "./orderDrafts/index.mjs";
|
|
7
8
|
export * as taskGroups from "./taskGroups/index.mjs";
|
|
8
9
|
export * as tasks from "./tasks/index.mjs";
|
|
10
|
+
export * from "./docs/client/requests/index.mjs";
|
|
9
11
|
export * from "./drivers/client/requests/index.mjs";
|
|
10
12
|
export * from "./taskArtifacts/client/requests/index.mjs";
|
|
13
|
+
export * from "./orders/client/requests/index.mjs";
|
|
11
14
|
export * from "./orderDrafts/client/requests/index.mjs";
|
|
12
15
|
export * from "./taskGroups/client/requests/index.mjs";
|
|
13
16
|
export * from "./tasks/client/requests/index.mjs";
|
|
@@ -61,17 +61,16 @@ export declare class OrderDrafts {
|
|
|
61
61
|
/**
|
|
62
62
|
* Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
63
63
|
*
|
|
64
|
+
* @param {string} orderId
|
|
64
65
|
* @param {Chrt.shipping.OrdersDraftUpdateReq} request
|
|
65
66
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
68
69
|
*
|
|
69
70
|
* @example
|
|
70
|
-
* await client.shipping.orderDrafts.updateV1(
|
|
71
|
-
* order_id: "order_id"
|
|
72
|
-
* })
|
|
71
|
+
* await client.shipping.orderDrafts.updateV1("order_id")
|
|
73
72
|
*/
|
|
74
|
-
updateV1(
|
|
73
|
+
updateV1(orderId: string, request?: Chrt.shipping.OrdersDraftUpdateReq, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrdersDraftUpdateRes>;
|
|
75
74
|
private __updateV1;
|
|
76
75
|
/**
|
|
77
76
|
* Deletes a draft order and all associated entities. | () -> (bool)
|
|
@@ -87,7 +86,7 @@ export declare class OrderDrafts {
|
|
|
87
86
|
deleteV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
88
87
|
private __deleteV1;
|
|
89
88
|
/**
|
|
90
|
-
*
|
|
89
|
+
* Validates the draft order for staging and returns all issues found. | () -> (OrderDraftValidationResult)
|
|
91
90
|
*
|
|
92
91
|
* @param {string} orderId
|
|
93
92
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -97,7 +96,7 @@ export declare class OrderDrafts {
|
|
|
97
96
|
* @example
|
|
98
97
|
* await client.shipping.orderDrafts.validateV1("order_id")
|
|
99
98
|
*/
|
|
100
|
-
validateV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<
|
|
99
|
+
validateV1(orderId: string, requestOptions?: OrderDrafts.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftValidationResult>;
|
|
101
100
|
private __validateV1;
|
|
102
101
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
103
102
|
}
|
|
@@ -109,25 +109,24 @@ export class OrderDrafts {
|
|
|
109
109
|
/**
|
|
110
110
|
* Updates forwarder and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
111
111
|
*
|
|
112
|
+
* @param {string} orderId
|
|
112
113
|
* @param {Chrt.shipping.OrdersDraftUpdateReq} request
|
|
113
114
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
114
115
|
*
|
|
115
116
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
116
117
|
*
|
|
117
118
|
* @example
|
|
118
|
-
* await client.shipping.orderDrafts.updateV1(
|
|
119
|
-
* order_id: "order_id"
|
|
120
|
-
* })
|
|
119
|
+
* await client.shipping.orderDrafts.updateV1("order_id")
|
|
121
120
|
*/
|
|
122
|
-
updateV1(request, requestOptions) {
|
|
123
|
-
return core.HttpResponsePromise.fromPromise(this.__updateV1(request, requestOptions));
|
|
121
|
+
updateV1(orderId, request = {}, requestOptions) {
|
|
122
|
+
return core.HttpResponsePromise.fromPromise(this.__updateV1(orderId, request, requestOptions));
|
|
124
123
|
}
|
|
125
|
-
__updateV1(
|
|
126
|
-
return __awaiter(this,
|
|
124
|
+
__updateV1(orderId_1) {
|
|
125
|
+
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
127
126
|
var _a, _b, _c, _d;
|
|
128
127
|
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);
|
|
129
128
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
130
|
-
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,
|
|
129
|
+
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_drafts/update/v1/${encodeURIComponent(orderId)}`),
|
|
131
130
|
method: "PATCH",
|
|
132
131
|
headers: _headers,
|
|
133
132
|
contentType: "application/json",
|
|
@@ -161,7 +160,7 @@ export class OrderDrafts {
|
|
|
161
160
|
rawResponse: _response.rawResponse,
|
|
162
161
|
});
|
|
163
162
|
case "timeout":
|
|
164
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_drafts/update/v1.");
|
|
163
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/order_drafts/update/v1/{order_id}.");
|
|
165
164
|
case "unknown":
|
|
166
165
|
throw new errors.ChrtError({
|
|
167
166
|
message: _response.error.errorMessage,
|
|
@@ -230,7 +229,7 @@ export class OrderDrafts {
|
|
|
230
229
|
});
|
|
231
230
|
}
|
|
232
231
|
/**
|
|
233
|
-
*
|
|
232
|
+
* Validates the draft order for staging and returns all issues found. | () -> (OrderDraftValidationResult)
|
|
234
233
|
*
|
|
235
234
|
* @param {string} orderId
|
|
236
235
|
* @param {OrderDrafts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,18 +3,17 @@
|
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
|
-
* {
|
|
7
|
-
* order_id: "order_id"
|
|
8
|
-
* }
|
|
6
|
+
* {}
|
|
9
7
|
*/
|
|
10
8
|
export interface OrdersDraftUpdateReq {
|
|
11
|
-
order_id: string;
|
|
12
9
|
/** Must be a string starting with `org_` */
|
|
13
10
|
forwarder_org_id?: string | null;
|
|
11
|
+
forwarder_org_id__set_to_None?: boolean;
|
|
14
12
|
/** Must be a string starting with `org_` */
|
|
15
13
|
shipper_org_id?: string | null;
|
|
16
|
-
off_chrt_shipper_org_id?: string | null;
|
|
17
|
-
forwarder_org_id__set_to_None?: boolean;
|
|
18
14
|
shipper_org_id__set_to_None?: boolean;
|
|
15
|
+
off_chrt_shipper_org_id?: string | null;
|
|
19
16
|
off_chrt_shipper_org_id__set_to_None?: boolean;
|
|
17
|
+
off_chrt_reference_id?: string | null;
|
|
18
|
+
off_chrt_reference_id__set_to_None?: boolean;
|
|
20
19
|
}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as environments from "../../../../../../environments.mjs";
|
|
5
5
|
import * as core from "../../../../../../core/index.mjs";
|
|
6
|
+
import * as Chrt from "../../../../../index.mjs";
|
|
6
7
|
import { Expanded } from "../resources/expanded/client/Client.mjs";
|
|
7
8
|
export declare namespace Orders {
|
|
8
9
|
interface Options {
|
|
@@ -45,6 +46,20 @@ export declare class Orders {
|
|
|
45
46
|
*/
|
|
46
47
|
stageV1(orderId: string, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
47
48
|
private __stageV1;
|
|
49
|
+
/**
|
|
50
|
+
* Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
51
|
+
*
|
|
52
|
+
* @param {string} orderId
|
|
53
|
+
* @param {Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq} request
|
|
54
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* await client.shipping.orders.updateOffChrtReferenceIdV1("order_id")
|
|
60
|
+
*/
|
|
61
|
+
updateOffChrtReferenceIdV1(orderId: string, request?: Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq, requestOptions?: Orders.RequestOptions): core.HttpResponsePromise<Chrt.OrdersUpdateOffChrtReferenceIdRes>;
|
|
62
|
+
private __updateOffChrtReferenceIdV1;
|
|
48
63
|
/**
|
|
49
64
|
* Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
50
65
|
*
|
|
@@ -83,6 +83,72 @@ export class Orders {
|
|
|
83
83
|
}
|
|
84
84
|
});
|
|
85
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
88
|
+
*
|
|
89
|
+
* @param {string} orderId
|
|
90
|
+
* @param {Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq} request
|
|
91
|
+
* @param {Orders.RequestOptions} requestOptions - Request-specific configuration.
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* await client.shipping.orders.updateOffChrtReferenceIdV1("order_id")
|
|
97
|
+
*/
|
|
98
|
+
updateOffChrtReferenceIdV1(orderId, request = {}, requestOptions) {
|
|
99
|
+
return core.HttpResponsePromise.fromPromise(this.__updateOffChrtReferenceIdV1(orderId, request, requestOptions));
|
|
100
|
+
}
|
|
101
|
+
__updateOffChrtReferenceIdV1(orderId_1) {
|
|
102
|
+
return __awaiter(this, arguments, void 0, function* (orderId, request = {}, requestOptions) {
|
|
103
|
+
var _a, _b, _c, _d;
|
|
104
|
+
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);
|
|
105
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
106
|
+
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_off_chrt_reference_id/v1/${encodeURIComponent(orderId)}`),
|
|
107
|
+
method: "PATCH",
|
|
108
|
+
headers: _headers,
|
|
109
|
+
contentType: "application/json",
|
|
110
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
111
|
+
requestType: "json",
|
|
112
|
+
body: request,
|
|
113
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
114
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
115
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
116
|
+
});
|
|
117
|
+
if (_response.ok) {
|
|
118
|
+
return {
|
|
119
|
+
data: _response.body,
|
|
120
|
+
rawResponse: _response.rawResponse,
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
if (_response.error.reason === "status-code") {
|
|
124
|
+
switch (_response.error.statusCode) {
|
|
125
|
+
case 422:
|
|
126
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
127
|
+
default:
|
|
128
|
+
throw new errors.ChrtError({
|
|
129
|
+
statusCode: _response.error.statusCode,
|
|
130
|
+
body: _response.error.body,
|
|
131
|
+
rawResponse: _response.rawResponse,
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
switch (_response.error.reason) {
|
|
136
|
+
case "non-json":
|
|
137
|
+
throw new errors.ChrtError({
|
|
138
|
+
statusCode: _response.error.statusCode,
|
|
139
|
+
body: _response.error.rawBody,
|
|
140
|
+
rawResponse: _response.rawResponse,
|
|
141
|
+
});
|
|
142
|
+
case "timeout":
|
|
143
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/orders/update_off_chrt_reference_id/v1/{order_id}.");
|
|
144
|
+
case "unknown":
|
|
145
|
+
throw new errors.ChrtError({
|
|
146
|
+
message: _response.error.errorMessage,
|
|
147
|
+
rawResponse: _response.rawResponse,
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
}
|
|
86
152
|
/**
|
|
87
153
|
* Cancels an order and all related task groups and tasks in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
88
154
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export
|
|
1
|
+
export * from "./requests/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { type OrdersUpdateOffChrtReferenceIdReq } from "./OrdersUpdateOffChrtReferenceIdReq.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|