@chrt-inc/typescript-sdk 1.760.0 → 1.772.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/notifications/resources/adHoc/client/Client.d.ts +36 -2
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/Client.js +138 -1
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/index.d.ts +1 -1
- 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/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -0
- 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 +2 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +4 -0
- 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/cjs/api/types/{InternalDelegationTokenRes.d.ts → 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/NotificationEventsForAdHocEnum.d.ts +4 -3
- package/dist/cjs/api/types/NotificationEventsForAdHocEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +1 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +2 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +1 -0
- package/dist/cjs/api/types/NotificationIntentAdHoc1.d.ts +2 -1
- package/dist/cjs/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.ts +1 -8
- package/dist/cjs/api/types/NotificationIntentAdHocClientCreate1.js +5 -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/OnboardCourierTaskActionEnum1.d.ts +1 -11
- package/dist/cjs/api/types/OnboardCourierTaskActionEnum1.js +0 -10
- 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/Session1.d.ts +3 -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/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.ts +10 -0
- package/dist/cjs/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.js +5 -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 +22 -6
- package/dist/cjs/api/types/index.js +22 -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/notifications/resources/adHoc/client/Client.d.mts +36 -2
- package/dist/esm/api/resources/notifications/resources/adHoc/client/Client.mjs +138 -1
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/AdHocListBySessionIdV1Request.d.mts +14 -0
- package/dist/esm/api/resources/notifications/resources/adHoc/client/requests/index.d.mts +1 -1
- 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/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -0
- 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 +2 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +4 -0
- 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/esm/api/types/{InternalDelegationTokenRes.d.mts → 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/NotificationEventsForAdHocEnum.d.mts +4 -3
- package/dist/esm/api/types/NotificationEventsForAdHocEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +2 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +1 -0
- package/dist/esm/api/types/NotificationIntentAdHoc1.d.mts +2 -1
- package/dist/esm/api/{resources/notifications/resources/adHoc/client/requests → types}/NotificationIntentAdHocClientCreate1.d.mts +1 -8
- package/dist/esm/api/types/NotificationIntentAdHocClientCreate1.mjs +4 -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/OnboardCourierTaskActionEnum1.d.mts +1 -11
- package/dist/esm/api/types/OnboardCourierTaskActionEnum1.mjs +0 -10
- 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/Session1.d.mts +3 -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/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.d.mts +10 -0
- package/dist/esm/api/types/TrackingSessionDestinationGeofenceEnteredWebhookPayload.mjs +4 -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 +22 -6
- package/dist/esm/api/types/index.mjs +22 -6
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1650 -478
- package/dist/cjs/api/types/OrderBuilderPrecheckRes.d.ts +0 -7
- package/dist/esm/api/types/OrderBuilderPrecheckRes.d.mts +0 -7
- /package/dist/cjs/api/resources/notifications/resources/adHoc/client/requests/{NotificationIntentAdHocClientCreate1.js → AdHocListBySessionIdV1Request.js} +0 -0
- /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/resources/notifications/resources/adHoc/client/requests/{NotificationIntentAdHocClientCreate1.mjs → AdHocListBySessionIdV1Request.mjs} +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
|
@@ -9594,6 +9594,80 @@ await client.notifications.adHoc.listByOrderIdV1("order_id", {
|
|
|
9594
9594
|
</dl>
|
|
9595
9595
|
</details>
|
|
9596
9596
|
|
|
9597
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">listBySessionIdV1</a>(sessionId, { ...params }) -> Chrt.NotificationAdHocListRes</code></summary>
|
|
9598
|
+
<dl>
|
|
9599
|
+
<dd>
|
|
9600
|
+
|
|
9601
|
+
#### 📝 Description
|
|
9602
|
+
|
|
9603
|
+
<dl>
|
|
9604
|
+
<dd>
|
|
9605
|
+
|
|
9606
|
+
<dl>
|
|
9607
|
+
<dd>
|
|
9608
|
+
|
|
9609
|
+
Lists all ad-hoc notification intents for a tracking session. | authz: min_org_role=operator | () -> (NotificationAdHocListRes)
|
|
9610
|
+
|
|
9611
|
+
</dd>
|
|
9612
|
+
</dl>
|
|
9613
|
+
</dd>
|
|
9614
|
+
</dl>
|
|
9615
|
+
|
|
9616
|
+
#### 🔌 Usage
|
|
9617
|
+
|
|
9618
|
+
<dl>
|
|
9619
|
+
<dd>
|
|
9620
|
+
|
|
9621
|
+
<dl>
|
|
9622
|
+
<dd>
|
|
9623
|
+
|
|
9624
|
+
```typescript
|
|
9625
|
+
await client.notifications.adHoc.listBySessionIdV1("session_id", {
|
|
9626
|
+
page: 1,
|
|
9627
|
+
page_size: 1,
|
|
9628
|
+
});
|
|
9629
|
+
```
|
|
9630
|
+
|
|
9631
|
+
</dd>
|
|
9632
|
+
</dl>
|
|
9633
|
+
</dd>
|
|
9634
|
+
</dl>
|
|
9635
|
+
|
|
9636
|
+
#### ⚙️ Parameters
|
|
9637
|
+
|
|
9638
|
+
<dl>
|
|
9639
|
+
<dd>
|
|
9640
|
+
|
|
9641
|
+
<dl>
|
|
9642
|
+
<dd>
|
|
9643
|
+
|
|
9644
|
+
**sessionId:** `string`
|
|
9645
|
+
|
|
9646
|
+
</dd>
|
|
9647
|
+
</dl>
|
|
9648
|
+
|
|
9649
|
+
<dl>
|
|
9650
|
+
<dd>
|
|
9651
|
+
|
|
9652
|
+
**request:** `Chrt.notifications.AdHocListBySessionIdV1Request`
|
|
9653
|
+
|
|
9654
|
+
</dd>
|
|
9655
|
+
</dl>
|
|
9656
|
+
|
|
9657
|
+
<dl>
|
|
9658
|
+
<dd>
|
|
9659
|
+
|
|
9660
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9661
|
+
|
|
9662
|
+
</dd>
|
|
9663
|
+
</dl>
|
|
9664
|
+
</dd>
|
|
9665
|
+
</dl>
|
|
9666
|
+
|
|
9667
|
+
</dd>
|
|
9668
|
+
</dl>
|
|
9669
|
+
</details>
|
|
9670
|
+
|
|
9597
9671
|
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createV1</a>(orderId, { ...params }) -> string</code></summary>
|
|
9598
9672
|
<dl>
|
|
9599
9673
|
<dd>
|
|
@@ -9649,7 +9723,81 @@ await client.notifications.adHoc.createV1("order_id", {
|
|
|
9649
9723
|
<dl>
|
|
9650
9724
|
<dd>
|
|
9651
9725
|
|
|
9652
|
-
**request:** `Chrt.
|
|
9726
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9727
|
+
|
|
9728
|
+
</dd>
|
|
9729
|
+
</dl>
|
|
9730
|
+
|
|
9731
|
+
<dl>
|
|
9732
|
+
<dd>
|
|
9733
|
+
|
|
9734
|
+
**requestOptions:** `AdHoc.RequestOptions`
|
|
9735
|
+
|
|
9736
|
+
</dd>
|
|
9737
|
+
</dl>
|
|
9738
|
+
</dd>
|
|
9739
|
+
</dl>
|
|
9740
|
+
|
|
9741
|
+
</dd>
|
|
9742
|
+
</dl>
|
|
9743
|
+
</details>
|
|
9744
|
+
|
|
9745
|
+
<details><summary><code>client.notifications.adHoc.<a href="/src/api/resources/notifications/resources/adHoc/client/Client.ts">createForSessionV1</a>(sessionId, { ...params }) -> string</code></summary>
|
|
9746
|
+
<dl>
|
|
9747
|
+
<dd>
|
|
9748
|
+
|
|
9749
|
+
#### 📝 Description
|
|
9750
|
+
|
|
9751
|
+
<dl>
|
|
9752
|
+
<dd>
|
|
9753
|
+
|
|
9754
|
+
<dl>
|
|
9755
|
+
<dd>
|
|
9756
|
+
|
|
9757
|
+
Creates a new ad-hoc notification intent for a tracking session. | authz: min_org_role=operator | (NotificationIntentAdHocClientCreate1) -> (PydanticObjectId)
|
|
9758
|
+
|
|
9759
|
+
</dd>
|
|
9760
|
+
</dl>
|
|
9761
|
+
</dd>
|
|
9762
|
+
</dl>
|
|
9763
|
+
|
|
9764
|
+
#### 🔌 Usage
|
|
9765
|
+
|
|
9766
|
+
<dl>
|
|
9767
|
+
<dd>
|
|
9768
|
+
|
|
9769
|
+
<dl>
|
|
9770
|
+
<dd>
|
|
9771
|
+
|
|
9772
|
+
```typescript
|
|
9773
|
+
await client.notifications.adHoc.createForSessionV1("session_id", {
|
|
9774
|
+
schema_version: 1,
|
|
9775
|
+
directory_entry_id: "directory_entry_id",
|
|
9776
|
+
});
|
|
9777
|
+
```
|
|
9778
|
+
|
|
9779
|
+
</dd>
|
|
9780
|
+
</dl>
|
|
9781
|
+
</dd>
|
|
9782
|
+
</dl>
|
|
9783
|
+
|
|
9784
|
+
#### ⚙️ Parameters
|
|
9785
|
+
|
|
9786
|
+
<dl>
|
|
9787
|
+
<dd>
|
|
9788
|
+
|
|
9789
|
+
<dl>
|
|
9790
|
+
<dd>
|
|
9791
|
+
|
|
9792
|
+
**sessionId:** `string`
|
|
9793
|
+
|
|
9794
|
+
</dd>
|
|
9795
|
+
</dl>
|
|
9796
|
+
|
|
9797
|
+
<dl>
|
|
9798
|
+
<dd>
|
|
9799
|
+
|
|
9800
|
+
**request:** `Chrt.NotificationIntentAdHocClientCreate1`
|
|
9653
9801
|
|
|
9654
9802
|
</dd>
|
|
9655
9803
|
</dl>
|
|
@@ -11474,6 +11622,79 @@ await client.operations.cases.getSuggestedDepartmentV1("case_id");
|
|
|
11474
11622
|
</dl>
|
|
11475
11623
|
</details>
|
|
11476
11624
|
|
|
11625
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">setBillingReviewStatusV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11626
|
+
<dl>
|
|
11627
|
+
<dd>
|
|
11628
|
+
|
|
11629
|
+
#### 📝 Description
|
|
11630
|
+
|
|
11631
|
+
<dl>
|
|
11632
|
+
<dd>
|
|
11633
|
+
|
|
11634
|
+
<dl>
|
|
11635
|
+
<dd>
|
|
11636
|
+
|
|
11637
|
+
Sets the case's operator billing-review status. | authz: min_org_role=operator | (CaseSetBillingReviewStatusReq) -> (bool)
|
|
11638
|
+
|
|
11639
|
+
</dd>
|
|
11640
|
+
</dl>
|
|
11641
|
+
</dd>
|
|
11642
|
+
</dl>
|
|
11643
|
+
|
|
11644
|
+
#### 🔌 Usage
|
|
11645
|
+
|
|
11646
|
+
<dl>
|
|
11647
|
+
<dd>
|
|
11648
|
+
|
|
11649
|
+
<dl>
|
|
11650
|
+
<dd>
|
|
11651
|
+
|
|
11652
|
+
```typescript
|
|
11653
|
+
await client.operations.cases.setBillingReviewStatusV1("case_id", {
|
|
11654
|
+
billing_review_status: "not_started",
|
|
11655
|
+
});
|
|
11656
|
+
```
|
|
11657
|
+
|
|
11658
|
+
</dd>
|
|
11659
|
+
</dl>
|
|
11660
|
+
</dd>
|
|
11661
|
+
</dl>
|
|
11662
|
+
|
|
11663
|
+
#### ⚙️ Parameters
|
|
11664
|
+
|
|
11665
|
+
<dl>
|
|
11666
|
+
<dd>
|
|
11667
|
+
|
|
11668
|
+
<dl>
|
|
11669
|
+
<dd>
|
|
11670
|
+
|
|
11671
|
+
**caseId:** `string`
|
|
11672
|
+
|
|
11673
|
+
</dd>
|
|
11674
|
+
</dl>
|
|
11675
|
+
|
|
11676
|
+
<dl>
|
|
11677
|
+
<dd>
|
|
11678
|
+
|
|
11679
|
+
**request:** `Chrt.operations.CaseSetBillingReviewStatusReq`
|
|
11680
|
+
|
|
11681
|
+
</dd>
|
|
11682
|
+
</dl>
|
|
11683
|
+
|
|
11684
|
+
<dl>
|
|
11685
|
+
<dd>
|
|
11686
|
+
|
|
11687
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11688
|
+
|
|
11689
|
+
</dd>
|
|
11690
|
+
</dl>
|
|
11691
|
+
</dd>
|
|
11692
|
+
</dl>
|
|
11693
|
+
|
|
11694
|
+
</dd>
|
|
11695
|
+
</dl>
|
|
11696
|
+
</details>
|
|
11697
|
+
|
|
11477
11698
|
<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
11699
|
<dl>
|
|
11479
11700
|
<dd>
|
|
@@ -15880,9 +16101,9 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
15880
16101
|
</dl>
|
|
15881
16102
|
</details>
|
|
15882
16103
|
|
|
15883
|
-
## Orgs
|
|
16104
|
+
## Orgs OffChrtVendor
|
|
15884
16105
|
|
|
15885
|
-
<details><summary><code>client.orgs.
|
|
16106
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
15886
16107
|
<dl>
|
|
15887
16108
|
<dd>
|
|
15888
16109
|
|
|
@@ -15894,7 +16115,7 @@ await client.orgs.publicData.getHandleAvailabilityV1("handle");
|
|
|
15894
16115
|
<dl>
|
|
15895
16116
|
<dd>
|
|
15896
16117
|
|
|
15897
|
-
|
|
16118
|
+
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
16119
|
|
|
15899
16120
|
</dd>
|
|
15900
16121
|
</dl>
|
|
@@ -15910,7 +16131,10 @@ Retrieves metadata for an organization compliance document S3 object. | authz: a
|
|
|
15910
16131
|
<dd>
|
|
15911
16132
|
|
|
15912
16133
|
```typescript
|
|
15913
|
-
await client.orgs.
|
|
16134
|
+
await client.orgs.offChrtVendor.createV1({
|
|
16135
|
+
schema_version: 1,
|
|
16136
|
+
name: "name",
|
|
16137
|
+
});
|
|
15914
16138
|
```
|
|
15915
16139
|
|
|
15916
16140
|
</dd>
|
|
@@ -15926,7 +16150,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15926
16150
|
<dl>
|
|
15927
16151
|
<dd>
|
|
15928
16152
|
|
|
15929
|
-
**
|
|
16153
|
+
**request:** `Chrt.orgs.OffChrtVendorClientCreate1`
|
|
15930
16154
|
|
|
15931
16155
|
</dd>
|
|
15932
16156
|
</dl>
|
|
@@ -15934,7 +16158,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15934
16158
|
<dl>
|
|
15935
16159
|
<dd>
|
|
15936
16160
|
|
|
15937
|
-
**requestOptions:** `
|
|
16161
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
15938
16162
|
|
|
15939
16163
|
</dd>
|
|
15940
16164
|
</dl>
|
|
@@ -15945,7 +16169,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15945
16169
|
</dl>
|
|
15946
16170
|
</details>
|
|
15947
16171
|
|
|
15948
|
-
<details><summary><code>client.orgs.
|
|
16172
|
+
<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
16173
|
<dl>
|
|
15950
16174
|
<dd>
|
|
15951
16175
|
|
|
@@ -15957,7 +16181,7 @@ await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compli
|
|
|
15957
16181
|
<dl>
|
|
15958
16182
|
<dd>
|
|
15959
16183
|
|
|
15960
|
-
|
|
16184
|
+
Lists all off-chrt vendors created by the caller's organization. Pagination only — no search/filter. | () -> (OffChrtVendorListRes)
|
|
15961
16185
|
|
|
15962
16186
|
</dd>
|
|
15963
16187
|
</dl>
|
|
@@ -15973,7 +16197,10 @@ Streams an organization compliance document S3 object file from storage. | authz
|
|
|
15973
16197
|
<dd>
|
|
15974
16198
|
|
|
15975
16199
|
```typescript
|
|
15976
|
-
await client.orgs.
|
|
16200
|
+
await client.orgs.offChrtVendor.listV1({
|
|
16201
|
+
page: 1,
|
|
16202
|
+
page_size: 1,
|
|
16203
|
+
});
|
|
15977
16204
|
```
|
|
15978
16205
|
|
|
15979
16206
|
</dd>
|
|
@@ -15989,7 +16216,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
15989
16216
|
<dl>
|
|
15990
16217
|
<dd>
|
|
15991
16218
|
|
|
15992
|
-
**
|
|
16219
|
+
**request:** `Chrt.orgs.OffChrtVendorListV1Request`
|
|
15993
16220
|
|
|
15994
16221
|
</dd>
|
|
15995
16222
|
</dl>
|
|
@@ -15997,7 +16224,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
15997
16224
|
<dl>
|
|
15998
16225
|
<dd>
|
|
15999
16226
|
|
|
16000
|
-
**requestOptions:** `
|
|
16227
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16001
16228
|
|
|
16002
16229
|
</dd>
|
|
16003
16230
|
</dl>
|
|
@@ -16008,7 +16235,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16008
16235
|
</dl>
|
|
16009
16236
|
</details>
|
|
16010
16237
|
|
|
16011
|
-
<details><summary><code>client.orgs.
|
|
16238
|
+
<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
16239
|
<dl>
|
|
16013
16240
|
<dd>
|
|
16014
16241
|
|
|
@@ -16020,7 +16247,7 @@ await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3
|
|
|
16020
16247
|
<dl>
|
|
16021
16248
|
<dd>
|
|
16022
16249
|
|
|
16023
|
-
|
|
16250
|
+
Retrieves a specific off-chrt vendor by ID. Scoped to the caller's org. | () -> (OffChrtVendor1)
|
|
16024
16251
|
|
|
16025
16252
|
</dd>
|
|
16026
16253
|
</dl>
|
|
@@ -16036,9 +16263,7 @@ Uploads a file to an organization compliance document. Automatic blurhash genera
|
|
|
16036
16263
|
<dd>
|
|
16037
16264
|
|
|
16038
16265
|
```typescript
|
|
16039
|
-
await client.orgs.
|
|
16040
|
-
file: fs.createReadStream("/path/to/your/file"),
|
|
16041
|
-
});
|
|
16266
|
+
await client.orgs.offChrtVendor.getByIdV1("id");
|
|
16042
16267
|
```
|
|
16043
16268
|
|
|
16044
16269
|
</dd>
|
|
@@ -16054,15 +16279,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16054
16279
|
<dl>
|
|
16055
16280
|
<dd>
|
|
16056
16281
|
|
|
16057
|
-
**
|
|
16058
|
-
|
|
16059
|
-
</dd>
|
|
16060
|
-
</dl>
|
|
16061
|
-
|
|
16062
|
-
<dl>
|
|
16063
|
-
<dd>
|
|
16064
|
-
|
|
16065
|
-
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16282
|
+
**id:** `string`
|
|
16066
16283
|
|
|
16067
16284
|
</dd>
|
|
16068
16285
|
</dl>
|
|
@@ -16070,7 +16287,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16070
16287
|
<dl>
|
|
16071
16288
|
<dd>
|
|
16072
16289
|
|
|
16073
|
-
**requestOptions:** `
|
|
16290
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16074
16291
|
|
|
16075
16292
|
</dd>
|
|
16076
16293
|
</dl>
|
|
@@ -16081,7 +16298,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16081
16298
|
</dl>
|
|
16082
16299
|
</details>
|
|
16083
16300
|
|
|
16084
|
-
<details><summary><code>client.orgs.
|
|
16301
|
+
<details><summary><code>client.orgs.offChrtVendor.<a href="/src/api/resources/orgs/resources/offChrtVendor/client/Client.ts">deleteByIdV1</a>(id) -> boolean</code></summary>
|
|
16085
16302
|
<dl>
|
|
16086
16303
|
<dd>
|
|
16087
16304
|
|
|
@@ -16093,7 +16310,7 @@ await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id
|
|
|
16093
16310
|
<dl>
|
|
16094
16311
|
<dd>
|
|
16095
16312
|
|
|
16096
|
-
Deletes an
|
|
16313
|
+
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
16314
|
|
|
16098
16315
|
</dd>
|
|
16099
16316
|
</dl>
|
|
@@ -16109,7 +16326,7 @@ Deletes an organization compliance document S3 object and metadata. | authz: all
|
|
|
16109
16326
|
<dd>
|
|
16110
16327
|
|
|
16111
16328
|
```typescript
|
|
16112
|
-
await client.orgs.
|
|
16329
|
+
await client.orgs.offChrtVendor.deleteByIdV1("id");
|
|
16113
16330
|
```
|
|
16114
16331
|
|
|
16115
16332
|
</dd>
|
|
@@ -16125,7 +16342,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16125
16342
|
<dl>
|
|
16126
16343
|
<dd>
|
|
16127
16344
|
|
|
16128
|
-
**
|
|
16345
|
+
**id:** `string`
|
|
16129
16346
|
|
|
16130
16347
|
</dd>
|
|
16131
16348
|
</dl>
|
|
@@ -16133,7 +16350,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16133
16350
|
<dl>
|
|
16134
16351
|
<dd>
|
|
16135
16352
|
|
|
16136
|
-
**requestOptions:** `
|
|
16353
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16137
16354
|
|
|
16138
16355
|
</dd>
|
|
16139
16356
|
</dl>
|
|
@@ -16144,9 +16361,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16144
16361
|
</dl>
|
|
16145
16362
|
</details>
|
|
16146
16363
|
|
|
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>
|
|
16364
|
+
<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
16365
|
<dl>
|
|
16151
16366
|
<dd>
|
|
16152
16367
|
|
|
@@ -16158,7 +16373,7 @@ await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document
|
|
|
16158
16373
|
<dl>
|
|
16159
16374
|
<dd>
|
|
16160
16375
|
|
|
16161
|
-
|
|
16376
|
+
Updates an existing off-chrt vendor owned by the caller's organization. | (OffChrtVendorClientUpdate1) -> (bool)
|
|
16162
16377
|
|
|
16163
16378
|
</dd>
|
|
16164
16379
|
</dl>
|
|
@@ -16174,7 +16389,7 @@ Retrieves shipper organization connection information for the caller's organizat
|
|
|
16174
16389
|
<dd>
|
|
16175
16390
|
|
|
16176
16391
|
```typescript
|
|
16177
|
-
await client.orgs.
|
|
16392
|
+
await client.orgs.offChrtVendor.updateByIdV1("id");
|
|
16178
16393
|
```
|
|
16179
16394
|
|
|
16180
16395
|
</dd>
|
|
@@ -16190,18 +16405,36 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16190
16405
|
<dl>
|
|
16191
16406
|
<dd>
|
|
16192
16407
|
|
|
16193
|
-
**
|
|
16408
|
+
**id:** `string`
|
|
16194
16409
|
|
|
16195
|
-
</dd>
|
|
16196
|
-
</dl>
|
|
16197
16410
|
</dd>
|
|
16198
16411
|
</dl>
|
|
16199
16412
|
|
|
16200
|
-
|
|
16201
|
-
|
|
16413
|
+
<dl>
|
|
16414
|
+
<dd>
|
|
16415
|
+
|
|
16416
|
+
**request:** `Chrt.orgs.OffChrtVendorClientUpdate1`
|
|
16417
|
+
|
|
16418
|
+
</dd>
|
|
16419
|
+
</dl>
|
|
16420
|
+
|
|
16421
|
+
<dl>
|
|
16422
|
+
<dd>
|
|
16423
|
+
|
|
16424
|
+
**requestOptions:** `OffChrtVendor.RequestOptions`
|
|
16425
|
+
|
|
16426
|
+
</dd>
|
|
16427
|
+
</dl>
|
|
16428
|
+
</dd>
|
|
16429
|
+
</dl>
|
|
16430
|
+
|
|
16431
|
+
</dd>
|
|
16432
|
+
</dl>
|
|
16202
16433
|
</details>
|
|
16203
16434
|
|
|
16204
|
-
|
|
16435
|
+
## Orgs ComplianceDocuments S3Object
|
|
16436
|
+
|
|
16437
|
+
<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
16438
|
<dl>
|
|
16206
16439
|
<dd>
|
|
16207
16440
|
|
|
@@ -16213,7 +16446,7 @@ await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
|
16213
16446
|
<dl>
|
|
16214
16447
|
<dd>
|
|
16215
16448
|
|
|
16216
|
-
|
|
16449
|
+
Retrieves metadata for an organization compliance document S3 object. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (OrgComplianceDocumentS3ObjectMetadata1)
|
|
16217
16450
|
|
|
16218
16451
|
</dd>
|
|
16219
16452
|
</dl>
|
|
@@ -16229,10 +16462,7 @@ Creates shipper organization connection information. Fails if already exists. |
|
|
|
16229
16462
|
<dd>
|
|
16230
16463
|
|
|
16231
16464
|
```typescript
|
|
16232
|
-
await client.orgs.
|
|
16233
|
-
schema_version: 1,
|
|
16234
|
-
email_address_primary: "email_address_primary",
|
|
16235
|
-
});
|
|
16465
|
+
await client.orgs.complianceDocuments.s3Object.getS3ObjectMetadataV1("org_compliance_document_s3_object_metadata_id");
|
|
16236
16466
|
```
|
|
16237
16467
|
|
|
16238
16468
|
</dd>
|
|
@@ -16248,7 +16478,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16248
16478
|
<dl>
|
|
16249
16479
|
<dd>
|
|
16250
16480
|
|
|
16251
|
-
**
|
|
16481
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16252
16482
|
|
|
16253
16483
|
</dd>
|
|
16254
16484
|
</dl>
|
|
@@ -16256,7 +16486,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16256
16486
|
<dl>
|
|
16257
16487
|
<dd>
|
|
16258
16488
|
|
|
16259
|
-
**requestOptions:** `
|
|
16489
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16260
16490
|
|
|
16261
16491
|
</dd>
|
|
16262
16492
|
</dl>
|
|
@@ -16267,7 +16497,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16267
16497
|
</dl>
|
|
16268
16498
|
</details>
|
|
16269
16499
|
|
|
16270
|
-
<details><summary><code>client.orgs.
|
|
16500
|
+
<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
16501
|
<dl>
|
|
16272
16502
|
<dd>
|
|
16273
16503
|
|
|
@@ -16279,7 +16509,7 @@ await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
|
16279
16509
|
<dl>
|
|
16280
16510
|
<dd>
|
|
16281
16511
|
|
|
16282
|
-
|
|
16512
|
+
Streams an organization compliance document S3 object file from storage. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (binary)
|
|
16283
16513
|
|
|
16284
16514
|
</dd>
|
|
16285
16515
|
</dl>
|
|
@@ -16295,7 +16525,7 @@ Updates existing shipper organization connection information. | (ShipperOrgInfoF
|
|
|
16295
16525
|
<dd>
|
|
16296
16526
|
|
|
16297
16527
|
```typescript
|
|
16298
|
-
await client.orgs.
|
|
16528
|
+
await client.orgs.complianceDocuments.s3Object.getV1("org_compliance_document_s3_object_metadata_id");
|
|
16299
16529
|
```
|
|
16300
16530
|
|
|
16301
16531
|
</dd>
|
|
@@ -16311,7 +16541,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16311
16541
|
<dl>
|
|
16312
16542
|
<dd>
|
|
16313
16543
|
|
|
16314
|
-
**
|
|
16544
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16315
16545
|
|
|
16316
16546
|
</dd>
|
|
16317
16547
|
</dl>
|
|
@@ -16319,7 +16549,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16319
16549
|
<dl>
|
|
16320
16550
|
<dd>
|
|
16321
16551
|
|
|
16322
|
-
**requestOptions:** `
|
|
16552
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16323
16553
|
|
|
16324
16554
|
</dd>
|
|
16325
16555
|
</dl>
|
|
@@ -16330,9 +16560,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16330
16560
|
</dl>
|
|
16331
16561
|
</details>
|
|
16332
16562
|
|
|
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>
|
|
16563
|
+
<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
16564
|
<dl>
|
|
16337
16565
|
<dd>
|
|
16338
16566
|
|
|
@@ -16344,7 +16572,7 @@ await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
|
16344
16572
|
<dl>
|
|
16345
16573
|
<dd>
|
|
16346
16574
|
|
|
16347
|
-
|
|
16575
|
+
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
16576
|
|
|
16349
16577
|
</dd>
|
|
16350
16578
|
</dl>
|
|
@@ -16360,7 +16588,9 @@ Retrieves provider organization connection information for the caller's organiza
|
|
|
16360
16588
|
<dd>
|
|
16361
16589
|
|
|
16362
16590
|
```typescript
|
|
16363
|
-
await client.orgs.
|
|
16591
|
+
await client.orgs.complianceDocuments.s3Object.addV1("org_compliance_document_id", {
|
|
16592
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
16593
|
+
});
|
|
16364
16594
|
```
|
|
16365
16595
|
|
|
16366
16596
|
</dd>
|
|
@@ -16376,7 +16606,23 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16376
16606
|
<dl>
|
|
16377
16607
|
<dd>
|
|
16378
16608
|
|
|
16379
|
-
**
|
|
16609
|
+
**orgComplianceDocumentId:** `string`
|
|
16610
|
+
|
|
16611
|
+
</dd>
|
|
16612
|
+
</dl>
|
|
16613
|
+
|
|
16614
|
+
<dl>
|
|
16615
|
+
<dd>
|
|
16616
|
+
|
|
16617
|
+
**request:** `Chrt.orgs.complianceDocuments.BodyPostOrgComplianceDocumentsS3ObjectAddV1OrgsComplianceDocumentsS3ObjectAddV1OrgComplianceDocumentIdPost`
|
|
16618
|
+
|
|
16619
|
+
</dd>
|
|
16620
|
+
</dl>
|
|
16621
|
+
|
|
16622
|
+
<dl>
|
|
16623
|
+
<dd>
|
|
16624
|
+
|
|
16625
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16380
16626
|
|
|
16381
16627
|
</dd>
|
|
16382
16628
|
</dl>
|
|
@@ -16387,7 +16633,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16387
16633
|
</dl>
|
|
16388
16634
|
</details>
|
|
16389
16635
|
|
|
16390
|
-
<details><summary><code>client.orgs.
|
|
16636
|
+
<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
16637
|
<dl>
|
|
16392
16638
|
<dd>
|
|
16393
16639
|
|
|
@@ -16399,7 +16645,7 @@ await client.orgs.orgInfoForConnections.provider.getV1();
|
|
|
16399
16645
|
<dl>
|
|
16400
16646
|
<dd>
|
|
16401
16647
|
|
|
16402
|
-
|
|
16648
|
+
Deletes an organization compliance document S3 object and metadata. | authz: allowed_org_types=[provider], min_org_role=administrator | () -> (bool)
|
|
16403
16649
|
|
|
16404
16650
|
</dd>
|
|
16405
16651
|
</dl>
|
|
@@ -16415,7 +16661,7 @@ Retrieves list of provider org info documents for providers connected to the cal
|
|
|
16415
16661
|
<dd>
|
|
16416
16662
|
|
|
16417
16663
|
```typescript
|
|
16418
|
-
await client.orgs.
|
|
16664
|
+
await client.orgs.complianceDocuments.s3Object.deleteV1("org_compliance_document_s3_object_metadata_id");
|
|
16419
16665
|
```
|
|
16420
16666
|
|
|
16421
16667
|
</dd>
|
|
@@ -16431,7 +16677,15 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16431
16677
|
<dl>
|
|
16432
16678
|
<dd>
|
|
16433
16679
|
|
|
16434
|
-
**
|
|
16680
|
+
**orgComplianceDocumentS3ObjectMetadataId:** `string`
|
|
16681
|
+
|
|
16682
|
+
</dd>
|
|
16683
|
+
</dl>
|
|
16684
|
+
|
|
16685
|
+
<dl>
|
|
16686
|
+
<dd>
|
|
16687
|
+
|
|
16688
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
16435
16689
|
|
|
16436
16690
|
</dd>
|
|
16437
16691
|
</dl>
|
|
@@ -16442,7 +16696,9 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16442
16696
|
</dl>
|
|
16443
16697
|
</details>
|
|
16444
16698
|
|
|
16445
|
-
|
|
16699
|
+
## Orgs OrgInfoForConnections Shipper
|
|
16700
|
+
|
|
16701
|
+
<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
16702
|
<dl>
|
|
16447
16703
|
<dd>
|
|
16448
16704
|
|
|
@@ -16454,7 +16710,7 @@ await client.orgs.orgInfoForConnections.provider.listV1();
|
|
|
16454
16710
|
<dl>
|
|
16455
16711
|
<dd>
|
|
16456
16712
|
|
|
16457
|
-
|
|
16713
|
+
Retrieves shipper organization connection information for the caller's organization. | () -> (ShipperOrgInfoForConnections1)
|
|
16458
16714
|
|
|
16459
16715
|
</dd>
|
|
16460
16716
|
</dl>
|
|
@@ -16470,10 +16726,7 @@ Creates provider organization connection information. Fails if already exists. |
|
|
|
16470
16726
|
<dd>
|
|
16471
16727
|
|
|
16472
16728
|
```typescript
|
|
16473
|
-
await client.orgs.orgInfoForConnections.
|
|
16474
|
-
schema_version: 1,
|
|
16475
|
-
email_address_primary: "email_address_primary",
|
|
16476
|
-
});
|
|
16729
|
+
await client.orgs.orgInfoForConnections.shipper.getV1();
|
|
16477
16730
|
```
|
|
16478
16731
|
|
|
16479
16732
|
</dd>
|
|
@@ -16489,15 +16742,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16489
16742
|
<dl>
|
|
16490
16743
|
<dd>
|
|
16491
16744
|
|
|
16492
|
-
**
|
|
16493
|
-
|
|
16494
|
-
</dd>
|
|
16495
|
-
</dl>
|
|
16496
|
-
|
|
16497
|
-
<dl>
|
|
16498
|
-
<dd>
|
|
16499
|
-
|
|
16500
|
-
**requestOptions:** `Provider.RequestOptions`
|
|
16745
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16501
16746
|
|
|
16502
16747
|
</dd>
|
|
16503
16748
|
</dl>
|
|
@@ -16508,7 +16753,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16508
16753
|
</dl>
|
|
16509
16754
|
</details>
|
|
16510
16755
|
|
|
16511
|
-
<details><summary><code>client.orgs.orgInfoForConnections.
|
|
16756
|
+
<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
16757
|
<dl>
|
|
16513
16758
|
<dd>
|
|
16514
16759
|
|
|
@@ -16520,7 +16765,7 @@ await client.orgs.orgInfoForConnections.provider.createV1({
|
|
|
16520
16765
|
<dl>
|
|
16521
16766
|
<dd>
|
|
16522
16767
|
|
|
16523
|
-
|
|
16768
|
+
Creates shipper organization connection information. Fails if already exists. | (ShipperOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16524
16769
|
|
|
16525
16770
|
</dd>
|
|
16526
16771
|
</dl>
|
|
@@ -16536,7 +16781,10 @@ Updates existing provider organization connection information. | (ProviderOrgInf
|
|
|
16536
16781
|
<dd>
|
|
16537
16782
|
|
|
16538
16783
|
```typescript
|
|
16539
|
-
await client.orgs.orgInfoForConnections.
|
|
16784
|
+
await client.orgs.orgInfoForConnections.shipper.createV1({
|
|
16785
|
+
schema_version: 1,
|
|
16786
|
+
email_address_primary: "email_address_primary",
|
|
16787
|
+
});
|
|
16540
16788
|
```
|
|
16541
16789
|
|
|
16542
16790
|
</dd>
|
|
@@ -16552,7 +16800,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16552
16800
|
<dl>
|
|
16553
16801
|
<dd>
|
|
16554
16802
|
|
|
16555
|
-
**request:** `Chrt.orgs.orgInfoForConnections.
|
|
16803
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientCreate1`
|
|
16556
16804
|
|
|
16557
16805
|
</dd>
|
|
16558
16806
|
</dl>
|
|
@@ -16560,7 +16808,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16560
16808
|
<dl>
|
|
16561
16809
|
<dd>
|
|
16562
16810
|
|
|
16563
|
-
**requestOptions:** `
|
|
16811
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16564
16812
|
|
|
16565
16813
|
</dd>
|
|
16566
16814
|
</dl>
|
|
@@ -16571,9 +16819,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16571
16819
|
</dl>
|
|
16572
16820
|
</details>
|
|
16573
16821
|
|
|
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>
|
|
16822
|
+
<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
16823
|
<dl>
|
|
16578
16824
|
<dd>
|
|
16579
16825
|
|
|
@@ -16585,7 +16831,7 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16585
16831
|
<dl>
|
|
16586
16832
|
<dd>
|
|
16587
16833
|
|
|
16588
|
-
|
|
16834
|
+
Updates existing shipper organization connection information. | (ShipperOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16589
16835
|
|
|
16590
16836
|
</dd>
|
|
16591
16837
|
</dl>
|
|
@@ -16601,10 +16847,7 @@ Retrieves driver stats for a time window: overlap-corrected hours worked, total
|
|
|
16601
16847
|
<dd>
|
|
16602
16848
|
|
|
16603
16849
|
```typescript
|
|
16604
|
-
await client.
|
|
16605
|
-
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16606
|
-
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16607
|
-
});
|
|
16850
|
+
await client.orgs.orgInfoForConnections.shipper.updateV1();
|
|
16608
16851
|
```
|
|
16609
16852
|
|
|
16610
16853
|
</dd>
|
|
@@ -16620,15 +16863,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16620
16863
|
<dl>
|
|
16621
16864
|
<dd>
|
|
16622
16865
|
|
|
16623
|
-
**
|
|
16624
|
-
|
|
16625
|
-
</dd>
|
|
16626
|
-
</dl>
|
|
16627
|
-
|
|
16628
|
-
<dl>
|
|
16629
|
-
<dd>
|
|
16630
|
-
|
|
16631
|
-
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16866
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ShipperOrgInfoForConnectionsClientUpdate1`
|
|
16632
16867
|
|
|
16633
16868
|
</dd>
|
|
16634
16869
|
</dl>
|
|
@@ -16636,7 +16871,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16636
16871
|
<dl>
|
|
16637
16872
|
<dd>
|
|
16638
16873
|
|
|
16639
|
-
**requestOptions:** `
|
|
16874
|
+
**requestOptions:** `Shipper.RequestOptions`
|
|
16640
16875
|
|
|
16641
16876
|
</dd>
|
|
16642
16877
|
</dl>
|
|
@@ -16647,7 +16882,9 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16647
16882
|
</dl>
|
|
16648
16883
|
</details>
|
|
16649
16884
|
|
|
16650
|
-
|
|
16885
|
+
## Orgs OrgInfoForConnections Provider
|
|
16886
|
+
|
|
16887
|
+
<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>
|
|
16651
16888
|
<dl>
|
|
16652
16889
|
<dd>
|
|
16653
16890
|
|
|
@@ -16659,7 +16896,7 @@ await client.shipping.drivers.getStatsV1("driver_id", {
|
|
|
16659
16896
|
<dl>
|
|
16660
16897
|
<dd>
|
|
16661
16898
|
|
|
16662
|
-
Retrieves
|
|
16899
|
+
Retrieves provider organization connection information for the caller's organization. | () -> (ProviderOrgInfoForConnections1)
|
|
16663
16900
|
|
|
16664
16901
|
</dd>
|
|
16665
16902
|
</dl>
|
|
@@ -16675,7 +16912,7 @@ Retrieves a driver's self-report for a single calendar day. Caller must be the d
|
|
|
16675
16912
|
<dd>
|
|
16676
16913
|
|
|
16677
16914
|
```typescript
|
|
16678
|
-
await client.
|
|
16915
|
+
await client.orgs.orgInfoForConnections.provider.getV1();
|
|
16679
16916
|
```
|
|
16680
16917
|
|
|
16681
16918
|
</dd>
|
|
@@ -16691,23 +16928,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16691
16928
|
<dl>
|
|
16692
16929
|
<dd>
|
|
16693
16930
|
|
|
16694
|
-
**
|
|
16695
|
-
|
|
16696
|
-
</dd>
|
|
16697
|
-
</dl>
|
|
16698
|
-
|
|
16699
|
-
<dl>
|
|
16700
|
-
<dd>
|
|
16701
|
-
|
|
16702
|
-
**reportDate:** `string`
|
|
16703
|
-
|
|
16704
|
-
</dd>
|
|
16705
|
-
</dl>
|
|
16706
|
-
|
|
16707
|
-
<dl>
|
|
16708
|
-
<dd>
|
|
16709
|
-
|
|
16710
|
-
**requestOptions:** `Drivers.RequestOptions`
|
|
16931
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16711
16932
|
|
|
16712
16933
|
</dd>
|
|
16713
16934
|
</dl>
|
|
@@ -16718,7 +16939,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16718
16939
|
</dl>
|
|
16719
16940
|
</details>
|
|
16720
16941
|
|
|
16721
|
-
<details><summary><code>client.
|
|
16942
|
+
<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>
|
|
16722
16943
|
<dl>
|
|
16723
16944
|
<dd>
|
|
16724
16945
|
|
|
@@ -16730,7 +16951,7 @@ await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "rep
|
|
|
16730
16951
|
<dl>
|
|
16731
16952
|
<dd>
|
|
16732
16953
|
|
|
16733
|
-
|
|
16954
|
+
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])
|
|
16734
16955
|
|
|
16735
16956
|
</dd>
|
|
16736
16957
|
</dl>
|
|
@@ -16746,13 +16967,7 @@ Lists a driver's self-reports across an optional date range with sorting and pag
|
|
|
16746
16967
|
<dd>
|
|
16747
16968
|
|
|
16748
16969
|
```typescript
|
|
16749
|
-
await client.
|
|
16750
|
-
filter_start_date: "filter_start_date",
|
|
16751
|
-
filter_end_date: "filter_end_date",
|
|
16752
|
-
sort_order: "asc",
|
|
16753
|
-
page: 1,
|
|
16754
|
-
page_size: 1,
|
|
16755
|
-
});
|
|
16970
|
+
await client.orgs.orgInfoForConnections.provider.listV1();
|
|
16756
16971
|
```
|
|
16757
16972
|
|
|
16758
16973
|
</dd>
|
|
@@ -16768,23 +16983,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16768
16983
|
<dl>
|
|
16769
16984
|
<dd>
|
|
16770
16985
|
|
|
16771
|
-
**
|
|
16772
|
-
|
|
16773
|
-
</dd>
|
|
16774
|
-
</dl>
|
|
16775
|
-
|
|
16776
|
-
<dl>
|
|
16777
|
-
<dd>
|
|
16778
|
-
|
|
16779
|
-
**request:** `Chrt.shipping.DriversListSelfReportedHoursAndMileageV1Request`
|
|
16780
|
-
|
|
16781
|
-
</dd>
|
|
16782
|
-
</dl>
|
|
16783
|
-
|
|
16784
|
-
<dl>
|
|
16785
|
-
<dd>
|
|
16786
|
-
|
|
16787
|
-
**requestOptions:** `Drivers.RequestOptions`
|
|
16986
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16788
16987
|
|
|
16789
16988
|
</dd>
|
|
16790
16989
|
</dl>
|
|
@@ -16795,7 +16994,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16795
16994
|
</dl>
|
|
16796
16995
|
</details>
|
|
16797
16996
|
|
|
16798
|
-
<details><summary><code>client.
|
|
16997
|
+
<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>
|
|
16799
16998
|
<dl>
|
|
16800
16999
|
<dd>
|
|
16801
17000
|
|
|
@@ -16807,7 +17006,7 @@ await client.shipping.drivers.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
|
16807
17006
|
<dl>
|
|
16808
17007
|
<dd>
|
|
16809
17008
|
|
|
16810
|
-
|
|
17009
|
+
Creates provider organization connection information. Fails if already exists. | (ProviderOrgInfoForConnectionsClientCreate1) -> (PydanticObjectId)
|
|
16811
17010
|
|
|
16812
17011
|
</dd>
|
|
16813
17012
|
</dl>
|
|
@@ -16823,14 +17022,9 @@ Lists all drivers' self-reports in the caller's org with date-range filtering, s
|
|
|
16823
17022
|
<dd>
|
|
16824
17023
|
|
|
16825
17024
|
```typescript
|
|
16826
|
-
await client.
|
|
16827
|
-
|
|
16828
|
-
|
|
16829
|
-
filter_end_date: "filter_end_date",
|
|
16830
|
-
sort_by: "date",
|
|
16831
|
-
sort_order: "asc",
|
|
16832
|
-
page: 1,
|
|
16833
|
-
page_size: 1,
|
|
17025
|
+
await client.orgs.orgInfoForConnections.provider.createV1({
|
|
17026
|
+
schema_version: 1,
|
|
17027
|
+
email_address_primary: "email_address_primary",
|
|
16834
17028
|
});
|
|
16835
17029
|
```
|
|
16836
17030
|
|
|
@@ -16847,7 +17041,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16847
17041
|
<dl>
|
|
16848
17042
|
<dd>
|
|
16849
17043
|
|
|
16850
|
-
**request:** `Chrt.
|
|
17044
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientCreate1`
|
|
16851
17045
|
|
|
16852
17046
|
</dd>
|
|
16853
17047
|
</dl>
|
|
@@ -16855,7 +17049,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16855
17049
|
<dl>
|
|
16856
17050
|
<dd>
|
|
16857
17051
|
|
|
16858
|
-
**requestOptions:** `
|
|
17052
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16859
17053
|
|
|
16860
17054
|
</dd>
|
|
16861
17055
|
</dl>
|
|
@@ -16866,7 +17060,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16866
17060
|
</dl>
|
|
16867
17061
|
</details>
|
|
16868
17062
|
|
|
16869
|
-
<details><summary><code>client.
|
|
17063
|
+
<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>
|
|
16870
17064
|
<dl>
|
|
16871
17065
|
<dd>
|
|
16872
17066
|
|
|
@@ -16878,7 +17072,7 @@ await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
|
16878
17072
|
<dl>
|
|
16879
17073
|
<dd>
|
|
16880
17074
|
|
|
16881
|
-
|
|
17075
|
+
Updates existing provider organization connection information. | (ProviderOrgInfoForConnectionsClientUpdate1) -> (bool)
|
|
16882
17076
|
|
|
16883
17077
|
</dd>
|
|
16884
17078
|
</dl>
|
|
@@ -16894,11 +17088,7 @@ Creates a driver's self-reported hours worked and miles driven for a single cale
|
|
|
16894
17088
|
<dd>
|
|
16895
17089
|
|
|
16896
17090
|
```typescript
|
|
16897
|
-
await client.
|
|
16898
|
-
schema_version: 1,
|
|
16899
|
-
driver_id: "driver_id",
|
|
16900
|
-
date: "date",
|
|
16901
|
-
});
|
|
17091
|
+
await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
16902
17092
|
```
|
|
16903
17093
|
|
|
16904
17094
|
</dd>
|
|
@@ -16914,7 +17104,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16914
17104
|
<dl>
|
|
16915
17105
|
<dd>
|
|
16916
17106
|
|
|
16917
|
-
**request:** `Chrt.
|
|
17107
|
+
**request:** `Chrt.orgs.orgInfoForConnections.ProviderOrgInfoForConnectionsClientUpdate1`
|
|
16918
17108
|
|
|
16919
17109
|
</dd>
|
|
16920
17110
|
</dl>
|
|
@@ -16922,7 +17112,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16922
17112
|
<dl>
|
|
16923
17113
|
<dd>
|
|
16924
17114
|
|
|
16925
|
-
**requestOptions:** `
|
|
17115
|
+
**requestOptions:** `Provider.RequestOptions`
|
|
16926
17116
|
|
|
16927
17117
|
</dd>
|
|
16928
17118
|
</dl>
|
|
@@ -16933,7 +17123,9 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16933
17123
|
</dl>
|
|
16934
17124
|
</details>
|
|
16935
17125
|
|
|
16936
|
-
|
|
17126
|
+
## Shipping Drivers
|
|
17127
|
+
|
|
17128
|
+
<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>
|
|
16937
17129
|
<dl>
|
|
16938
17130
|
<dd>
|
|
16939
17131
|
|
|
@@ -16945,7 +17137,7 @@ await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
|
16945
17137
|
<dl>
|
|
16946
17138
|
<dd>
|
|
16947
17139
|
|
|
16948
|
-
|
|
17140
|
+
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)
|
|
16949
17141
|
|
|
16950
17142
|
</dd>
|
|
16951
17143
|
</dl>
|
|
@@ -16961,7 +17153,10 @@ Partially updates a driver's self-reported hours worked and/or miles driven for
|
|
|
16961
17153
|
<dd>
|
|
16962
17154
|
|
|
16963
17155
|
```typescript
|
|
16964
|
-
await client.shipping.drivers.
|
|
17156
|
+
await client.shipping.drivers.getStatsV1("driver_id", {
|
|
17157
|
+
start_timestamp: "2024-01-15T09:30:00Z",
|
|
17158
|
+
end_timestamp: "2024-01-15T09:30:00Z",
|
|
17159
|
+
});
|
|
16965
17160
|
```
|
|
16966
17161
|
|
|
16967
17162
|
</dd>
|
|
@@ -16985,15 +17180,7 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
16985
17180
|
<dl>
|
|
16986
17181
|
<dd>
|
|
16987
17182
|
|
|
16988
|
-
**
|
|
16989
|
-
|
|
16990
|
-
</dd>
|
|
16991
|
-
</dl>
|
|
16992
|
-
|
|
16993
|
-
<dl>
|
|
16994
|
-
<dd>
|
|
16995
|
-
|
|
16996
|
-
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientUpdate1`
|
|
17183
|
+
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16997
17184
|
|
|
16998
17185
|
</dd>
|
|
16999
17186
|
</dl>
|
|
@@ -17012,7 +17199,7 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17012
17199
|
</dl>
|
|
17013
17200
|
</details>
|
|
17014
17201
|
|
|
17015
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17202
|
+
<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>
|
|
17016
17203
|
<dl>
|
|
17017
17204
|
<dd>
|
|
17018
17205
|
|
|
@@ -17024,7 +17211,7 @@ await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17024
17211
|
<dl>
|
|
17025
17212
|
<dd>
|
|
17026
17213
|
|
|
17027
|
-
|
|
17214
|
+
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)
|
|
17028
17215
|
|
|
17029
17216
|
</dd>
|
|
17030
17217
|
</dl>
|
|
@@ -17040,7 +17227,7 @@ Permanently deletes a driver's self-report for a calendar day. Caller must be th
|
|
|
17040
17227
|
<dd>
|
|
17041
17228
|
|
|
17042
17229
|
```typescript
|
|
17043
|
-
await client.shipping.drivers.
|
|
17230
|
+
await client.shipping.drivers.getSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17044
17231
|
```
|
|
17045
17232
|
|
|
17046
17233
|
</dd>
|
|
@@ -17083,7 +17270,7 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17083
17270
|
</dl>
|
|
17084
17271
|
</details>
|
|
17085
17272
|
|
|
17086
|
-
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">
|
|
17273
|
+
<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>
|
|
17087
17274
|
<dl>
|
|
17088
17275
|
<dd>
|
|
17089
17276
|
|
|
@@ -17095,14 +17282,987 @@ await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "
|
|
|
17095
17282
|
<dl>
|
|
17096
17283
|
<dd>
|
|
17097
17284
|
|
|
17098
|
-
|
|
17285
|
+
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)
|
|
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.listSelfReportedHoursAndMileageV1("driver_id", {
|
|
17302
|
+
filter_start_date: "filter_start_date",
|
|
17303
|
+
filter_end_date: "filter_end_date",
|
|
17304
|
+
sort_order: "asc",
|
|
17305
|
+
page: 1,
|
|
17306
|
+
page_size: 1,
|
|
17307
|
+
});
|
|
17308
|
+
```
|
|
17309
|
+
|
|
17310
|
+
</dd>
|
|
17311
|
+
</dl>
|
|
17312
|
+
</dd>
|
|
17313
|
+
</dl>
|
|
17314
|
+
|
|
17315
|
+
#### ⚙️ Parameters
|
|
17316
|
+
|
|
17317
|
+
<dl>
|
|
17318
|
+
<dd>
|
|
17319
|
+
|
|
17320
|
+
<dl>
|
|
17321
|
+
<dd>
|
|
17322
|
+
|
|
17323
|
+
**driverId:** `string`
|
|
17324
|
+
|
|
17325
|
+
</dd>
|
|
17326
|
+
</dl>
|
|
17327
|
+
|
|
17328
|
+
<dl>
|
|
17329
|
+
<dd>
|
|
17330
|
+
|
|
17331
|
+
**request:** `Chrt.shipping.DriversListSelfReportedHoursAndMileageV1Request`
|
|
17332
|
+
|
|
17333
|
+
</dd>
|
|
17334
|
+
</dl>
|
|
17335
|
+
|
|
17336
|
+
<dl>
|
|
17337
|
+
<dd>
|
|
17338
|
+
|
|
17339
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17340
|
+
|
|
17341
|
+
</dd>
|
|
17342
|
+
</dl>
|
|
17343
|
+
</dd>
|
|
17344
|
+
</dl>
|
|
17345
|
+
|
|
17346
|
+
</dd>
|
|
17347
|
+
</dl>
|
|
17348
|
+
</details>
|
|
17349
|
+
|
|
17350
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">orgListSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileageListRes</code></summary>
|
|
17351
|
+
<dl>
|
|
17352
|
+
<dd>
|
|
17353
|
+
|
|
17354
|
+
#### 📝 Description
|
|
17355
|
+
|
|
17356
|
+
<dl>
|
|
17357
|
+
<dd>
|
|
17358
|
+
|
|
17359
|
+
<dl>
|
|
17360
|
+
<dd>
|
|
17361
|
+
|
|
17362
|
+
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)
|
|
17363
|
+
|
|
17364
|
+
</dd>
|
|
17365
|
+
</dl>
|
|
17366
|
+
</dd>
|
|
17367
|
+
</dl>
|
|
17368
|
+
|
|
17369
|
+
#### 🔌 Usage
|
|
17370
|
+
|
|
17371
|
+
<dl>
|
|
17372
|
+
<dd>
|
|
17373
|
+
|
|
17374
|
+
<dl>
|
|
17375
|
+
<dd>
|
|
17376
|
+
|
|
17377
|
+
```typescript
|
|
17378
|
+
await client.shipping.drivers.orgListSelfReportedHoursAndMileageV1({
|
|
17379
|
+
filter_driver_id: "filter_driver_id",
|
|
17380
|
+
filter_start_date: "filter_start_date",
|
|
17381
|
+
filter_end_date: "filter_end_date",
|
|
17382
|
+
sort_by: "date",
|
|
17383
|
+
sort_order: "asc",
|
|
17384
|
+
page: 1,
|
|
17385
|
+
page_size: 1,
|
|
17386
|
+
});
|
|
17387
|
+
```
|
|
17388
|
+
|
|
17389
|
+
</dd>
|
|
17390
|
+
</dl>
|
|
17391
|
+
</dd>
|
|
17392
|
+
</dl>
|
|
17393
|
+
|
|
17394
|
+
#### ⚙️ Parameters
|
|
17395
|
+
|
|
17396
|
+
<dl>
|
|
17397
|
+
<dd>
|
|
17398
|
+
|
|
17399
|
+
<dl>
|
|
17400
|
+
<dd>
|
|
17401
|
+
|
|
17402
|
+
**request:** `Chrt.shipping.DriversOrgListSelfReportedHoursAndMileageV1Request`
|
|
17403
|
+
|
|
17404
|
+
</dd>
|
|
17405
|
+
</dl>
|
|
17406
|
+
|
|
17407
|
+
<dl>
|
|
17408
|
+
<dd>
|
|
17409
|
+
|
|
17410
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17411
|
+
|
|
17412
|
+
</dd>
|
|
17413
|
+
</dl>
|
|
17414
|
+
</dd>
|
|
17415
|
+
</dl>
|
|
17416
|
+
|
|
17417
|
+
</dd>
|
|
17418
|
+
</dl>
|
|
17419
|
+
</details>
|
|
17420
|
+
|
|
17421
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createSelfReportedHoursAndMileageV1</a>({ ...params }) -> Chrt.DriverSelfReportedHoursAndMileage1</code></summary>
|
|
17422
|
+
<dl>
|
|
17423
|
+
<dd>
|
|
17424
|
+
|
|
17425
|
+
#### 📝 Description
|
|
17426
|
+
|
|
17427
|
+
<dl>
|
|
17428
|
+
<dd>
|
|
17429
|
+
|
|
17430
|
+
<dl>
|
|
17431
|
+
<dd>
|
|
17432
|
+
|
|
17433
|
+
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)
|
|
17434
|
+
|
|
17435
|
+
</dd>
|
|
17436
|
+
</dl>
|
|
17437
|
+
</dd>
|
|
17438
|
+
</dl>
|
|
17439
|
+
|
|
17440
|
+
#### 🔌 Usage
|
|
17441
|
+
|
|
17442
|
+
<dl>
|
|
17443
|
+
<dd>
|
|
17444
|
+
|
|
17445
|
+
<dl>
|
|
17446
|
+
<dd>
|
|
17447
|
+
|
|
17448
|
+
```typescript
|
|
17449
|
+
await client.shipping.drivers.createSelfReportedHoursAndMileageV1({
|
|
17450
|
+
schema_version: 1,
|
|
17451
|
+
driver_id: "driver_id",
|
|
17452
|
+
date: "date",
|
|
17453
|
+
});
|
|
17454
|
+
```
|
|
17455
|
+
|
|
17456
|
+
</dd>
|
|
17457
|
+
</dl>
|
|
17458
|
+
</dd>
|
|
17459
|
+
</dl>
|
|
17460
|
+
|
|
17461
|
+
#### ⚙️ Parameters
|
|
17462
|
+
|
|
17463
|
+
<dl>
|
|
17464
|
+
<dd>
|
|
17465
|
+
|
|
17466
|
+
<dl>
|
|
17467
|
+
<dd>
|
|
17468
|
+
|
|
17469
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientCreate1`
|
|
17470
|
+
|
|
17471
|
+
</dd>
|
|
17472
|
+
</dl>
|
|
17473
|
+
|
|
17474
|
+
<dl>
|
|
17475
|
+
<dd>
|
|
17476
|
+
|
|
17477
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17478
|
+
|
|
17479
|
+
</dd>
|
|
17480
|
+
</dl>
|
|
17481
|
+
</dd>
|
|
17482
|
+
</dl>
|
|
17483
|
+
|
|
17484
|
+
</dd>
|
|
17485
|
+
</dl>
|
|
17486
|
+
</details>
|
|
17487
|
+
|
|
17488
|
+
<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>
|
|
17489
|
+
<dl>
|
|
17490
|
+
<dd>
|
|
17491
|
+
|
|
17492
|
+
#### 📝 Description
|
|
17493
|
+
|
|
17494
|
+
<dl>
|
|
17495
|
+
<dd>
|
|
17496
|
+
|
|
17497
|
+
<dl>
|
|
17498
|
+
<dd>
|
|
17499
|
+
|
|
17500
|
+
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)
|
|
17501
|
+
|
|
17502
|
+
</dd>
|
|
17503
|
+
</dl>
|
|
17504
|
+
</dd>
|
|
17505
|
+
</dl>
|
|
17506
|
+
|
|
17507
|
+
#### 🔌 Usage
|
|
17508
|
+
|
|
17509
|
+
<dl>
|
|
17510
|
+
<dd>
|
|
17511
|
+
|
|
17512
|
+
<dl>
|
|
17513
|
+
<dd>
|
|
17514
|
+
|
|
17515
|
+
```typescript
|
|
17516
|
+
await client.shipping.drivers.updateSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17517
|
+
```
|
|
17518
|
+
|
|
17519
|
+
</dd>
|
|
17520
|
+
</dl>
|
|
17521
|
+
</dd>
|
|
17522
|
+
</dl>
|
|
17523
|
+
|
|
17524
|
+
#### ⚙️ Parameters
|
|
17525
|
+
|
|
17526
|
+
<dl>
|
|
17527
|
+
<dd>
|
|
17528
|
+
|
|
17529
|
+
<dl>
|
|
17530
|
+
<dd>
|
|
17531
|
+
|
|
17532
|
+
**driverId:** `string`
|
|
17533
|
+
|
|
17534
|
+
</dd>
|
|
17535
|
+
</dl>
|
|
17536
|
+
|
|
17537
|
+
<dl>
|
|
17538
|
+
<dd>
|
|
17539
|
+
|
|
17540
|
+
**reportDate:** `string`
|
|
17541
|
+
|
|
17542
|
+
</dd>
|
|
17543
|
+
</dl>
|
|
17544
|
+
|
|
17545
|
+
<dl>
|
|
17546
|
+
<dd>
|
|
17547
|
+
|
|
17548
|
+
**request:** `Chrt.shipping.DriverSelfReportedHoursAndMileageClientUpdate1`
|
|
17549
|
+
|
|
17550
|
+
</dd>
|
|
17551
|
+
</dl>
|
|
17552
|
+
|
|
17553
|
+
<dl>
|
|
17554
|
+
<dd>
|
|
17555
|
+
|
|
17556
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17557
|
+
|
|
17558
|
+
</dd>
|
|
17559
|
+
</dl>
|
|
17560
|
+
</dd>
|
|
17561
|
+
</dl>
|
|
17562
|
+
|
|
17563
|
+
</dd>
|
|
17564
|
+
</dl>
|
|
17565
|
+
</details>
|
|
17566
|
+
|
|
17567
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">deleteSelfReportedHoursAndMileageV1</a>(driverId, reportDate) -> boolean</code></summary>
|
|
17568
|
+
<dl>
|
|
17569
|
+
<dd>
|
|
17570
|
+
|
|
17571
|
+
#### 📝 Description
|
|
17572
|
+
|
|
17573
|
+
<dl>
|
|
17574
|
+
<dd>
|
|
17575
|
+
|
|
17576
|
+
<dl>
|
|
17577
|
+
<dd>
|
|
17578
|
+
|
|
17579
|
+
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)
|
|
17580
|
+
|
|
17581
|
+
</dd>
|
|
17582
|
+
</dl>
|
|
17583
|
+
</dd>
|
|
17584
|
+
</dl>
|
|
17585
|
+
|
|
17586
|
+
#### 🔌 Usage
|
|
17587
|
+
|
|
17588
|
+
<dl>
|
|
17589
|
+
<dd>
|
|
17590
|
+
|
|
17591
|
+
<dl>
|
|
17592
|
+
<dd>
|
|
17593
|
+
|
|
17594
|
+
```typescript
|
|
17595
|
+
await client.shipping.drivers.deleteSelfReportedHoursAndMileageV1("driver_id", "report_date");
|
|
17596
|
+
```
|
|
17597
|
+
|
|
17598
|
+
</dd>
|
|
17599
|
+
</dl>
|
|
17600
|
+
</dd>
|
|
17601
|
+
</dl>
|
|
17602
|
+
|
|
17603
|
+
#### ⚙️ Parameters
|
|
17604
|
+
|
|
17605
|
+
<dl>
|
|
17606
|
+
<dd>
|
|
17607
|
+
|
|
17608
|
+
<dl>
|
|
17609
|
+
<dd>
|
|
17610
|
+
|
|
17611
|
+
**driverId:** `string`
|
|
17612
|
+
|
|
17613
|
+
</dd>
|
|
17614
|
+
</dl>
|
|
17615
|
+
|
|
17616
|
+
<dl>
|
|
17617
|
+
<dd>
|
|
17618
|
+
|
|
17619
|
+
**reportDate:** `string`
|
|
17620
|
+
|
|
17621
|
+
</dd>
|
|
17622
|
+
</dl>
|
|
17623
|
+
|
|
17624
|
+
<dl>
|
|
17625
|
+
<dd>
|
|
17626
|
+
|
|
17627
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17628
|
+
|
|
17629
|
+
</dd>
|
|
17630
|
+
</dl>
|
|
17631
|
+
</dd>
|
|
17632
|
+
</dl>
|
|
17633
|
+
|
|
17634
|
+
</dd>
|
|
17635
|
+
</dl>
|
|
17636
|
+
</details>
|
|
17637
|
+
|
|
17638
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
17639
|
+
<dl>
|
|
17640
|
+
<dd>
|
|
17641
|
+
|
|
17642
|
+
#### 📝 Description
|
|
17643
|
+
|
|
17644
|
+
<dl>
|
|
17645
|
+
<dd>
|
|
17646
|
+
|
|
17647
|
+
<dl>
|
|
17648
|
+
<dd>
|
|
17649
|
+
|
|
17650
|
+
Retrieves driver information for the caller within their organization. | () -> (Driver1)
|
|
17651
|
+
|
|
17652
|
+
</dd>
|
|
17653
|
+
</dl>
|
|
17654
|
+
</dd>
|
|
17655
|
+
</dl>
|
|
17656
|
+
|
|
17657
|
+
#### 🔌 Usage
|
|
17658
|
+
|
|
17659
|
+
<dl>
|
|
17660
|
+
<dd>
|
|
17661
|
+
|
|
17662
|
+
<dl>
|
|
17663
|
+
<dd>
|
|
17664
|
+
|
|
17665
|
+
```typescript
|
|
17666
|
+
await client.shipping.drivers.getForCallerV1();
|
|
17667
|
+
```
|
|
17668
|
+
|
|
17669
|
+
</dd>
|
|
17670
|
+
</dl>
|
|
17671
|
+
</dd>
|
|
17672
|
+
</dl>
|
|
17673
|
+
|
|
17674
|
+
#### ⚙️ Parameters
|
|
17675
|
+
|
|
17676
|
+
<dl>
|
|
17677
|
+
<dd>
|
|
17678
|
+
|
|
17679
|
+
<dl>
|
|
17680
|
+
<dd>
|
|
17681
|
+
|
|
17682
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17683
|
+
|
|
17684
|
+
</dd>
|
|
17685
|
+
</dl>
|
|
17686
|
+
</dd>
|
|
17687
|
+
</dl>
|
|
17688
|
+
|
|
17689
|
+
</dd>
|
|
17690
|
+
</dl>
|
|
17691
|
+
</details>
|
|
17692
|
+
|
|
17693
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getByDriverIdV1</a>(driverId) -> Chrt.Driver1</code></summary>
|
|
17694
|
+
<dl>
|
|
17695
|
+
<dd>
|
|
17696
|
+
|
|
17697
|
+
#### 📝 Description
|
|
17698
|
+
|
|
17699
|
+
<dl>
|
|
17700
|
+
<dd>
|
|
17701
|
+
|
|
17702
|
+
<dl>
|
|
17703
|
+
<dd>
|
|
17704
|
+
|
|
17705
|
+
Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
|
|
17706
|
+
|
|
17707
|
+
</dd>
|
|
17708
|
+
</dl>
|
|
17709
|
+
</dd>
|
|
17710
|
+
</dl>
|
|
17711
|
+
|
|
17712
|
+
#### 🔌 Usage
|
|
17713
|
+
|
|
17714
|
+
<dl>
|
|
17715
|
+
<dd>
|
|
17716
|
+
|
|
17717
|
+
<dl>
|
|
17718
|
+
<dd>
|
|
17719
|
+
|
|
17720
|
+
```typescript
|
|
17721
|
+
await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
17722
|
+
```
|
|
17723
|
+
|
|
17724
|
+
</dd>
|
|
17725
|
+
</dl>
|
|
17726
|
+
</dd>
|
|
17727
|
+
</dl>
|
|
17728
|
+
|
|
17729
|
+
#### ⚙️ Parameters
|
|
17730
|
+
|
|
17731
|
+
<dl>
|
|
17732
|
+
<dd>
|
|
17733
|
+
|
|
17734
|
+
<dl>
|
|
17735
|
+
<dd>
|
|
17736
|
+
|
|
17737
|
+
**driverId:** `string`
|
|
17738
|
+
|
|
17739
|
+
</dd>
|
|
17740
|
+
</dl>
|
|
17741
|
+
|
|
17742
|
+
<dl>
|
|
17743
|
+
<dd>
|
|
17744
|
+
|
|
17745
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17746
|
+
|
|
17747
|
+
</dd>
|
|
17748
|
+
</dl>
|
|
17749
|
+
</dd>
|
|
17750
|
+
</dl>
|
|
17751
|
+
|
|
17752
|
+
</dd>
|
|
17753
|
+
</dl>
|
|
17754
|
+
</details>
|
|
17755
|
+
|
|
17756
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listOrgMembersAndDriversV1</a>({ ...params }) -> Chrt.OrgMembersAndDriversListRes</code></summary>
|
|
17757
|
+
<dl>
|
|
17758
|
+
<dd>
|
|
17759
|
+
|
|
17760
|
+
#### 📝 Description
|
|
17761
|
+
|
|
17762
|
+
<dl>
|
|
17763
|
+
<dd>
|
|
17764
|
+
|
|
17765
|
+
<dl>
|
|
17766
|
+
<dd>
|
|
17767
|
+
|
|
17768
|
+
Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
17769
|
+
|
|
17770
|
+
</dd>
|
|
17771
|
+
</dl>
|
|
17772
|
+
</dd>
|
|
17773
|
+
</dl>
|
|
17774
|
+
|
|
17775
|
+
#### 🔌 Usage
|
|
17776
|
+
|
|
17777
|
+
<dl>
|
|
17778
|
+
<dd>
|
|
17779
|
+
|
|
17780
|
+
<dl>
|
|
17781
|
+
<dd>
|
|
17782
|
+
|
|
17783
|
+
```typescript
|
|
17784
|
+
await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
17785
|
+
search: "search",
|
|
17786
|
+
filter_available_according_to_driver: true,
|
|
17787
|
+
filter_available_according_to_operators: true,
|
|
17788
|
+
sort_by: "first_name",
|
|
17789
|
+
sort_order: "asc",
|
|
17790
|
+
page: 1,
|
|
17791
|
+
page_size: 1,
|
|
17792
|
+
});
|
|
17793
|
+
```
|
|
17794
|
+
|
|
17795
|
+
</dd>
|
|
17796
|
+
</dl>
|
|
17797
|
+
</dd>
|
|
17798
|
+
</dl>
|
|
17799
|
+
|
|
17800
|
+
#### ⚙️ Parameters
|
|
17801
|
+
|
|
17802
|
+
<dl>
|
|
17803
|
+
<dd>
|
|
17804
|
+
|
|
17805
|
+
<dl>
|
|
17806
|
+
<dd>
|
|
17807
|
+
|
|
17808
|
+
**request:** `Chrt.shipping.DriversListOrgMembersAndDriversV1Request`
|
|
17809
|
+
|
|
17810
|
+
</dd>
|
|
17811
|
+
</dl>
|
|
17812
|
+
|
|
17813
|
+
<dl>
|
|
17814
|
+
<dd>
|
|
17815
|
+
|
|
17816
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17817
|
+
|
|
17818
|
+
</dd>
|
|
17819
|
+
</dl>
|
|
17820
|
+
</dd>
|
|
17821
|
+
</dl>
|
|
17822
|
+
|
|
17823
|
+
</dd>
|
|
17824
|
+
</dl>
|
|
17825
|
+
</details>
|
|
17826
|
+
|
|
17827
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DriverListRes</code></summary>
|
|
17828
|
+
<dl>
|
|
17829
|
+
<dd>
|
|
17830
|
+
|
|
17831
|
+
#### 📝 Description
|
|
17832
|
+
|
|
17833
|
+
<dl>
|
|
17834
|
+
<dd>
|
|
17835
|
+
|
|
17836
|
+
<dl>
|
|
17837
|
+
<dd>
|
|
17838
|
+
|
|
17839
|
+
Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)
|
|
17840
|
+
|
|
17841
|
+
</dd>
|
|
17842
|
+
</dl>
|
|
17843
|
+
</dd>
|
|
17844
|
+
</dl>
|
|
17845
|
+
|
|
17846
|
+
#### 🔌 Usage
|
|
17847
|
+
|
|
17848
|
+
<dl>
|
|
17849
|
+
<dd>
|
|
17850
|
+
|
|
17851
|
+
<dl>
|
|
17852
|
+
<dd>
|
|
17853
|
+
|
|
17854
|
+
```typescript
|
|
17855
|
+
await client.shipping.drivers.listV1({
|
|
17856
|
+
sort_order: "asc",
|
|
17857
|
+
page: 1,
|
|
17858
|
+
page_size: 1,
|
|
17859
|
+
search: "search",
|
|
17860
|
+
filter_available_according_to_driver: true,
|
|
17861
|
+
filter_available_according_to_operators: true,
|
|
17862
|
+
});
|
|
17863
|
+
```
|
|
17864
|
+
|
|
17865
|
+
</dd>
|
|
17866
|
+
</dl>
|
|
17867
|
+
</dd>
|
|
17868
|
+
</dl>
|
|
17869
|
+
|
|
17870
|
+
#### ⚙️ Parameters
|
|
17871
|
+
|
|
17872
|
+
<dl>
|
|
17873
|
+
<dd>
|
|
17874
|
+
|
|
17875
|
+
<dl>
|
|
17876
|
+
<dd>
|
|
17877
|
+
|
|
17878
|
+
**request:** `Chrt.shipping.DriversListV1Request`
|
|
17879
|
+
|
|
17880
|
+
</dd>
|
|
17881
|
+
</dl>
|
|
17882
|
+
|
|
17883
|
+
<dl>
|
|
17884
|
+
<dd>
|
|
17885
|
+
|
|
17886
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17887
|
+
|
|
17888
|
+
</dd>
|
|
17889
|
+
</dl>
|
|
17890
|
+
</dd>
|
|
17891
|
+
</dl>
|
|
17892
|
+
|
|
17893
|
+
</dd>
|
|
17894
|
+
</dl>
|
|
17895
|
+
</details>
|
|
17896
|
+
|
|
17897
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
17898
|
+
<dl>
|
|
17899
|
+
<dd>
|
|
17900
|
+
|
|
17901
|
+
#### 📝 Description
|
|
17902
|
+
|
|
17903
|
+
<dl>
|
|
17904
|
+
<dd>
|
|
17905
|
+
|
|
17906
|
+
<dl>
|
|
17907
|
+
<dd>
|
|
17908
|
+
|
|
17909
|
+
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)
|
|
17910
|
+
|
|
17911
|
+
</dd>
|
|
17912
|
+
</dl>
|
|
17913
|
+
</dd>
|
|
17914
|
+
</dl>
|
|
17915
|
+
|
|
17916
|
+
#### 🔌 Usage
|
|
17917
|
+
|
|
17918
|
+
<dl>
|
|
17919
|
+
<dd>
|
|
17920
|
+
|
|
17921
|
+
<dl>
|
|
17922
|
+
<dd>
|
|
17923
|
+
|
|
17924
|
+
```typescript
|
|
17925
|
+
await client.shipping.drivers.createV1({
|
|
17926
|
+
target_user_id: "target_user_id",
|
|
17927
|
+
schema_version: 1,
|
|
17928
|
+
});
|
|
17929
|
+
```
|
|
17930
|
+
|
|
17931
|
+
</dd>
|
|
17932
|
+
</dl>
|
|
17933
|
+
</dd>
|
|
17934
|
+
</dl>
|
|
17935
|
+
|
|
17936
|
+
#### ⚙️ Parameters
|
|
17937
|
+
|
|
17938
|
+
<dl>
|
|
17939
|
+
<dd>
|
|
17940
|
+
|
|
17941
|
+
<dl>
|
|
17942
|
+
<dd>
|
|
17943
|
+
|
|
17944
|
+
**request:** `Chrt.shipping.DriverClientCreate1`
|
|
17945
|
+
|
|
17946
|
+
</dd>
|
|
17947
|
+
</dl>
|
|
17948
|
+
|
|
17949
|
+
<dl>
|
|
17950
|
+
<dd>
|
|
17951
|
+
|
|
17952
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
17953
|
+
|
|
17954
|
+
</dd>
|
|
17955
|
+
</dl>
|
|
17956
|
+
</dd>
|
|
17957
|
+
</dl>
|
|
17958
|
+
|
|
17959
|
+
</dd>
|
|
17960
|
+
</dl>
|
|
17961
|
+
</details>
|
|
17962
|
+
|
|
17963
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
17964
|
+
<dl>
|
|
17965
|
+
<dd>
|
|
17966
|
+
|
|
17967
|
+
#### 📝 Description
|
|
17968
|
+
|
|
17969
|
+
<dl>
|
|
17970
|
+
<dd>
|
|
17971
|
+
|
|
17972
|
+
<dl>
|
|
17973
|
+
<dd>
|
|
17974
|
+
|
|
17975
|
+
Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
|
|
17976
|
+
|
|
17977
|
+
</dd>
|
|
17978
|
+
</dl>
|
|
17979
|
+
</dd>
|
|
17980
|
+
</dl>
|
|
17981
|
+
|
|
17982
|
+
#### 🔌 Usage
|
|
17983
|
+
|
|
17984
|
+
<dl>
|
|
17985
|
+
<dd>
|
|
17986
|
+
|
|
17987
|
+
<dl>
|
|
17988
|
+
<dd>
|
|
17989
|
+
|
|
17990
|
+
```typescript
|
|
17991
|
+
await client.shipping.drivers.updateV1("driver_id");
|
|
17992
|
+
```
|
|
17993
|
+
|
|
17994
|
+
</dd>
|
|
17995
|
+
</dl>
|
|
17996
|
+
</dd>
|
|
17997
|
+
</dl>
|
|
17998
|
+
|
|
17999
|
+
#### ⚙️ Parameters
|
|
18000
|
+
|
|
18001
|
+
<dl>
|
|
18002
|
+
<dd>
|
|
18003
|
+
|
|
18004
|
+
<dl>
|
|
18005
|
+
<dd>
|
|
18006
|
+
|
|
18007
|
+
**driverId:** `string`
|
|
18008
|
+
|
|
18009
|
+
</dd>
|
|
18010
|
+
</dl>
|
|
18011
|
+
|
|
18012
|
+
<dl>
|
|
18013
|
+
<dd>
|
|
18014
|
+
|
|
18015
|
+
**request:** `Chrt.shipping.DriverClientUpdate1`
|
|
18016
|
+
|
|
18017
|
+
</dd>
|
|
18018
|
+
</dl>
|
|
18019
|
+
|
|
18020
|
+
<dl>
|
|
18021
|
+
<dd>
|
|
18022
|
+
|
|
18023
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18024
|
+
|
|
18025
|
+
</dd>
|
|
18026
|
+
</dl>
|
|
18027
|
+
</dd>
|
|
18028
|
+
</dl>
|
|
18029
|
+
|
|
18030
|
+
</dd>
|
|
18031
|
+
</dl>
|
|
18032
|
+
</details>
|
|
18033
|
+
|
|
18034
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">clearLastSeenV1</a>() -> boolean</code></summary>
|
|
18035
|
+
<dl>
|
|
18036
|
+
<dd>
|
|
18037
|
+
|
|
18038
|
+
#### 📝 Description
|
|
18039
|
+
|
|
18040
|
+
<dl>
|
|
18041
|
+
<dd>
|
|
18042
|
+
|
|
18043
|
+
<dl>
|
|
18044
|
+
<dd>
|
|
18045
|
+
|
|
18046
|
+
Clears the driver's last known location and timestamp. | () -> (bool)
|
|
18047
|
+
|
|
18048
|
+
</dd>
|
|
18049
|
+
</dl>
|
|
18050
|
+
</dd>
|
|
18051
|
+
</dl>
|
|
18052
|
+
|
|
18053
|
+
#### 🔌 Usage
|
|
18054
|
+
|
|
18055
|
+
<dl>
|
|
18056
|
+
<dd>
|
|
18057
|
+
|
|
18058
|
+
<dl>
|
|
18059
|
+
<dd>
|
|
18060
|
+
|
|
18061
|
+
```typescript
|
|
18062
|
+
await client.shipping.drivers.clearLastSeenV1();
|
|
18063
|
+
```
|
|
18064
|
+
|
|
18065
|
+
</dd>
|
|
18066
|
+
</dl>
|
|
18067
|
+
</dd>
|
|
18068
|
+
</dl>
|
|
18069
|
+
|
|
18070
|
+
#### ⚙️ Parameters
|
|
18071
|
+
|
|
18072
|
+
<dl>
|
|
18073
|
+
<dd>
|
|
18074
|
+
|
|
18075
|
+
<dl>
|
|
18076
|
+
<dd>
|
|
18077
|
+
|
|
18078
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18079
|
+
|
|
18080
|
+
</dd>
|
|
18081
|
+
</dl>
|
|
18082
|
+
</dd>
|
|
18083
|
+
</dl>
|
|
18084
|
+
|
|
18085
|
+
</dd>
|
|
18086
|
+
</dl>
|
|
18087
|
+
</details>
|
|
18088
|
+
|
|
18089
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToDriverV1</a>({ ...params }) -> boolean</code></summary>
|
|
18090
|
+
<dl>
|
|
18091
|
+
<dd>
|
|
18092
|
+
|
|
18093
|
+
#### 📝 Description
|
|
18094
|
+
|
|
18095
|
+
<dl>
|
|
18096
|
+
<dd>
|
|
18097
|
+
|
|
18098
|
+
<dl>
|
|
18099
|
+
<dd>
|
|
18100
|
+
|
|
18101
|
+
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)
|
|
18102
|
+
|
|
18103
|
+
</dd>
|
|
18104
|
+
</dl>
|
|
18105
|
+
</dd>
|
|
18106
|
+
</dl>
|
|
18107
|
+
|
|
18108
|
+
#### 🔌 Usage
|
|
18109
|
+
|
|
18110
|
+
<dl>
|
|
18111
|
+
<dd>
|
|
18112
|
+
|
|
18113
|
+
<dl>
|
|
18114
|
+
<dd>
|
|
18115
|
+
|
|
18116
|
+
```typescript
|
|
18117
|
+
await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
18118
|
+
available: true,
|
|
18119
|
+
});
|
|
18120
|
+
```
|
|
18121
|
+
|
|
18122
|
+
</dd>
|
|
18123
|
+
</dl>
|
|
18124
|
+
</dd>
|
|
18125
|
+
</dl>
|
|
18126
|
+
|
|
18127
|
+
#### ⚙️ Parameters
|
|
18128
|
+
|
|
18129
|
+
<dl>
|
|
18130
|
+
<dd>
|
|
18131
|
+
|
|
18132
|
+
<dl>
|
|
18133
|
+
<dd>
|
|
18134
|
+
|
|
18135
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
18136
|
+
|
|
18137
|
+
</dd>
|
|
18138
|
+
</dl>
|
|
18139
|
+
|
|
18140
|
+
<dl>
|
|
18141
|
+
<dd>
|
|
18142
|
+
|
|
18143
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18144
|
+
|
|
18145
|
+
</dd>
|
|
18146
|
+
</dl>
|
|
18147
|
+
</dd>
|
|
18148
|
+
</dl>
|
|
18149
|
+
|
|
18150
|
+
</dd>
|
|
18151
|
+
</dl>
|
|
18152
|
+
</details>
|
|
18153
|
+
|
|
18154
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAvailabilityAccordingToOperatorsV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
18155
|
+
<dl>
|
|
18156
|
+
<dd>
|
|
18157
|
+
|
|
18158
|
+
#### 📝 Description
|
|
18159
|
+
|
|
18160
|
+
<dl>
|
|
18161
|
+
<dd>
|
|
18162
|
+
|
|
18163
|
+
<dl>
|
|
18164
|
+
<dd>
|
|
18165
|
+
|
|
18166
|
+
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)
|
|
18167
|
+
|
|
18168
|
+
</dd>
|
|
18169
|
+
</dl>
|
|
18170
|
+
</dd>
|
|
18171
|
+
</dl>
|
|
18172
|
+
|
|
18173
|
+
#### 🔌 Usage
|
|
18174
|
+
|
|
18175
|
+
<dl>
|
|
18176
|
+
<dd>
|
|
18177
|
+
|
|
18178
|
+
<dl>
|
|
18179
|
+
<dd>
|
|
18180
|
+
|
|
18181
|
+
```typescript
|
|
18182
|
+
await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
18183
|
+
available: true,
|
|
18184
|
+
});
|
|
18185
|
+
```
|
|
18186
|
+
|
|
18187
|
+
</dd>
|
|
18188
|
+
</dl>
|
|
18189
|
+
</dd>
|
|
18190
|
+
</dl>
|
|
18191
|
+
|
|
18192
|
+
#### ⚙️ Parameters
|
|
18193
|
+
|
|
18194
|
+
<dl>
|
|
18195
|
+
<dd>
|
|
18196
|
+
|
|
18197
|
+
<dl>
|
|
18198
|
+
<dd>
|
|
18199
|
+
|
|
18200
|
+
**driverId:** `string`
|
|
18201
|
+
|
|
18202
|
+
</dd>
|
|
18203
|
+
</dl>
|
|
18204
|
+
|
|
18205
|
+
<dl>
|
|
18206
|
+
<dd>
|
|
18207
|
+
|
|
18208
|
+
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
18209
|
+
|
|
18210
|
+
</dd>
|
|
18211
|
+
</dl>
|
|
18212
|
+
|
|
18213
|
+
<dl>
|
|
18214
|
+
<dd>
|
|
18215
|
+
|
|
18216
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
18217
|
+
|
|
18218
|
+
</dd>
|
|
18219
|
+
</dl>
|
|
18220
|
+
</dd>
|
|
18221
|
+
</dl>
|
|
18222
|
+
|
|
18223
|
+
</dd>
|
|
18224
|
+
</dl>
|
|
18225
|
+
</details>
|
|
18226
|
+
|
|
18227
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">updateAutoAssignV1</a>(driverId, { ...params }) -> boolean</code></summary>
|
|
18228
|
+
<dl>
|
|
18229
|
+
<dd>
|
|
18230
|
+
|
|
18231
|
+
#### 📝 Description
|
|
18232
|
+
|
|
18233
|
+
<dl>
|
|
18234
|
+
<dd>
|
|
18235
|
+
|
|
18236
|
+
<dl>
|
|
18237
|
+
<dd>
|
|
18238
|
+
|
|
18239
|
+
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)
|
|
18240
|
+
|
|
18241
|
+
</dd>
|
|
18242
|
+
</dl>
|
|
18243
|
+
</dd>
|
|
18244
|
+
</dl>
|
|
18245
|
+
|
|
18246
|
+
#### 🔌 Usage
|
|
18247
|
+
|
|
18248
|
+
<dl>
|
|
18249
|
+
<dd>
|
|
18250
|
+
|
|
18251
|
+
<dl>
|
|
18252
|
+
<dd>
|
|
18253
|
+
|
|
18254
|
+
```typescript
|
|
18255
|
+
await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
18256
|
+
auto_assign_enabled: true,
|
|
18257
|
+
});
|
|
18258
|
+
```
|
|
17099
18259
|
|
|
17100
18260
|
</dd>
|
|
17101
18261
|
</dl>
|
|
17102
18262
|
</dd>
|
|
17103
18263
|
</dl>
|
|
17104
18264
|
|
|
17105
|
-
####
|
|
18265
|
+
#### ⚙️ Parameters
|
|
17106
18266
|
|
|
17107
18267
|
<dl>
|
|
17108
18268
|
<dd>
|
|
@@ -17110,20 +18270,19 @@ Retrieves driver information for the caller within their organization. | () -> (
|
|
|
17110
18270
|
<dl>
|
|
17111
18271
|
<dd>
|
|
17112
18272
|
|
|
17113
|
-
|
|
17114
|
-
await client.shipping.drivers.getForCallerV1();
|
|
17115
|
-
```
|
|
18273
|
+
**driverId:** `string`
|
|
17116
18274
|
|
|
17117
|
-
</dd>
|
|
17118
|
-
</dl>
|
|
17119
18275
|
</dd>
|
|
17120
18276
|
</dl>
|
|
17121
18277
|
|
|
17122
|
-
#### ⚙️ Parameters
|
|
17123
|
-
|
|
17124
18278
|
<dl>
|
|
17125
18279
|
<dd>
|
|
17126
18280
|
|
|
18281
|
+
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
18282
|
+
|
|
18283
|
+
</dd>
|
|
18284
|
+
</dl>
|
|
18285
|
+
|
|
17127
18286
|
<dl>
|
|
17128
18287
|
<dd>
|
|
17129
18288
|
|
|
@@ -17138,7 +18297,9 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17138
18297
|
</dl>
|
|
17139
18298
|
</details>
|
|
17140
18299
|
|
|
17141
|
-
|
|
18300
|
+
## Shipping Cargos
|
|
18301
|
+
|
|
18302
|
+
<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
18303
|
<dl>
|
|
17143
18304
|
<dd>
|
|
17144
18305
|
|
|
@@ -17150,7 +18311,7 @@ await client.shipping.drivers.getForCallerV1();
|
|
|
17150
18311
|
<dl>
|
|
17151
18312
|
<dd>
|
|
17152
18313
|
|
|
17153
|
-
|
|
18314
|
+
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
18315
|
|
|
17155
18316
|
</dd>
|
|
17156
18317
|
</dl>
|
|
@@ -17166,7 +18327,7 @@ Retrieves detailed driver information by driver ID within the organization. | ()
|
|
|
17166
18327
|
<dd>
|
|
17167
18328
|
|
|
17168
18329
|
```typescript
|
|
17169
|
-
await client.shipping.
|
|
18330
|
+
await client.shipping.cargos.updateV1("cargo_id", {});
|
|
17170
18331
|
```
|
|
17171
18332
|
|
|
17172
18333
|
</dd>
|
|
@@ -17182,7 +18343,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17182
18343
|
<dl>
|
|
17183
18344
|
<dd>
|
|
17184
18345
|
|
|
17185
|
-
**
|
|
18346
|
+
**cargoId:** `string`
|
|
17186
18347
|
|
|
17187
18348
|
</dd>
|
|
17188
18349
|
</dl>
|
|
@@ -17190,7 +18351,15 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17190
18351
|
<dl>
|
|
17191
18352
|
<dd>
|
|
17192
18353
|
|
|
17193
|
-
**
|
|
18354
|
+
**request:** `Chrt.CargoClientUpdate1`
|
|
18355
|
+
|
|
18356
|
+
</dd>
|
|
18357
|
+
</dl>
|
|
18358
|
+
|
|
18359
|
+
<dl>
|
|
18360
|
+
<dd>
|
|
18361
|
+
|
|
18362
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
17194
18363
|
|
|
17195
18364
|
</dd>
|
|
17196
18365
|
</dl>
|
|
@@ -17201,7 +18370,9 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17201
18370
|
</dl>
|
|
17202
18371
|
</details>
|
|
17203
18372
|
|
|
17204
|
-
|
|
18373
|
+
## Shipping Flights
|
|
18374
|
+
|
|
18375
|
+
<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
18376
|
<dl>
|
|
17206
18377
|
<dd>
|
|
17207
18378
|
|
|
@@ -17213,7 +18384,7 @@ await client.shipping.drivers.getByDriverIdV1("driver_id");
|
|
|
17213
18384
|
<dl>
|
|
17214
18385
|
<dd>
|
|
17215
18386
|
|
|
17216
|
-
|
|
18387
|
+
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
18388
|
|
|
17218
18389
|
</dd>
|
|
17219
18390
|
</dl>
|
|
@@ -17229,15 +18400,7 @@ Lists all organization members paired with their driver information if they are
|
|
|
17229
18400
|
<dd>
|
|
17230
18401
|
|
|
17231
18402
|
```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
|
-
});
|
|
18403
|
+
await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
17241
18404
|
```
|
|
17242
18405
|
|
|
17243
18406
|
</dd>
|
|
@@ -17253,7 +18416,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17253
18416
|
<dl>
|
|
17254
18417
|
<dd>
|
|
17255
18418
|
|
|
17256
|
-
**
|
|
18419
|
+
**taskId:** `string`
|
|
17257
18420
|
|
|
17258
18421
|
</dd>
|
|
17259
18422
|
</dl>
|
|
@@ -17261,7 +18424,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17261
18424
|
<dl>
|
|
17262
18425
|
<dd>
|
|
17263
18426
|
|
|
17264
|
-
**requestOptions:** `
|
|
18427
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17265
18428
|
|
|
17266
18429
|
</dd>
|
|
17267
18430
|
</dl>
|
|
@@ -17272,7 +18435,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17272
18435
|
</dl>
|
|
17273
18436
|
</details>
|
|
17274
18437
|
|
|
17275
|
-
<details><summary><code>client.shipping.
|
|
18438
|
+
<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
18439
|
<dl>
|
|
17277
18440
|
<dd>
|
|
17278
18441
|
|
|
@@ -17284,7 +18447,7 @@ await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
|
17284
18447
|
<dl>
|
|
17285
18448
|
<dd>
|
|
17286
18449
|
|
|
17287
|
-
|
|
18450
|
+
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
18451
|
|
|
17289
18452
|
</dd>
|
|
17290
18453
|
</dl>
|
|
@@ -17300,14 +18463,7 @@ Lists all drivers belonging to the caller's organization with filtering, sorting
|
|
|
17300
18463
|
<dd>
|
|
17301
18464
|
|
|
17302
18465
|
```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
|
-
});
|
|
18466
|
+
await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
17311
18467
|
```
|
|
17312
18468
|
|
|
17313
18469
|
</dd>
|
|
@@ -17323,7 +18479,7 @@ await client.shipping.drivers.listV1({
|
|
|
17323
18479
|
<dl>
|
|
17324
18480
|
<dd>
|
|
17325
18481
|
|
|
17326
|
-
**
|
|
18482
|
+
**taskGroupId:** `string`
|
|
17327
18483
|
|
|
17328
18484
|
</dd>
|
|
17329
18485
|
</dl>
|
|
@@ -17331,7 +18487,7 @@ await client.shipping.drivers.listV1({
|
|
|
17331
18487
|
<dl>
|
|
17332
18488
|
<dd>
|
|
17333
18489
|
|
|
17334
|
-
**requestOptions:** `
|
|
18490
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17335
18491
|
|
|
17336
18492
|
</dd>
|
|
17337
18493
|
</dl>
|
|
@@ -17342,7 +18498,7 @@ await client.shipping.drivers.listV1({
|
|
|
17342
18498
|
</dl>
|
|
17343
18499
|
</details>
|
|
17344
18500
|
|
|
17345
|
-
<details><summary><code>client.shipping.
|
|
18501
|
+
<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
18502
|
<dl>
|
|
17347
18503
|
<dd>
|
|
17348
18504
|
|
|
@@ -17354,7 +18510,7 @@ await client.shipping.drivers.listV1({
|
|
|
17354
18510
|
<dl>
|
|
17355
18511
|
<dd>
|
|
17356
18512
|
|
|
17357
|
-
|
|
18513
|
+
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
18514
|
|
|
17359
18515
|
</dd>
|
|
17360
18516
|
</dl>
|
|
@@ -17370,10 +18526,7 @@ Creates a new driver profile for the target user (defaults to caller). Drivers c
|
|
|
17370
18526
|
<dd>
|
|
17371
18527
|
|
|
17372
18528
|
```typescript
|
|
17373
|
-
await client.shipping.
|
|
17374
|
-
target_user_id: "target_user_id",
|
|
17375
|
-
schema_version: 1,
|
|
17376
|
-
});
|
|
18529
|
+
await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
17377
18530
|
```
|
|
17378
18531
|
|
|
17379
18532
|
</dd>
|
|
@@ -17389,7 +18542,7 @@ await client.shipping.drivers.createV1({
|
|
|
17389
18542
|
<dl>
|
|
17390
18543
|
<dd>
|
|
17391
18544
|
|
|
17392
|
-
**
|
|
18545
|
+
**flightLegId:** `string`
|
|
17393
18546
|
|
|
17394
18547
|
</dd>
|
|
17395
18548
|
</dl>
|
|
@@ -17397,7 +18550,7 @@ await client.shipping.drivers.createV1({
|
|
|
17397
18550
|
<dl>
|
|
17398
18551
|
<dd>
|
|
17399
18552
|
|
|
17400
|
-
**requestOptions:** `
|
|
18553
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17401
18554
|
|
|
17402
18555
|
</dd>
|
|
17403
18556
|
</dl>
|
|
@@ -17408,7 +18561,7 @@ await client.shipping.drivers.createV1({
|
|
|
17408
18561
|
</dl>
|
|
17409
18562
|
</details>
|
|
17410
18563
|
|
|
17411
|
-
<details><summary><code>client.shipping.
|
|
18564
|
+
<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
18565
|
<dl>
|
|
17413
18566
|
<dd>
|
|
17414
18567
|
|
|
@@ -17420,7 +18573,7 @@ await client.shipping.drivers.createV1({
|
|
|
17420
18573
|
<dl>
|
|
17421
18574
|
<dd>
|
|
17422
18575
|
|
|
17423
|
-
|
|
18576
|
+
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
18577
|
|
|
17425
18578
|
</dd>
|
|
17426
18579
|
</dl>
|
|
@@ -17436,7 +18589,7 @@ Updates driver contact details and vehicle type assignments. Provider orgs only;
|
|
|
17436
18589
|
<dd>
|
|
17437
18590
|
|
|
17438
18591
|
```typescript
|
|
17439
|
-
await client.shipping.
|
|
18592
|
+
await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
17440
18593
|
```
|
|
17441
18594
|
|
|
17442
18595
|
</dd>
|
|
@@ -17452,15 +18605,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17452
18605
|
<dl>
|
|
17453
18606
|
<dd>
|
|
17454
18607
|
|
|
17455
|
-
**
|
|
17456
|
-
|
|
17457
|
-
</dd>
|
|
17458
|
-
</dl>
|
|
17459
|
-
|
|
17460
|
-
<dl>
|
|
17461
|
-
<dd>
|
|
17462
|
-
|
|
17463
|
-
**request:** `Chrt.shipping.DriverClientUpdate1`
|
|
18608
|
+
**flightLegId:** `string`
|
|
17464
18609
|
|
|
17465
18610
|
</dd>
|
|
17466
18611
|
</dl>
|
|
@@ -17468,7 +18613,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17468
18613
|
<dl>
|
|
17469
18614
|
<dd>
|
|
17470
18615
|
|
|
17471
|
-
**requestOptions:** `
|
|
18616
|
+
**requestOptions:** `Flights.RequestOptions`
|
|
17472
18617
|
|
|
17473
18618
|
</dd>
|
|
17474
18619
|
</dl>
|
|
@@ -17479,7 +18624,9 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17479
18624
|
</dl>
|
|
17480
18625
|
</details>
|
|
17481
18626
|
|
|
17482
|
-
|
|
18627
|
+
## Shipping TaskArtifacts
|
|
18628
|
+
|
|
18629
|
+
<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
18630
|
<dl>
|
|
17484
18631
|
<dd>
|
|
17485
18632
|
|
|
@@ -17491,7 +18638,7 @@ await client.shipping.drivers.updateV1("driver_id");
|
|
|
17491
18638
|
<dl>
|
|
17492
18639
|
<dd>
|
|
17493
18640
|
|
|
17494
|
-
|
|
18641
|
+
Adds a new task artifact to a task. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | (AddTaskArtifactReq) -> (PydanticObjectId)
|
|
17495
18642
|
|
|
17496
18643
|
</dd>
|
|
17497
18644
|
</dl>
|
|
@@ -17507,7 +18654,13 @@ Clears the driver's last known location and timestamp. | () -> (bool)
|
|
|
17507
18654
|
<dd>
|
|
17508
18655
|
|
|
17509
18656
|
```typescript
|
|
17510
|
-
await client.shipping.
|
|
18657
|
+
await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
18658
|
+
task_artifact: {
|
|
18659
|
+
schema_version: 1,
|
|
18660
|
+
type: "image",
|
|
18661
|
+
},
|
|
18662
|
+
status: "draft",
|
|
18663
|
+
});
|
|
17511
18664
|
```
|
|
17512
18665
|
|
|
17513
18666
|
</dd>
|
|
@@ -17523,7 +18676,23 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17523
18676
|
<dl>
|
|
17524
18677
|
<dd>
|
|
17525
18678
|
|
|
17526
|
-
**
|
|
18679
|
+
**taskId:** `string`
|
|
18680
|
+
|
|
18681
|
+
</dd>
|
|
18682
|
+
</dl>
|
|
18683
|
+
|
|
18684
|
+
<dl>
|
|
18685
|
+
<dd>
|
|
18686
|
+
|
|
18687
|
+
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
18688
|
+
|
|
18689
|
+
</dd>
|
|
18690
|
+
</dl>
|
|
18691
|
+
|
|
18692
|
+
<dl>
|
|
18693
|
+
<dd>
|
|
18694
|
+
|
|
18695
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17527
18696
|
|
|
17528
18697
|
</dd>
|
|
17529
18698
|
</dl>
|
|
@@ -17534,7 +18703,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17534
18703
|
</dl>
|
|
17535
18704
|
</details>
|
|
17536
18705
|
|
|
17537
|
-
<details><summary><code>client.shipping.
|
|
18706
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">completeV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17538
18707
|
<dl>
|
|
17539
18708
|
<dd>
|
|
17540
18709
|
|
|
@@ -17546,7 +18715,7 @@ await client.shipping.drivers.clearLastSeenV1();
|
|
|
17546
18715
|
<dl>
|
|
17547
18716
|
<dd>
|
|
17548
18717
|
|
|
17549
|
-
|
|
18718
|
+
Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
17550
18719
|
|
|
17551
18720
|
</dd>
|
|
17552
18721
|
</dl>
|
|
@@ -17562,9 +18731,7 @@ Updates the caller's driver availability status. Must have status UNASSIGNED to
|
|
|
17562
18731
|
<dd>
|
|
17563
18732
|
|
|
17564
18733
|
```typescript
|
|
17565
|
-
await client.shipping.
|
|
17566
|
-
available: true,
|
|
17567
|
-
});
|
|
18734
|
+
await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
17568
18735
|
```
|
|
17569
18736
|
|
|
17570
18737
|
</dd>
|
|
@@ -17580,7 +18747,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17580
18747
|
<dl>
|
|
17581
18748
|
<dd>
|
|
17582
18749
|
|
|
17583
|
-
**
|
|
18750
|
+
**taskArtifactId:** `string`
|
|
17584
18751
|
|
|
17585
18752
|
</dd>
|
|
17586
18753
|
</dl>
|
|
@@ -17588,7 +18755,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17588
18755
|
<dl>
|
|
17589
18756
|
<dd>
|
|
17590
18757
|
|
|
17591
|
-
**requestOptions:** `
|
|
18758
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17592
18759
|
|
|
17593
18760
|
</dd>
|
|
17594
18761
|
</dl>
|
|
@@ -17599,7 +18766,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17599
18766
|
</dl>
|
|
17600
18767
|
</details>
|
|
17601
18768
|
|
|
17602
|
-
<details><summary><code>client.shipping.
|
|
18769
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">skipV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17603
18770
|
<dl>
|
|
17604
18771
|
<dd>
|
|
17605
18772
|
|
|
@@ -17611,7 +18778,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToDriverV1({
|
|
|
17611
18778
|
<dl>
|
|
17612
18779
|
<dd>
|
|
17613
18780
|
|
|
17614
|
-
|
|
18781
|
+
Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
17615
18782
|
|
|
17616
18783
|
</dd>
|
|
17617
18784
|
</dl>
|
|
@@ -17627,9 +18794,7 @@ Updates a driver's availability status. Must have status UNASSIGNED to set avail
|
|
|
17627
18794
|
<dd>
|
|
17628
18795
|
|
|
17629
18796
|
```typescript
|
|
17630
|
-
await client.shipping.
|
|
17631
|
-
available: true,
|
|
17632
|
-
});
|
|
18797
|
+
await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
17633
18798
|
```
|
|
17634
18799
|
|
|
17635
18800
|
</dd>
|
|
@@ -17645,15 +18810,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17645
18810
|
<dl>
|
|
17646
18811
|
<dd>
|
|
17647
18812
|
|
|
17648
|
-
**
|
|
17649
|
-
|
|
17650
|
-
</dd>
|
|
17651
|
-
</dl>
|
|
17652
|
-
|
|
17653
|
-
<dl>
|
|
17654
|
-
<dd>
|
|
17655
|
-
|
|
17656
|
-
**request:** `Chrt.DriverUpdateAvailabilityReq`
|
|
18813
|
+
**taskArtifactId:** `string`
|
|
17657
18814
|
|
|
17658
18815
|
</dd>
|
|
17659
18816
|
</dl>
|
|
@@ -17661,7 +18818,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17661
18818
|
<dl>
|
|
17662
18819
|
<dd>
|
|
17663
18820
|
|
|
17664
|
-
**requestOptions:** `
|
|
18821
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17665
18822
|
|
|
17666
18823
|
</dd>
|
|
17667
18824
|
</dl>
|
|
@@ -17672,7 +18829,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17672
18829
|
</dl>
|
|
17673
18830
|
</details>
|
|
17674
18831
|
|
|
17675
|
-
<details><summary><code>client.shipping.
|
|
18832
|
+
<details><summary><code>client.shipping.taskArtifacts.<a href="/src/api/resources/shipping/resources/taskArtifacts/client/Client.ts">deleteV1</a>(taskArtifactId) -> boolean</code></summary>
|
|
17676
18833
|
<dl>
|
|
17677
18834
|
<dd>
|
|
17678
18835
|
|
|
@@ -17684,7 +18841,7 @@ await client.shipping.drivers.updateAvailabilityAccordingToOperatorsV1("driver_i
|
|
|
17684
18841
|
<dl>
|
|
17685
18842
|
<dd>
|
|
17686
18843
|
|
|
17687
|
-
|
|
18844
|
+
Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17688
18845
|
|
|
17689
18846
|
</dd>
|
|
17690
18847
|
</dl>
|
|
@@ -17700,9 +18857,7 @@ Toggles a driver's `auto_assign_enabled` flag — opt-in for direct (non-bidding
|
|
|
17700
18857
|
<dd>
|
|
17701
18858
|
|
|
17702
18859
|
```typescript
|
|
17703
|
-
await client.shipping.
|
|
17704
|
-
auto_assign_enabled: true,
|
|
17705
|
-
});
|
|
18860
|
+
await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
17706
18861
|
```
|
|
17707
18862
|
|
|
17708
18863
|
</dd>
|
|
@@ -17718,15 +18873,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17718
18873
|
<dl>
|
|
17719
18874
|
<dd>
|
|
17720
18875
|
|
|
17721
|
-
**
|
|
17722
|
-
|
|
17723
|
-
</dd>
|
|
17724
|
-
</dl>
|
|
17725
|
-
|
|
17726
|
-
<dl>
|
|
17727
|
-
<dd>
|
|
17728
|
-
|
|
17729
|
-
**request:** `Chrt.shipping.DriverUpdateAutoAssignReq`
|
|
18876
|
+
**taskArtifactId:** `string`
|
|
17730
18877
|
|
|
17731
18878
|
</dd>
|
|
17732
18879
|
</dl>
|
|
@@ -17734,7 +18881,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17734
18881
|
<dl>
|
|
17735
18882
|
<dd>
|
|
17736
18883
|
|
|
17737
|
-
**requestOptions:** `
|
|
18884
|
+
**requestOptions:** `TaskArtifacts.RequestOptions`
|
|
17738
18885
|
|
|
17739
18886
|
</dd>
|
|
17740
18887
|
</dl>
|
|
@@ -17745,9 +18892,9 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17745
18892
|
</dl>
|
|
17746
18893
|
</details>
|
|
17747
18894
|
|
|
17748
|
-
## Shipping
|
|
18895
|
+
## Shipping Orders
|
|
17749
18896
|
|
|
17750
|
-
<details><summary><code>client.shipping.
|
|
18897
|
+
<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
18898
|
<dl>
|
|
17752
18899
|
<dd>
|
|
17753
18900
|
|
|
@@ -17759,7 +18906,7 @@ await client.shipping.drivers.updateAutoAssignV1("driver_id", {
|
|
|
17759
18906
|
<dl>
|
|
17760
18907
|
<dd>
|
|
17761
18908
|
|
|
17762
|
-
|
|
18909
|
+
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
18910
|
|
|
17764
18911
|
</dd>
|
|
17765
18912
|
</dl>
|
|
@@ -17775,7 +18922,10 @@ Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPP
|
|
|
17775
18922
|
<dd>
|
|
17776
18923
|
|
|
17777
18924
|
```typescript
|
|
17778
|
-
await client.shipping.
|
|
18925
|
+
await client.shipping.orders.typeaheadV1({
|
|
18926
|
+
query: "query",
|
|
18927
|
+
limit: 1,
|
|
18928
|
+
});
|
|
17779
18929
|
```
|
|
17780
18930
|
|
|
17781
18931
|
</dd>
|
|
@@ -17791,15 +18941,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17791
18941
|
<dl>
|
|
17792
18942
|
<dd>
|
|
17793
18943
|
|
|
17794
|
-
**
|
|
17795
|
-
|
|
17796
|
-
</dd>
|
|
17797
|
-
</dl>
|
|
17798
|
-
|
|
17799
|
-
<dl>
|
|
17800
|
-
<dd>
|
|
17801
|
-
|
|
17802
|
-
**request:** `Chrt.CargoClientUpdate1`
|
|
18944
|
+
**request:** `Chrt.shipping.OrdersTypeaheadV1Request`
|
|
17803
18945
|
|
|
17804
18946
|
</dd>
|
|
17805
18947
|
</dl>
|
|
@@ -17807,7 +18949,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17807
18949
|
<dl>
|
|
17808
18950
|
<dd>
|
|
17809
18951
|
|
|
17810
|
-
**requestOptions:** `
|
|
18952
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17811
18953
|
|
|
17812
18954
|
</dd>
|
|
17813
18955
|
</dl>
|
|
@@ -17818,9 +18960,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17818
18960
|
</dl>
|
|
17819
18961
|
</details>
|
|
17820
18962
|
|
|
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>
|
|
18963
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
17824
18964
|
<dl>
|
|
17825
18965
|
<dd>
|
|
17826
18966
|
|
|
@@ -17832,7 +18972,7 @@ await client.shipping.cargos.updateV1("cargo_id", {});
|
|
|
17832
18972
|
<dl>
|
|
17833
18973
|
<dd>
|
|
17834
18974
|
|
|
17835
|
-
|
|
18975
|
+
Validates a draft order and stages all related entities in a transaction. | () -> (bool)
|
|
17836
18976
|
|
|
17837
18977
|
</dd>
|
|
17838
18978
|
</dl>
|
|
@@ -17848,7 +18988,7 @@ Returns flight info from an adjacent FLIGHT task group for TENDER_TO_AIRLINE or
|
|
|
17848
18988
|
<dd>
|
|
17849
18989
|
|
|
17850
18990
|
```typescript
|
|
17851
|
-
await client.shipping.
|
|
18991
|
+
await client.shipping.orders.stageV1("order_id");
|
|
17852
18992
|
```
|
|
17853
18993
|
|
|
17854
18994
|
</dd>
|
|
@@ -17864,7 +19004,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17864
19004
|
<dl>
|
|
17865
19005
|
<dd>
|
|
17866
19006
|
|
|
17867
|
-
**
|
|
19007
|
+
**orderId:** `string`
|
|
17868
19008
|
|
|
17869
19009
|
</dd>
|
|
17870
19010
|
</dl>
|
|
@@ -17872,7 +19012,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17872
19012
|
<dl>
|
|
17873
19013
|
<dd>
|
|
17874
19014
|
|
|
17875
|
-
**requestOptions:** `
|
|
19015
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17876
19016
|
|
|
17877
19017
|
</dd>
|
|
17878
19018
|
</dl>
|
|
@@ -17883,7 +19023,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17883
19023
|
</dl>
|
|
17884
19024
|
</details>
|
|
17885
19025
|
|
|
17886
|
-
<details><summary><code>client.shipping.
|
|
19026
|
+
<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
19027
|
<dl>
|
|
17888
19028
|
<dd>
|
|
17889
19029
|
|
|
@@ -17895,7 +19035,7 @@ await client.shipping.flights.getFlightInfoForTaskV1("task_id");
|
|
|
17895
19035
|
<dl>
|
|
17896
19036
|
<dd>
|
|
17897
19037
|
|
|
17898
|
-
|
|
19038
|
+
Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
17899
19039
|
|
|
17900
19040
|
</dd>
|
|
17901
19041
|
</dl>
|
|
@@ -17911,7 +19051,7 @@ Returns the ordered list of flight legs for a task group. | authz_personas=[driv
|
|
|
17911
19051
|
<dd>
|
|
17912
19052
|
|
|
17913
19053
|
```typescript
|
|
17914
|
-
await client.shipping.
|
|
19054
|
+
await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
17915
19055
|
```
|
|
17916
19056
|
|
|
17917
19057
|
</dd>
|
|
@@ -17927,7 +19067,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17927
19067
|
<dl>
|
|
17928
19068
|
<dd>
|
|
17929
19069
|
|
|
17930
|
-
**
|
|
19070
|
+
**orderId:** `string`
|
|
17931
19071
|
|
|
17932
19072
|
</dd>
|
|
17933
19073
|
</dl>
|
|
@@ -17935,7 +19075,15 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17935
19075
|
<dl>
|
|
17936
19076
|
<dd>
|
|
17937
19077
|
|
|
17938
|
-
**
|
|
19078
|
+
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
19079
|
+
|
|
19080
|
+
</dd>
|
|
19081
|
+
</dl>
|
|
19082
|
+
|
|
19083
|
+
<dl>
|
|
19084
|
+
<dd>
|
|
19085
|
+
|
|
19086
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17939
19087
|
|
|
17940
19088
|
</dd>
|
|
17941
19089
|
</dl>
|
|
@@ -17946,7 +19094,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17946
19094
|
</dl>
|
|
17947
19095
|
</details>
|
|
17948
19096
|
|
|
17949
|
-
<details><summary><code>client.shipping.
|
|
19097
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
17950
19098
|
<dl>
|
|
17951
19099
|
<dd>
|
|
17952
19100
|
|
|
@@ -17958,7 +19106,7 @@ await client.shipping.flights.getFlightLegsForTaskGroupV1("task_group_id");
|
|
|
17958
19106
|
<dl>
|
|
17959
19107
|
<dd>
|
|
17960
19108
|
|
|
17961
|
-
|
|
19109
|
+
Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17962
19110
|
|
|
17963
19111
|
</dd>
|
|
17964
19112
|
</dl>
|
|
@@ -17974,7 +19122,7 @@ Returns the flight leg with its Cirium-sourced status, lazily resolving the Ciri
|
|
|
17974
19122
|
<dd>
|
|
17975
19123
|
|
|
17976
19124
|
```typescript
|
|
17977
|
-
await client.shipping.
|
|
19125
|
+
await client.shipping.orders.cancelV1("order_id");
|
|
17978
19126
|
```
|
|
17979
19127
|
|
|
17980
19128
|
</dd>
|
|
@@ -17990,7 +19138,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
17990
19138
|
<dl>
|
|
17991
19139
|
<dd>
|
|
17992
19140
|
|
|
17993
|
-
**
|
|
19141
|
+
**orderId:** `string`
|
|
17994
19142
|
|
|
17995
19143
|
</dd>
|
|
17996
19144
|
</dl>
|
|
@@ -17998,7 +19146,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
17998
19146
|
<dl>
|
|
17999
19147
|
<dd>
|
|
18000
19148
|
|
|
18001
|
-
**requestOptions:** `
|
|
19149
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
18002
19150
|
|
|
18003
19151
|
</dd>
|
|
18004
19152
|
</dl>
|
|
@@ -18009,7 +19157,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
18009
19157
|
</dl>
|
|
18010
19158
|
</details>
|
|
18011
19159
|
|
|
18012
|
-
<details><summary><code>client.shipping.
|
|
19160
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18013
19161
|
<dl>
|
|
18014
19162
|
<dd>
|
|
18015
19163
|
|
|
@@ -18021,7 +19169,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
18021
19169
|
<dl>
|
|
18022
19170
|
<dd>
|
|
18023
19171
|
|
|
18024
|
-
|
|
19172
|
+
Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)
|
|
18025
19173
|
|
|
18026
19174
|
</dd>
|
|
18027
19175
|
</dl>
|
|
@@ -18037,7 +19185,9 @@ Returns the Cirium-sourced positional track for a flight leg — the live breadc
|
|
|
18037
19185
|
<dd>
|
|
18038
19186
|
|
|
18039
19187
|
```typescript
|
|
18040
|
-
await client.shipping.
|
|
19188
|
+
await client.shipping.orders.cancelManyV1({
|
|
19189
|
+
order_ids: ["order_ids"],
|
|
19190
|
+
});
|
|
18041
19191
|
```
|
|
18042
19192
|
|
|
18043
19193
|
</dd>
|
|
@@ -18053,7 +19203,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18053
19203
|
<dl>
|
|
18054
19204
|
<dd>
|
|
18055
19205
|
|
|
18056
|
-
**
|
|
19206
|
+
**request:** `Chrt.shipping.OrdersCancelManyReq`
|
|
18057
19207
|
|
|
18058
19208
|
</dd>
|
|
18059
19209
|
</dl>
|
|
@@ -18061,7 +19211,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18061
19211
|
<dl>
|
|
18062
19212
|
<dd>
|
|
18063
19213
|
|
|
18064
|
-
**requestOptions:** `
|
|
19214
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
18065
19215
|
|
|
18066
19216
|
</dd>
|
|
18067
19217
|
</dl>
|
|
@@ -18072,9 +19222,9 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18072
19222
|
</dl>
|
|
18073
19223
|
</details>
|
|
18074
19224
|
|
|
18075
|
-
## Shipping
|
|
19225
|
+
## Shipping OrderDrafts
|
|
18076
19226
|
|
|
18077
|
-
<details><summary><code>client.shipping.
|
|
19227
|
+
<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
19228
|
<dl>
|
|
18079
19229
|
<dd>
|
|
18080
19230
|
|
|
@@ -18086,7 +19236,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
18086
19236
|
<dl>
|
|
18087
19237
|
<dd>
|
|
18088
19238
|
|
|
18089
|
-
|
|
19239
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
18090
19240
|
|
|
18091
19241
|
</dd>
|
|
18092
19242
|
</dl>
|
|
@@ -18102,13 +19252,7 @@ Adds a new task artifact to a task. | authz_personas=[driver_for_executor, execu
|
|
|
18102
19252
|
<dd>
|
|
18103
19253
|
|
|
18104
19254
|
```typescript
|
|
18105
|
-
await client.shipping.
|
|
18106
|
-
task_artifact: {
|
|
18107
|
-
schema_version: 1,
|
|
18108
|
-
type: "image",
|
|
18109
|
-
},
|
|
18110
|
-
status: "draft",
|
|
18111
|
-
});
|
|
19255
|
+
await client.shipping.orderDrafts.newV1();
|
|
18112
19256
|
```
|
|
18113
19257
|
|
|
18114
19258
|
</dd>
|
|
@@ -18124,15 +19268,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18124
19268
|
<dl>
|
|
18125
19269
|
<dd>
|
|
18126
19270
|
|
|
18127
|
-
**
|
|
18128
|
-
|
|
18129
|
-
</dd>
|
|
18130
|
-
</dl>
|
|
18131
|
-
|
|
18132
|
-
<dl>
|
|
18133
|
-
<dd>
|
|
18134
|
-
|
|
18135
|
-
**request:** `Chrt.shipping.AddTaskArtifactReq`
|
|
19271
|
+
**request:** `Chrt.shipping.OrdersNewDraftReq`
|
|
18136
19272
|
|
|
18137
19273
|
</dd>
|
|
18138
19274
|
</dl>
|
|
@@ -18140,7 +19276,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18140
19276
|
<dl>
|
|
18141
19277
|
<dd>
|
|
18142
19278
|
|
|
18143
|
-
**requestOptions:** `
|
|
19279
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18144
19280
|
|
|
18145
19281
|
</dd>
|
|
18146
19282
|
</dl>
|
|
@@ -18151,7 +19287,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18151
19287
|
</dl>
|
|
18152
19288
|
</details>
|
|
18153
19289
|
|
|
18154
|
-
<details><summary><code>client.shipping.
|
|
19290
|
+
<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
19291
|
<dl>
|
|
18156
19292
|
<dd>
|
|
18157
19293
|
|
|
@@ -18163,7 +19299,7 @@ await client.shipping.taskArtifacts.addToTaskV1("task_id", {
|
|
|
18163
19299
|
<dl>
|
|
18164
19300
|
<dd>
|
|
18165
19301
|
|
|
18166
|
-
|
|
19302
|
+
Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
18167
19303
|
|
|
18168
19304
|
</dd>
|
|
18169
19305
|
</dl>
|
|
@@ -18179,7 +19315,7 @@ Marks a task artifact as COMPLETED. | authz_personas=[driver_for_executor, execu
|
|
|
18179
19315
|
<dd>
|
|
18180
19316
|
|
|
18181
19317
|
```typescript
|
|
18182
|
-
await client.shipping.
|
|
19318
|
+
await client.shipping.orderDrafts.updateV1("order_id");
|
|
18183
19319
|
```
|
|
18184
19320
|
|
|
18185
19321
|
</dd>
|
|
@@ -18195,7 +19331,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18195
19331
|
<dl>
|
|
18196
19332
|
<dd>
|
|
18197
19333
|
|
|
18198
|
-
**
|
|
19334
|
+
**orderId:** `string`
|
|
18199
19335
|
|
|
18200
19336
|
</dd>
|
|
18201
19337
|
</dl>
|
|
@@ -18203,7 +19339,15 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18203
19339
|
<dl>
|
|
18204
19340
|
<dd>
|
|
18205
19341
|
|
|
18206
|
-
**
|
|
19342
|
+
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
19343
|
+
|
|
19344
|
+
</dd>
|
|
19345
|
+
</dl>
|
|
19346
|
+
|
|
19347
|
+
<dl>
|
|
19348
|
+
<dd>
|
|
19349
|
+
|
|
19350
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18207
19351
|
|
|
18208
19352
|
</dd>
|
|
18209
19353
|
</dl>
|
|
@@ -18214,7 +19358,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18214
19358
|
</dl>
|
|
18215
19359
|
</details>
|
|
18216
19360
|
|
|
18217
|
-
<details><summary><code>client.shipping.
|
|
19361
|
+
<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
19362
|
<dl>
|
|
18219
19363
|
<dd>
|
|
18220
19364
|
|
|
@@ -18226,7 +19370,7 @@ await client.shipping.taskArtifacts.completeV1("task_artifact_id");
|
|
|
18226
19370
|
<dl>
|
|
18227
19371
|
<dd>
|
|
18228
19372
|
|
|
18229
|
-
|
|
19373
|
+
Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)
|
|
18230
19374
|
|
|
18231
19375
|
</dd>
|
|
18232
19376
|
</dl>
|
|
@@ -18242,7 +19386,9 @@ Marks a task artifact as SKIPPED. | authz_personas=[driver_for_executor, executo
|
|
|
18242
19386
|
<dd>
|
|
18243
19387
|
|
|
18244
19388
|
```typescript
|
|
18245
|
-
await client.shipping.
|
|
19389
|
+
await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
19390
|
+
task_group_ids: ["task_group_ids"],
|
|
19391
|
+
});
|
|
18246
19392
|
```
|
|
18247
19393
|
|
|
18248
19394
|
</dd>
|
|
@@ -18258,7 +19404,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18258
19404
|
<dl>
|
|
18259
19405
|
<dd>
|
|
18260
19406
|
|
|
18261
|
-
**
|
|
19407
|
+
**orderId:** `string`
|
|
18262
19408
|
|
|
18263
19409
|
</dd>
|
|
18264
19410
|
</dl>
|
|
@@ -18266,7 +19412,15 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18266
19412
|
<dl>
|
|
18267
19413
|
<dd>
|
|
18268
19414
|
|
|
18269
|
-
**
|
|
19415
|
+
**request:** `Chrt.shipping.SetTaskGroupOrderingDraftReq`
|
|
19416
|
+
|
|
19417
|
+
</dd>
|
|
19418
|
+
</dl>
|
|
19419
|
+
|
|
19420
|
+
<dl>
|
|
19421
|
+
<dd>
|
|
19422
|
+
|
|
19423
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18270
19424
|
|
|
18271
19425
|
</dd>
|
|
18272
19426
|
</dl>
|
|
@@ -18277,7 +19431,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18277
19431
|
</dl>
|
|
18278
19432
|
</details>
|
|
18279
19433
|
|
|
18280
|
-
<details><summary><code>client.shipping.
|
|
19434
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
18281
19435
|
<dl>
|
|
18282
19436
|
<dd>
|
|
18283
19437
|
|
|
@@ -18289,7 +19443,7 @@ await client.shipping.taskArtifacts.skipV1("task_artifact_id");
|
|
|
18289
19443
|
<dl>
|
|
18290
19444
|
<dd>
|
|
18291
19445
|
|
|
18292
|
-
Deletes a
|
|
19446
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
18293
19447
|
|
|
18294
19448
|
</dd>
|
|
18295
19449
|
</dl>
|
|
@@ -18305,7 +19459,7 @@ Deletes a task artifact. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
|
18305
19459
|
<dd>
|
|
18306
19460
|
|
|
18307
19461
|
```typescript
|
|
18308
|
-
await client.shipping.
|
|
19462
|
+
await client.shipping.orderDrafts.deleteV1("order_id");
|
|
18309
19463
|
```
|
|
18310
19464
|
|
|
18311
19465
|
</dd>
|
|
@@ -18321,7 +19475,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18321
19475
|
<dl>
|
|
18322
19476
|
<dd>
|
|
18323
19477
|
|
|
18324
|
-
**
|
|
19478
|
+
**orderId:** `string`
|
|
18325
19479
|
|
|
18326
19480
|
</dd>
|
|
18327
19481
|
</dl>
|
|
@@ -18329,7 +19483,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18329
19483
|
<dl>
|
|
18330
19484
|
<dd>
|
|
18331
19485
|
|
|
18332
|
-
**requestOptions:** `
|
|
19486
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18333
19487
|
|
|
18334
19488
|
</dd>
|
|
18335
19489
|
</dl>
|
|
@@ -18340,9 +19494,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18340
19494
|
</dl>
|
|
18341
19495
|
</details>
|
|
18342
19496
|
|
|
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>
|
|
19497
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18346
19498
|
<dl>
|
|
18347
19499
|
<dd>
|
|
18348
19500
|
|
|
@@ -18354,7 +19506,7 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
18354
19506
|
<dl>
|
|
18355
19507
|
<dd>
|
|
18356
19508
|
|
|
18357
|
-
|
|
19509
|
+
Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)
|
|
18358
19510
|
|
|
18359
19511
|
</dd>
|
|
18360
19512
|
</dl>
|
|
@@ -18370,9 +19522,8 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
18370
19522
|
<dd>
|
|
18371
19523
|
|
|
18372
19524
|
```typescript
|
|
18373
|
-
await client.shipping.
|
|
18374
|
-
|
|
18375
|
-
limit: 1,
|
|
19525
|
+
await client.shipping.orderDrafts.deleteManyV1({
|
|
19526
|
+
order_ids: ["order_ids"],
|
|
18376
19527
|
});
|
|
18377
19528
|
```
|
|
18378
19529
|
|
|
@@ -18389,7 +19540,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18389
19540
|
<dl>
|
|
18390
19541
|
<dd>
|
|
18391
19542
|
|
|
18392
|
-
**request:** `Chrt.shipping.
|
|
19543
|
+
**request:** `Chrt.shipping.OrdersDraftDeleteManyReq`
|
|
18393
19544
|
|
|
18394
19545
|
</dd>
|
|
18395
19546
|
</dl>
|
|
@@ -18397,7 +19548,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18397
19548
|
<dl>
|
|
18398
19549
|
<dd>
|
|
18399
19550
|
|
|
18400
|
-
**requestOptions:** `
|
|
19551
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18401
19552
|
|
|
18402
19553
|
</dd>
|
|
18403
19554
|
</dl>
|
|
@@ -18408,7 +19559,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18408
19559
|
</dl>
|
|
18409
19560
|
</details>
|
|
18410
19561
|
|
|
18411
|
-
<details><summary><code>client.shipping.
|
|
19562
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
18412
19563
|
<dl>
|
|
18413
19564
|
<dd>
|
|
18414
19565
|
|
|
@@ -18420,7 +19571,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
18420
19571
|
<dl>
|
|
18421
19572
|
<dd>
|
|
18422
19573
|
|
|
18423
|
-
|
|
19574
|
+
Converts an order screenshot into lightly structured text for the AI order builder. | authz: min_org_role=operator | (UploadFile) -> (str)
|
|
18424
19575
|
|
|
18425
19576
|
</dd>
|
|
18426
19577
|
</dl>
|
|
@@ -18436,7 +19587,9 @@ Validates a draft order and stages all related entities in a transaction. | () -
|
|
|
18436
19587
|
<dd>
|
|
18437
19588
|
|
|
18438
19589
|
```typescript
|
|
18439
|
-
await client.shipping.
|
|
19590
|
+
await client.shipping.orderDrafts.imageToTextV1({
|
|
19591
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
19592
|
+
});
|
|
18440
19593
|
```
|
|
18441
19594
|
|
|
18442
19595
|
</dd>
|
|
@@ -18452,7 +19605,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18452
19605
|
<dl>
|
|
18453
19606
|
<dd>
|
|
18454
19607
|
|
|
18455
|
-
**
|
|
19608
|
+
**request:** `Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post`
|
|
18456
19609
|
|
|
18457
19610
|
</dd>
|
|
18458
19611
|
</dl>
|
|
@@ -18460,7 +19613,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18460
19613
|
<dl>
|
|
18461
19614
|
<dd>
|
|
18462
19615
|
|
|
18463
|
-
**requestOptions:** `
|
|
19616
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18464
19617
|
|
|
18465
19618
|
</dd>
|
|
18466
19619
|
</dl>
|
|
@@ -18471,7 +19624,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18471
19624
|
</dl>
|
|
18472
19625
|
</details>
|
|
18473
19626
|
|
|
18474
|
-
<details><summary><code>client.shipping.
|
|
19627
|
+
<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
19628
|
<dl>
|
|
18476
19629
|
<dd>
|
|
18477
19630
|
|
|
@@ -18483,7 +19636,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
18483
19636
|
<dl>
|
|
18484
19637
|
<dd>
|
|
18485
19638
|
|
|
18486
|
-
|
|
19639
|
+
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
19640
|
|
|
18488
19641
|
</dd>
|
|
18489
19642
|
</dl>
|
|
@@ -18499,7 +19652,10 @@ Updates off_chrt_reference_id on a non-draft order. | authz_personas=[order_crea
|
|
|
18499
19652
|
<dd>
|
|
18500
19653
|
|
|
18501
19654
|
```typescript
|
|
18502
|
-
await client.shipping.
|
|
19655
|
+
await client.shipping.orderDrafts.typeaheadV1({
|
|
19656
|
+
query: "query",
|
|
19657
|
+
limit: 1,
|
|
19658
|
+
});
|
|
18503
19659
|
```
|
|
18504
19660
|
|
|
18505
19661
|
</dd>
|
|
@@ -18515,15 +19671,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18515
19671
|
<dl>
|
|
18516
19672
|
<dd>
|
|
18517
19673
|
|
|
18518
|
-
**
|
|
18519
|
-
|
|
18520
|
-
</dd>
|
|
18521
|
-
</dl>
|
|
18522
|
-
|
|
18523
|
-
<dl>
|
|
18524
|
-
<dd>
|
|
18525
|
-
|
|
18526
|
-
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
19674
|
+
**request:** `Chrt.shipping.OrderDraftsTypeaheadV1Request`
|
|
18527
19675
|
|
|
18528
19676
|
</dd>
|
|
18529
19677
|
</dl>
|
|
@@ -18531,7 +19679,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18531
19679
|
<dl>
|
|
18532
19680
|
<dd>
|
|
18533
19681
|
|
|
18534
|
-
**requestOptions:** `
|
|
19682
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18535
19683
|
|
|
18536
19684
|
</dd>
|
|
18537
19685
|
</dl>
|
|
@@ -18542,7 +19690,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18542
19690
|
</dl>
|
|
18543
19691
|
</details>
|
|
18544
19692
|
|
|
18545
|
-
<details><summary><code>client.shipping.
|
|
19693
|
+
<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
19694
|
<dl>
|
|
18547
19695
|
<dd>
|
|
18548
19696
|
|
|
@@ -18554,7 +19702,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
18554
19702
|
<dl>
|
|
18555
19703
|
<dd>
|
|
18556
19704
|
|
|
18557
|
-
|
|
19705
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
18558
19706
|
|
|
18559
19707
|
</dd>
|
|
18560
19708
|
</dl>
|
|
@@ -18570,7 +19718,7 @@ Cancels an order and non-terminal child entities in a transaction. | authz_perso
|
|
|
18570
19718
|
<dd>
|
|
18571
19719
|
|
|
18572
19720
|
```typescript
|
|
18573
|
-
await client.shipping.
|
|
19721
|
+
await client.shipping.orderDrafts.validateV1("order_id");
|
|
18574
19722
|
```
|
|
18575
19723
|
|
|
18576
19724
|
</dd>
|
|
@@ -18594,7 +19742,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18594
19742
|
<dl>
|
|
18595
19743
|
<dd>
|
|
18596
19744
|
|
|
18597
|
-
**requestOptions:** `
|
|
19745
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18598
19746
|
|
|
18599
19747
|
</dd>
|
|
18600
19748
|
</dl>
|
|
@@ -18605,7 +19753,9 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18605
19753
|
</dl>
|
|
18606
19754
|
</details>
|
|
18607
19755
|
|
|
18608
|
-
|
|
19756
|
+
## Shipping OrderGroups
|
|
19757
|
+
|
|
19758
|
+
<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
19759
|
<dl>
|
|
18610
19760
|
<dd>
|
|
18611
19761
|
|
|
@@ -18617,7 +19767,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
18617
19767
|
<dl>
|
|
18618
19768
|
<dd>
|
|
18619
19769
|
|
|
18620
|
-
|
|
19770
|
+
Lists order groups for the caller's organization with filtering, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroupListRes)
|
|
18621
19771
|
|
|
18622
19772
|
</dd>
|
|
18623
19773
|
</dl>
|
|
@@ -18633,8 +19783,14 @@ Cancels multiple orders and their non-terminal child entities in a transaction.
|
|
|
18633
19783
|
<dd>
|
|
18634
19784
|
|
|
18635
19785
|
```typescript
|
|
18636
|
-
await client.shipping.
|
|
18637
|
-
|
|
19786
|
+
await client.shipping.orderGroups.listV1({
|
|
19787
|
+
sort_by: "created_at_timestamp",
|
|
19788
|
+
sort_order: "asc",
|
|
19789
|
+
page: 1,
|
|
19790
|
+
page_size: 1,
|
|
19791
|
+
filter_order_id: "filter_order_id",
|
|
19792
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19793
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18638
19794
|
});
|
|
18639
19795
|
```
|
|
18640
19796
|
|
|
@@ -18651,7 +19807,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18651
19807
|
<dl>
|
|
18652
19808
|
<dd>
|
|
18653
19809
|
|
|
18654
|
-
**request:** `Chrt.shipping.
|
|
19810
|
+
**request:** `Chrt.shipping.OrderGroupsListV1Request`
|
|
18655
19811
|
|
|
18656
19812
|
</dd>
|
|
18657
19813
|
</dl>
|
|
@@ -18659,7 +19815,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18659
19815
|
<dl>
|
|
18660
19816
|
<dd>
|
|
18661
19817
|
|
|
18662
|
-
**requestOptions:** `
|
|
19818
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18663
19819
|
|
|
18664
19820
|
</dd>
|
|
18665
19821
|
</dl>
|
|
@@ -18670,9 +19826,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18670
19826
|
</dl>
|
|
18671
19827
|
</details>
|
|
18672
19828
|
|
|
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>
|
|
19829
|
+
<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
19830
|
<dl>
|
|
18677
19831
|
<dd>
|
|
18678
19832
|
|
|
@@ -18684,7 +19838,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
18684
19838
|
<dl>
|
|
18685
19839
|
<dd>
|
|
18686
19840
|
|
|
18687
|
-
|
|
19841
|
+
Retrieves an order group by ID. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)
|
|
18688
19842
|
|
|
18689
19843
|
</dd>
|
|
18690
19844
|
</dl>
|
|
@@ -18700,7 +19854,7 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
18700
19854
|
<dd>
|
|
18701
19855
|
|
|
18702
19856
|
```typescript
|
|
18703
|
-
await client.shipping.
|
|
19857
|
+
await client.shipping.orderGroups.getByIdV1("order_group_id");
|
|
18704
19858
|
```
|
|
18705
19859
|
|
|
18706
19860
|
</dd>
|
|
@@ -18716,7 +19870,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18716
19870
|
<dl>
|
|
18717
19871
|
<dd>
|
|
18718
19872
|
|
|
18719
|
-
**
|
|
19873
|
+
**orderGroupId:** `string`
|
|
18720
19874
|
|
|
18721
19875
|
</dd>
|
|
18722
19876
|
</dl>
|
|
@@ -18724,7 +19878,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18724
19878
|
<dl>
|
|
18725
19879
|
<dd>
|
|
18726
19880
|
|
|
18727
|
-
**requestOptions:** `
|
|
19881
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18728
19882
|
|
|
18729
19883
|
</dd>
|
|
18730
19884
|
</dl>
|
|
@@ -18735,7 +19889,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18735
19889
|
</dl>
|
|
18736
19890
|
</details>
|
|
18737
19891
|
|
|
18738
|
-
<details><summary><code>client.shipping.
|
|
19892
|
+
<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
19893
|
<dl>
|
|
18740
19894
|
<dd>
|
|
18741
19895
|
|
|
@@ -18747,7 +19901,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
18747
19901
|
<dl>
|
|
18748
19902
|
<dd>
|
|
18749
19903
|
|
|
18750
|
-
|
|
19904
|
+
Creates an order group owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupClientCreate1) -> (OrderGroup1)
|
|
18751
19905
|
|
|
18752
19906
|
</dd>
|
|
18753
19907
|
</dl>
|
|
@@ -18763,7 +19917,10 @@ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersD
|
|
|
18763
19917
|
<dd>
|
|
18764
19918
|
|
|
18765
19919
|
```typescript
|
|
18766
|
-
await client.shipping.
|
|
19920
|
+
await client.shipping.orderGroups.newV1({
|
|
19921
|
+
schema_version: 1,
|
|
19922
|
+
name: "name",
|
|
19923
|
+
});
|
|
18767
19924
|
```
|
|
18768
19925
|
|
|
18769
19926
|
</dd>
|
|
@@ -18779,15 +19936,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18779
19936
|
<dl>
|
|
18780
19937
|
<dd>
|
|
18781
19938
|
|
|
18782
|
-
**
|
|
18783
|
-
|
|
18784
|
-
</dd>
|
|
18785
|
-
</dl>
|
|
18786
|
-
|
|
18787
|
-
<dl>
|
|
18788
|
-
<dd>
|
|
18789
|
-
|
|
18790
|
-
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
19939
|
+
**request:** `Chrt.shipping.OrderGroupClientCreate1`
|
|
18791
19940
|
|
|
18792
19941
|
</dd>
|
|
18793
19942
|
</dl>
|
|
@@ -18795,7 +19944,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18795
19944
|
<dl>
|
|
18796
19945
|
<dd>
|
|
18797
19946
|
|
|
18798
|
-
**requestOptions:** `
|
|
19947
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18799
19948
|
|
|
18800
19949
|
</dd>
|
|
18801
19950
|
</dl>
|
|
@@ -18806,7 +19955,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18806
19955
|
</dl>
|
|
18807
19956
|
</details>
|
|
18808
19957
|
|
|
18809
|
-
<details><summary><code>client.shipping.
|
|
19958
|
+
<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
19959
|
<dl>
|
|
18811
19960
|
<dd>
|
|
18812
19961
|
|
|
@@ -18818,7 +19967,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
18818
19967
|
<dl>
|
|
18819
19968
|
<dd>
|
|
18820
19969
|
|
|
18821
|
-
|
|
19970
|
+
Updates an order group's name or description. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupClientUpdate1) -> (OrderGroup1)
|
|
18822
19971
|
|
|
18823
19972
|
</dd>
|
|
18824
19973
|
</dl>
|
|
@@ -18834,9 +19983,7 @@ Sets the ordering of task groups within a draft order. Must provide all task gro
|
|
|
18834
19983
|
<dd>
|
|
18835
19984
|
|
|
18836
19985
|
```typescript
|
|
18837
|
-
await client.shipping.
|
|
18838
|
-
task_group_ids: ["task_group_ids"],
|
|
18839
|
-
});
|
|
19986
|
+
await client.shipping.orderGroups.updateV1("order_group_id");
|
|
18840
19987
|
```
|
|
18841
19988
|
|
|
18842
19989
|
</dd>
|
|
@@ -18852,7 +19999,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18852
19999
|
<dl>
|
|
18853
20000
|
<dd>
|
|
18854
20001
|
|
|
18855
|
-
**
|
|
20002
|
+
**orderGroupId:** `string`
|
|
18856
20003
|
|
|
18857
20004
|
</dd>
|
|
18858
20005
|
</dl>
|
|
@@ -18860,7 +20007,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18860
20007
|
<dl>
|
|
18861
20008
|
<dd>
|
|
18862
20009
|
|
|
18863
|
-
**request:** `Chrt.shipping.
|
|
20010
|
+
**request:** `Chrt.shipping.OrderGroupClientUpdate1`
|
|
18864
20011
|
|
|
18865
20012
|
</dd>
|
|
18866
20013
|
</dl>
|
|
@@ -18868,7 +20015,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18868
20015
|
<dl>
|
|
18869
20016
|
<dd>
|
|
18870
20017
|
|
|
18871
|
-
**requestOptions:** `
|
|
20018
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18872
20019
|
|
|
18873
20020
|
</dd>
|
|
18874
20021
|
</dl>
|
|
@@ -18879,7 +20026,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18879
20026
|
</dl>
|
|
18880
20027
|
</details>
|
|
18881
20028
|
|
|
18882
|
-
<details><summary><code>client.shipping.
|
|
20029
|
+
<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
20030
|
<dl>
|
|
18884
20031
|
<dd>
|
|
18885
20032
|
|
|
@@ -18891,7 +20038,7 @@ await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
|
18891
20038
|
<dl>
|
|
18892
20039
|
<dd>
|
|
18893
20040
|
|
|
18894
|
-
|
|
20041
|
+
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
20042
|
|
|
18896
20043
|
</dd>
|
|
18897
20044
|
</dl>
|
|
@@ -18907,7 +20054,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
18907
20054
|
<dd>
|
|
18908
20055
|
|
|
18909
20056
|
```typescript
|
|
18910
|
-
await client.shipping.
|
|
20057
|
+
await client.shipping.orderGroups.addOrderV1("order_group_id", "order_id");
|
|
18911
20058
|
```
|
|
18912
20059
|
|
|
18913
20060
|
</dd>
|
|
@@ -18923,6 +20070,14 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18923
20070
|
<dl>
|
|
18924
20071
|
<dd>
|
|
18925
20072
|
|
|
20073
|
+
**orderGroupId:** `string`
|
|
20074
|
+
|
|
20075
|
+
</dd>
|
|
20076
|
+
</dl>
|
|
20077
|
+
|
|
20078
|
+
<dl>
|
|
20079
|
+
<dd>
|
|
20080
|
+
|
|
18926
20081
|
**orderId:** `string`
|
|
18927
20082
|
|
|
18928
20083
|
</dd>
|
|
@@ -18931,7 +20086,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18931
20086
|
<dl>
|
|
18932
20087
|
<dd>
|
|
18933
20088
|
|
|
18934
|
-
**requestOptions:** `
|
|
20089
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
18935
20090
|
|
|
18936
20091
|
</dd>
|
|
18937
20092
|
</dl>
|
|
@@ -18942,7 +20097,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18942
20097
|
</dl>
|
|
18943
20098
|
</details>
|
|
18944
20099
|
|
|
18945
|
-
<details><summary><code>client.shipping.
|
|
20100
|
+
<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
20101
|
<dl>
|
|
18947
20102
|
<dd>
|
|
18948
20103
|
|
|
@@ -18954,7 +20109,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18954
20109
|
<dl>
|
|
18955
20110
|
<dd>
|
|
18956
20111
|
|
|
18957
|
-
|
|
20112
|
+
Removes an order from an order group. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderGroup1)
|
|
18958
20113
|
|
|
18959
20114
|
</dd>
|
|
18960
20115
|
</dl>
|
|
@@ -18970,9 +20125,7 @@ Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyR
|
|
|
18970
20125
|
<dd>
|
|
18971
20126
|
|
|
18972
20127
|
```typescript
|
|
18973
|
-
await client.shipping.
|
|
18974
|
-
order_ids: ["order_ids"],
|
|
18975
|
-
});
|
|
20128
|
+
await client.shipping.orderGroups.removeOrderV1("order_group_id", "order_id");
|
|
18976
20129
|
```
|
|
18977
20130
|
|
|
18978
20131
|
</dd>
|
|
@@ -18988,7 +20141,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
18988
20141
|
<dl>
|
|
18989
20142
|
<dd>
|
|
18990
20143
|
|
|
18991
|
-
**
|
|
20144
|
+
**orderGroupId:** `string`
|
|
18992
20145
|
|
|
18993
20146
|
</dd>
|
|
18994
20147
|
</dl>
|
|
@@ -18996,7 +20149,15 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
18996
20149
|
<dl>
|
|
18997
20150
|
<dd>
|
|
18998
20151
|
|
|
18999
|
-
**
|
|
20152
|
+
**orderId:** `string`
|
|
20153
|
+
|
|
20154
|
+
</dd>
|
|
20155
|
+
</dl>
|
|
20156
|
+
|
|
20157
|
+
<dl>
|
|
20158
|
+
<dd>
|
|
20159
|
+
|
|
20160
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
19000
20161
|
|
|
19001
20162
|
</dd>
|
|
19002
20163
|
</dl>
|
|
@@ -19007,7 +20168,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
19007
20168
|
</dl>
|
|
19008
20169
|
</details>
|
|
19009
20170
|
|
|
19010
|
-
<details><summary><code>client.shipping.
|
|
20171
|
+
<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
20172
|
<dl>
|
|
19012
20173
|
<dd>
|
|
19013
20174
|
|
|
@@ -19019,7 +20180,7 @@ await client.shipping.orderDrafts.deleteManyV1({
|
|
|
19019
20180
|
<dl>
|
|
19020
20181
|
<dd>
|
|
19021
20182
|
|
|
19022
|
-
|
|
20183
|
+
Sets the order group's operator billing-review status. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderGroupSetBillingReviewStatusReq) -> (OrderGroup1)
|
|
19023
20184
|
|
|
19024
20185
|
</dd>
|
|
19025
20186
|
</dl>
|
|
@@ -19035,8 +20196,8 @@ Converts an order screenshot into lightly structured text for the AI order build
|
|
|
19035
20196
|
<dd>
|
|
19036
20197
|
|
|
19037
20198
|
```typescript
|
|
19038
|
-
await client.shipping.
|
|
19039
|
-
|
|
20199
|
+
await client.shipping.orderGroups.setBillingReviewStatusV1("order_group_id", {
|
|
20200
|
+
billing_review_status: "not_started",
|
|
19040
20201
|
});
|
|
19041
20202
|
```
|
|
19042
20203
|
|
|
@@ -19053,7 +20214,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19053
20214
|
<dl>
|
|
19054
20215
|
<dd>
|
|
19055
20216
|
|
|
19056
|
-
**
|
|
20217
|
+
**orderGroupId:** `string`
|
|
19057
20218
|
|
|
19058
20219
|
</dd>
|
|
19059
20220
|
</dl>
|
|
@@ -19061,7 +20222,15 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19061
20222
|
<dl>
|
|
19062
20223
|
<dd>
|
|
19063
20224
|
|
|
19064
|
-
**
|
|
20225
|
+
**request:** `Chrt.shipping.OrderGroupSetBillingReviewStatusReq`
|
|
20226
|
+
|
|
20227
|
+
</dd>
|
|
20228
|
+
</dl>
|
|
20229
|
+
|
|
20230
|
+
<dl>
|
|
20231
|
+
<dd>
|
|
20232
|
+
|
|
20233
|
+
**requestOptions:** `OrderGroups.RequestOptions`
|
|
19065
20234
|
|
|
19066
20235
|
</dd>
|
|
19067
20236
|
</dl>
|
|
@@ -19072,7 +20241,9 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19072
20241
|
</dl>
|
|
19073
20242
|
</details>
|
|
19074
20243
|
|
|
19075
|
-
|
|
20244
|
+
## Shipping OrdersAndOrderGroups
|
|
20245
|
+
|
|
20246
|
+
<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
20247
|
<dl>
|
|
19077
20248
|
<dd>
|
|
19078
20249
|
|
|
@@ -19084,7 +20255,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
19084
20255
|
<dl>
|
|
19085
20256
|
<dd>
|
|
19086
20257
|
|
|
19087
|
-
|
|
20258
|
+
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
20259
|
|
|
19089
20260
|
</dd>
|
|
19090
20261
|
</dl>
|
|
@@ -19100,9 +20271,14 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
19100
20271
|
<dd>
|
|
19101
20272
|
|
|
19102
20273
|
```typescript
|
|
19103
|
-
await client.shipping.
|
|
19104
|
-
|
|
19105
|
-
|
|
20274
|
+
await client.shipping.ordersAndOrderGroups.orderGroupsListV1({
|
|
20275
|
+
sort_by: "created_at_timestamp",
|
|
20276
|
+
sort_order: "asc",
|
|
20277
|
+
page: 1,
|
|
20278
|
+
page_size: 1,
|
|
20279
|
+
filter_order_id: "filter_order_id",
|
|
20280
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
20281
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19106
20282
|
});
|
|
19107
20283
|
```
|
|
19108
20284
|
|
|
@@ -19119,7 +20295,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19119
20295
|
<dl>
|
|
19120
20296
|
<dd>
|
|
19121
20297
|
|
|
19122
|
-
**request:** `Chrt.shipping.
|
|
20298
|
+
**request:** `Chrt.shipping.OrdersAndOrderGroupsOrderGroupsListV1Request`
|
|
19123
20299
|
|
|
19124
20300
|
</dd>
|
|
19125
20301
|
</dl>
|
|
@@ -19127,7 +20303,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19127
20303
|
<dl>
|
|
19128
20304
|
<dd>
|
|
19129
20305
|
|
|
19130
|
-
**requestOptions:** `
|
|
20306
|
+
**requestOptions:** `OrdersAndOrderGroups.RequestOptions`
|
|
19131
20307
|
|
|
19132
20308
|
</dd>
|
|
19133
20309
|
</dl>
|
|
@@ -19138,7 +20314,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19138
20314
|
</dl>
|
|
19139
20315
|
</details>
|
|
19140
20316
|
|
|
19141
|
-
<details><summary><code>client.shipping.
|
|
20317
|
+
<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
20318
|
<dl>
|
|
19143
20319
|
<dd>
|
|
19144
20320
|
|
|
@@ -19150,7 +20326,7 @@ await client.shipping.orderDrafts.typeaheadV1({
|
|
|
19150
20326
|
<dl>
|
|
19151
20327
|
<dd>
|
|
19152
20328
|
|
|
19153
|
-
|
|
20329
|
+
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
20330
|
|
|
19155
20331
|
</dd>
|
|
19156
20332
|
</dl>
|
|
@@ -19166,7 +20342,12 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
19166
20342
|
<dd>
|
|
19167
20343
|
|
|
19168
20344
|
```typescript
|
|
19169
|
-
await client.shipping.
|
|
20345
|
+
await client.shipping.ordersAndOrderGroups.ungroupedOrdersListV1({
|
|
20346
|
+
sort_by: "draft_started_at_timestamp",
|
|
20347
|
+
sort_order: "asc",
|
|
20348
|
+
page: 1,
|
|
20349
|
+
page_size: 1,
|
|
20350
|
+
});
|
|
19170
20351
|
```
|
|
19171
20352
|
|
|
19172
20353
|
</dd>
|
|
@@ -19182,7 +20363,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
19182
20363
|
<dl>
|
|
19183
20364
|
<dd>
|
|
19184
20365
|
|
|
19185
|
-
**
|
|
20366
|
+
**request:** `Chrt.shipping.OrdersAndOrderGroupsUngroupedOrdersListV1Request`
|
|
19186
20367
|
|
|
19187
20368
|
</dd>
|
|
19188
20369
|
</dl>
|
|
@@ -19190,7 +20371,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
19190
20371
|
<dl>
|
|
19191
20372
|
<dd>
|
|
19192
20373
|
|
|
19193
|
-
**requestOptions:** `
|
|
20374
|
+
**requestOptions:** `OrdersAndOrderGroups.RequestOptions`
|
|
19194
20375
|
|
|
19195
20376
|
</dd>
|
|
19196
20377
|
</dl>
|
|
@@ -19845,7 +21026,7 @@ await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
|
19845
21026
|
|
|
19846
21027
|
## Shipping OrderTemplates
|
|
19847
21028
|
|
|
19848
|
-
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getExpandedByIdV1</a>(orderTemplateId) -> Chrt.
|
|
21029
|
+
<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
21030
|
<dl>
|
|
19850
21031
|
<dd>
|
|
19851
21032
|
|
|
@@ -19857,7 +21038,7 @@ await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id")
|
|
|
19857
21038
|
<dl>
|
|
19858
21039
|
<dd>
|
|
19859
21040
|
|
|
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 | () -> (
|
|
21041
|
+
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
21042
|
|
|
19862
21043
|
</dd>
|
|
19863
21044
|
</dl>
|
|
@@ -19920,7 +21101,7 @@ await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
|
19920
21101
|
<dl>
|
|
19921
21102
|
<dd>
|
|
19922
21103
|
|
|
19923
|
-
Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description,
|
|
21104
|
+
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
21105
|
|
|
19925
21106
|
</dd>
|
|
19926
21107
|
</dl>
|
|
@@ -23380,7 +24561,7 @@ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_comp
|
|
|
23380
24561
|
|
|
23381
24562
|
## Shipping OrderDrafts Agentic
|
|
23382
24563
|
|
|
23383
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24564
|
+
<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
24565
|
<dl>
|
|
23385
24566
|
<dd>
|
|
23386
24567
|
|
|
@@ -23392,7 +24573,7 @@ await client.shipping.drivers.complianceDocuments.s3Object.deleteV1("driver_comp
|
|
|
23392
24573
|
<dl>
|
|
23393
24574
|
<dd>
|
|
23394
24575
|
|
|
23395
|
-
|
|
24576
|
+
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
24577
|
|
|
23397
24578
|
</dd>
|
|
23398
24579
|
</dl>
|
|
@@ -23408,10 +24589,7 @@ Predicts whether input is complete enough for the AI order builder. | (OrderBuil
|
|
|
23408
24589
|
<dd>
|
|
23409
24590
|
|
|
23410
24591
|
```typescript
|
|
23411
|
-
await client.shipping.orderDrafts.agentic.
|
|
23412
|
-
order_short_id: "order_short_id",
|
|
23413
|
-
text: "text",
|
|
23414
|
-
});
|
|
24592
|
+
await client.shipping.orderDrafts.agentic.newV1({});
|
|
23415
24593
|
```
|
|
23416
24594
|
|
|
23417
24595
|
</dd>
|
|
@@ -23446,7 +24624,7 @@ await client.shipping.orderDrafts.agentic.precheckV1({
|
|
|
23446
24624
|
</dl>
|
|
23447
24625
|
</details>
|
|
23448
24626
|
|
|
23449
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24627
|
+
<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
24628
|
<dl>
|
|
23451
24629
|
<dd>
|
|
23452
24630
|
|
|
@@ -23458,7 +24636,7 @@ await client.shipping.orderDrafts.agentic.precheckV1({
|
|
|
23458
24636
|
<dl>
|
|
23459
24637
|
<dd>
|
|
23460
24638
|
|
|
23461
|
-
|
|
24639
|
+
Creates a draft order from natural language or a template and streams progress events via SSE. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderBuilderStreamEvent)
|
|
23462
24640
|
|
|
23463
24641
|
</dd>
|
|
23464
24642
|
</dl>
|
|
@@ -23474,10 +24652,10 @@ Populates an existing draft order with cargo, task groups, and tasks parsed from
|
|
|
23474
24652
|
<dd>
|
|
23475
24653
|
|
|
23476
24654
|
```typescript
|
|
23477
|
-
await client.shipping.orderDrafts.agentic.
|
|
23478
|
-
|
|
23479
|
-
|
|
23480
|
-
}
|
|
24655
|
+
const response = await client.shipping.orderDrafts.agentic.newWithStreamingV1({});
|
|
24656
|
+
for await (const item of response) {
|
|
24657
|
+
console.log(item);
|
|
24658
|
+
}
|
|
23481
24659
|
```
|
|
23482
24660
|
|
|
23483
24661
|
</dd>
|
|
@@ -23512,7 +24690,7 @@ await client.shipping.orderDrafts.agentic.newV1({
|
|
|
23512
24690
|
</dl>
|
|
23513
24691
|
</details>
|
|
23514
24692
|
|
|
23515
|
-
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">
|
|
24693
|
+
<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
24694
|
<dl>
|
|
23517
24695
|
<dd>
|
|
23518
24696
|
|
|
@@ -23524,7 +24702,7 @@ await client.shipping.orderDrafts.agentic.newV1({
|
|
|
23524
24702
|
<dl>
|
|
23525
24703
|
<dd>
|
|
23526
24704
|
|
|
23527
|
-
|
|
24705
|
+
Reports whether an order builder request's references resolve. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderTemplateResolvabilityRes)
|
|
23528
24706
|
|
|
23529
24707
|
</dd>
|
|
23530
24708
|
</dl>
|
|
@@ -23540,13 +24718,7 @@ Populates an existing draft order from natural language and streams progress eve
|
|
|
23540
24718
|
<dd>
|
|
23541
24719
|
|
|
23542
24720
|
```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
|
-
}
|
|
24721
|
+
await client.shipping.orderDrafts.agentic.precheckV1({});
|
|
23550
24722
|
```
|
|
23551
24723
|
|
|
23552
24724
|
</dd>
|
|
@@ -28029,7 +29201,7 @@ await client.tracking.sessions.typeaheadV1({
|
|
|
28029
29201
|
<dl>
|
|
28030
29202
|
<dd>
|
|
28031
29203
|
|
|
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 ~
|
|
29204
|
+
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. Optionally seed a destination geofence (location + radius) to fire a destination geofence entered notification. 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
29205
|
|
|
28034
29206
|
</dd>
|
|
28035
29207
|
</dl>
|
|
@@ -28096,7 +29268,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
28096
29268
|
<dl>
|
|
28097
29269
|
<dd>
|
|
28098
29270
|
|
|
28099
|
-
Updates a session's metadata. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
29271
|
+
Updates a session's mutable metadata (off_chrt_reference_id, comments, public, termination_scheduled_for_timestamp, destination_geofence_location, destination_geofence_radius_miles). Setting or replacing the destination geofence location resets the entered latch so it can fire again; clearing it (destination_geofence_location\_\_set_to_None) also resets the latch. | auth: api_key | (SessionClientUpdate1) -> (bool)
|
|
28100
29272
|
|
|
28101
29273
|
</dd>
|
|
28102
29274
|
</dl>
|