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