@chrt-inc/typescript-sdk 1.760.0 → 1.762.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/lineItemGroups/client/requests/LineItemGroupAdHocCreateClientReq.d.ts +2 -0
- package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementCreateClientReq.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +65 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseSetBillingReviewStatusReq.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/client/Client.js +7 -2
- package/dist/cjs/api/resources/orgs/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/index.js +3 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/Client.d.ts +106 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/Client.js +384 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.d.ts +15 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.ts +12 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtVendor/index.js +17 -0
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +18 -8
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +2 -2
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +5 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.d.ts +13 -19
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.js +41 -47
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/Client.d.ts +142 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/Client.js +530 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupClientCreate1.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupClientUpdate1.d.ts +12 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupSetBillingReviewStatusReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupSetBillingReviewStatusReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupsListV1Request.d.ts +30 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupsListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderGroups/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.js +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +7 -4
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +7 -2
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.d.ts +73 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.js +252 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsOrderGroupsListV1Request.d.ts +32 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsOrderGroupsListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsUngroupedOrdersListV1Request.d.ts +23 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsUngroupedOrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/ordersAndOrderGroups/index.js +17 -0
- 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/types/BillingReviewStatusEnum.d.ts +15 -0
- package/dist/cjs/api/types/BillingReviewStatusEnum.js +12 -0
- package/dist/cjs/api/types/Case1.d.ts +1 -0
- package/dist/cjs/api/types/{InternalDelegationTokenReq.d.ts → InternalDelegationJwtReq.d.ts} +2 -2
- package/dist/cjs/api/types/InternalDelegationJwtReq.js +5 -0
- package/dist/{esm/api/types/InternalDelegationTokenRes.d.mts → cjs/api/types/InternalDelegationJwtRes.d.ts} +1 -1
- package/dist/cjs/api/types/InternalDelegationJwtRes.js +5 -0
- package/dist/cjs/api/types/LineItemGroup1.d.ts +3 -0
- package/dist/cjs/api/types/OffChrtVendor1.d.ts +13 -0
- package/dist/cjs/api/types/OffChrtVendor1.js +5 -0
- package/dist/cjs/api/types/OffChrtVendorListRes.d.ts +8 -0
- package/dist/cjs/api/types/OffChrtVendorListRes.js +5 -0
- package/dist/cjs/api/types/Order1.d.ts +2 -0
- package/dist/cjs/api/types/OrderBuilderReq.d.ts +3 -2
- package/dist/cjs/api/types/OrderBuilderRes.d.ts +2 -2
- package/dist/cjs/api/types/OrderGroup1.d.ts +21 -0
- package/dist/cjs/api/types/OrderGroup1.js +5 -0
- package/dist/cjs/api/types/OrderGroupExpandedListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderGroupExpandedListRes.js +5 -0
- package/dist/cjs/api/types/OrderGroupExpandedRow.d.ts +9 -0
- package/dist/cjs/api/types/OrderGroupExpandedRow.js +5 -0
- package/dist/cjs/api/types/OrderGroupExpandedSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/OrderGroupExpandedSortByEnum.js +12 -0
- package/dist/cjs/api/types/OrderGroupListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderGroupListRes.js +5 -0
- package/dist/cjs/api/types/OrderGroupSortByEnum.d.ts +9 -0
- package/dist/cjs/api/types/OrderGroupSortByEnum.js +11 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +7 -4
- package/dist/cjs/api/types/OrderTemplateCore1.d.ts +21 -0
- package/dist/cjs/api/types/OrderTemplateCore1.js +5 -0
- package/dist/cjs/api/types/{OrderTemplateExpanded.d.ts → OrderTemplateExpanded1.d.ts} +4 -4
- package/dist/cjs/api/types/OrderTemplateExpanded1.js +5 -0
- package/dist/{esm/api/types/OrderTemplateOrgRef1.d.mts → cjs/api/types/OrderTemplateOrgInfo1.d.ts} +1 -1
- package/dist/cjs/api/types/OrderTemplateOrgInfo1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateResolvabilityRes.d.ts +10 -0
- package/dist/cjs/api/types/OrderTemplateResolvabilityRes.js +5 -0
- package/dist/cjs/api/types/ShippingTurnClientCreate1.d.ts +16 -0
- package/dist/cjs/api/types/ShippingTurnClientCreate1.js +5 -0
- package/dist/cjs/api/types/Statement1.d.ts +3 -0
- package/dist/cjs/api/types/UngroupedOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/UngroupedOrderListRes.js +5 -0
- package/dist/cjs/api/types/UngroupedOrderRow.d.ts +8 -0
- package/dist/cjs/api/types/UngroupedOrderRow.js +5 -0
- package/dist/cjs/api/types/UngroupedOrderSortByEnum.d.ts +11 -0
- package/dist/cjs/api/types/UngroupedOrderSortByEnum.js +13 -0
- package/dist/cjs/api/types/{WorkflowActorContext.d.ts → WorkflowActor.d.ts} +1 -1
- package/dist/cjs/api/types/WorkflowActor.js +5 -0
- package/dist/cjs/api/types/index.d.ts +20 -6
- package/dist/cjs/api/types/index.js +20 -6
- 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/lineItemGroups/client/requests/LineItemGroupAdHocCreateClientReq.d.mts +2 -0
- package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementCreateClientReq.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +65 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseSetBillingReviewStatusReq.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/orgs/client/Client.mjs +5 -0
- package/dist/esm/api/resources/orgs/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/index.mjs +2 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/Client.d.mts +106 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/Client.mjs +347 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/index.d.mts +2 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.d.mts +15 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.d.mts +12 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/offChrtVendor/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +10 -0
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +2 -2
- package/dist/esm/api/resources/shipping/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +5 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.d.mts +13 -19
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.mjs +41 -47
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/Client.d.mts +142 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/Client.mjs +493 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupClientCreate1.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupClientUpdate1.d.mts +12 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupSetBillingReviewStatusReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupSetBillingReviewStatusReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupsListV1Request.d.mts +30 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/OrderGroupsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderGroups/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.mjs +2 -2
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +7 -4
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +7 -2
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.d.mts +73 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.mjs +215 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsOrderGroupsListV1Request.d.mts +32 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsOrderGroupsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsUngroupedOrdersListV1Request.d.mts +23 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/OrdersAndOrderGroupsUngroupedOrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/ordersAndOrderGroups/index.mjs +1 -0
- 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/types/BillingReviewStatusEnum.d.mts +15 -0
- package/dist/esm/api/types/BillingReviewStatusEnum.mjs +9 -0
- package/dist/esm/api/types/Case1.d.mts +1 -0
- package/dist/esm/api/types/{InternalDelegationTokenReq.d.mts → InternalDelegationJwtReq.d.mts} +2 -2
- package/dist/esm/api/types/InternalDelegationJwtReq.mjs +4 -0
- package/dist/{cjs/api/types/InternalDelegationTokenRes.d.ts → esm/api/types/InternalDelegationJwtRes.d.mts} +1 -1
- package/dist/esm/api/types/InternalDelegationJwtRes.mjs +4 -0
- package/dist/esm/api/types/LineItemGroup1.d.mts +3 -0
- package/dist/esm/api/types/OffChrtVendor1.d.mts +13 -0
- package/dist/esm/api/types/OffChrtVendor1.mjs +4 -0
- package/dist/esm/api/types/OffChrtVendorListRes.d.mts +8 -0
- package/dist/esm/api/types/OffChrtVendorListRes.mjs +4 -0
- package/dist/esm/api/types/Order1.d.mts +2 -0
- package/dist/esm/api/types/OrderBuilderReq.d.mts +3 -2
- package/dist/esm/api/types/OrderBuilderRes.d.mts +2 -2
- package/dist/esm/api/types/OrderGroup1.d.mts +21 -0
- package/dist/esm/api/types/OrderGroup1.mjs +4 -0
- package/dist/esm/api/types/OrderGroupExpandedListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderGroupExpandedListRes.mjs +4 -0
- package/dist/esm/api/types/OrderGroupExpandedRow.d.mts +9 -0
- package/dist/esm/api/types/OrderGroupExpandedRow.mjs +4 -0
- package/dist/esm/api/types/OrderGroupExpandedSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/OrderGroupExpandedSortByEnum.mjs +9 -0
- package/dist/esm/api/types/OrderGroupListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderGroupListRes.mjs +4 -0
- package/dist/esm/api/types/OrderGroupSortByEnum.d.mts +9 -0
- package/dist/esm/api/types/OrderGroupSortByEnum.mjs +8 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +7 -4
- package/dist/esm/api/types/OrderTemplateCore1.d.mts +21 -0
- package/dist/esm/api/types/OrderTemplateCore1.mjs +4 -0
- package/dist/esm/api/types/{OrderTemplateExpanded.d.mts → OrderTemplateExpanded1.d.mts} +4 -4
- package/dist/esm/api/types/OrderTemplateExpanded1.mjs +4 -0
- package/dist/{cjs/api/types/OrderTemplateOrgRef1.d.ts → esm/api/types/OrderTemplateOrgInfo1.d.mts} +1 -1
- package/dist/esm/api/types/OrderTemplateOrgInfo1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateResolvabilityRes.d.mts +10 -0
- package/dist/esm/api/types/OrderTemplateResolvabilityRes.mjs +4 -0
- package/dist/esm/api/types/ShippingTurnClientCreate1.d.mts +16 -0
- package/dist/esm/api/types/ShippingTurnClientCreate1.mjs +4 -0
- package/dist/esm/api/types/Statement1.d.mts +3 -0
- package/dist/esm/api/types/UngroupedOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/UngroupedOrderListRes.mjs +4 -0
- package/dist/esm/api/types/UngroupedOrderRow.d.mts +8 -0
- package/dist/esm/api/types/UngroupedOrderRow.mjs +4 -0
- package/dist/esm/api/types/UngroupedOrderSortByEnum.d.mts +11 -0
- package/dist/esm/api/types/UngroupedOrderSortByEnum.mjs +10 -0
- package/dist/esm/api/types/{WorkflowActorContext.d.mts → WorkflowActor.d.mts} +1 -1
- package/dist/esm/api/types/WorkflowActor.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +20 -6
- package/dist/esm/api/types/index.mjs +20 -6
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1456 -432
- package/dist/cjs/api/types/OrderBuilderPrecheckRes.d.ts +0 -7
- package/dist/esm/api/types/OrderBuilderPrecheckRes.d.mts +0 -7
- /package/dist/cjs/api/{types/InternalDelegationTokenReq.js → resources/operations/resources/cases/client/requests/CaseSetBillingReviewStatusReq.js} +0 -0
- /package/dist/cjs/api/{types/InternalDelegationTokenRes.js → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.js} +0 -0
- /package/dist/cjs/api/{types/OrderBuilderPrecheckRes.js → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.js} +0 -0
- /package/dist/cjs/api/{types/OrderTemplateExpanded.js → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.js} +0 -0
- /package/dist/cjs/api/{types/OrderTemplateOrgRef1.js → resources/shipping/resources/orderGroups/client/requests/OrderGroupClientCreate1.js} +0 -0
- /package/dist/cjs/api/{types/WorkflowActorContext.js → resources/shipping/resources/orderGroups/client/requests/OrderGroupClientUpdate1.js} +0 -0
- /package/dist/esm/api/{types/InternalDelegationTokenReq.mjs → resources/operations/resources/cases/client/requests/CaseSetBillingReviewStatusReq.mjs} +0 -0
- /package/dist/esm/api/{types/InternalDelegationTokenRes.mjs → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientCreate1.mjs} +0 -0
- /package/dist/esm/api/{types/OrderBuilderPrecheckRes.mjs → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/{types/OrderTemplateExpanded.mjs → resources/orgs/resources/offChrtVendor/client/requests/OffChrtVendorListV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/OrderTemplateOrgRef1.mjs → resources/shipping/resources/orderGroups/client/requests/OrderGroupClientCreate1.mjs} +0 -0
- /package/dist/esm/api/{types/WorkflowActorContext.mjs → resources/shipping/resources/orderGroups/client/requests/OrderGroupClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -11474,6 +11474,79 @@ await client.operations.cases.getSuggestedDepartmentV1("case_id");
|
|
|
11474
11474
|
</dl>
|
|
11475
11475
|
</details>
|
|
11476
11476
|
|
|
11477
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">setBillingReviewStatusV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11478
|
+
<dl>
|
|
11479
|
+
<dd>
|
|
11480
|
+
|
|
11481
|
+
#### 📝 Description
|
|
11482
|
+
|
|
11483
|
+
<dl>
|
|
11484
|
+
<dd>
|
|
11485
|
+
|
|
11486
|
+
<dl>
|
|
11487
|
+
<dd>
|
|
11488
|
+
|
|
11489
|
+
Sets the case's operator billing-review status. | authz: min_org_role=operator | (CaseSetBillingReviewStatusReq) -> (bool)
|
|
11490
|
+
|
|
11491
|
+
</dd>
|
|
11492
|
+
</dl>
|
|
11493
|
+
</dd>
|
|
11494
|
+
</dl>
|
|
11495
|
+
|
|
11496
|
+
#### 🔌 Usage
|
|
11497
|
+
|
|
11498
|
+
<dl>
|
|
11499
|
+
<dd>
|
|
11500
|
+
|
|
11501
|
+
<dl>
|
|
11502
|
+
<dd>
|
|
11503
|
+
|
|
11504
|
+
```typescript
|
|
11505
|
+
await client.operations.cases.setBillingReviewStatusV1("case_id", {
|
|
11506
|
+
billing_review_status: "not_started",
|
|
11507
|
+
});
|
|
11508
|
+
```
|
|
11509
|
+
|
|
11510
|
+
</dd>
|
|
11511
|
+
</dl>
|
|
11512
|
+
</dd>
|
|
11513
|
+
</dl>
|
|
11514
|
+
|
|
11515
|
+
#### ⚙️ Parameters
|
|
11516
|
+
|
|
11517
|
+
<dl>
|
|
11518
|
+
<dd>
|
|
11519
|
+
|
|
11520
|
+
<dl>
|
|
11521
|
+
<dd>
|
|
11522
|
+
|
|
11523
|
+
**caseId:** `string`
|
|
11524
|
+
|
|
11525
|
+
</dd>
|
|
11526
|
+
</dl>
|
|
11527
|
+
|
|
11528
|
+
<dl>
|
|
11529
|
+
<dd>
|
|
11530
|
+
|
|
11531
|
+
**request:** `Chrt.operations.CaseSetBillingReviewStatusReq`
|
|
11532
|
+
|
|
11533
|
+
</dd>
|
|
11534
|
+
</dl>
|
|
11535
|
+
|
|
11536
|
+
<dl>
|
|
11537
|
+
<dd>
|
|
11538
|
+
|
|
11539
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11540
|
+
|
|
11541
|
+
</dd>
|
|
11542
|
+
</dl>
|
|
11543
|
+
</dd>
|
|
11544
|
+
</dl>
|
|
11545
|
+
|
|
11546
|
+
</dd>
|
|
11547
|
+
</dl>
|
|
11548
|
+
</details>
|
|
11549
|
+
|
|
11477
11550
|
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">assignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11478
11551
|
<dl>
|
|
11479
11552
|
<dd>
|
|
@@ -15880,9 +15953,9 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
15880
15953
|
</dl>
|
|
15881
15954
|
</details>
|
|
15882
15955
|
|
|
15883
|
-
## Orgs
|
|
15956
|
+
## Orgs OffChrtVendor
|
|
15884
15957
|
|
|
15885
|
-
<details><summary><code>client.orgs.
|
|
15958
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15886
15959
|
<dl>
|
|
15887
15960
|
<dd>
|
|
15888
15961
|
|
|
@@ -15894,7 +15967,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
15894
15967
|
<dl>
|
|
15895
15968
|
<dd>
|
|
15896
15969
|
|
|
15897
|
-
|
|
15970
|
+
Creates an off-platform vendor shell owned by the caller's org. Used as an off-CHRT billing payment destination (e.g. an airline). | (OffChrtVendorClientCreate1) -> (PydanticObjectId)
|
|
15898
15971
|
|
|
15899
15972
|
</dd>
|
|
15900
15973
|
</dl>
|
|
@@ -15910,7 +15983,10 @@ Retrieves metadata for an organization compliance document S3 object. | authz: a
|
|
|
15910
15983
|
<dd>
|
|
15911
15984
|
|
|
15912
15985
|
```typescript
|
|
15913
|
-
await client.orgs.
|
|
15986
|
+
await client.orgs.offChrtVendor.createV1({
|
|
15987
|
+
schema_version: 1,
|
|
15988
|
+
name: "name",
|
|
15989
|
+
});
|
|
15914
15990
|
```
|
|
15915
15991
|
|
|
15916
15992
|
</dd>
|
|
@@ -15926,7 +16002,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15926
16002
|
<dl>
|
|
15927
16003
|
<dd>
|
|
15928
16004
|
|
|
15929
|
-
**
|
|
16005
|
+
**request:** `Chrt.orgs.OffChrtVendorClientCreate1`
|
|
15930
16006
|
|
|
15931
16007
|
</dd>
|
|
15932
16008
|
</dl>
|
|
@@ -15934,7 +16010,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15934
16010
|
<dl>
|
|
15935
16011
|
<dd>
|
|
15936
16012
|
|
|
15937
|
-
**requestOptions:** `
|
|
16013
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
15938
16014
|
|
|
15939
16015
|
</dd>
|
|
15940
16016
|
</dl>
|
|
@@ -15945,7 +16021,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15945
16021
|
</dl>
|
|
15946
16022
|
</details>
|
|
15947
16023
|
|
|
15948
|
-
<details><summary><code>client.orgs.
|
|
16024
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OffChrtVendorListRes</code></summary>
|
|
15949
16025
|
<dl>
|
|
15950
16026
|
<dd>
|
|
15951
16027
|
|
|
@@ -15957,7 +16033,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15957
16033
|
<dl>
|
|
15958
16034
|
<dd>
|
|
15959
16035
|
|
|
15960
|
-
|
|
16036
|
+
Lists all off-chrt vendors created by the caller's organization. Pagination only — no search/filter. | () -> (OffChrtVendorListRes)
|
|
15961
16037
|
|
|
15962
16038
|
</dd>
|
|
15963
16039
|
</dl>
|
|
@@ -15973,7 +16049,10 @@ Streams an organization compliance document S3 object file from storage. | authz
|
|
|
15973
16049
|
<dd>
|
|
15974
16050
|
|
|
15975
16051
|
```typescript
|
|
15976
|
-
await client.orgs.
|
|
16052
|
+
await client.orgs.offChrtVendor.listV1({
|
|
16053
|
+
page: 1,
|
|
16054
|
+
page_size: 1,
|
|
16055
|
+
});
|
|
15977
16056
|
```
|
|
15978
16057
|
|
|
15979
16058
|
</dd>
|
|
@@ -15989,7 +16068,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
15989
16068
|
<dl>
|
|
15990
16069
|
<dd>
|
|
15991
16070
|
|
|
15992
|
-
**
|
|
16071
|
+
**request:** `Chrt.orgs.OffChrtVendorListV1Request`
|
|
15993
16072
|
|
|
15994
16073
|
</dd>
|
|
15995
16074
|
</dl>
|
|
@@ -15997,7 +16076,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
15997
16076
|
<dl>
|
|
15998
16077
|
<dd>
|
|
15999
16078
|
|
|
16000
|
-
**requestOptions:** `
|
|
16079
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16001
16080
|
|
|
16002
16081
|
</dd>
|
|
16003
16082
|
</dl>
|
|
@@ -16008,7 +16087,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16008
16087
|
</dl>
|
|
16009
16088
|
</details>
|
|
16010
16089
|
|
|
16011
|
-
<details><summary><code>client.orgs.
|
|
16090
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">getByIdV1</a>(id) -> Chrt.OffChrtVendor1</code></summary>
|
|
16012
16091
|
<dl>
|
|
16013
16092
|
<dd>
|
|
16014
16093
|
|
|
@@ -16020,7 +16099,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16020
16099
|
<dl>
|
|
16021
16100
|
<dd>
|
|
16022
16101
|
|
|
16023
|
-
|
|
16102
|
+
Retrieves a specific off-chrt vendor by ID. Scoped to the caller's org. | () -> (OffChrtVendor1)
|
|
16024
16103
|
|
|
16025
16104
|
</dd>
|
|
16026
16105
|
</dl>
|
|
@@ -16036,9 +16115,7 @@ Uploads a file to an organization compliance document. Automatic blurhash genera
|
|
|
16036
16115
|
<dd>
|
|
16037
16116
|
|
|
16038
16117
|
```typescript
|
|
16039
|
-
await client.orgs.
|
|
16040
|
-
file: fs.createReadStream("/path/to/your/file"),
|
|
16041
|
-
});
|
|
16118
|
+
await client.orgs.offChrtVendor.getByIdV1("id");
|
|
16042
16119
|
```
|
|
16043
16120
|
|
|
16044
16121
|
</dd>
|
|
@@ -16054,15 +16131,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16054
16131
|
<dl>
|
|
16055
16132
|
<dd>
|
|
16056
16133
|
|
|
16057
|
-
**
|
|
16058
|
-
|
|
16059
|
-
</dd>
|
|
16060
|
-
</dl>
|
|
16061
|
-
|
|
16062
|
-
<dl>
|
|
16063
|
-
<dd>
|
|
16064
|
-
|
|
16065
|
-
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16134
|
+
**id:** `string`
|
|
16066
16135
|
|
|
16067
16136
|
</dd>
|
|
16068
16137
|
</dl>
|
|
@@ -16070,7 +16139,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16070
16139
|
<dl>
|
|
16071
16140
|
<dd>
|
|
16072
16141
|
|
|
16073
|
-
**requestOptions:** `
|
|
16142
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16074
16143
|
|
|
16075
16144
|
</dd>
|
|
16076
16145
|
</dl>
|
|
@@ -16081,7 +16150,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16081
16150
|
</dl>
|
|
16082
16151
|
</details>
|
|
16083
16152
|
|
|
16084
|
-
<details><summary><code>client.orgs.
|
|
16153
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
16085
16154
|
<dl>
|
|
16086
16155
|
<dd>
|
|
16087
16156
|
|
|
@@ -16093,7 +16162,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16093
16162
|
<dl>
|
|
16094
16163
|
<dd>
|
|
16095
16164
|
|
|
16096
|
-
Deletes an
|
|
16165
|
+
Deletes an off-chrt vendor owned by the caller's organization. Existing LineItemGroups / Statements keep their snapshotted destination id; deletion does not cascade. | () -> (bool)
|
|
16097
16166
|
|
|
16098
16167
|
</dd>
|
|
16099
16168
|
</dl>
|
|
@@ -16109,7 +16178,7 @@ Deletes an organization compliance document S3 object and metadata. | authz: all
|
|
|
16109
16178
|
<dd>
|
|
16110
16179
|
|
|
16111
16180
|
```typescript
|
|
16112
|
-
await client.orgs.
|
|
16181
|
+
await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
16113
16182
|
```
|
|
16114
16183
|
|
|
16115
16184
|
</dd>
|
|
@@ -16125,7 +16194,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16125
16194
|
<dl>
|
|
16126
16195
|
<dd>
|
|
16127
16196
|
|
|
16128
|
-
**
|
|
16197
|
+
**id:** `string`
|
|
16129
16198
|
|
|
16130
16199
|
</dd>
|
|
16131
16200
|
</dl>
|
|
@@ -16133,7 +16202,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16133
16202
|
<dl>
|
|
16134
16203
|
<dd>
|
|
16135
16204
|
|
|
16136
|
-
**requestOptions:** `
|
|
16205
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16137
16206
|
|
|
16138
16207
|
</dd>
|
|
16139
16208
|
</dl>
|
|
@@ -16144,9 +16213,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16144
16213
|
</dl>
|
|
16145
16214
|
</details>
|
|
16146
16215
|
|
|
16147
|
-
|
|
16148
|
-
|
|
16149
|
-
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
16216
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">updateByIdV1</a>(id, { ...params }) -> boolean</code></summary>
|
|
16150
16217
|
<dl>
|
|
16151
16218
|
<dd>
|
|
16152
16219
|
|
|
@@ -16158,7 +16225,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16158
16225
|
<dl>
|
|
16159
16226
|
<dd>
|
|
16160
16227
|
|
|
16161
|
-
|
|
16228
|
+
Updates an existing off-chrt vendor owned by the caller's organization. | (OffChrtVendorClientUpdate1) -> (bool)
|
|
16162
16229
|
|
|
16163
16230
|
</dd>
|
|
16164
16231
|
</dl>
|
|
@@ -16174,7 +16241,7 @@ Retrieves shipper organization connection information for the caller's organizat
|
|
|
16174
16241
|
<dd>
|
|
16175
16242
|
|
|
16176
16243
|
```typescript
|
|
16177
|
-
await client.orgs.
|
|
16244
|
+
await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
16178
16245
|
```
|
|
16179
16246
|
|
|
16180
16247
|
</dd>
|
|
@@ -16190,7 +16257,23 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16190
16257
|
<dl>
|
|
16191
16258
|
<dd>
|
|
16192
16259
|
|
|
16193
|
-
**
|
|
16260
|
+
**id:** `string`
|
|
16261
|
+
|
|
16262
|
+
</dd>
|
|
16263
|
+
</dl>
|
|
16264
|
+
|
|
16265
|
+
<dl>
|
|
16266
|
+
<dd>
|
|
16267
|
+
|
|
16268
|
+
**request:** `Chrt.orgs.OffChrtVendorClientUpdate1`
|
|
16269
|
+
|
|
16270
|
+
</dd>
|
|
16271
|
+
</dl>
|
|
16272
|
+
|
|
16273
|
+
<dl>
|
|
16274
|
+
<dd>
|
|
16275
|
+
|
|
16276
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16194
16277
|
|
|
16195
16278
|
</dd>
|
|
16196
16279
|
</dl>
|
|
@@ -16201,7 +16284,9 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16201
16284
|
</dl>
|
|
16202
16285
|
</details>
|
|
16203
16286
|
|
|
16204
|
-
|
|
16287
|
+
## Orgs ComplianceDocuments S3Object
|
|
16288
|
+
|
|
16289
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> Chrt.OrgComplianceDocumentS3ObjectMetadata1</code></summary>
|
|
16205
16290
|
<dl>
|
|
16206
16291
|
<dd>
|
|
16207
16292
|
|
|
@@ -16213,7 +16298,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16213
16298
|
<dl>
|
|
16214
16299
|
<dd>
|
|
16215
16300
|
|
|
16216
|
-
|
|
16301
|
+
Retrieves metadata for an organization compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (OrgComplianceDocumentS3ObjectMetadata1)
|
|
16217
16302
|
|
|
16218
16303
|
</dd>
|
|
16219
16304
|
</dl>
|
|
@@ -16229,10 +16314,7 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
16229
16314
|
<dd>
|
|
16230
16315
|
|
|
16231
16316
|
```typescript
|
|
16232
|
-
await client.orgs.
|
|
16233
|
-
schema_version: 1,
|
|
16234
|
-
email_address_primary: "email_address_primary",
|
|
16235
|
-
});
|
|
16317
|
+
await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compliance_document_s3_object_metadata_id");
|
|
16236
16318
|
```
|
|
16237
16319
|
|
|
16238
16320
|
</dd>
|
|
@@ -16248,7 +16330,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16248
16330
|
<dl>
|
|
16249
16331
|
<dd>
|
|
16250
16332
|
|
|
16251
|
-
**
|
|
16333
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16252
16334
|
|
|
16253
16335
|
</dd>
|
|
16254
16336
|
</dl>
|
|
@@ -16256,7 +16338,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16256
16338
|
<dl>
|
|
16257
16339
|
<dd>
|
|
16258
16340
|
|
|
16259
|
-
**requestOptions:** `
|
|
16341
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16260
16342
|
|
|
16261
16343
|
</dd>
|
|
16262
16344
|
</dl>
|
|
@@ -16267,7 +16349,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16267
16349
|
</dl>
|
|
16268
16350
|
</details>
|
|
16269
16351
|
|
|
16270
|
-
<details><summary><code>client.orgs.
|
|
16352
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">getV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
16271
16353
|
<dl>
|
|
16272
16354
|
<dd>
|
|
16273
16355
|
|
|
@@ -16279,7 +16361,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16279
16361
|
<dl>
|
|
16280
16362
|
<dd>
|
|
16281
16363
|
|
|
16282
|
-
|
|
16364
|
+
Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
|
|
16283
16365
|
|
|
16284
16366
|
</dd>
|
|
16285
16367
|
</dl>
|
|
@@ -16295,7 +16377,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
16295
16377
|
<dd>
|
|
16296
16378
|
|
|
16297
16379
|
```typescript
|
|
16298
|
-
await client.orgs.
|
|
16380
|
+
await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3_object_metadata_id");
|
|
16299
16381
|
```
|
|
16300
16382
|
|
|
16301
16383
|
</dd>
|
|
@@ -16311,7 +16393,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16311
16393
|
<dl>
|
|
16312
16394
|
<dd>
|
|
16313
16395
|
|
|
16314
|
-
**
|
|
16396
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16315
16397
|
|
|
16316
16398
|
</dd>
|
|
16317
16399
|
</dl>
|
|
@@ -16319,7 +16401,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16319
16401
|
<dl>
|
|
16320
16402
|
<dd>
|
|
16321
16403
|
|
|
16322
|
-
**requestOptions:** `
|
|
16404
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16323
16405
|
|
|
16324
16406
|
</dd>
|
|
16325
16407
|
</dl>
|
|
@@ -16330,9 +16412,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16330
16412
|
</dl>
|
|
16331
16413
|
</details>
|
|
16332
16414
|
|
|
16333
|
-
|
|
16334
|
-
|
|
16335
|
-
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
|
|
16415
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">addV1</a>(orgComplianceDocumentId, { ...params }) -> boolean</code></summary>
|
|
16336
16416
|
<dl>
|
|
16337
16417
|
<dd>
|
|
16338
16418
|
|
|
@@ -16344,7 +16424,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16344
16424
|
<dl>
|
|
16345
16425
|
<dd>
|
|
16346
16426
|
|
|
16347
|
-
|
|
16427
|
+
Uploads a file to an organization compliance document. Automatic blurhash generation for images. | authz: allowed_org_types=[provider], min_org_role=administrator | (UploadFile) -> (bool)
|
|
16348
16428
|
|
|
16349
16429
|
</dd>
|
|
16350
16430
|
</dl>
|
|
@@ -16360,7 +16440,9 @@ Retrieves provider organization connection information for the caller's organiza
|
|
|
16360
16440
|
<dd>
|
|
16361
16441
|
|
|
16362
16442
|
```typescript
|
|
16363
|
-
await client.orgs.
|
|
16443
|
+
await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id", {
|
|
16444
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
16445
|
+
});
|
|
16364
16446
|
```
|
|
16365
16447
|
|
|
16366
16448
|
</dd>
|
|
@@ -16376,7 +16458,23 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16376
16458
|
<dl>
|
|
16377
16459
|
<dd>
|
|
16378
16460
|
|
|
16379
|
-
**
|
|
16461
|
+
**orgComplianceDocumentId:** `string`
|
|
16462
|
+
|
|
16463
|
+
</dd>
|
|
16464
|
+
</dl>
|
|
16465
|
+
|
|
16466
|
+
<dl>
|
|
16467
|
+
<dd>
|
|
16468
|
+
|
|
16469
|
+
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16470
|
+
|
|
16471
|
+
</dd>
|
|
16472
|
+
</dl>
|
|
16473
|
+
|
|
16474
|
+
<dl>
|
|
16475
|
+
<dd>
|
|
16476
|
+
|
|
16477
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16380
16478
|
|
|
16381
16479
|
</dd>
|
|
16382
16480
|
</dl>
|
|
@@ -16387,7 +16485,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16387
16485
|
</dl>
|
|
16388
16486
|
</details>
|
|
16389
16487
|
|
|
16390
|
-
<details><summary><code>client.orgs.
|
|
16488
|
+
<details><summary><code>client.orgs.complianceDocuments.s3Object.<a href="/src/api/resources/orgs/resources/complianceDocuments/resources/s3Object/client/Client.ts">deleteV1</a>(orgComplianceDocumentS3ObjectMetadataId) -> boolean</code></summary>
|
|
16391
16489
|
<dl>
|
|
16392
16490
|
<dd>
|
|
16393
16491
|
|
|
@@ -16399,7 +16497,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16399
16497
|
<dl>
|
|
16400
16498
|
<dd>
|
|
16401
16499
|
|
|
16402
|
-
|
|
16500
|
+
Deletes an organization compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
|
|
16403
16501
|
|
|
16404
16502
|
</dd>
|
|
16405
16503
|
</dl>
|
|
@@ -16415,7 +16513,7 @@ Retrieves list of provider org info documents for providers connected to the cal
|
|
|
16415
16513
|
<dd>
|
|
16416
16514
|
|
|
16417
16515
|
```typescript
|
|
16418
|
-
await client.orgs.
|
|
16516
|
+
await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document_s3_object_metadata_id");
|
|
16419
16517
|
```
|
|
16420
16518
|
|
|
16421
16519
|
</dd>
|
|
@@ -16431,7 +16529,15 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16431
16529
|
<dl>
|
|
16432
16530
|
<dd>
|
|
16433
16531
|
|
|
16434
|
-
**
|
|
16532
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16533
|
+
|
|
16534
|
+
</dd>
|
|
16535
|
+
</dl>
|
|
16536
|
+
|
|
16537
|
+
<dl>
|
|
16538
|
+
<dd>
|
|
16539
|
+
|
|
16540
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16435
16541
|
|
|
16436
16542
|
</dd>
|
|
16437
16543
|
</dl>
|
|
@@ -16442,7 +16548,9 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16442
16548
|
</dl>
|
|
16443
16549
|
</details>
|
|
16444
16550
|
|
|
16445
|
-
|
|
16551
|
+
## Orgs OrgInfoForConnections Shipper
|
|
16552
|
+
|
|
16553
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">getV1</a>() -> Chrt.ShipperOrgInfoForConnections1</code></summary>
|
|
16446
16554
|
<dl>
|
|
16447
16555
|
<dd>
|
|
16448
16556
|
|
|
@@ -16454,7 +16562,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16454
16562
|
<dl>
|
|
16455
16563
|
<dd>
|
|
16456
16564
|
|
|
16457
|
-
|
|
16565
|
+
Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
|
|
16458
16566
|
|
|
16459
16567
|
</dd>
|
|
16460
16568
|
</dl>
|
|
@@ -16470,10 +16578,7 @@ Creates provider organization connection information. Fails if already exists. |
|
|
|
16470
16578
|
<dd>
|
|
16471
16579
|
|
|
16472
16580
|
```typescript
|
|
16473
|
-
await client.orgs.orgInfoForConnections.
|
|
16474
|
-
schema_version: 1,
|
|
16475
|
-
email_address_primary: "email_address_primary",
|
|
16476
|
-
});
|
|
16581
|
+
await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
16477
16582
|
```
|
|
16478
16583
|
|
|
16479
16584
|
</dd>
|
|
@@ -16489,15 +16594,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16489
16594
|
<dl>
|
|
16490
16595
|
<dd>
|
|
16491
16596
|
|
|
16492
|
-
**
|
|
16493
|
-
|
|
16494
|
-
</dd>
|
|
16495
|
-
</dl>
|
|
16496
|
-
|
|
16497
|
-
<dl>
|
|
16498
|
-
<dd>
|
|
16499
|
-
|
|
16500
|
-
**requestOptions:** `Provider.RequestOptions`
|
|
16597
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16501
16598
|
|
|
16502
16599
|
</dd>
|
|
16503
16600
|
</dl>
|
|
@@ -16508,7 +16605,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16508
16605
|
</dl>
|
|
16509
16606
|
</details>
|
|
16510
16607
|
|
|
16511
|
-
<details><summary><code>client.orgs.orgInfoForConnections.
|
|
16608
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
16512
16609
|
<dl>
|
|
16513
16610
|
<dd>
|
|
16514
16611
|
|
|
@@ -16520,7 +16617,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16520
16617
|
<dl>
|
|
16521
16618
|
<dd>
|
|
16522
16619
|
|
|
16523
|
-
|
|
16620
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16524
16621
|
|
|
16525
16622
|
</dd>
|
|
16526
16623
|
</dl>
|
|
@@ -16536,7 +16633,10 @@ Updates existing provider organization connection information. | (ProviderOrgInf
|
|
|
16536
16633
|
<dd>
|
|
16537
16634
|
|
|
16538
16635
|
```typescript
|
|
16539
|
-
await client.orgs.orgInfoForConnections.
|
|
16636
|
+
await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
16637
|
+
schema_version: 1,
|
|
16638
|
+
email_address_primary: "email_address_primary",
|
|
16639
|
+
});
|
|
16540
16640
|
```
|
|
16541
16641
|
|
|
16542
16642
|
</dd>
|
|
@@ -16552,7 +16652,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16552
16652
|
<dl>
|
|
16553
16653
|
<dd>
|
|
16554
16654
|
|
|
16555
|
-
**request:** `Chrt.orgs.orgInfoForConnections.
|
|
16655
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
16556
16656
|
|
|
16557
16657
|
</dd>
|
|
16558
16658
|
</dl>
|
|
@@ -16560,7 +16660,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16560
16660
|
<dl>
|
|
16561
16661
|
<dd>
|
|
16562
16662
|
|
|
16563
|
-
**requestOptions:** `
|
|
16663
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16564
16664
|
|
|
16565
16665
|
</dd>
|
|
16566
16666
|
</dl>
|
|
@@ -16571,9 +16671,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16571
16671
|
</dl>
|
|
16572
16672
|
</details>
|
|
16573
16673
|
|
|
16574
|
-
|
|
16575
|
-
|
|
16576
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getStatsV1</a>(driverId, { ...params }) -> Chrt.DriverStatsRes</code></summary>
|
|
16674
|
+
<details><summary><code>client.orgs.orgInfoForConnections.shipper.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/shipper/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
16577
16675
|
<dl>
|
|
16578
16676
|
<dd>
|
|
16579
16677
|
|
|
@@ -16585,7 +16683,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16585
16683
|
<dl>
|
|
16586
16684
|
<dd>
|
|
16587
16685
|
|
|
16588
|
-
|
|
16686
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16589
16687
|
|
|
16590
16688
|
</dd>
|
|
16591
16689
|
</dl>
|
|
@@ -16601,10 +16699,7 @@ Retrieves driver stats for a time window: overlap-corrected hours worked, total
|
|
|
16601
16699
|
<dd>
|
|
16602
16700
|
|
|
16603
16701
|
```typescript
|
|
16604
|
-
await client.
|
|
16605
|
-
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16606
|
-
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16607
|
-
});
|
|
16702
|
+
await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
16608
16703
|
```
|
|
16609
16704
|
|
|
16610
16705
|
</dd>
|
|
@@ -16620,15 +16715,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16620
16715
|
<dl>
|
|
16621
16716
|
<dd>
|
|
16622
16717
|
|
|
16623
|
-
**
|
|
16624
|
-
|
|
16625
|
-
</dd>
|
|
16626
|
-
</dl>
|
|
16627
|
-
|
|
16628
|
-
<dl>
|
|
16629
|
-
<dd>
|
|
16630
|
-
|
|
16631
|
-
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16718
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
16632
16719
|
|
|
16633
16720
|
</dd>
|
|
16634
16721
|
</dl>
|
|
@@ -16636,7 +16723,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16636
16723
|
<dl>
|
|
16637
16724
|
<dd>
|
|
16638
16725
|
|
|
16639
|
-
**requestOptions:** `
|
|
16726
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16640
16727
|
|
|
16641
16728
|
</dd>
|
|
16642
16729
|
</dl>
|
|
@@ -16647,8 +16734,761 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16647
16734
|
</dl>
|
|
16648
16735
|
</details>
|
|
16649
16736
|
|
|
16650
|
-
|
|
16651
|
-
|
|
16737
|
+
## Orgs OrgInfoForConnections Provider
|
|
16738
|
+
|
|
16739
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">getV1</a>() -> Chrt.ProviderOrgInfoForConnections1</code></summary>
|
|
16740
|
+
<dl>
|
|
16741
|
+
<dd>
|
|
16742
|
+
|
|
16743
|
+
#### 📝 Description
|
|
16744
|
+
|
|
16745
|
+
<dl>
|
|
16746
|
+
<dd>
|
|
16747
|
+
|
|
16748
|
+
<dl>
|
|
16749
|
+
<dd>
|
|
16750
|
+
|
|
16751
|
+
Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
|
|
16752
|
+
|
|
16753
|
+
</dd>
|
|
16754
|
+
</dl>
|
|
16755
|
+
</dd>
|
|
16756
|
+
</dl>
|
|
16757
|
+
|
|
16758
|
+
#### 🔌 Usage
|
|
16759
|
+
|
|
16760
|
+
<dl>
|
|
16761
|
+
<dd>
|
|
16762
|
+
|
|
16763
|
+
<dl>
|
|
16764
|
+
<dd>
|
|
16765
|
+
|
|
16766
|
+
```typescript
|
|
16767
|
+
await client.orgs.orgInfoForConnections.provider.getV1();
|
|
16768
|
+
```
|
|
16769
|
+
|
|
16770
|
+
</dd>
|
|
16771
|
+
</dl>
|
|
16772
|
+
</dd>
|
|
16773
|
+
</dl>
|
|
16774
|
+
|
|
16775
|
+
#### ⚙️ Parameters
|
|
16776
|
+
|
|
16777
|
+
<dl>
|
|
16778
|
+
<dd>
|
|
16779
|
+
|
|
16780
|
+
<dl>
|
|
16781
|
+
<dd>
|
|
16782
|
+
|
|
16783
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16784
|
+
|
|
16785
|
+
</dd>
|
|
16786
|
+
</dl>
|
|
16787
|
+
</dd>
|
|
16788
|
+
</dl>
|
|
16789
|
+
|
|
16790
|
+
</dd>
|
|
16791
|
+
</dl>
|
|
16792
|
+
</details>
|
|
16793
|
+
|
|
16794
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">listV1</a>() -> Chrt.ProviderOrgInfoForConnections1[]</code></summary>
|
|
16795
|
+
<dl>
|
|
16796
|
+
<dd>
|
|
16797
|
+
|
|
16798
|
+
#### 📝 Description
|
|
16799
|
+
|
|
16800
|
+
<dl>
|
|
16801
|
+
<dd>
|
|
16802
|
+
|
|
16803
|
+
<dl>
|
|
16804
|
+
<dd>
|
|
16805
|
+
|
|
16806
|
+
Retrieves list of provider org info documents for providers connected to the caller. Shippers see providers via shipper_provider_connections; providers see other providers via provider_provider_connections (in either direction). | () -> (list[ProviderOrgInfoForConnections1])
|
|
16807
|
+
|
|
16808
|
+
</dd>
|
|
16809
|
+
</dl>
|
|
16810
|
+
</dd>
|
|
16811
|
+
</dl>
|
|
16812
|
+
|
|
16813
|
+
#### 🔌 Usage
|
|
16814
|
+
|
|
16815
|
+
<dl>
|
|
16816
|
+
<dd>
|
|
16817
|
+
|
|
16818
|
+
<dl>
|
|
16819
|
+
<dd>
|
|
16820
|
+
|
|
16821
|
+
```typescript
|
|
16822
|
+
await client.orgs.orgInfoForConnections.provider.listV1();
|
|
16823
|
+
```
|
|
16824
|
+
|
|
16825
|
+
</dd>
|
|
16826
|
+
</dl>
|
|
16827
|
+
</dd>
|
|
16828
|
+
</dl>
|
|
16829
|
+
|
|
16830
|
+
#### ⚙️ Parameters
|
|
16831
|
+
|
|
16832
|
+
<dl>
|
|
16833
|
+
<dd>
|
|
16834
|
+
|
|
16835
|
+
<dl>
|
|
16836
|
+
<dd>
|
|
16837
|
+
|
|
16838
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16839
|
+
|
|
16840
|
+
</dd>
|
|
16841
|
+
</dl>
|
|
16842
|
+
</dd>
|
|
16843
|
+
</dl>
|
|
16844
|
+
|
|
16845
|
+
</dd>
|
|
16846
|
+
</dl>
|
|
16847
|
+
</details>
|
|
16848
|
+
|
|
16849
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
16850
|
+
<dl>
|
|
16851
|
+
<dd>
|
|
16852
|
+
|
|
16853
|
+
#### 📝 Description
|
|
16854
|
+
|
|
16855
|
+
<dl>
|
|
16856
|
+
<dd>
|
|
16857
|
+
|
|
16858
|
+
<dl>
|
|
16859
|
+
<dd>
|
|
16860
|
+
|
|
16861
|
+
Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16862
|
+
|
|
16863
|
+
</dd>
|
|
16864
|
+
</dl>
|
|
16865
|
+
</dd>
|
|
16866
|
+
</dl>
|
|
16867
|
+
|
|
16868
|
+
#### 🔌 Usage
|
|
16869
|
+
|
|
16870
|
+
<dl>
|
|
16871
|
+
<dd>
|
|
16872
|
+
|
|
16873
|
+
<dl>
|
|
16874
|
+
<dd>
|
|
16875
|
+
|
|
16876
|
+
```typescript
|
|
16877
|
+
await client.orgs.orgInfoForConnections.provider.createV1({
|
|
16878
|
+
schema_version: 1,
|
|
16879
|
+
email_address_primary: "email_address_primary",
|
|
16880
|
+
});
|
|
16881
|
+
```
|
|
16882
|
+
|
|
16883
|
+
</dd>
|
|
16884
|
+
</dl>
|
|
16885
|
+
</dd>
|
|
16886
|
+
</dl>
|
|
16887
|
+
|
|
16888
|
+
#### ⚙️ Parameters
|
|
16889
|
+
|
|
16890
|
+
<dl>
|
|
16891
|
+
<dd>
|
|
16892
|
+
|
|
16893
|
+
<dl>
|
|
16894
|
+
<dd>
|
|
16895
|
+
|
|
16896
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
|
|
16897
|
+
|
|
16898
|
+
</dd>
|
|
16899
|
+
</dl>
|
|
16900
|
+
|
|
16901
|
+
<dl>
|
|
16902
|
+
<dd>
|
|
16903
|
+
|
|
16904
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16905
|
+
|
|
16906
|
+
</dd>
|
|
16907
|
+
</dl>
|
|
16908
|
+
</dd>
|
|
16909
|
+
</dl>
|
|
16910
|
+
|
|
16911
|
+
</dd>
|
|
16912
|
+
</dl>
|
|
16913
|
+
</details>
|
|
16914
|
+
|
|
16915
|
+
<details><summary><code>client.orgs.orgInfoForConnections.provider.<a href="/src/api/resources/orgs/resources/orgInfoForConnections/resources/provider/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
16916
|
+
<dl>
|
|
16917
|
+
<dd>
|
|
16918
|
+
|
|
16919
|
+
#### 📝 Description
|
|
16920
|
+
|
|
16921
|
+
<dl>
|
|
16922
|
+
<dd>
|
|
16923
|
+
|
|
16924
|
+
<dl>
|
|
16925
|
+
<dd>
|
|
16926
|
+
|
|
16927
|
+
Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16928
|
+
|
|
16929
|
+
</dd>
|
|
16930
|
+
</dl>
|
|
16931
|
+
</dd>
|
|
16932
|
+
</dl>
|
|
16933
|
+
|
|
16934
|
+
#### 🔌 Usage
|
|
16935
|
+
|
|
16936
|
+
<dl>
|
|
16937
|
+
<dd>
|
|
16938
|
+
|
|
16939
|
+
<dl>
|
|
16940
|
+
<dd>
|
|
16941
|
+
|
|
16942
|
+
```typescript
|
|
16943
|
+
await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
16944
|
+
```
|
|
16945
|
+
|
|
16946
|
+
</dd>
|
|
16947
|
+
</dl>
|
|
16948
|
+
</dd>
|
|
16949
|
+
</dl>
|
|
16950
|
+
|
|
16951
|
+
#### ⚙️ Parameters
|
|
16952
|
+
|
|
16953
|
+
<dl>
|
|
16954
|
+
<dd>
|
|
16955
|
+
|
|
16956
|
+
<dl>
|
|
16957
|
+
<dd>
|
|
16958
|
+
|
|
16959
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
|
|
16960
|
+
|
|
16961
|
+
</dd>
|
|
16962
|
+
</dl>
|
|
16963
|
+
|
|
16964
|
+
<dl>
|
|
16965
|
+
<dd>
|
|
16966
|
+
|
|
16967
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16968
|
+
|
|
16969
|
+
</dd>
|
|
16970
|
+
</dl>
|
|
16971
|
+
</dd>
|
|
16972
|
+
</dl>
|
|
16973
|
+
|
|
16974
|
+
</dd>
|
|
16975
|
+
</dl>
|
|
16976
|
+
</details>
|
|
16977
|
+
|
|
16978
|
+
## Shipping Drivers
|
|
16979
|
+
|
|
16980
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getStatsV1</a>(driverId, { ...params }) -> Chrt.DriverStatsRes</code></summary>
|
|
16981
|
+
<dl>
|
|
16982
|
+
<dd>
|
|
16983
|
+
|
|
16984
|
+
#### 📝 Description
|
|
16985
|
+
|
|
16986
|
+
<dl>
|
|
16987
|
+
<dd>
|
|
16988
|
+
|
|
16989
|
+
<dl>
|
|
16990
|
+
<dd>
|
|
16991
|
+
|
|
16992
|
+
Retrieves driver stats for a time window: overlap-corrected hours worked, total GPS mileage, and mileage restricted to worked task-group intervals. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
16993
|
+
|
|
16994
|
+
</dd>
|
|
16995
|
+
</dl>
|
|
16996
|
+
</dd>
|
|
16997
|
+
</dl>
|
|
16998
|
+
|
|
16999
|
+
#### 🔌 Usage
|
|
17000
|
+
|
|
17001
|
+
<dl>
|
|
17002
|
+
<dd>
|
|
17003
|
+
|
|
17004
|
+
<dl>
|
|
17005
|
+
<dd>
|
|
17006
|
+
|
|
17007
|
+
```typescript
|
|
17008
|
+
await client.shipping.drivers.getStatsV1("driver_id", {
|
|
17009
|
+
start_timestamp: "2024-01-15T09:30:00Z",
|
|
17010
|
+
end_timestamp: "2024-01-15T09:30:00Z",
|
|
17011
|
+
});
|
|
17012
|
+
```
|
|
17013
|
+
|
|
17014
|
+
</dd>
|
|
17015
|
+
</dl>
|
|
17016
|
+
</dd>
|
|
17017
|
+
</dl>
|
|
17018
|
+
|
|
17019
|
+
#### ⚙️ Parameters
|
|
17020
|
+
|
|
17021
|
+
<dl>
|
|
17022
|
+
<dd>
|
|
17023
|
+
|
|
17024
|
+
<dl>
|
|
17025
|
+
<dd>
|
|
17026
|
+
|
|
17027
|
+
**driverId:** `string`
|
|
17028
|
+
|
|
17029
|
+
</dd>
|
|
17030
|
+
</dl>
|
|
17031
|
+
|
|
17032
|
+
<dl>
|
|
17033
|
+
<dd>
|
|
17034
|
+
|
|
17035
|
+
**request:** `Chrt.shipping.DriverStatsReq`
|
|
17036
|
+
|
|
17037
|
+
</dd>
|
|
17038
|
+
</dl>
|
|
17039
|
+
|
|
17040
|
+
<dl>
|
|
17041
|
+
<dd>
|
|
17042
|
+
|
|
17043
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17044
|
+
|
|
17045
|
+
</dd>
|
|
17046
|
+
</dl>
|
|
17047
|
+
</dd>
|
|
17048
|
+
</dl>
|
|
17049
|
+
|
|
17050
|
+
</dd>
|
|
17051
|
+
</dl>
|
|
17052
|
+
</details>
|
|
17053
|
+
|
|
17054
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
17055
|
+
<dl>
|
|
17056
|
+
<dd>
|
|
17057
|
+
|
|
17058
|
+
#### 📝 Description
|
|
17059
|
+
|
|
17060
|
+
<dl>
|
|
17061
|
+
<dd>
|
|
17062
|
+
|
|
17063
|
+
<dl>
|
|
17064
|
+
<dd>
|
|
17065
|
+
|
|
17066
|
+
Retrieves a driver's self-report for a single calendar day. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileage1)
|
|
17067
|
+
|
|
17068
|
+
</dd>
|
|
17069
|
+
</dl>
|
|
17070
|
+
</dd>
|
|
17071
|
+
</dl>
|
|
17072
|
+
|
|
17073
|
+
#### 🔌 Usage
|
|
17074
|
+
|
|
17075
|
+
<dl>
|
|
17076
|
+
<dd>
|
|
17077
|
+
|
|
17078
|
+
<dl>
|
|
17079
|
+
<dd>
|
|
17080
|
+
|
|
17081
|
+
```typescript
|
|
17082
|
+
await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17083
|
+
```
|
|
17084
|
+
|
|
17085
|
+
</dd>
|
|
17086
|
+
</dl>
|
|
17087
|
+
</dd>
|
|
17088
|
+
</dl>
|
|
17089
|
+
|
|
17090
|
+
#### ⚙️ Parameters
|
|
17091
|
+
|
|
17092
|
+
<dl>
|
|
17093
|
+
<dd>
|
|
17094
|
+
|
|
17095
|
+
<dl>
|
|
17096
|
+
<dd>
|
|
17097
|
+
|
|
17098
|
+
**driverId:** `string`
|
|
17099
|
+
|
|
17100
|
+
</dd>
|
|
17101
|
+
</dl>
|
|
17102
|
+
|
|
17103
|
+
<dl>
|
|
17104
|
+
<dd>
|
|
17105
|
+
|
|
17106
|
+
**reportDate:** `string`
|
|
17107
|
+
|
|
17108
|
+
</dd>
|
|
17109
|
+
</dl>
|
|
17110
|
+
|
|
17111
|
+
<dl>
|
|
17112
|
+
<dd>
|
|
17113
|
+
|
|
17114
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17115
|
+
|
|
17116
|
+
</dd>
|
|
17117
|
+
</dl>
|
|
17118
|
+
</dd>
|
|
17119
|
+
</dl>
|
|
17120
|
+
|
|
17121
|
+
</dd>
|
|
17122
|
+
</dl>
|
|
17123
|
+
</details>
|
|
17124
|
+
|
|
17125
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listSelfReportedHoursAndMileageV1</a>(driverId, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
17126
|
+
<dl>
|
|
17127
|
+
<dd>
|
|
17128
|
+
|
|
17129
|
+
#### 📝 Description
|
|
17130
|
+
|
|
17131
|
+
<dl>
|
|
17132
|
+
<dd>
|
|
17133
|
+
|
|
17134
|
+
<dl>
|
|
17135
|
+
<dd>
|
|
17136
|
+
|
|
17137
|
+
Lists a driver's self-reports across an optional date range with sorting and pagination. Caller must be the driver themselves or an operator+ in the driver's org. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
17138
|
+
|
|
17139
|
+
</dd>
|
|
17140
|
+
</dl>
|
|
17141
|
+
</dd>
|
|
17142
|
+
</dl>
|
|
17143
|
+
|
|
17144
|
+
#### 🔌 Usage
|
|
17145
|
+
|
|
17146
|
+
<dl>
|
|
17147
|
+
<dd>
|
|
17148
|
+
|
|
17149
|
+
<dl>
|
|
17150
|
+
<dd>
|
|
17151
|
+
|
|
17152
|
+
```typescript
|
|
17153
|
+
await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
17154
|
+
filter_start_date: "filter_start_date",
|
|
17155
|
+
filter_end_date: "filter_end_date",
|
|
17156
|
+
sort_order: "asc",
|
|
17157
|
+
page: 1,
|
|
17158
|
+
page_size: 1,
|
|
17159
|
+
});
|
|
17160
|
+
```
|
|
17161
|
+
|
|
17162
|
+
</dd>
|
|
17163
|
+
</dl>
|
|
17164
|
+
</dd>
|
|
17165
|
+
</dl>
|
|
17166
|
+
|
|
17167
|
+
#### ⚙️ Parameters
|
|
17168
|
+
|
|
17169
|
+
<dl>
|
|
17170
|
+
<dd>
|
|
17171
|
+
|
|
17172
|
+
<dl>
|
|
17173
|
+
<dd>
|
|
17174
|
+
|
|
17175
|
+
**driverId:** `string`
|
|
17176
|
+
|
|
17177
|
+
</dd>
|
|
17178
|
+
</dl>
|
|
17179
|
+
|
|
17180
|
+
<dl>
|
|
17181
|
+
<dd>
|
|
17182
|
+
|
|
17183
|
+
**request:** `Chrt.shipping.DriversListSelfReportedHoursAndMileageV1Request`
|
|
17184
|
+
|
|
17185
|
+
</dd>
|
|
17186
|
+
</dl>
|
|
17187
|
+
|
|
17188
|
+
<dl>
|
|
17189
|
+
<dd>
|
|
17190
|
+
|
|
17191
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17192
|
+
|
|
17193
|
+
</dd>
|
|
17194
|
+
</dl>
|
|
17195
|
+
</dd>
|
|
17196
|
+
</dl>
|
|
17197
|
+
|
|
17198
|
+
</dd>
|
|
17199
|
+
</dl>
|
|
17200
|
+
</details>
|
|
17201
|
+
|
|
17202
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">orgListSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
17203
|
+
<dl>
|
|
17204
|
+
<dd>
|
|
17205
|
+
|
|
17206
|
+
#### 📝 Description
|
|
17207
|
+
|
|
17208
|
+
<dl>
|
|
17209
|
+
<dd>
|
|
17210
|
+
|
|
17211
|
+
<dl>
|
|
17212
|
+
<dd>
|
|
17213
|
+
|
|
17214
|
+
Lists all drivers' self-reports in the caller's org with date-range filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (DriverSelfReportedHoursAndMileageListRes)
|
|
17215
|
+
|
|
17216
|
+
</dd>
|
|
17217
|
+
</dl>
|
|
17218
|
+
</dd>
|
|
17219
|
+
</dl>
|
|
17220
|
+
|
|
17221
|
+
#### 🔌 Usage
|
|
17222
|
+
|
|
17223
|
+
<dl>
|
|
17224
|
+
<dd>
|
|
17225
|
+
|
|
17226
|
+
<dl>
|
|
17227
|
+
<dd>
|
|
17228
|
+
|
|
17229
|
+
```typescript
|
|
17230
|
+
await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
17231
|
+
filter_driver_id: "filter_driver_id",
|
|
17232
|
+
filter_start_date: "filter_start_date",
|
|
17233
|
+
filter_end_date: "filter_end_date",
|
|
17234
|
+
sort_by: "date",
|
|
17235
|
+
sort_order: "asc",
|
|
17236
|
+
page: 1,
|
|
17237
|
+
page_size: 1,
|
|
17238
|
+
});
|
|
17239
|
+
```
|
|
17240
|
+
|
|
17241
|
+
</dd>
|
|
17242
|
+
</dl>
|
|
17243
|
+
</dd>
|
|
17244
|
+
</dl>
|
|
17245
|
+
|
|
17246
|
+
#### ⚙️ Parameters
|
|
17247
|
+
|
|
17248
|
+
<dl>
|
|
17249
|
+
<dd>
|
|
17250
|
+
|
|
17251
|
+
<dl>
|
|
17252
|
+
<dd>
|
|
17253
|
+
|
|
17254
|
+
**request:** `Chrt.shipping.DriversOrgListSelfReportedHoursAndMileageV1Request`
|
|
17255
|
+
|
|
17256
|
+
</dd>
|
|
17257
|
+
</dl>
|
|
17258
|
+
|
|
17259
|
+
<dl>
|
|
17260
|
+
<dd>
|
|
17261
|
+
|
|
17262
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17263
|
+
|
|
17264
|
+
</dd>
|
|
17265
|
+
</dl>
|
|
17266
|
+
</dd>
|
|
17267
|
+
</dl>
|
|
17268
|
+
|
|
17269
|
+
</dd>
|
|
17270
|
+
</dl>
|
|
17271
|
+
</details>
|
|
17272
|
+
|
|
17273
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
17274
|
+
<dl>
|
|
17275
|
+
<dd>
|
|
17276
|
+
|
|
17277
|
+
#### 📝 Description
|
|
17278
|
+
|
|
17279
|
+
<dl>
|
|
17280
|
+
<dd>
|
|
17281
|
+
|
|
17282
|
+
<dl>
|
|
17283
|
+
<dd>
|
|
17284
|
+
|
|
17285
|
+
Creates a driver's self-reported hours worked and miles driven for a single calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientCreate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
17286
|
+
|
|
17287
|
+
</dd>
|
|
17288
|
+
</dl>
|
|
17289
|
+
</dd>
|
|
17290
|
+
</dl>
|
|
17291
|
+
|
|
17292
|
+
#### 🔌 Usage
|
|
17293
|
+
|
|
17294
|
+
<dl>
|
|
17295
|
+
<dd>
|
|
17296
|
+
|
|
17297
|
+
<dl>
|
|
17298
|
+
<dd>
|
|
17299
|
+
|
|
17300
|
+
```typescript
|
|
17301
|
+
await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
17302
|
+
schema_version: 1,
|
|
17303
|
+
driver_id: "driver_id",
|
|
17304
|
+
date: "date",
|
|
17305
|
+
});
|
|
17306
|
+
```
|
|
17307
|
+
|
|
17308
|
+
</dd>
|
|
17309
|
+
</dl>
|
|
17310
|
+
</dd>
|
|
17311
|
+
</dl>
|
|
17312
|
+
|
|
17313
|
+
#### ⚙️ Parameters
|
|
17314
|
+
|
|
17315
|
+
<dl>
|
|
17316
|
+
<dd>
|
|
17317
|
+
|
|
17318
|
+
<dl>
|
|
17319
|
+
<dd>
|
|
17320
|
+
|
|
17321
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientCreate1`
|
|
17322
|
+
|
|
17323
|
+
</dd>
|
|
17324
|
+
</dl>
|
|
17325
|
+
|
|
17326
|
+
<dl>
|
|
17327
|
+
<dd>
|
|
17328
|
+
|
|
17329
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17330
|
+
|
|
17331
|
+
</dd>
|
|
17332
|
+
</dl>
|
|
17333
|
+
</dd>
|
|
17334
|
+
</dl>
|
|
17335
|
+
|
|
17336
|
+
</dd>
|
|
17337
|
+
</dl>
|
|
17338
|
+
</details>
|
|
17339
|
+
|
|
17340
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateSelfReportedHoursAndMileageV1</a>(driverId, reportDate, { ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
17341
|
+
<dl>
|
|
17342
|
+
<dd>
|
|
17343
|
+
|
|
17344
|
+
#### 📝 Description
|
|
17345
|
+
|
|
17346
|
+
<dl>
|
|
17347
|
+
<dd>
|
|
17348
|
+
|
|
17349
|
+
<dl>
|
|
17350
|
+
<dd>
|
|
17351
|
+
|
|
17352
|
+
Partially updates a driver's self-reported hours worked and/or miles driven for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | (DriverSelfReportedHoursAndMileageClientUpdate1) -> (DriverSelfReportedHoursAndMileage1)
|
|
17353
|
+
|
|
17354
|
+
</dd>
|
|
17355
|
+
</dl>
|
|
17356
|
+
</dd>
|
|
17357
|
+
</dl>
|
|
17358
|
+
|
|
17359
|
+
#### 🔌 Usage
|
|
17360
|
+
|
|
17361
|
+
<dl>
|
|
17362
|
+
<dd>
|
|
17363
|
+
|
|
17364
|
+
<dl>
|
|
17365
|
+
<dd>
|
|
17366
|
+
|
|
17367
|
+
```typescript
|
|
17368
|
+
await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17369
|
+
```
|
|
17370
|
+
|
|
17371
|
+
</dd>
|
|
17372
|
+
</dl>
|
|
17373
|
+
</dd>
|
|
17374
|
+
</dl>
|
|
17375
|
+
|
|
17376
|
+
#### ⚙️ Parameters
|
|
17377
|
+
|
|
17378
|
+
<dl>
|
|
17379
|
+
<dd>
|
|
17380
|
+
|
|
17381
|
+
<dl>
|
|
17382
|
+
<dd>
|
|
17383
|
+
|
|
17384
|
+
**driverId:** `string`
|
|
17385
|
+
|
|
17386
|
+
</dd>
|
|
17387
|
+
</dl>
|
|
17388
|
+
|
|
17389
|
+
<dl>
|
|
17390
|
+
<dd>
|
|
17391
|
+
|
|
17392
|
+
**reportDate:** `string`
|
|
17393
|
+
|
|
17394
|
+
</dd>
|
|
17395
|
+
</dl>
|
|
17396
|
+
|
|
17397
|
+
<dl>
|
|
17398
|
+
<dd>
|
|
17399
|
+
|
|
17400
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientUpdate1`
|
|
17401
|
+
|
|
17402
|
+
</dd>
|
|
17403
|
+
</dl>
|
|
17404
|
+
|
|
17405
|
+
<dl>
|
|
17406
|
+
<dd>
|
|
17407
|
+
|
|
17408
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17409
|
+
|
|
17410
|
+
</dd>
|
|
17411
|
+
</dl>
|
|
17412
|
+
</dd>
|
|
17413
|
+
</dl>
|
|
17414
|
+
|
|
17415
|
+
</dd>
|
|
17416
|
+
</dl>
|
|
17417
|
+
</details>
|
|
17418
|
+
|
|
17419
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">deleteSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> boolean</code></summary>
|
|
17420
|
+
<dl>
|
|
17421
|
+
<dd>
|
|
17422
|
+
|
|
17423
|
+
#### 📝 Description
|
|
17424
|
+
|
|
17425
|
+
<dl>
|
|
17426
|
+
<dd>
|
|
17427
|
+
|
|
17428
|
+
<dl>
|
|
17429
|
+
<dd>
|
|
17430
|
+
|
|
17431
|
+
Permanently deletes a driver's self-report for a calendar day. Caller must be the driver themselves. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (bool)
|
|
17432
|
+
|
|
17433
|
+
</dd>
|
|
17434
|
+
</dl>
|
|
17435
|
+
</dd>
|
|
17436
|
+
</dl>
|
|
17437
|
+
|
|
17438
|
+
#### 🔌 Usage
|
|
17439
|
+
|
|
17440
|
+
<dl>
|
|
17441
|
+
<dd>
|
|
17442
|
+
|
|
17443
|
+
<dl>
|
|
17444
|
+
<dd>
|
|
17445
|
+
|
|
17446
|
+
```typescript
|
|
17447
|
+
await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17448
|
+
```
|
|
17449
|
+
|
|
17450
|
+
</dd>
|
|
17451
|
+
</dl>
|
|
17452
|
+
</dd>
|
|
17453
|
+
</dl>
|
|
17454
|
+
|
|
17455
|
+
#### ⚙️ Parameters
|
|
17456
|
+
|
|
17457
|
+
<dl>
|
|
17458
|
+
<dd>
|
|
17459
|
+
|
|
17460
|
+
<dl>
|
|
17461
|
+
<dd>
|
|
17462
|
+
|
|
17463
|
+
**driverId:** `string`
|
|
17464
|
+
|
|
17465
|
+
</dd>
|
|
17466
|
+
</dl>
|
|
17467
|
+
|
|
17468
|
+
<dl>
|
|
17469
|
+
<dd>
|
|
17470
|
+
|
|
17471
|
+
**reportDate:** `string`
|
|
17472
|
+
|
|
17473
|
+
</dd>
|
|
17474
|
+
</dl>
|
|
17475
|
+
|
|
17476
|
+
<dl>
|
|
17477
|
+
<dd>
|
|
17478
|
+
|
|
17479
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17480
|
+
|
|
17481
|
+
</dd>
|
|
17482
|
+
</dl>
|
|
17483
|
+
</dd>
|
|
17484
|
+
</dl>
|
|
17485
|
+
|
|
17486
|
+
</dd>
|
|
17487
|
+
</dl>
|
|
17488
|
+
</details>
|
|
17489
|
+
|
|
17490
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
17491
|
+
<dl>
|
|
16652
17492
|
<dd>
|
|
16653
17493
|
|
|
16654
17494
|
#### 📝 Description
|
|
@@ -16659,7 +17499,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16659
17499
|
<dl>
|
|
16660
17500
|
<dd>
|
|
16661
17501
|
|
|
16662
|
-
Retrieves
|
|
17502
|
+
Retrieves driver information for the caller within their organization. | () -> (Driver1)
|
|
16663
17503
|
|
|
16664
17504
|
</dd>
|
|
16665
17505
|
</dl>
|
|
@@ -16675,7 +17515,7 @@ Retrieves a driver's self-report for a single calendar day. Caller must be the d
|
|
|
16675
17515
|
<dd>
|
|
16676
17516
|
|
|
16677
17517
|
```typescript
|
|
16678
|
-
await client.shipping.drivers.
|
|
17518
|
+
await client.shipping.drivers.getForCallerV1();
|
|
16679
17519
|
```
|
|
16680
17520
|
|
|
16681
17521
|
</dd>
|
|
@@ -16691,15 +17531,62 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16691
17531
|
<dl>
|
|
16692
17532
|
<dd>
|
|
16693
17533
|
|
|
16694
|
-
**
|
|
17534
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17535
|
+
|
|
17536
|
+
</dd>
|
|
17537
|
+
</dl>
|
|
17538
|
+
</dd>
|
|
17539
|
+
</dl>
|
|
16695
17540
|
|
|
16696
17541
|
</dd>
|
|
16697
17542
|
</dl>
|
|
17543
|
+
</details>
|
|
16698
17544
|
|
|
17545
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
|
|
16699
17546
|
<dl>
|
|
16700
17547
|
<dd>
|
|
16701
17548
|
|
|
16702
|
-
|
|
17549
|
+
#### 📝 Description
|
|
17550
|
+
|
|
17551
|
+
<dl>
|
|
17552
|
+
<dd>
|
|
17553
|
+
|
|
17554
|
+
<dl>
|
|
17555
|
+
<dd>
|
|
17556
|
+
|
|
17557
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
|
|
17558
|
+
|
|
17559
|
+
</dd>
|
|
17560
|
+
</dl>
|
|
17561
|
+
</dd>
|
|
17562
|
+
</dl>
|
|
17563
|
+
|
|
17564
|
+
#### 🔌 Usage
|
|
17565
|
+
|
|
17566
|
+
<dl>
|
|
17567
|
+
<dd>
|
|
17568
|
+
|
|
17569
|
+
<dl>
|
|
17570
|
+
<dd>
|
|
17571
|
+
|
|
17572
|
+
```typescript
|
|
17573
|
+
await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
17574
|
+
```
|
|
17575
|
+
|
|
17576
|
+
</dd>
|
|
17577
|
+
</dl>
|
|
17578
|
+
</dd>
|
|
17579
|
+
</dl>
|
|
17580
|
+
|
|
17581
|
+
#### ⚙️ Parameters
|
|
17582
|
+
|
|
17583
|
+
<dl>
|
|
17584
|
+
<dd>
|
|
17585
|
+
|
|
17586
|
+
<dl>
|
|
17587
|
+
<dd>
|
|
17588
|
+
|
|
17589
|
+
**driverId:** `string`
|
|
16703
17590
|
|
|
16704
17591
|
</dd>
|
|
16705
17592
|
</dl>
|
|
@@ -16718,7 +17605,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16718
17605
|
</dl>
|
|
16719
17606
|
</details>
|
|
16720
17607
|
|
|
16721
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17608
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
|
|
16722
17609
|
<dl>
|
|
16723
17610
|
<dd>
|
|
16724
17611
|
|
|
@@ -16730,7 +17617,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16730
17617
|
<dl>
|
|
16731
17618
|
<dd>
|
|
16732
17619
|
|
|
16733
|
-
Lists
|
|
17620
|
+
Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
16734
17621
|
|
|
16735
17622
|
</dd>
|
|
16736
17623
|
</dl>
|
|
@@ -16746,9 +17633,11 @@ Lists a driver's self-reports across an optional date range with sorting and pag
|
|
|
16746
17633
|
<dd>
|
|
16747
17634
|
|
|
16748
17635
|
```typescript
|
|
16749
|
-
await client.shipping.drivers.
|
|
16750
|
-
|
|
16751
|
-
|
|
17636
|
+
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
17637
|
+
search: "search",
|
|
17638
|
+
filter_available_according_to_driver: true,
|
|
17639
|
+
filter_available_according_to_operators: true,
|
|
17640
|
+
sort_by: "first_name",
|
|
16752
17641
|
sort_order: "asc",
|
|
16753
17642
|
page: 1,
|
|
16754
17643
|
page_size: 1,
|
|
@@ -16768,7 +17657,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16768
17657
|
<dl>
|
|
16769
17658
|
<dd>
|
|
16770
17659
|
|
|
16771
|
-
**
|
|
17660
|
+
**request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
|
|
16772
17661
|
|
|
16773
17662
|
</dd>
|
|
16774
17663
|
</dl>
|
|
@@ -16776,7 +17665,69 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16776
17665
|
<dl>
|
|
16777
17666
|
<dd>
|
|
16778
17667
|
|
|
16779
|
-
**
|
|
17668
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17669
|
+
|
|
17670
|
+
</dd>
|
|
17671
|
+
</dl>
|
|
17672
|
+
</dd>
|
|
17673
|
+
</dl>
|
|
17674
|
+
|
|
17675
|
+
</dd>
|
|
17676
|
+
</dl>
|
|
17677
|
+
</details>
|
|
17678
|
+
|
|
17679
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DriverListRes</code></summary>
|
|
17680
|
+
<dl>
|
|
17681
|
+
<dd>
|
|
17682
|
+
|
|
17683
|
+
#### 📝 Description
|
|
17684
|
+
|
|
17685
|
+
<dl>
|
|
17686
|
+
<dd>
|
|
17687
|
+
|
|
17688
|
+
<dl>
|
|
17689
|
+
<dd>
|
|
17690
|
+
|
|
17691
|
+
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
17692
|
+
|
|
17693
|
+
</dd>
|
|
17694
|
+
</dl>
|
|
17695
|
+
</dd>
|
|
17696
|
+
</dl>
|
|
17697
|
+
|
|
17698
|
+
#### 🔌 Usage
|
|
17699
|
+
|
|
17700
|
+
<dl>
|
|
17701
|
+
<dd>
|
|
17702
|
+
|
|
17703
|
+
<dl>
|
|
17704
|
+
<dd>
|
|
17705
|
+
|
|
17706
|
+
```typescript
|
|
17707
|
+
await client.shipping.drivers.listV1({
|
|
17708
|
+
sort_order: "asc",
|
|
17709
|
+
page: 1,
|
|
17710
|
+
page_size: 1,
|
|
17711
|
+
search: "search",
|
|
17712
|
+
filter_available_according_to_driver: true,
|
|
17713
|
+
filter_available_according_to_operators: true,
|
|
17714
|
+
});
|
|
17715
|
+
```
|
|
17716
|
+
|
|
17717
|
+
</dd>
|
|
17718
|
+
</dl>
|
|
17719
|
+
</dd>
|
|
17720
|
+
</dl>
|
|
17721
|
+
|
|
17722
|
+
#### ⚙️ Parameters
|
|
17723
|
+
|
|
17724
|
+
<dl>
|
|
17725
|
+
<dd>
|
|
17726
|
+
|
|
17727
|
+
<dl>
|
|
17728
|
+
<dd>
|
|
17729
|
+
|
|
17730
|
+
**request:** `Chrt.shipping.DriversListV1Request`
|
|
16780
17731
|
|
|
16781
17732
|
</dd>
|
|
16782
17733
|
</dl>
|
|
@@ -16795,7 +17746,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16795
17746
|
</dl>
|
|
16796
17747
|
</details>
|
|
16797
17748
|
|
|
16798
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17749
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
16799
17750
|
<dl>
|
|
16800
17751
|
<dd>
|
|
16801
17752
|
|
|
@@ -16807,7 +17758,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16807
17758
|
<dl>
|
|
16808
17759
|
<dd>
|
|
16809
17760
|
|
|
16810
|
-
|
|
17761
|
+
Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)
|
|
16811
17762
|
|
|
16812
17763
|
</dd>
|
|
16813
17764
|
</dl>
|
|
@@ -16823,14 +17774,9 @@ Lists all drivers' self-reports in the caller's org with date-range filtering, s
|
|
|
16823
17774
|
<dd>
|
|
16824
17775
|
|
|
16825
17776
|
```typescript
|
|
16826
|
-
await client.shipping.drivers.
|
|
16827
|
-
|
|
16828
|
-
|
|
16829
|
-
filter_end_date: "filter_end_date",
|
|
16830
|
-
sort_by: "date",
|
|
16831
|
-
sort_order: "asc",
|
|
16832
|
-
page: 1,
|
|
16833
|
-
page_size: 1,
|
|
17777
|
+
await client.shipping.drivers.createV1({
|
|
17778
|
+
target_user_id: "target_user_id",
|
|
17779
|
+
schema_version: 1,
|
|
16834
17780
|
});
|
|
16835
17781
|
```
|
|
16836
17782
|
|
|
@@ -16847,7 +17793,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16847
17793
|
<dl>
|
|
16848
17794
|
<dd>
|
|
16849
17795
|
|
|
16850
|
-
**request:** `Chrt.shipping.
|
|
17796
|
+
**request:** `Chrt.shipping.DriverClientCreate1`
|
|
16851
17797
|
|
|
16852
17798
|
</dd>
|
|
16853
17799
|
</dl>
|
|
@@ -16866,7 +17812,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16866
17812
|
</dl>
|
|
16867
17813
|
</details>
|
|
16868
17814
|
|
|
16869
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17815
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
16870
17816
|
<dl>
|
|
16871
17817
|
<dd>
|
|
16872
17818
|
|
|
@@ -16878,7 +17824,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16878
17824
|
<dl>
|
|
16879
17825
|
<dd>
|
|
16880
17826
|
|
|
16881
|
-
|
|
17827
|
+
Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
|
|
16882
17828
|
|
|
16883
17829
|
</dd>
|
|
16884
17830
|
</dl>
|
|
@@ -16894,11 +17840,7 @@ Creates a driver's self-reported hours worked and miles driven for a single cale
|
|
|
16894
17840
|
<dd>
|
|
16895
17841
|
|
|
16896
17842
|
```typescript
|
|
16897
|
-
await client.shipping.drivers.
|
|
16898
|
-
schema_version: 1,
|
|
16899
|
-
driver_id: "driver_id",
|
|
16900
|
-
date: "date",
|
|
16901
|
-
});
|
|
17843
|
+
await client.shipping.drivers.updateV1("driver_id");
|
|
16902
17844
|
```
|
|
16903
17845
|
|
|
16904
17846
|
</dd>
|
|
@@ -16914,7 +17856,15 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16914
17856
|
<dl>
|
|
16915
17857
|
<dd>
|
|
16916
17858
|
|
|
16917
|
-
**
|
|
17859
|
+
**driverId:** `string`
|
|
17860
|
+
|
|
17861
|
+
</dd>
|
|
17862
|
+
</dl>
|
|
17863
|
+
|
|
17864
|
+
<dl>
|
|
17865
|
+
<dd>
|
|
17866
|
+
|
|
17867
|
+
**request:** `Chrt.shipping.DriverClientUpdate1`
|
|
16918
17868
|
|
|
16919
17869
|
</dd>
|
|
16920
17870
|
</dl>
|
|
@@ -16933,7 +17883,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16933
17883
|
</dl>
|
|
16934
17884
|
</details>
|
|
16935
17885
|
|
|
16936
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17886
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
16937
17887
|
<dl>
|
|
16938
17888
|
<dd>
|
|
16939
17889
|
|
|
@@ -16945,7 +17895,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16945
17895
|
<dl>
|
|
16946
17896
|
<dd>
|
|
16947
17897
|
|
|
16948
|
-
|
|
17898
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
16949
17899
|
|
|
16950
17900
|
</dd>
|
|
16951
17901
|
</dl>
|
|
@@ -16961,7 +17911,7 @@ Partially updates a driver's self-reported hours worked and/or miles driven for
|
|
|
16961
17911
|
<dd>
|
|
16962
17912
|
|
|
16963
17913
|
```typescript
|
|
16964
|
-
await client.shipping.drivers.
|
|
17914
|
+
await client.shipping.drivers.clearLastSeenV1();
|
|
16965
17915
|
```
|
|
16966
17916
|
|
|
16967
17917
|
</dd>
|
|
@@ -16977,23 +17927,64 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
16977
17927
|
<dl>
|
|
16978
17928
|
<dd>
|
|
16979
17929
|
|
|
16980
|
-
**
|
|
17930
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17931
|
+
|
|
17932
|
+
</dd>
|
|
17933
|
+
</dl>
|
|
17934
|
+
</dd>
|
|
17935
|
+
</dl>
|
|
16981
17936
|
|
|
16982
17937
|
</dd>
|
|
16983
17938
|
</dl>
|
|
17939
|
+
</details>
|
|
16984
17940
|
|
|
17941
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
|
|
16985
17942
|
<dl>
|
|
16986
17943
|
<dd>
|
|
16987
17944
|
|
|
16988
|
-
|
|
17945
|
+
#### 📝 Description
|
|
17946
|
+
|
|
17947
|
+
<dl>
|
|
17948
|
+
<dd>
|
|
17949
|
+
|
|
17950
|
+
<dl>
|
|
17951
|
+
<dd>
|
|
17952
|
+
|
|
17953
|
+
Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
16989
17954
|
|
|
16990
17955
|
</dd>
|
|
16991
17956
|
</dl>
|
|
17957
|
+
</dd>
|
|
17958
|
+
</dl>
|
|
17959
|
+
|
|
17960
|
+
#### 🔌 Usage
|
|
16992
17961
|
|
|
16993
17962
|
<dl>
|
|
16994
17963
|
<dd>
|
|
16995
17964
|
|
|
16996
|
-
|
|
17965
|
+
<dl>
|
|
17966
|
+
<dd>
|
|
17967
|
+
|
|
17968
|
+
```typescript
|
|
17969
|
+
await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
17970
|
+
available: true,
|
|
17971
|
+
});
|
|
17972
|
+
```
|
|
17973
|
+
|
|
17974
|
+
</dd>
|
|
17975
|
+
</dl>
|
|
17976
|
+
</dd>
|
|
17977
|
+
</dl>
|
|
17978
|
+
|
|
17979
|
+
#### ⚙️ Parameters
|
|
17980
|
+
|
|
17981
|
+
<dl>
|
|
17982
|
+
<dd>
|
|
17983
|
+
|
|
17984
|
+
<dl>
|
|
17985
|
+
<dd>
|
|
17986
|
+
|
|
17987
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
16997
17988
|
|
|
16998
17989
|
</dd>
|
|
16999
17990
|
</dl>
|
|
@@ -17012,7 +18003,7 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17012
18003
|
</dl>
|
|
17013
18004
|
</details>
|
|
17014
18005
|
|
|
17015
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
18006
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
17016
18007
|
<dl>
|
|
17017
18008
|
<dd>
|
|
17018
18009
|
|
|
@@ -17024,7 +18015,7 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17024
18015
|
<dl>
|
|
17025
18016
|
<dd>
|
|
17026
18017
|
|
|
17027
|
-
|
|
18018
|
+
Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)
|
|
17028
18019
|
|
|
17029
18020
|
</dd>
|
|
17030
18021
|
</dl>
|
|
@@ -17040,7 +18031,9 @@ Permanently deletes a driver's self-report for a calendar day. Caller must be th
|
|
|
17040
18031
|
<dd>
|
|
17041
18032
|
|
|
17042
18033
|
```typescript
|
|
17043
|
-
await client.shipping.drivers.
|
|
18034
|
+
await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
18035
|
+
available: true,
|
|
18036
|
+
});
|
|
17044
18037
|
```
|
|
17045
18038
|
|
|
17046
18039
|
</dd>
|
|
@@ -17064,7 +18057,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17064
18057
|
<dl>
|
|
17065
18058
|
<dd>
|
|
17066
18059
|
|
|
17067
|
-
**
|
|
18060
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
17068
18061
|
|
|
17069
18062
|
</dd>
|
|
17070
18063
|
</dl>
|
|
@@ -17083,7 +18076,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17083
18076
|
</dl>
|
|
17084
18077
|
</details>
|
|
17085
18078
|
|
|
17086
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
18079
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAutoAssignV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
17087
18080
|
<dl>
|
|
17088
18081
|
<dd>
|
|
17089
18082
|
|
|
@@ -17095,14 +18088,33 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17095
18088
|
<dl>
|
|
17096
18089
|
<dd>
|
|
17097
18090
|
|
|
17098
|
-
|
|
18091
|
+
Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)
|
|
18092
|
+
|
|
18093
|
+
</dd>
|
|
18094
|
+
</dl>
|
|
18095
|
+
</dd>
|
|
18096
|
+
</dl>
|
|
18097
|
+
|
|
18098
|
+
#### 🔌 Usage
|
|
18099
|
+
|
|
18100
|
+
<dl>
|
|
18101
|
+
<dd>
|
|
18102
|
+
|
|
18103
|
+
<dl>
|
|
18104
|
+
<dd>
|
|
18105
|
+
|
|
18106
|
+
```typescript
|
|
18107
|
+
await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
18108
|
+
auto_assign_enabled: true,
|
|
18109
|
+
});
|
|
18110
|
+
```
|
|
17099
18111
|
|
|
17100
18112
|
</dd>
|
|
17101
18113
|
</dl>
|
|
17102
18114
|
</dd>
|
|
17103
18115
|
</dl>
|
|
17104
18116
|
|
|
17105
|
-
####
|
|
18117
|
+
#### ⚙️ Parameters
|
|
17106
18118
|
|
|
17107
18119
|
<dl>
|
|
17108
18120
|
<dd>
|
|
@@ -17110,20 +18122,19 @@ Retrieves driver information for the caller within their organization. | () -> (
|
|
|
17110
18122
|
<dl>
|
|
17111
18123
|
<dd>
|
|
17112
18124
|
|
|
17113
|
-
|
|
17114
|
-
await client.shipping.drivers.getForCallerV1();
|
|
17115
|
-
```
|
|
18125
|
+
**driverId:** `string`
|
|
17116
18126
|
|
|
17117
|
-
</dd>
|
|
17118
|
-
</dl>
|
|
17119
18127
|
</dd>
|
|
17120
18128
|
</dl>
|
|
17121
18129
|
|
|
17122
|
-
#### ⚙️ Parameters
|
|
17123
|
-
|
|
17124
18130
|
<dl>
|
|
17125
18131
|
<dd>
|
|
17126
18132
|
|
|
18133
|
+
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
18134
|
+
|
|
18135
|
+
</dd>
|
|
18136
|
+
</dl>
|
|
18137
|
+
|
|
17127
18138
|
<dl>
|
|
17128
18139
|
<dd>
|
|
17129
18140
|
|
|
@@ -17138,7 +18149,9 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17138
18149
|
</dl>
|
|
17139
18150
|
</details>
|
|
17140
18151
|
|
|
17141
|
-
|
|
18152
|
+
## Shipping Cargos
|
|
18153
|
+
|
|
18154
|
+
<details><summary><code>client.shipping.cargos.<a href="/src/api/resources/shipping/resources/cargos/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
17142
18155
|
<dl>
|
|
17143
18156
|
<dd>
|
|
17144
18157
|
|
|
@@ -17150,7 +18163,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17150
18163
|
<dl>
|
|
17151
18164
|
<dd>
|
|
17152
18165
|
|
|
17153
|
-
|
|
18166
|
+
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_owner_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
17154
18167
|
|
|
17155
18168
|
</dd>
|
|
17156
18169
|
</dl>
|
|
@@ -17166,7 +18179,7 @@ Retrieves detailed driver information by driver ID within the organization. | ()
|
|
|
17166
18179
|
<dd>
|
|
17167
18180
|
|
|
17168
18181
|
```typescript
|
|
17169
|
-
await client.shipping.
|
|
18182
|
+
await client.shipping.cargos.updateV1("cargo_id", {});
|
|
17170
18183
|
```
|
|
17171
18184
|
|
|
17172
18185
|
</dd>
|
|
@@ -17182,7 +18195,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17182
18195
|
<dl>
|
|
17183
18196
|
<dd>
|
|
17184
18197
|
|
|
17185
|
-
**
|
|
18198
|
+
**cargoId:** `string`
|
|
17186
18199
|
|
|
17187
18200
|
</dd>
|
|
17188
18201
|
</dl>
|
|
@@ -17190,7 +18203,15 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17190
18203
|
<dl>
|
|
17191
18204
|
<dd>
|
|
17192
18205
|
|
|
17193
|
-
**
|
|
18206
|
+
**request:** `Chrt.CargoClientUpdate1`
|
|
18207
|
+
|
|
18208
|
+
</dd>
|
|
18209
|
+
</dl>
|
|
18210
|
+
|
|
18211
|
+
<dl>
|
|
18212
|
+
<dd>
|
|
18213
|
+
|
|
18214
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
17194
18215
|
|
|
17195
18216
|
</dd>
|
|
17196
18217
|
</dl>
|
|
@@ -17201,7 +18222,9 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17201
18222
|
</dl>
|
|
17202
18223
|
</details>
|
|
17203
18224
|
|
|
17204
|
-
|
|
18225
|
+
## Shipping Flights
|
|
18226
|
+
|
|
18227
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
17205
18228
|
<dl>
|
|
17206
18229
|
<dd>
|
|
17207
18230
|
|
|
@@ -17213,7 +18236,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17213
18236
|
<dl>
|
|
17214
18237
|
<dd>
|
|
17215
18238
|
|
|
17216
|
-
|
|
18239
|
+
Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or RECOVER_FROM_AIRLINE tasks. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
|
|
17217
18240
|
|
|
17218
18241
|
</dd>
|
|
17219
18242
|
</dl>
|
|
@@ -17229,15 +18252,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
17229
18252
|
<dd>
|
|
17230
18253
|
|
|
17231
18254
|
```typescript
|
|
17232
|
-
await client.shipping.
|
|
17233
|
-
search: "search",
|
|
17234
|
-
filter_available_according_to_driver: true,
|
|
17235
|
-
filter_available_according_to_operators: true,
|
|
17236
|
-
sort_by: "first_name",
|
|
17237
|
-
sort_order: "asc",
|
|
17238
|
-
page: 1,
|
|
17239
|
-
page_size: 1,
|
|
17240
|
-
});
|
|
18255
|
+
await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
17241
18256
|
```
|
|
17242
18257
|
|
|
17243
18258
|
</dd>
|
|
@@ -17253,7 +18268,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17253
18268
|
<dl>
|
|
17254
18269
|
<dd>
|
|
17255
18270
|
|
|
17256
|
-
**
|
|
18271
|
+
**taskId:** `string`
|
|
17257
18272
|
|
|
17258
18273
|
</dd>
|
|
17259
18274
|
</dl>
|
|
@@ -17261,7 +18276,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17261
18276
|
<dl>
|
|
17262
18277
|
<dd>
|
|
17263
18278
|
|
|
17264
|
-
**requestOptions:** `
|
|
18279
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17265
18280
|
|
|
17266
18281
|
</dd>
|
|
17267
18282
|
</dl>
|
|
@@ -17272,7 +18287,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17272
18287
|
</dl>
|
|
17273
18288
|
</details>
|
|
17274
18289
|
|
|
17275
|
-
<details><summary><code>client.shipping.
|
|
18290
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightLegsForTaskGroupV1</a>(taskGroupId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
17276
18291
|
<dl>
|
|
17277
18292
|
<dd>
|
|
17278
18293
|
|
|
@@ -17284,7 +18299,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17284
18299
|
<dl>
|
|
17285
18300
|
<dd>
|
|
17286
18301
|
|
|
17287
|
-
|
|
18302
|
+
Returns the ordered list of flight legs for a task group. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (FlightInfoForTaskRes)
|
|
17288
18303
|
|
|
17289
18304
|
</dd>
|
|
17290
18305
|
</dl>
|
|
@@ -17300,14 +18315,7 @@ Lists all drivers belonging to the caller's organization with filtering, sorting
|
|
|
17300
18315
|
<dd>
|
|
17301
18316
|
|
|
17302
18317
|
```typescript
|
|
17303
|
-
await client.shipping.
|
|
17304
|
-
sort_order: "asc",
|
|
17305
|
-
page: 1,
|
|
17306
|
-
page_size: 1,
|
|
17307
|
-
search: "search",
|
|
17308
|
-
filter_available_according_to_driver: true,
|
|
17309
|
-
filter_available_according_to_operators: true,
|
|
17310
|
-
});
|
|
18318
|
+
await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
17311
18319
|
```
|
|
17312
18320
|
|
|
17313
18321
|
</dd>
|
|
@@ -17323,7 +18331,7 @@ await client.shipping.drivers.listV1({
|
|
|
17323
18331
|
<dl>
|
|
17324
18332
|
<dd>
|
|
17325
18333
|
|
|
17326
|
-
**
|
|
18334
|
+
**taskGroupId:** `string`
|
|
17327
18335
|
|
|
17328
18336
|
</dd>
|
|
17329
18337
|
</dl>
|
|
@@ -17331,7 +18339,7 @@ await client.shipping.drivers.listV1({
|
|
|
17331
18339
|
<dl>
|
|
17332
18340
|
<dd>
|
|
17333
18341
|
|
|
17334
|
-
**requestOptions:** `
|
|
18342
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17335
18343
|
|
|
17336
18344
|
</dd>
|
|
17337
18345
|
</dl>
|
|
@@ -17342,7 +18350,7 @@ await client.shipping.drivers.listV1({
|
|
|
17342
18350
|
</dl>
|
|
17343
18351
|
</details>
|
|
17344
18352
|
|
|
17345
|
-
<details><summary><code>client.shipping.
|
|
18353
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightStatusForFlightLegV1</a>(flightLegId) -> Chrt.FlightLeg1</code></summary>
|
|
17346
18354
|
<dl>
|
|
17347
18355
|
<dd>
|
|
17348
18356
|
|
|
@@ -17354,7 +18362,7 @@ await client.shipping.drivers.listV1({
|
|
|
17354
18362
|
<dl>
|
|
17355
18363
|
<dd>
|
|
17356
18364
|
|
|
17357
|
-
|
|
18365
|
+
Returns the flight leg with its Cirium-sourced status, lazily resolving the Cirium flightId and refreshing the cached status on read. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, order_executor_org_operators, shipper_org_operators] | () -> (FlightLeg1)
|
|
17358
18366
|
|
|
17359
18367
|
</dd>
|
|
17360
18368
|
</dl>
|
|
@@ -17370,10 +18378,7 @@ Creates a new driver profile for the target user (defaults to caller). Drivers c
|
|
|
17370
18378
|
<dd>
|
|
17371
18379
|
|
|
17372
18380
|
```typescript
|
|
17373
|
-
await client.shipping.
|
|
17374
|
-
target_user_id: "target_user_id",
|
|
17375
|
-
schema_version: 1,
|
|
17376
|
-
});
|
|
18381
|
+
await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
17377
18382
|
```
|
|
17378
18383
|
|
|
17379
18384
|
</dd>
|
|
@@ -17389,7 +18394,7 @@ await client.shipping.drivers.createV1({
|
|
|
17389
18394
|
<dl>
|
|
17390
18395
|
<dd>
|
|
17391
18396
|
|
|
17392
|
-
**
|
|
18397
|
+
**flightLegId:** `string`
|
|
17393
18398
|
|
|
17394
18399
|
</dd>
|
|
17395
18400
|
</dl>
|
|
@@ -17397,7 +18402,7 @@ await client.shipping.drivers.createV1({
|
|
|
17397
18402
|
<dl>
|
|
17398
18403
|
<dd>
|
|
17399
18404
|
|
|
17400
|
-
**requestOptions:** `
|
|
18405
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17401
18406
|
|
|
17402
18407
|
</dd>
|
|
17403
18408
|
</dl>
|
|
@@ -17408,7 +18413,7 @@ await client.shipping.drivers.createV1({
|
|
|
17408
18413
|
</dl>
|
|
17409
18414
|
</details>
|
|
17410
18415
|
|
|
17411
|
-
<details><summary><code>client.shipping.
|
|
18416
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightTrackForFlightLegV1</a>(flightLegId) -> Chrt.FlightTrackRes</code></summary>
|
|
17412
18417
|
<dl>
|
|
17413
18418
|
<dd>
|
|
17414
18419
|
|
|
@@ -17420,7 +18425,7 @@ await client.shipping.drivers.createV1({
|
|
|
17420
18425
|
<dl>
|
|
17421
18426
|
<dd>
|
|
17422
18427
|
|
|
17423
|
-
|
|
18428
|
+
Returns the Cirium-sourced positional track for a flight leg — the live breadcrumb trail plus the planned path (waypoints + legacy route) in one read-through call, cached on read. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, order_executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
|
|
17424
18429
|
|
|
17425
18430
|
</dd>
|
|
17426
18431
|
</dl>
|
|
@@ -17436,7 +18441,7 @@ Updates driver contact details and vehicle type assignments. Provider orgs only;
|
|
|
17436
18441
|
<dd>
|
|
17437
18442
|
|
|
17438
18443
|
```typescript
|
|
17439
|
-
await client.shipping.
|
|
18444
|
+
await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
17440
18445
|
```
|
|
17441
18446
|
|
|
17442
18447
|
</dd>
|
|
@@ -17452,15 +18457,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17452
18457
|
<dl>
|
|
17453
18458
|
<dd>
|
|
17454
18459
|
|
|
17455
|
-
**
|
|
17456
|
-
|
|
17457
|
-
</dd>
|
|
17458
|
-
</dl>
|
|
17459
|
-
|
|
17460
|
-
<dl>
|
|
17461
|
-
<dd>
|
|
17462
|
-
|
|
17463
|
-
**request:** `Chrt.shipping.DriverClientUpdate1`
|
|
18460
|
+
**flightLegId:** `string`
|
|
17464
18461
|
|
|
17465
18462
|
</dd>
|
|
17466
18463
|
</dl>
|
|
@@ -17468,7 +18465,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17468
18465
|
<dl>
|
|
17469
18466
|
<dd>
|
|
17470
18467
|
|
|
17471
|
-
**requestOptions:** `
|
|
18468
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17472
18469
|
|
|
17473
18470
|
</dd>
|
|
17474
18471
|
</dl>
|
|
@@ -17479,7 +18476,9 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17479
18476
|
</dl>
|
|
17480
18477
|
</details>
|
|
17481
18478
|
|
|
17482
|
-
|
|
18479
|
+
## Shipping TaskArtifacts
|
|
18480
|
+
|
|
18481
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">addToTaskV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
17483
18482
|
<dl>
|
|
17484
18483
|
<dd>
|
|
17485
18484
|
|
|
@@ -17491,7 +18490,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17491
18490
|
<dl>
|
|
17492
18491
|
<dd>
|
|
17493
18492
|
|
|
17494
|
-
|
|
18493
|
+
Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
17495
18494
|
|
|
17496
18495
|
</dd>
|
|
17497
18496
|
</dl>
|
|
@@ -17507,7 +18506,13 @@ Clears the driver's last known location and timestamp. | () -> (bool)
|
|
|
17507
18506
|
<dd>
|
|
17508
18507
|
|
|
17509
18508
|
```typescript
|
|
17510
|
-
await client.shipping.
|
|
18509
|
+
await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
18510
|
+
task_artifact: {
|
|
18511
|
+
schema_version: 1,
|
|
18512
|
+
type: "image",
|
|
18513
|
+
},
|
|
18514
|
+
status: "draft",
|
|
18515
|
+
});
|
|
17511
18516
|
```
|
|
17512
18517
|
|
|
17513
18518
|
</dd>
|
|
@@ -17523,7 +18528,23 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17523
18528
|
<dl>
|
|
17524
18529
|
<dd>
|
|
17525
18530
|
|
|
17526
|
-
**
|
|
18531
|
+
**taskId:** `string`
|
|
18532
|
+
|
|
18533
|
+
</dd>
|
|
18534
|
+
</dl>
|
|
18535
|
+
|
|
18536
|
+
<dl>
|
|
18537
|
+
<dd>
|
|
18538
|
+
|
|
18539
|
+
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
18540
|
+
|
|
18541
|
+
</dd>
|
|
18542
|
+
</dl>
|
|
18543
|
+
|
|
18544
|
+
<dl>
|
|
18545
|
+
<dd>
|
|
18546
|
+
|
|
18547
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17527
18548
|
|
|
17528
18549
|
</dd>
|
|
17529
18550
|
</dl>
|
|
@@ -17534,7 +18555,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17534
18555
|
</dl>
|
|
17535
18556
|
</details>
|
|
17536
18557
|
|
|
17537
|
-
<details><summary><code>client.shipping.
|
|
18558
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17538
18559
|
<dl>
|
|
17539
18560
|
<dd>
|
|
17540
18561
|
|
|
@@ -17546,7 +18567,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17546
18567
|
<dl>
|
|
17547
18568
|
<dd>
|
|
17548
18569
|
|
|
17549
|
-
|
|
18570
|
+
Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
17550
18571
|
|
|
17551
18572
|
</dd>
|
|
17552
18573
|
</dl>
|
|
@@ -17562,9 +18583,7 @@ Updates the caller's driver availability status. Must have status UNASSIGNED to
|
|
|
17562
18583
|
<dd>
|
|
17563
18584
|
|
|
17564
18585
|
```typescript
|
|
17565
|
-
await client.shipping.
|
|
17566
|
-
available: true,
|
|
17567
|
-
});
|
|
18586
|
+
await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
17568
18587
|
```
|
|
17569
18588
|
|
|
17570
18589
|
</dd>
|
|
@@ -17580,7 +18599,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17580
18599
|
<dl>
|
|
17581
18600
|
<dd>
|
|
17582
18601
|
|
|
17583
|
-
**
|
|
18602
|
+
**taskArtifactId:** `string`
|
|
17584
18603
|
|
|
17585
18604
|
</dd>
|
|
17586
18605
|
</dl>
|
|
@@ -17588,7 +18607,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17588
18607
|
<dl>
|
|
17589
18608
|
<dd>
|
|
17590
18609
|
|
|
17591
|
-
**requestOptions:** `
|
|
18610
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17592
18611
|
|
|
17593
18612
|
</dd>
|
|
17594
18613
|
</dl>
|
|
@@ -17599,7 +18618,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17599
18618
|
</dl>
|
|
17600
18619
|
</details>
|
|
17601
18620
|
|
|
17602
|
-
<details><summary><code>client.shipping.
|
|
18621
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17603
18622
|
<dl>
|
|
17604
18623
|
<dd>
|
|
17605
18624
|
|
|
@@ -17611,7 +18630,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17611
18630
|
<dl>
|
|
17612
18631
|
<dd>
|
|
17613
18632
|
|
|
17614
|
-
|
|
18633
|
+
Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
17615
18634
|
|
|
17616
18635
|
</dd>
|
|
17617
18636
|
</dl>
|
|
@@ -17627,9 +18646,7 @@ Updates a driver's availability status. Must have status UNASSIGNED to set avail
|
|
|
17627
18646
|
<dd>
|
|
17628
18647
|
|
|
17629
18648
|
```typescript
|
|
17630
|
-
await client.shipping.
|
|
17631
|
-
available: true,
|
|
17632
|
-
});
|
|
18649
|
+
await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
17633
18650
|
```
|
|
17634
18651
|
|
|
17635
18652
|
</dd>
|
|
@@ -17645,15 +18662,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17645
18662
|
<dl>
|
|
17646
18663
|
<dd>
|
|
17647
18664
|
|
|
17648
|
-
**
|
|
17649
|
-
|
|
17650
|
-
</dd>
|
|
17651
|
-
</dl>
|
|
17652
|
-
|
|
17653
|
-
<dl>
|
|
17654
|
-
<dd>
|
|
17655
|
-
|
|
17656
|
-
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
18665
|
+
**taskArtifactId:** `string`
|
|
17657
18666
|
|
|
17658
18667
|
</dd>
|
|
17659
18668
|
</dl>
|
|
@@ -17661,7 +18670,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17661
18670
|
<dl>
|
|
17662
18671
|
<dd>
|
|
17663
18672
|
|
|
17664
|
-
**requestOptions:** `
|
|
18673
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17665
18674
|
|
|
17666
18675
|
</dd>
|
|
17667
18676
|
</dl>
|
|
@@ -17672,7 +18681,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17672
18681
|
</dl>
|
|
17673
18682
|
</details>
|
|
17674
18683
|
|
|
17675
|
-
<details><summary><code>client.shipping.
|
|
18684
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17676
18685
|
<dl>
|
|
17677
18686
|
<dd>
|
|
17678
18687
|
|
|
@@ -17684,7 +18693,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17684
18693
|
<dl>
|
|
17685
18694
|
<dd>
|
|
17686
18695
|
|
|
17687
|
-
|
|
18696
|
+
Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17688
18697
|
|
|
17689
18698
|
</dd>
|
|
17690
18699
|
</dl>
|
|
@@ -17700,9 +18709,7 @@ Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding
|
|
|
17700
18709
|
<dd>
|
|
17701
18710
|
|
|
17702
18711
|
```typescript
|
|
17703
|
-
await client.shipping.
|
|
17704
|
-
auto_assign_enabled: true,
|
|
17705
|
-
});
|
|
18712
|
+
await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
17706
18713
|
```
|
|
17707
18714
|
|
|
17708
18715
|
</dd>
|
|
@@ -17718,15 +18725,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17718
18725
|
<dl>
|
|
17719
18726
|
<dd>
|
|
17720
18727
|
|
|
17721
|
-
**
|
|
17722
|
-
|
|
17723
|
-
</dd>
|
|
17724
|
-
</dl>
|
|
17725
|
-
|
|
17726
|
-
<dl>
|
|
17727
|
-
<dd>
|
|
17728
|
-
|
|
17729
|
-
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
18728
|
+
**taskArtifactId:** `string`
|
|
17730
18729
|
|
|
17731
18730
|
</dd>
|
|
17732
18731
|
</dl>
|
|
@@ -17734,7 +18733,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17734
18733
|
<dl>
|
|
17735
18734
|
<dd>
|
|
17736
18735
|
|
|
17737
|
-
**requestOptions:** `
|
|
18736
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17738
18737
|
|
|
17739
18738
|
</dd>
|
|
17740
18739
|
</dl>
|
|
@@ -17745,9 +18744,9 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17745
18744
|
</dl>
|
|
17746
18745
|
</details>
|
|
17747
18746
|
|
|
17748
|
-
## Shipping
|
|
18747
|
+
## Shipping Orders
|
|
17749
18748
|
|
|
17750
|
-
<details><summary><code>client.shipping.
|
|
18749
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
17751
18750
|
<dl>
|
|
17752
18751
|
<dd>
|
|
17753
18752
|
|
|
@@ -17759,7 +18758,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17759
18758
|
<dl>
|
|
17760
18759
|
<dd>
|
|
17761
18760
|
|
|
17762
|
-
|
|
18761
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
17763
18762
|
|
|
17764
18763
|
</dd>
|
|
17765
18764
|
</dl>
|
|
@@ -17775,7 +18774,10 @@ Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPP
|
|
|
17775
18774
|
<dd>
|
|
17776
18775
|
|
|
17777
18776
|
```typescript
|
|
17778
|
-
await client.shipping.
|
|
18777
|
+
await client.shipping.orders.typeaheadV1({
|
|
18778
|
+
query: "query",
|
|
18779
|
+
limit: 1,
|
|
18780
|
+
});
|
|
17779
18781
|
```
|
|
17780
18782
|
|
|
17781
18783
|
</dd>
|
|
@@ -17791,15 +18793,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17791
18793
|
<dl>
|
|
17792
18794
|
<dd>
|
|
17793
18795
|
|
|
17794
|
-
**
|
|
17795
|
-
|
|
17796
|
-
</dd>
|
|
17797
|
-
</dl>
|
|
17798
|
-
|
|
17799
|
-
<dl>
|
|
17800
|
-
<dd>
|
|
17801
|
-
|
|
17802
|
-
**request:** `Chrt.CargoClientUpdate1`
|
|
18796
|
+
**request:** `Chrt.shipping.OrdersTypeaheadV1Request`
|
|
17803
18797
|
|
|
17804
18798
|
</dd>
|
|
17805
18799
|
</dl>
|
|
@@ -17807,7 +18801,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17807
18801
|
<dl>
|
|
17808
18802
|
<dd>
|
|
17809
18803
|
|
|
17810
|
-
**requestOptions:** `
|
|
18804
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17811
18805
|
|
|
17812
18806
|
</dd>
|
|
17813
18807
|
</dl>
|
|
@@ -17818,9 +18812,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17818
18812
|
</dl>
|
|
17819
18813
|
</details>
|
|
17820
18814
|
|
|
17821
|
-
|
|
17822
|
-
|
|
17823
|
-
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightInfoForTaskV1</a>(taskId) -> Chrt.FlightInfoForTaskRes</code></summary>
|
|
18815
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
17824
18816
|
<dl>
|
|
17825
18817
|
<dd>
|
|
17826
18818
|
|
|
@@ -17832,7 +18824,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17832
18824
|
<dl>
|
|
17833
18825
|
<dd>
|
|
17834
18826
|
|
|
17835
|
-
|
|
18827
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
17836
18828
|
|
|
17837
18829
|
</dd>
|
|
17838
18830
|
</dl>
|
|
@@ -17848,7 +18840,7 @@ Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or
|
|
|
17848
18840
|
<dd>
|
|
17849
18841
|
|
|
17850
18842
|
```typescript
|
|
17851
|
-
await client.shipping.
|
|
18843
|
+
await client.shipping.orders.stageV1("order_id");
|
|
17852
18844
|
```
|
|
17853
18845
|
|
|
17854
18846
|
</dd>
|
|
@@ -17864,7 +18856,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17864
18856
|
<dl>
|
|
17865
18857
|
<dd>
|
|
17866
18858
|
|
|
17867
|
-
**
|
|
18859
|
+
**orderId:** `string`
|
|
17868
18860
|
|
|
17869
18861
|
</dd>
|
|
17870
18862
|
</dl>
|
|
@@ -17872,7 +18864,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17872
18864
|
<dl>
|
|
17873
18865
|
<dd>
|
|
17874
18866
|
|
|
17875
|
-
**requestOptions:** `
|
|
18867
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17876
18868
|
|
|
17877
18869
|
</dd>
|
|
17878
18870
|
</dl>
|
|
@@ -17883,7 +18875,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17883
18875
|
</dl>
|
|
17884
18876
|
</details>
|
|
17885
18877
|
|
|
17886
|
-
<details><summary><code>client.shipping.
|
|
18878
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
|
|
17887
18879
|
<dl>
|
|
17888
18880
|
<dd>
|
|
17889
18881
|
|
|
@@ -17895,7 +18887,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17895
18887
|
<dl>
|
|
17896
18888
|
<dd>
|
|
17897
18889
|
|
|
17898
|
-
|
|
18890
|
+
Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
17899
18891
|
|
|
17900
18892
|
</dd>
|
|
17901
18893
|
</dl>
|
|
@@ -17911,7 +18903,7 @@ Returns the ordered list of flight legs for a task group. | authz_personas=[driv
|
|
|
17911
18903
|
<dd>
|
|
17912
18904
|
|
|
17913
18905
|
```typescript
|
|
17914
|
-
await client.shipping.
|
|
18906
|
+
await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
17915
18907
|
```
|
|
17916
18908
|
|
|
17917
18909
|
</dd>
|
|
@@ -17927,7 +18919,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17927
18919
|
<dl>
|
|
17928
18920
|
<dd>
|
|
17929
18921
|
|
|
17930
|
-
**
|
|
18922
|
+
**orderId:** `string`
|
|
17931
18923
|
|
|
17932
18924
|
</dd>
|
|
17933
18925
|
</dl>
|
|
@@ -17935,7 +18927,15 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17935
18927
|
<dl>
|
|
17936
18928
|
<dd>
|
|
17937
18929
|
|
|
17938
|
-
**
|
|
18930
|
+
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
18931
|
+
|
|
18932
|
+
</dd>
|
|
18933
|
+
</dl>
|
|
18934
|
+
|
|
18935
|
+
<dl>
|
|
18936
|
+
<dd>
|
|
18937
|
+
|
|
18938
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17939
18939
|
|
|
17940
18940
|
</dd>
|
|
17941
18941
|
</dl>
|
|
@@ -17946,7 +18946,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17946
18946
|
</dl>
|
|
17947
18947
|
</details>
|
|
17948
18948
|
|
|
17949
|
-
<details><summary><code>client.shipping.
|
|
18949
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
17950
18950
|
<dl>
|
|
17951
18951
|
<dd>
|
|
17952
18952
|
|
|
@@ -17958,7 +18958,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17958
18958
|
<dl>
|
|
17959
18959
|
<dd>
|
|
17960
18960
|
|
|
17961
|
-
|
|
18961
|
+
Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17962
18962
|
|
|
17963
18963
|
</dd>
|
|
17964
18964
|
</dl>
|
|
@@ -17974,7 +18974,7 @@ Returns the flight leg with its Cirium-sourced status, lazily resolving the Ciri
|
|
|
17974
18974
|
<dd>
|
|
17975
18975
|
|
|
17976
18976
|
```typescript
|
|
17977
|
-
await client.shipping.
|
|
18977
|
+
await client.shipping.orders.cancelV1("order_id");
|
|
17978
18978
|
```
|
|
17979
18979
|
|
|
17980
18980
|
</dd>
|
|
@@ -17990,7 +18990,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
17990
18990
|
<dl>
|
|
17991
18991
|
<dd>
|
|
17992
18992
|
|
|
17993
|
-
**
|
|
18993
|
+
**orderId:** `string`
|
|
17994
18994
|
|
|
17995
18995
|
</dd>
|
|
17996
18996
|
</dl>
|
|
@@ -17998,7 +18998,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
17998
18998
|
<dl>
|
|
17999
18999
|
<dd>
|
|
18000
19000
|
|
|
18001
|
-
**requestOptions:** `
|
|
19001
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
18002
19002
|
|
|
18003
19003
|
</dd>
|
|
18004
19004
|
</dl>
|
|
@@ -18009,7 +19009,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
18009
19009
|
</dl>
|
|
18010
19010
|
</details>
|
|
18011
19011
|
|
|
18012
|
-
<details><summary><code>client.shipping.
|
|
19012
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18013
19013
|
<dl>
|
|
18014
19014
|
<dd>
|
|
18015
19015
|
|
|
@@ -18021,7 +19021,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
18021
19021
|
<dl>
|
|
18022
19022
|
<dd>
|
|
18023
19023
|
|
|
18024
|
-
|
|
19024
|
+
Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)
|
|
18025
19025
|
|
|
18026
19026
|
</dd>
|
|
18027
19027
|
</dl>
|
|
@@ -18037,7 +19037,9 @@ Returns the Cirium-sourced positional track for a flight leg — the live breadc
|
|
|
18037
19037
|
<dd>
|
|
18038
19038
|
|
|
18039
19039
|
```typescript
|
|
18040
|
-
await client.shipping.
|
|
19040
|
+
await client.shipping.orders.cancelManyV1({
|
|
19041
|
+
order_ids: ["order_ids"],
|
|
19042
|
+
});
|
|
18041
19043
|
```
|
|
18042
19044
|
|
|
18043
19045
|
</dd>
|
|
@@ -18053,7 +19055,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18053
19055
|
<dl>
|
|
18054
19056
|
<dd>
|
|
18055
19057
|
|
|
18056
|
-
**
|
|
19058
|
+
**request:** `Chrt.shipping.OrdersCancelManyReq`
|
|
18057
19059
|
|
|
18058
19060
|
</dd>
|
|
18059
19061
|
</dl>
|
|
@@ -18061,7 +19063,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18061
19063
|
<dl>
|
|
18062
19064
|
<dd>
|
|
18063
19065
|
|
|
18064
|
-
**requestOptions:** `
|
|
19066
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
18065
19067
|
|
|
18066
19068
|
</dd>
|
|
18067
19069
|
</dl>
|
|
@@ -18072,9 +19074,9 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18072
19074
|
</dl>
|
|
18073
19075
|
</details>
|
|
18074
19076
|
|
|
18075
|
-
## Shipping
|
|
19077
|
+
## Shipping OrderDrafts
|
|
18076
19078
|
|
|
18077
|
-
<details><summary><code>client.shipping.
|
|
19079
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
18078
19080
|
<dl>
|
|
18079
19081
|
<dd>
|
|
18080
19082
|
|
|
@@ -18086,7 +19088,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18086
19088
|
<dl>
|
|
18087
19089
|
<dd>
|
|
18088
19090
|
|
|
18089
|
-
|
|
19091
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
18090
19092
|
|
|
18091
19093
|
</dd>
|
|
18092
19094
|
</dl>
|
|
@@ -18102,13 +19104,7 @@ Adds a new task artifact to a task. | authz_personas=[driver_for_executor, execu
|
|
|
18102
19104
|
<dd>
|
|
18103
19105
|
|
|
18104
19106
|
```typescript
|
|
18105
|
-
await client.shipping.
|
|
18106
|
-
task_artifact: {
|
|
18107
|
-
schema_version: 1,
|
|
18108
|
-
type: "image",
|
|
18109
|
-
},
|
|
18110
|
-
status: "draft",
|
|
18111
|
-
});
|
|
19107
|
+
await client.shipping.orderDrafts.newV1();
|
|
18112
19108
|
```
|
|
18113
19109
|
|
|
18114
19110
|
</dd>
|
|
@@ -18124,15 +19120,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18124
19120
|
<dl>
|
|
18125
19121
|
<dd>
|
|
18126
19122
|
|
|
18127
|
-
**
|
|
18128
|
-
|
|
18129
|
-
</dd>
|
|
18130
|
-
</dl>
|
|
18131
|
-
|
|
18132
|
-
<dl>
|
|
18133
|
-
<dd>
|
|
18134
|
-
|
|
18135
|
-
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
19123
|
+
**request:** `Chrt.shipping.OrdersNewDraftReq`
|
|
18136
19124
|
|
|
18137
19125
|
</dd>
|
|
18138
19126
|
</dl>
|
|
@@ -18140,7 +19128,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18140
19128
|
<dl>
|
|
18141
19129
|
<dd>
|
|
18142
19130
|
|
|
18143
|
-
**requestOptions:** `
|
|
19131
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18144
19132
|
|
|
18145
19133
|
</dd>
|
|
18146
19134
|
</dl>
|
|
@@ -18151,7 +19139,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18151
19139
|
</dl>
|
|
18152
19140
|
</details>
|
|
18153
19141
|
|
|
18154
|
-
<details><summary><code>client.shipping.
|
|
19142
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
18155
19143
|
<dl>
|
|
18156
19144
|
<dd>
|
|
18157
19145
|
|
|
@@ -18163,7 +19151,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18163
19151
|
<dl>
|
|
18164
19152
|
<dd>
|
|
18165
19153
|
|
|
18166
|
-
|
|
19154
|
+
Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
18167
19155
|
|
|
18168
19156
|
</dd>
|
|
18169
19157
|
</dl>
|
|
@@ -18179,7 +19167,7 @@ Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, execu
|
|
|
18179
19167
|
<dd>
|
|
18180
19168
|
|
|
18181
19169
|
```typescript
|
|
18182
|
-
await client.shipping.
|
|
19170
|
+
await client.shipping.orderDrafts.updateV1("order_id");
|
|
18183
19171
|
```
|
|
18184
19172
|
|
|
18185
19173
|
</dd>
|
|
@@ -18195,7 +19183,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18195
19183
|
<dl>
|
|
18196
19184
|
<dd>
|
|
18197
19185
|
|
|
18198
|
-
**
|
|
19186
|
+
**orderId:** `string`
|
|
18199
19187
|
|
|
18200
19188
|
</dd>
|
|
18201
19189
|
</dl>
|
|
@@ -18203,7 +19191,15 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18203
19191
|
<dl>
|
|
18204
19192
|
<dd>
|
|
18205
19193
|
|
|
18206
|
-
**
|
|
19194
|
+
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
19195
|
+
|
|
19196
|
+
</dd>
|
|
19197
|
+
</dl>
|
|
19198
|
+
|
|
19199
|
+
<dl>
|
|
19200
|
+
<dd>
|
|
19201
|
+
|
|
19202
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18207
19203
|
|
|
18208
19204
|
</dd>
|
|
18209
19205
|
</dl>
|
|
@@ -18214,7 +19210,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18214
19210
|
</dl>
|
|
18215
19211
|
</details>
|
|
18216
19212
|
|
|
18217
|
-
<details><summary><code>client.shipping.
|
|
19213
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">setTaskGroupOrderingV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
18218
19214
|
<dl>
|
|
18219
19215
|
<dd>
|
|
18220
19216
|
|
|
@@ -18226,7 +19222,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18226
19222
|
<dl>
|
|
18227
19223
|
<dd>
|
|
18228
19224
|
|
|
18229
|
-
|
|
19225
|
+
Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)
|
|
18230
19226
|
|
|
18231
19227
|
</dd>
|
|
18232
19228
|
</dl>
|
|
@@ -18242,7 +19238,9 @@ Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executo
|
|
|
18242
19238
|
<dd>
|
|
18243
19239
|
|
|
18244
19240
|
```typescript
|
|
18245
|
-
await client.shipping.
|
|
19241
|
+
await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
19242
|
+
task_group_ids: ["task_group_ids"],
|
|
19243
|
+
});
|
|
18246
19244
|
```
|
|
18247
19245
|
|
|
18248
19246
|
</dd>
|
|
@@ -18258,7 +19256,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18258
19256
|
<dl>
|
|
18259
19257
|
<dd>
|
|
18260
19258
|
|
|
18261
|
-
**
|
|
19259
|
+
**orderId:** `string`
|
|
18262
19260
|
|
|
18263
19261
|
</dd>
|
|
18264
19262
|
</dl>
|
|
@@ -18266,7 +19264,15 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18266
19264
|
<dl>
|
|
18267
19265
|
<dd>
|
|
18268
19266
|
|
|
18269
|
-
**
|
|
19267
|
+
**request:** `Chrt.shipping.SetTaskGroupOrderingDraftReq`
|
|
19268
|
+
|
|
19269
|
+
</dd>
|
|
19270
|
+
</dl>
|
|
19271
|
+
|
|
19272
|
+
<dl>
|
|
19273
|
+
<dd>
|
|
19274
|
+
|
|
19275
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18270
19276
|
|
|
18271
19277
|
</dd>
|
|
18272
19278
|
</dl>
|
|
@@ -18277,7 +19283,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18277
19283
|
</dl>
|
|
18278
19284
|
</details>
|
|
18279
19285
|
|
|
18280
|
-
<details><summary><code>client.shipping.
|
|
19286
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
18281
19287
|
<dl>
|
|
18282
19288
|
<dd>
|
|
18283
19289
|
|
|
@@ -18289,7 +19295,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18289
19295
|
<dl>
|
|
18290
19296
|
<dd>
|
|
18291
19297
|
|
|
18292
|
-
Deletes a
|
|
19298
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
18293
19299
|
|
|
18294
19300
|
</dd>
|
|
18295
19301
|
</dl>
|
|
@@ -18305,7 +19311,7 @@ Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
|
18305
19311
|
<dd>
|
|
18306
19312
|
|
|
18307
19313
|
```typescript
|
|
18308
|
-
await client.shipping.
|
|
19314
|
+
await client.shipping.orderDrafts.deleteV1("order_id");
|
|
18309
19315
|
```
|
|
18310
19316
|
|
|
18311
19317
|
</dd>
|
|
@@ -18321,7 +19327,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18321
19327
|
<dl>
|
|
18322
19328
|
<dd>
|
|
18323
19329
|
|
|
18324
|
-
**
|
|
19330
|
+
**orderId:** `string`
|
|
18325
19331
|
|
|
18326
19332
|
</dd>
|
|
18327
19333
|
</dl>
|
|
@@ -18329,7 +19335,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18329
19335
|
<dl>
|
|
18330
19336
|
<dd>
|
|
18331
19337
|
|
|
18332
|
-
**requestOptions:** `
|
|
19338
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18333
19339
|
|
|
18334
19340
|
</dd>
|
|
18335
19341
|
</dl>
|
|
@@ -18340,9 +19346,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18340
19346
|
</dl>
|
|
18341
19347
|
</details>
|
|
18342
19348
|
|
|
18343
|
-
|
|
18344
|
-
|
|
18345
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
19349
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18346
19350
|
<dl>
|
|
18347
19351
|
<dd>
|
|
18348
19352
|
|
|
@@ -18354,7 +19358,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18354
19358
|
<dl>
|
|
18355
19359
|
<dd>
|
|
18356
19360
|
|
|
18357
|
-
|
|
19361
|
+
Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)
|
|
18358
19362
|
|
|
18359
19363
|
</dd>
|
|
18360
19364
|
</dl>
|
|
@@ -18370,9 +19374,8 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
18370
19374
|
<dd>
|
|
18371
19375
|
|
|
18372
19376
|
```typescript
|
|
18373
|
-
await client.shipping.
|
|
18374
|
-
|
|
18375
|
-
limit: 1,
|
|
19377
|
+
await client.shipping.orderDrafts.deleteManyV1({
|
|
19378
|
+
order_ids: ["order_ids"],
|
|
18376
19379
|
});
|
|
18377
19380
|
```
|
|
18378
19381
|
|
|
@@ -18389,7 +19392,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18389
19392
|
<dl>
|
|
18390
19393
|
<dd>
|
|
18391
19394
|
|
|
18392
|
-
**request:** `Chrt.shipping.
|
|
19395
|
+
**request:** `Chrt.shipping.OrdersDraftDeleteManyReq`
|
|
18393
19396
|
|
|
18394
19397
|
</dd>
|
|
18395
19398
|
</dl>
|
|
@@ -18397,7 +19400,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18397
19400
|
<dl>
|
|
18398
19401
|
<dd>
|
|
18399
19402
|
|
|
18400
|
-
**requestOptions:** `
|
|
19403
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18401
19404
|
|
|
18402
19405
|
</dd>
|
|
18403
19406
|
</dl>
|
|
@@ -18408,7 +19411,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18408
19411
|
</dl>
|
|
18409
19412
|
</details>
|
|
18410
19413
|
|
|
18411
|
-
<details><summary><code>client.shipping.
|
|
19414
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
18412
19415
|
<dl>
|
|
18413
19416
|
<dd>
|
|
18414
19417
|
|
|
@@ -18420,7 +19423,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18420
19423
|
<dl>
|
|
18421
19424
|
<dd>
|
|
18422
19425
|
|
|
18423
|
-
|
|
19426
|
+
Converts an order screenshot into lightly structured text for the AI order builder. | authz: min_org_role=operator | (UploadFile) -> (str)
|
|
18424
19427
|
|
|
18425
19428
|
</dd>
|
|
18426
19429
|
</dl>
|
|
@@ -18436,7 +19439,9 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
18436
19439
|
<dd>
|
|
18437
19440
|
|
|
18438
19441
|
```typescript
|
|
18439
|
-
await client.shipping.
|
|
19442
|
+
await client.shipping.orderDrafts.imageToTextV1({
|
|
19443
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
19444
|
+
});
|
|
18440
19445
|
```
|
|
18441
19446
|
|
|
18442
19447
|
</dd>
|
|
@@ -18452,7 +19457,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18452
19457
|
<dl>
|
|
18453
19458
|
<dd>
|
|
18454
19459
|
|
|
18455
|
-
**
|
|
19460
|
+
**request:** `Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post`
|
|
18456
19461
|
|
|
18457
19462
|
</dd>
|
|
18458
19463
|
</dl>
|
|
@@ -18460,7 +19465,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18460
19465
|
<dl>
|
|
18461
19466
|
<dd>
|
|
18462
19467
|
|
|
18463
|
-
**requestOptions:** `
|
|
19468
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18464
19469
|
|
|
18465
19470
|
</dd>
|
|
18466
19471
|
</dl>
|
|
@@ -18471,7 +19476,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18471
19476
|
</dl>
|
|
18472
19477
|
</details>
|
|
18473
19478
|
|
|
18474
|
-
<details><summary><code>client.shipping.
|
|
19479
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
18475
19480
|
<dl>
|
|
18476
19481
|
<dd>
|
|
18477
19482
|
|
|
@@ -18483,7 +19488,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18483
19488
|
<dl>
|
|
18484
19489
|
<dd>
|
|
18485
19490
|
|
|
18486
|
-
|
|
19491
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
18487
19492
|
|
|
18488
19493
|
</dd>
|
|
18489
19494
|
</dl>
|
|
@@ -18499,7 +19504,10 @@ Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_crea
|
|
|
18499
19504
|
<dd>
|
|
18500
19505
|
|
|
18501
19506
|
```typescript
|
|
18502
|
-
await client.shipping.
|
|
19507
|
+
await client.shipping.orderDrafts.typeaheadV1({
|
|
19508
|
+
query: "query",
|
|
19509
|
+
limit: 1,
|
|
19510
|
+
});
|
|
18503
19511
|
```
|
|
18504
19512
|
|
|
18505
19513
|
</dd>
|
|
@@ -18515,15 +19523,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18515
19523
|
<dl>
|
|
18516
19524
|
<dd>
|
|
18517
19525
|
|
|
18518
|
-
**
|
|
18519
|
-
|
|
18520
|
-
</dd>
|
|
18521
|
-
</dl>
|
|
18522
|
-
|
|
18523
|
-
<dl>
|
|
18524
|
-
<dd>
|
|
18525
|
-
|
|
18526
|
-
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
19526
|
+
**request:** `Chrt.shipping.OrderDraftsTypeaheadV1Request`
|
|
18527
19527
|
|
|
18528
19528
|
</dd>
|
|
18529
19529
|
</dl>
|
|
@@ -18531,7 +19531,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18531
19531
|
<dl>
|
|
18532
19532
|
<dd>
|
|
18533
19533
|
|
|
18534
|
-
**requestOptions:** `
|
|
19534
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18535
19535
|
|
|
18536
19536
|
</dd>
|
|
18537
19537
|
</dl>
|
|
@@ -18542,7 +19542,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18542
19542
|
</dl>
|
|
18543
19543
|
</details>
|
|
18544
19544
|
|
|
18545
|
-
<details><summary><code>client.shipping.
|
|
19545
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
18546
19546
|
<dl>
|
|
18547
19547
|
<dd>
|
|
18548
19548
|
|
|
@@ -18554,7 +19554,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18554
19554
|
<dl>
|
|
18555
19555
|
<dd>
|
|
18556
19556
|
|
|
18557
|
-
|
|
19557
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
18558
19558
|
|
|
18559
19559
|
</dd>
|
|
18560
19560
|
</dl>
|
|
@@ -18570,7 +19570,7 @@ Cancels an order and non-terminal child entities in a transaction. | authz_perso
|
|
|
18570
19570
|
<dd>
|
|
18571
19571
|
|
|
18572
19572
|
```typescript
|
|
18573
|
-
await client.shipping.
|
|
19573
|
+
await client.shipping.orderDrafts.validateV1("order_id");
|
|
18574
19574
|
```
|
|
18575
19575
|
|
|
18576
19576
|
</dd>
|
|
@@ -18594,7 +19594,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18594
19594
|
<dl>
|
|
18595
19595
|
<dd>
|
|
18596
19596
|
|
|
18597
|
-
**requestOptions:** `
|
|
19597
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18598
19598
|
|
|
18599
19599
|
</dd>
|
|
18600
19600
|
</dl>
|
|
@@ -18605,7 +19605,9 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18605
19605
|
</dl>
|
|
18606
19606
|
</details>
|
|
18607
19607
|
|
|
18608
|
-
|
|
19608
|
+
## Shipping OrderGroups
|
|
19609
|
+
|
|
19610
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderGroupListRes</code></summary>
|
|
18609
19611
|
<dl>
|
|
18610
19612
|
<dd>
|
|
18611
19613
|
|
|
@@ -18617,7 +19619,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18617
19619
|
<dl>
|
|
18618
19620
|
<dd>
|
|
18619
19621
|
|
|
18620
|
-
|
|
19622
|
+
Lists order groups for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroupListRes)
|
|
18621
19623
|
|
|
18622
19624
|
</dd>
|
|
18623
19625
|
</dl>
|
|
@@ -18633,8 +19635,14 @@ Cancels multiple orders and their non-terminal child entities in a transaction.
|
|
|
18633
19635
|
<dd>
|
|
18634
19636
|
|
|
18635
19637
|
```typescript
|
|
18636
|
-
await client.shipping.
|
|
18637
|
-
|
|
19638
|
+
await client.shipping.orderGroups.listV1({
|
|
19639
|
+
sort_by: "created_at_timestamp",
|
|
19640
|
+
sort_order: "asc",
|
|
19641
|
+
page: 1,
|
|
19642
|
+
page_size: 1,
|
|
19643
|
+
filter_order_id: "filter_order_id",
|
|
19644
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19645
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18638
19646
|
});
|
|
18639
19647
|
```
|
|
18640
19648
|
|
|
@@ -18651,7 +19659,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18651
19659
|
<dl>
|
|
18652
19660
|
<dd>
|
|
18653
19661
|
|
|
18654
|
-
**request:** `Chrt.shipping.
|
|
19662
|
+
**request:** `Chrt.shipping.OrderGroupsListV1Request`
|
|
18655
19663
|
|
|
18656
19664
|
</dd>
|
|
18657
19665
|
</dl>
|
|
@@ -18659,7 +19667,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18659
19667
|
<dl>
|
|
18660
19668
|
<dd>
|
|
18661
19669
|
|
|
18662
|
-
**requestOptions:** `
|
|
19670
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18663
19671
|
|
|
18664
19672
|
</dd>
|
|
18665
19673
|
</dl>
|
|
@@ -18670,9 +19678,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18670
19678
|
</dl>
|
|
18671
19679
|
</details>
|
|
18672
19680
|
|
|
18673
|
-
|
|
18674
|
-
|
|
18675
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
19681
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">getByIdV1</a>(orderGroupId) -> Chrt.OrderGroup1</code></summary>
|
|
18676
19682
|
<dl>
|
|
18677
19683
|
<dd>
|
|
18678
19684
|
|
|
@@ -18684,7 +19690,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18684
19690
|
<dl>
|
|
18685
19691
|
<dd>
|
|
18686
19692
|
|
|
18687
|
-
|
|
19693
|
+
Retrieves an order group by ID. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)
|
|
18688
19694
|
|
|
18689
19695
|
</dd>
|
|
18690
19696
|
</dl>
|
|
@@ -18700,7 +19706,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
18700
19706
|
<dd>
|
|
18701
19707
|
|
|
18702
19708
|
```typescript
|
|
18703
|
-
await client.shipping.
|
|
19709
|
+
await client.shipping.orderGroups.getByIdV1("order_group_id");
|
|
18704
19710
|
```
|
|
18705
19711
|
|
|
18706
19712
|
</dd>
|
|
@@ -18716,7 +19722,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18716
19722
|
<dl>
|
|
18717
19723
|
<dd>
|
|
18718
19724
|
|
|
18719
|
-
**
|
|
19725
|
+
**orderGroupId:** `string`
|
|
18720
19726
|
|
|
18721
19727
|
</dd>
|
|
18722
19728
|
</dl>
|
|
@@ -18724,7 +19730,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18724
19730
|
<dl>
|
|
18725
19731
|
<dd>
|
|
18726
19732
|
|
|
18727
|
-
**requestOptions:** `
|
|
19733
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18728
19734
|
|
|
18729
19735
|
</dd>
|
|
18730
19736
|
</dl>
|
|
@@ -18735,7 +19741,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18735
19741
|
</dl>
|
|
18736
19742
|
</details>
|
|
18737
19743
|
|
|
18738
|
-
<details><summary><code>client.shipping.
|
|
19744
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrderGroup1</code></summary>
|
|
18739
19745
|
<dl>
|
|
18740
19746
|
<dd>
|
|
18741
19747
|
|
|
@@ -18747,7 +19753,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18747
19753
|
<dl>
|
|
18748
19754
|
<dd>
|
|
18749
19755
|
|
|
18750
|
-
|
|
19756
|
+
Creates an order group owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupClientCreate1) -> (OrderGroup1)
|
|
18751
19757
|
|
|
18752
19758
|
</dd>
|
|
18753
19759
|
</dl>
|
|
@@ -18763,7 +19769,10 @@ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersD
|
|
|
18763
19769
|
<dd>
|
|
18764
19770
|
|
|
18765
19771
|
```typescript
|
|
18766
|
-
await client.shipping.
|
|
19772
|
+
await client.shipping.orderGroups.newV1({
|
|
19773
|
+
schema_version: 1,
|
|
19774
|
+
name: "name",
|
|
19775
|
+
});
|
|
18767
19776
|
```
|
|
18768
19777
|
|
|
18769
19778
|
</dd>
|
|
@@ -18779,15 +19788,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18779
19788
|
<dl>
|
|
18780
19789
|
<dd>
|
|
18781
19790
|
|
|
18782
|
-
**
|
|
18783
|
-
|
|
18784
|
-
</dd>
|
|
18785
|
-
</dl>
|
|
18786
|
-
|
|
18787
|
-
<dl>
|
|
18788
|
-
<dd>
|
|
18789
|
-
|
|
18790
|
-
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
19791
|
+
**request:** `Chrt.shipping.OrderGroupClientCreate1`
|
|
18791
19792
|
|
|
18792
19793
|
</dd>
|
|
18793
19794
|
</dl>
|
|
@@ -18795,7 +19796,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18795
19796
|
<dl>
|
|
18796
19797
|
<dd>
|
|
18797
19798
|
|
|
18798
|
-
**requestOptions:** `
|
|
19799
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18799
19800
|
|
|
18800
19801
|
</dd>
|
|
18801
19802
|
</dl>
|
|
@@ -18806,7 +19807,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18806
19807
|
</dl>
|
|
18807
19808
|
</details>
|
|
18808
19809
|
|
|
18809
|
-
<details><summary><code>client.shipping.
|
|
19810
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">updateV1</a>(orderGroupId, { ...params }) -> Chrt.OrderGroup1</code></summary>
|
|
18810
19811
|
<dl>
|
|
18811
19812
|
<dd>
|
|
18812
19813
|
|
|
@@ -18818,7 +19819,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18818
19819
|
<dl>
|
|
18819
19820
|
<dd>
|
|
18820
19821
|
|
|
18821
|
-
|
|
19822
|
+
Updates an order group's name or description. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupClientUpdate1) -> (OrderGroup1)
|
|
18822
19823
|
|
|
18823
19824
|
</dd>
|
|
18824
19825
|
</dl>
|
|
@@ -18834,9 +19835,7 @@ Sets the ordering of task groups within a draft order. Must provide all task gro
|
|
|
18834
19835
|
<dd>
|
|
18835
19836
|
|
|
18836
19837
|
```typescript
|
|
18837
|
-
await client.shipping.
|
|
18838
|
-
task_group_ids: ["task_group_ids"],
|
|
18839
|
-
});
|
|
19838
|
+
await client.shipping.orderGroups.updateV1("order_group_id");
|
|
18840
19839
|
```
|
|
18841
19840
|
|
|
18842
19841
|
</dd>
|
|
@@ -18852,7 +19851,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18852
19851
|
<dl>
|
|
18853
19852
|
<dd>
|
|
18854
19853
|
|
|
18855
|
-
**
|
|
19854
|
+
**orderGroupId:** `string`
|
|
18856
19855
|
|
|
18857
19856
|
</dd>
|
|
18858
19857
|
</dl>
|
|
@@ -18860,7 +19859,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18860
19859
|
<dl>
|
|
18861
19860
|
<dd>
|
|
18862
19861
|
|
|
18863
|
-
**request:** `Chrt.shipping.
|
|
19862
|
+
**request:** `Chrt.shipping.OrderGroupClientUpdate1`
|
|
18864
19863
|
|
|
18865
19864
|
</dd>
|
|
18866
19865
|
</dl>
|
|
@@ -18868,7 +19867,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18868
19867
|
<dl>
|
|
18869
19868
|
<dd>
|
|
18870
19869
|
|
|
18871
|
-
**requestOptions:** `
|
|
19870
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18872
19871
|
|
|
18873
19872
|
</dd>
|
|
18874
19873
|
</dl>
|
|
@@ -18879,7 +19878,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18879
19878
|
</dl>
|
|
18880
19879
|
</details>
|
|
18881
19880
|
|
|
18882
|
-
<details><summary><code>client.shipping.
|
|
19881
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">addOrderV1</a>(orderGroupId, orderId) -> Chrt.OrderGroup1</code></summary>
|
|
18883
19882
|
<dl>
|
|
18884
19883
|
<dd>
|
|
18885
19884
|
|
|
@@ -18891,7 +19890,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18891
19890
|
<dl>
|
|
18892
19891
|
<dd>
|
|
18893
19892
|
|
|
18894
|
-
|
|
19893
|
+
Adds an order to an order group. The caller's org must be the coordinator or an executor on the order, and the order must not already belong to another of the caller's groups. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)
|
|
18895
19894
|
|
|
18896
19895
|
</dd>
|
|
18897
19896
|
</dl>
|
|
@@ -18907,7 +19906,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
18907
19906
|
<dd>
|
|
18908
19907
|
|
|
18909
19908
|
```typescript
|
|
18910
|
-
await client.shipping.
|
|
19909
|
+
await client.shipping.orderGroups.addOrderV1("order_group_id", "order_id");
|
|
18911
19910
|
```
|
|
18912
19911
|
|
|
18913
19912
|
</dd>
|
|
@@ -18923,6 +19922,14 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18923
19922
|
<dl>
|
|
18924
19923
|
<dd>
|
|
18925
19924
|
|
|
19925
|
+
**orderGroupId:** `string`
|
|
19926
|
+
|
|
19927
|
+
</dd>
|
|
19928
|
+
</dl>
|
|
19929
|
+
|
|
19930
|
+
<dl>
|
|
19931
|
+
<dd>
|
|
19932
|
+
|
|
18926
19933
|
**orderId:** `string`
|
|
18927
19934
|
|
|
18928
19935
|
</dd>
|
|
@@ -18931,7 +19938,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18931
19938
|
<dl>
|
|
18932
19939
|
<dd>
|
|
18933
19940
|
|
|
18934
|
-
**requestOptions:** `
|
|
19941
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18935
19942
|
|
|
18936
19943
|
</dd>
|
|
18937
19944
|
</dl>
|
|
@@ -18942,7 +19949,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18942
19949
|
</dl>
|
|
18943
19950
|
</details>
|
|
18944
19951
|
|
|
18945
|
-
<details><summary><code>client.shipping.
|
|
19952
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">removeOrderV1</a>(orderGroupId, orderId) -> Chrt.OrderGroup1</code></summary>
|
|
18946
19953
|
<dl>
|
|
18947
19954
|
<dd>
|
|
18948
19955
|
|
|
@@ -18954,7 +19961,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18954
19961
|
<dl>
|
|
18955
19962
|
<dd>
|
|
18956
19963
|
|
|
18957
|
-
|
|
19964
|
+
Removes an order from an order group. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)
|
|
18958
19965
|
|
|
18959
19966
|
</dd>
|
|
18960
19967
|
</dl>
|
|
@@ -18970,9 +19977,7 @@ Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyR
|
|
|
18970
19977
|
<dd>
|
|
18971
19978
|
|
|
18972
19979
|
```typescript
|
|
18973
|
-
await client.shipping.
|
|
18974
|
-
order_ids: ["order_ids"],
|
|
18975
|
-
});
|
|
19980
|
+
await client.shipping.orderGroups.removeOrderV1("order_group_id", "order_id");
|
|
18976
19981
|
```
|
|
18977
19982
|
|
|
18978
19983
|
</dd>
|
|
@@ -18988,7 +19993,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
18988
19993
|
<dl>
|
|
18989
19994
|
<dd>
|
|
18990
19995
|
|
|
18991
|
-
**
|
|
19996
|
+
**orderGroupId:** `string`
|
|
18992
19997
|
|
|
18993
19998
|
</dd>
|
|
18994
19999
|
</dl>
|
|
@@ -18996,7 +20001,15 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
18996
20001
|
<dl>
|
|
18997
20002
|
<dd>
|
|
18998
20003
|
|
|
18999
|
-
**
|
|
20004
|
+
**orderId:** `string`
|
|
20005
|
+
|
|
20006
|
+
</dd>
|
|
20007
|
+
</dl>
|
|
20008
|
+
|
|
20009
|
+
<dl>
|
|
20010
|
+
<dd>
|
|
20011
|
+
|
|
20012
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
19000
20013
|
|
|
19001
20014
|
</dd>
|
|
19002
20015
|
</dl>
|
|
@@ -19007,7 +20020,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
19007
20020
|
</dl>
|
|
19008
20021
|
</details>
|
|
19009
20022
|
|
|
19010
|
-
<details><summary><code>client.shipping.
|
|
20023
|
+
<details><summary><code>client.shipping.orderGroups.<a href="/src/api/resources/shipping/resources/orderGroups/client/Client.ts">setBillingReviewStatusV1</a>(orderGroupId, { ...params }) -> Chrt.OrderGroup1</code></summary>
|
|
19011
20024
|
<dl>
|
|
19012
20025
|
<dd>
|
|
19013
20026
|
|
|
@@ -19019,7 +20032,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
19019
20032
|
<dl>
|
|
19020
20033
|
<dd>
|
|
19021
20034
|
|
|
19022
|
-
|
|
20035
|
+
Sets the order group's operator billing-review status. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupSetBillingReviewStatusReq) -> (OrderGroup1)
|
|
19023
20036
|
|
|
19024
20037
|
</dd>
|
|
19025
20038
|
</dl>
|
|
@@ -19035,8 +20048,8 @@ Converts an order screenshot into lightly structured text for the AI order build
|
|
|
19035
20048
|
<dd>
|
|
19036
20049
|
|
|
19037
20050
|
```typescript
|
|
19038
|
-
await client.shipping.
|
|
19039
|
-
|
|
20051
|
+
await client.shipping.orderGroups.setBillingReviewStatusV1("order_group_id", {
|
|
20052
|
+
billing_review_status: "not_started",
|
|
19040
20053
|
});
|
|
19041
20054
|
```
|
|
19042
20055
|
|
|
@@ -19053,7 +20066,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19053
20066
|
<dl>
|
|
19054
20067
|
<dd>
|
|
19055
20068
|
|
|
19056
|
-
**
|
|
20069
|
+
**orderGroupId:** `string`
|
|
19057
20070
|
|
|
19058
20071
|
</dd>
|
|
19059
20072
|
</dl>
|
|
@@ -19061,7 +20074,15 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19061
20074
|
<dl>
|
|
19062
20075
|
<dd>
|
|
19063
20076
|
|
|
19064
|
-
**
|
|
20077
|
+
**request:** `Chrt.shipping.OrderGroupSetBillingReviewStatusReq`
|
|
20078
|
+
|
|
20079
|
+
</dd>
|
|
20080
|
+
</dl>
|
|
20081
|
+
|
|
20082
|
+
<dl>
|
|
20083
|
+
<dd>
|
|
20084
|
+
|
|
20085
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
19065
20086
|
|
|
19066
20087
|
</dd>
|
|
19067
20088
|
</dl>
|
|
@@ -19072,7 +20093,9 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19072
20093
|
</dl>
|
|
19073
20094
|
</details>
|
|
19074
20095
|
|
|
19075
|
-
|
|
20096
|
+
## Shipping OrdersAndOrderGroups
|
|
20097
|
+
|
|
20098
|
+
<details><summary><code>client.shipping.ordersAndOrderGroups.<a href="/src/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.ts">orderGroupsListV1</a>({ ...params }) -> Chrt.OrderGroupExpandedListRes</code></summary>
|
|
19076
20099
|
<dl>
|
|
19077
20100
|
<dd>
|
|
19078
20101
|
|
|
@@ -19084,7 +20107,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19084
20107
|
<dl>
|
|
19085
20108
|
<dd>
|
|
19086
20109
|
|
|
19087
|
-
|
|
20110
|
+
Lists the caller's order groups with member orders nested and a derived shipping-status rollup. Filtering, sorting, and pagination use stored group fields. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroupExpandedListRes)
|
|
19088
20111
|
|
|
19089
20112
|
</dd>
|
|
19090
20113
|
</dl>
|
|
@@ -19100,9 +20123,14 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
19100
20123
|
<dd>
|
|
19101
20124
|
|
|
19102
20125
|
```typescript
|
|
19103
|
-
await client.shipping.
|
|
19104
|
-
|
|
19105
|
-
|
|
20126
|
+
await client.shipping.ordersAndOrderGroups.orderGroupsListV1({
|
|
20127
|
+
sort_by: "created_at_timestamp",
|
|
20128
|
+
sort_order: "asc",
|
|
20129
|
+
page: 1,
|
|
20130
|
+
page_size: 1,
|
|
20131
|
+
filter_order_id: "filter_order_id",
|
|
20132
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20133
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19106
20134
|
});
|
|
19107
20135
|
```
|
|
19108
20136
|
|
|
@@ -19119,7 +20147,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19119
20147
|
<dl>
|
|
19120
20148
|
<dd>
|
|
19121
20149
|
|
|
19122
|
-
**request:** `Chrt.shipping.
|
|
20150
|
+
**request:** `Chrt.shipping.OrdersAndOrderGroupsOrderGroupsListV1Request`
|
|
19123
20151
|
|
|
19124
20152
|
</dd>
|
|
19125
20153
|
</dl>
|
|
@@ -19127,7 +20155,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19127
20155
|
<dl>
|
|
19128
20156
|
<dd>
|
|
19129
20157
|
|
|
19130
|
-
**requestOptions:** `
|
|
20158
|
+
**requestOptions:** `OrdersAndOrderGroups.RequestOptions`
|
|
19131
20159
|
|
|
19132
20160
|
</dd>
|
|
19133
20161
|
</dl>
|
|
@@ -19138,7 +20166,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19138
20166
|
</dl>
|
|
19139
20167
|
</details>
|
|
19140
20168
|
|
|
19141
|
-
<details><summary><code>client.shipping.
|
|
20169
|
+
<details><summary><code>client.shipping.ordersAndOrderGroups.<a href="/src/api/resources/shipping/resources/ordersAndOrderGroups/client/Client.ts">ungroupedOrdersListV1</a>({ ...params }) -> Chrt.UngroupedOrderListRes</code></summary>
|
|
19142
20170
|
<dl>
|
|
19143
20171
|
<dd>
|
|
19144
20172
|
|
|
@@ -19150,7 +20178,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19150
20178
|
<dl>
|
|
19151
20179
|
<dd>
|
|
19152
20180
|
|
|
19153
|
-
|
|
20181
|
+
Lists the caller's standalone orders (provider party, non-DRAFT, not in any of the caller's order groups), each with the caller org's billing-review status. Filtering, sorting, and pagination use stored Order fields. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (UngroupedOrderListRes)
|
|
19154
20182
|
|
|
19155
20183
|
</dd>
|
|
19156
20184
|
</dl>
|
|
@@ -19166,7 +20194,12 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
19166
20194
|
<dd>
|
|
19167
20195
|
|
|
19168
20196
|
```typescript
|
|
19169
|
-
await client.shipping.
|
|
20197
|
+
await client.shipping.ordersAndOrderGroups.ungroupedOrdersListV1({
|
|
20198
|
+
sort_by: "draft_started_at_timestamp",
|
|
20199
|
+
sort_order: "asc",
|
|
20200
|
+
page: 1,
|
|
20201
|
+
page_size: 1,
|
|
20202
|
+
});
|
|
19170
20203
|
```
|
|
19171
20204
|
|
|
19172
20205
|
</dd>
|
|
@@ -19182,7 +20215,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
19182
20215
|
<dl>
|
|
19183
20216
|
<dd>
|
|
19184
20217
|
|
|
19185
|
-
**
|
|
20218
|
+
**request:** `Chrt.shipping.OrdersAndOrderGroupsUngroupedOrdersListV1Request`
|
|
19186
20219
|
|
|
19187
20220
|
</dd>
|
|
19188
20221
|
</dl>
|
|
@@ -19190,7 +20223,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
19190
20223
|
<dl>
|
|
19191
20224
|
<dd>
|
|
19192
20225
|
|
|
19193
|
-
**requestOptions:** `
|
|
20226
|
+
**requestOptions:** `OrdersAndOrderGroups.RequestOptions`
|
|
19194
20227
|
|
|
19195
20228
|
</dd>
|
|
19196
20229
|
</dl>
|
|
@@ -19845,7 +20878,7 @@ await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
|
19845
20878
|
|
|
19846
20879
|
## Shipping OrderTemplates
|
|
19847
20880
|
|
|
19848
|
-
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getExpandedByIdV1</a>(orderTemplateId) -> Chrt.
|
|
20881
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getExpandedByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplateExpanded1</code></summary>
|
|
19849
20882
|
<dl>
|
|
19850
20883
|
<dd>
|
|
19851
20884
|
|
|
@@ -19857,7 +20890,7 @@ await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
|
19857
20890
|
<dl>
|
|
19858
20891
|
<dd>
|
|
19859
20892
|
|
|
19860
|
-
Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (
|
|
20893
|
+
Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded1)
|
|
19861
20894
|
|
|
19862
20895
|
</dd>
|
|
19863
20896
|
</dl>
|
|
@@ -19920,7 +20953,7 @@ await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
|
19920
20953
|
<dl>
|
|
19921
20954
|
<dd>
|
|
19922
20955
|
|
|
19923
|
-
Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description,
|
|
20956
|
+
Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, text, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)
|
|
19924
20957
|
|
|
19925
20958
|
</dd>
|
|
19926
20959
|
</dl>
|
|
@@ -23380,7 +24413,7 @@ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_comp
|
|
|
23380
24413
|
|
|
23381
24414
|
## Shipping OrderDrafts Agentic
|
|
23382
24415
|
|
|
23383
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24416
|
+
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrderBuilderRes</code></summary>
|
|
23384
24417
|
<dl>
|
|
23385
24418
|
<dd>
|
|
23386
24419
|
|
|
@@ -23392,7 +24425,7 @@ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_comp
|
|
|
23392
24425
|
<dl>
|
|
23393
24426
|
<dd>
|
|
23394
24427
|
|
|
23395
|
-
|
|
24428
|
+
Creates a draft order, populating cargo, task groups, and tasks parsed from natural language or a template. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderRes)
|
|
23396
24429
|
|
|
23397
24430
|
</dd>
|
|
23398
24431
|
</dl>
|
|
@@ -23408,10 +24441,7 @@ Predicts whether input is complete enough for the AI order builder. | (OrderBuil
|
|
|
23408
24441
|
<dd>
|
|
23409
24442
|
|
|
23410
24443
|
```typescript
|
|
23411
|
-
await client.shipping.orderDrafts.agentic.
|
|
23412
|
-
order_short_id: "order_short_id",
|
|
23413
|
-
text: "text",
|
|
23414
|
-
});
|
|
24444
|
+
await client.shipping.orderDrafts.agentic.newV1({});
|
|
23415
24445
|
```
|
|
23416
24446
|
|
|
23417
24447
|
</dd>
|
|
@@ -23446,7 +24476,7 @@ await client.shipping.orderDrafts.agentic.precheckV1({
|
|
|
23446
24476
|
</dl>
|
|
23447
24477
|
</details>
|
|
23448
24478
|
|
|
23449
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24479
|
+
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">newWithStreamingV1</a>({ ...params }) -> core.Stream<Chrt.OrderBuilderStreamEvent></code></summary>
|
|
23450
24480
|
<dl>
|
|
23451
24481
|
<dd>
|
|
23452
24482
|
|
|
@@ -23458,7 +24488,7 @@ await client.shipping.orderDrafts.agentic.precheckV1({
|
|
|
23458
24488
|
<dl>
|
|
23459
24489
|
<dd>
|
|
23460
24490
|
|
|
23461
|
-
|
|
24491
|
+
Creates a draft order from natural language or a template and streams progress events via SSE. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderStreamEvent)
|
|
23462
24492
|
|
|
23463
24493
|
</dd>
|
|
23464
24494
|
</dl>
|
|
@@ -23474,10 +24504,10 @@ Populates an existing draft order with cargo, task groups, and tasks parsed from
|
|
|
23474
24504
|
<dd>
|
|
23475
24505
|
|
|
23476
24506
|
```typescript
|
|
23477
|
-
await client.shipping.orderDrafts.agentic.
|
|
23478
|
-
|
|
23479
|
-
|
|
23480
|
-
}
|
|
24507
|
+
const response = await client.shipping.orderDrafts.agentic.newWithStreamingV1({});
|
|
24508
|
+
for await (const item of response) {
|
|
24509
|
+
console.log(item);
|
|
24510
|
+
}
|
|
23481
24511
|
```
|
|
23482
24512
|
|
|
23483
24513
|
</dd>
|
|
@@ -23512,7 +24542,7 @@ await client.shipping.orderDrafts.agentic.newV1({
|
|
|
23512
24542
|
</dl>
|
|
23513
24543
|
</details>
|
|
23514
24544
|
|
|
23515
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24545
|
+
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">precheckV1</a>({ ...params }) -> Chrt.OrderTemplateResolvabilityRes</code></summary>
|
|
23516
24546
|
<dl>
|
|
23517
24547
|
<dd>
|
|
23518
24548
|
|
|
@@ -23524,7 +24554,7 @@ await client.shipping.orderDrafts.agentic.newV1({
|
|
|
23524
24554
|
<dl>
|
|
23525
24555
|
<dd>
|
|
23526
24556
|
|
|
23527
|
-
|
|
24557
|
+
Reports whether an order builder request's references resolve. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderTemplateResolvabilityRes)
|
|
23528
24558
|
|
|
23529
24559
|
</dd>
|
|
23530
24560
|
</dl>
|
|
@@ -23540,13 +24570,7 @@ Populates an existing draft order from natural language and streams progress eve
|
|
|
23540
24570
|
<dd>
|
|
23541
24571
|
|
|
23542
24572
|
```typescript
|
|
23543
|
-
|
|
23544
|
-
order_short_id: "order_short_id",
|
|
23545
|
-
text: "text",
|
|
23546
|
-
});
|
|
23547
|
-
for await (const item of response) {
|
|
23548
|
-
console.log(item);
|
|
23549
|
-
}
|
|
24573
|
+
await client.shipping.orderDrafts.agentic.precheckV1({});
|
|
23550
24574
|
```
|
|
23551
24575
|
|
|
23552
24576
|
</dd>
|
|
@@ -28029,7 +29053,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
28029
29053
|
<dl>
|
|
28030
29054
|
<dd>
|
|
28031
29055
|
|
|
28032
|
-
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~
|
|
29056
|
+
Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~1 week out at 8 PM PT. Prevent auto termination with `no_auto_termination=True` | auth: api_key | (SessionClientCreate1) -> (PydanticObjectId)
|
|
28033
29057
|
|
|
28034
29058
|
</dd>
|
|
28035
29059
|
</dl>
|