@chrt-inc/typescript-sdk 1.924.0 → 1.925.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.d.ts +3 -0
- package/dist/cjs/Client.js +29 -24
- package/dist/cjs/api/resources/agent/client/Client.d.ts +23 -0
- package/dist/cjs/api/resources/agent/client/Client.js +17 -0
- package/dist/cjs/api/resources/agent/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agent/client/index.js +2 -0
- package/dist/cjs/api/resources/agent/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/index.js +18 -0
- package/dist/cjs/api/resources/agent/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/resources/index.js +41 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/Client.d.ts +79 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/Client.js +260 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/index.js +17 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.d.ts +11 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.d.ts +12 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.d.ts +13 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/index.d.ts +1 -0
- package/dist/cjs/api/resources/agent/resources/orderInformation/index.js +17 -0
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.d.ts +0 -1
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.js +1 -5
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesClientCreate1.d.ts +0 -1
- package/dist/cjs/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesListV1Request.d.ts +0 -3
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/billingNew/resources/invoiceLineItems/client/Client.js +1 -1
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.d.ts +19 -2
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/Client.js +68 -2
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/requests/InvoiceClientCreate1.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/requests/InvoicePeriodUpdateReq.d.ts +14 -0
- package/dist/cjs/api/resources/billingNew/resources/invoices/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/client/Client.js +5 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/index.js +1 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/index.js +41 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.d.ts +49 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.js +135 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/index.js +17 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/OrderRateSheetLineItemsGenerateManyReq.d.ts +12 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/index.d.ts +1 -0
- package/dist/cjs/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +2 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +10 -10
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/{OperationsTaskStatusReq.d.ts → OperationsTasksSetStatusReq1.d.ts} +3 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/contacts/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.js +60 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.js +59 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +2 -105
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +6 -518
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +18 -31
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +34 -93
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/{ExpandedListForDriverForExecutorV1Request.d.ts → ExpandedListForDriverV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/{ExpandedListForExecutorOperatorsV1Request.d.ts → ExpandedListForProviderOperatorsV1Request.d.ts} +3 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.ts +11 -7
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.js +23 -15
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/TaskGroupIdForProviderOperatorsV1Request.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.js +2 -2
- package/dist/cjs/api/types/AiImageDescription.d.ts +1 -1
- package/dist/cjs/api/types/{LlmModelEnum.d.ts → ArchivedModel.d.ts} +5 -2
- package/dist/cjs/api/types/{LlmModelEnum.js → ArchivedModel.js} +2 -2
- package/dist/cjs/api/types/ChrtGroundProviderRates1.d.ts +0 -1
- package/dist/cjs/api/types/ContactExpandedListItem.d.ts +10 -0
- package/dist/cjs/api/types/ContactListRes.d.ts +1 -1
- package/dist/cjs/api/types/Invoice1.d.ts +2 -0
- package/dist/cjs/api/types/InvoiceExpandedListItem.d.ts +11 -0
- package/dist/cjs/api/types/InvoiceLineItemExpandedListItem.d.ts +8 -0
- package/dist/cjs/api/types/InvoiceLineItemExpandedListItem.js +5 -0
- package/dist/cjs/api/types/InvoiceLineItemListRes.d.ts +1 -1
- package/dist/cjs/api/types/InvoiceListRes.d.ts +1 -1
- package/dist/cjs/api/types/Model.d.ts +12 -0
- package/dist/cjs/api/types/Model.js +11 -0
- package/dist/cjs/api/types/OperationsTaskExpandedListItem.d.ts +1 -0
- package/dist/cjs/api/types/OperationsTasksStatusUpdateRes1.d.ts +7 -0
- package/dist/cjs/api/types/OperationsTasksStatusUpdateRes1.js +5 -0
- package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +1 -0
- package/dist/cjs/api/types/OrderExpandedForProvider.d.ts +2 -0
- package/dist/cjs/api/types/OrderExpandedForShipper.d.ts +1 -0
- package/dist/cjs/api/types/OrderInformationConversationRes.d.ts +7 -0
- package/dist/cjs/api/types/OrderInformationConversationRes.js +5 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyRes.d.ts +12 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyRes.js +5 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyResult1.d.ts +11 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyResult1.js +5 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyStatusEnum.d.ts +9 -0
- package/dist/cjs/api/types/OrderRateSheetLineItemsGenerateManyStatusEnum.js +11 -0
- package/dist/cjs/api/types/StoredModel.d.ts +5 -0
- package/dist/cjs/api/types/StoredModel.js +5 -0
- package/dist/cjs/api/types/TaskGroupByDriverDataPointsRes.d.ts +8 -0
- package/dist/cjs/api/types/TaskGroupByDriverDataPointsRes.js +5 -0
- package/dist/cjs/api/types/TaskGroupByDriverLastSeenRes.d.ts +8 -0
- package/dist/cjs/api/types/TaskGroupByDriverLastSeenRes.js +5 -0
- package/dist/cjs/api/types/TaskGroupProviderRoleFilterEnum.d.ts +9 -0
- package/dist/cjs/api/types/TaskGroupProviderRoleFilterEnum.js +11 -0
- package/dist/cjs/api/types/index.d.ts +14 -7
- package/dist/cjs/api/types/index.js +14 -7
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -0
- package/dist/esm/Client.mjs +7 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +23 -0
- package/dist/esm/api/resources/agent/client/Client.mjs +13 -0
- package/dist/esm/api/resources/agent/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/client/index.mjs +1 -0
- package/dist/esm/api/resources/agent/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/index.mjs +2 -0
- package/dist/esm/api/resources/agent/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/resources/index.mjs +2 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/Client.d.mts +79 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/Client.mjs +223 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/index.mjs +1 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.d.mts +11 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.d.mts +12 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.d.mts +13 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/index.d.mts +1 -0
- package/dist/esm/api/resources/agent/resources/orderInformation/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.d.mts +0 -1
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/Client.mjs +1 -5
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesClientCreate1.d.mts +0 -1
- package/dist/esm/api/resources/billingNew/resources/chrtGroundProviderRates/client/requests/ChrtGroundProviderRatesListV1Request.d.mts +0 -3
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/billingNew/resources/invoiceLineItems/client/Client.mjs +1 -1
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.d.mts +19 -2
- package/dist/esm/api/resources/billingNew/resources/invoices/client/Client.mjs +68 -2
- package/dist/esm/api/resources/billingNew/resources/invoices/client/requests/InvoiceClientCreate1.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/requests/InvoicePeriodUpdateReq.d.mts +14 -0
- package/dist/esm/api/resources/billingNew/resources/invoices/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/billingNew/resources/orders/client/Client.mjs +5 -0
- package/dist/esm/api/resources/billingNew/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/index.mjs +2 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.d.mts +49 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.mjs +98 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/index.d.mts +2 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/OrderRateSheetLineItemsGenerateManyReq.d.mts +12 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/index.d.mts +1 -0
- package/dist/esm/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +10 -10
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/{OperationsTaskStatusReq.d.mts → OperationsTasksSetStatusReq1.d.mts} +3 -1
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/contacts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.mjs +60 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.mjs +59 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +2 -105
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +6 -518
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.d.mts +3 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +18 -31
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +34 -93
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/{ExpandedListForDriverForExecutorV1Request.d.mts → ExpandedListForDriverV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/{ExpandedListForExecutorOperatorsV1Request.d.mts → ExpandedListForProviderOperatorsV1Request.d.mts} +3 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.mts +11 -7
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.mjs +23 -15
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/TaskGroupIdForProviderOperatorsV1Request.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.mjs +2 -2
- package/dist/esm/api/types/AiImageDescription.d.mts +1 -1
- package/dist/esm/api/types/{LlmModelEnum.d.mts → ArchivedModel.d.mts} +5 -2
- package/dist/esm/api/types/{LlmModelEnum.mjs → ArchivedModel.mjs} +1 -1
- package/dist/esm/api/types/ChrtGroundProviderRates1.d.mts +0 -1
- package/dist/esm/api/types/ContactExpandedListItem.d.mts +10 -0
- package/dist/esm/api/types/ContactListRes.d.mts +1 -1
- package/dist/esm/api/types/Invoice1.d.mts +2 -0
- package/dist/esm/api/types/InvoiceExpandedListItem.d.mts +11 -0
- package/dist/esm/api/types/InvoiceLineItemExpandedListItem.d.mts +8 -0
- package/dist/esm/api/types/InvoiceLineItemExpandedListItem.mjs +4 -0
- package/dist/esm/api/types/InvoiceLineItemListRes.d.mts +1 -1
- package/dist/esm/api/types/InvoiceListRes.d.mts +1 -1
- package/dist/esm/api/types/Model.d.mts +12 -0
- package/dist/esm/api/types/Model.mjs +8 -0
- package/dist/esm/api/types/OperationsTaskExpandedListItem.d.mts +1 -0
- package/dist/esm/api/types/OperationsTasksStatusUpdateRes1.d.mts +7 -0
- package/dist/esm/api/types/OperationsTasksStatusUpdateRes1.mjs +4 -0
- package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +1 -0
- package/dist/esm/api/types/OrderExpandedForProvider.d.mts +2 -0
- package/dist/esm/api/types/OrderExpandedForShipper.d.mts +1 -0
- package/dist/esm/api/types/OrderInformationConversationRes.d.mts +7 -0
- package/dist/esm/api/types/OrderInformationConversationRes.mjs +4 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyRes.d.mts +12 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyRes.mjs +4 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyResult1.d.mts +11 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyResult1.mjs +4 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyStatusEnum.d.mts +9 -0
- package/dist/esm/api/types/OrderRateSheetLineItemsGenerateManyStatusEnum.mjs +8 -0
- package/dist/esm/api/types/StoredModel.d.mts +5 -0
- package/dist/esm/api/types/StoredModel.mjs +4 -0
- package/dist/esm/api/types/TaskGroupByDriverDataPointsRes.d.mts +8 -0
- package/dist/esm/api/types/TaskGroupByDriverDataPointsRes.mjs +4 -0
- package/dist/esm/api/types/TaskGroupByDriverLastSeenRes.d.mts +8 -0
- package/dist/esm/api/types/TaskGroupByDriverLastSeenRes.mjs +4 -0
- package/dist/esm/api/types/TaskGroupProviderRoleFilterEnum.d.mts +9 -0
- package/dist/esm/api/types/TaskGroupProviderRoleFilterEnum.mjs +8 -0
- package/dist/esm/api/types/index.d.mts +14 -7
- package/dist/esm/api/types/index.mjs +14 -7
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +577 -476
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +0 -73
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +0 -66
- package/dist/cjs/api/types/OrderExpandedForCoordinator.d.ts +0 -15
- package/dist/cjs/api/types/OrderExpandedForExecutor.d.ts +0 -14
- package/dist/cjs/api/types/OrderLimitedForCoordinator1.d.ts +0 -47
- package/dist/cjs/api/types/OrderLimitedForExecutor1.d.ts +0 -27
- package/dist/cjs/api/types/OrdersExpandedListForCoordinatorRes.d.ts +0 -8
- package/dist/cjs/api/types/OrdersExpandedListForExecutorRes.d.ts +0 -8
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +0 -73
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +0 -66
- package/dist/esm/api/types/OrderExpandedForCoordinator.d.mts +0 -15
- package/dist/esm/api/types/OrderExpandedForExecutor.d.mts +0 -14
- package/dist/esm/api/types/OrderLimitedForCoordinator1.d.mts +0 -47
- package/dist/esm/api/types/OrderLimitedForExecutor1.d.mts +0 -27
- package/dist/esm/api/types/OrdersExpandedListForCoordinatorRes.d.mts +0 -8
- package/dist/esm/api/types/OrdersExpandedListForExecutorRes.d.mts +0 -8
- /package/dist/cjs/api/resources/{operations/resources/operationsTasks/client/requests/OperationsTaskStatusReq.js → agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/{shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.js → agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.js} +0 -0
- /package/dist/cjs/api/resources/{shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.js → agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.js} +0 -0
- /package/dist/cjs/api/resources/{shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.js → billingNew/resources/invoices/client/requests/InvoicePeriodUpdateReq.js} +0 -0
- /package/dist/cjs/api/resources/{shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.js → billingNew/resources/orders/resources/rateSheetLineItems/client/requests/OrderRateSheetLineItemsGenerateManyReq.js} +0 -0
- /package/dist/cjs/api/{types/OrderExpandedForCoordinator.js → resources/operations/resources/operationsTasks/client/requests/OperationsTasksSetStatusReq1.js} +0 -0
- /package/dist/cjs/api/{types/OrderExpandedForExecutor.js → resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverV1Request.js} +0 -0
- /package/dist/cjs/api/{types/OrderLimitedForCoordinator1.js → resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.js} +0 -0
- /package/dist/cjs/api/{types/OrderLimitedForExecutor1.js → resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/TaskGroupIdForProviderOperatorsV1Request.js} +0 -0
- /package/dist/cjs/api/types/{OrdersExpandedListForCoordinatorRes.js → ContactExpandedListItem.js} +0 -0
- /package/dist/cjs/api/types/{OrdersExpandedListForExecutorRes.js → InvoiceExpandedListItem.js} +0 -0
- /package/dist/esm/api/resources/{operations/resources/operationsTasks/client/requests/OperationsTaskStatusReq.mjs → agent/resources/orderInformation/client/requests/OrderInformationConversationClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/{shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.mjs → agent/resources/orderInformation/client/requests/OrderInformationConversationMessageReq.mjs} +0 -0
- /package/dist/esm/api/resources/{shipping/resources/orders/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.mjs → agent/resources/orderInformation/client/requests/OrderInformationConversationStartReq.mjs} +0 -0
- /package/dist/esm/api/resources/{shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.mjs → billingNew/resources/invoices/client/requests/InvoicePeriodUpdateReq.mjs} +0 -0
- /package/dist/esm/api/resources/{shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.mjs → billingNew/resources/orders/resources/rateSheetLineItems/client/requests/OrderRateSheetLineItemsGenerateManyReq.mjs} +0 -0
- /package/dist/esm/api/{types/OrderExpandedForCoordinator.mjs → resources/operations/resources/operationsTasks/client/requests/OperationsTasksSetStatusReq1.mjs} +0 -0
- /package/dist/esm/api/{types/OrderExpandedForExecutor.mjs → resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/OrderLimitedForCoordinator1.mjs → resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForProviderOperatorsV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/OrderLimitedForExecutor1.mjs → resources/shipping/resources/taskGroups/resources/taskGroupId/client/requests/TaskGroupIdForProviderOperatorsV1Request.mjs} +0 -0
- /package/dist/esm/api/types/{OrdersExpandedListForCoordinatorRes.mjs → ContactExpandedListItem.mjs} +0 -0
- /package/dist/esm/api/types/{OrdersExpandedListForExecutorRes.mjs → InvoiceExpandedListItem.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -385,6 +385,217 @@ await client.utils.getTimezoneV1({
|
|
|
385
385
|
</dl>
|
|
386
386
|
</details>
|
|
387
387
|
|
|
388
|
+
## Agent OrderInformation
|
|
389
|
+
|
|
390
|
+
<details><summary><code>client.agent.orderInformation.<a href="/src/api/resources/agent/resources/orderInformation/client/Client.ts">messageV1</a>(conversationId, { ...params }) -> Chrt.OrderInformationConversationRes</code></summary>
|
|
391
|
+
<dl>
|
|
392
|
+
<dd>
|
|
393
|
+
|
|
394
|
+
#### 📝 Description
|
|
395
|
+
|
|
396
|
+
<dl>
|
|
397
|
+
<dd>
|
|
398
|
+
|
|
399
|
+
<dl>
|
|
400
|
+
<dd>
|
|
401
|
+
|
|
402
|
+
Adds a message to an existing order-information conversation for its owner. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (OrderInformationConversationMessageReq) -> (OrderInformationConversationRes)
|
|
403
|
+
|
|
404
|
+
</dd>
|
|
405
|
+
</dl>
|
|
406
|
+
</dd>
|
|
407
|
+
</dl>
|
|
408
|
+
|
|
409
|
+
#### 🔌 Usage
|
|
410
|
+
|
|
411
|
+
<dl>
|
|
412
|
+
<dd>
|
|
413
|
+
|
|
414
|
+
<dl>
|
|
415
|
+
<dd>
|
|
416
|
+
|
|
417
|
+
```typescript
|
|
418
|
+
await client.agent.orderInformation.messageV1("conversation_id", {
|
|
419
|
+
message: "message",
|
|
420
|
+
});
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
</dd>
|
|
424
|
+
</dl>
|
|
425
|
+
</dd>
|
|
426
|
+
</dl>
|
|
427
|
+
|
|
428
|
+
#### ⚙️ Parameters
|
|
429
|
+
|
|
430
|
+
<dl>
|
|
431
|
+
<dd>
|
|
432
|
+
|
|
433
|
+
<dl>
|
|
434
|
+
<dd>
|
|
435
|
+
|
|
436
|
+
**conversationId:** `string`
|
|
437
|
+
|
|
438
|
+
</dd>
|
|
439
|
+
</dl>
|
|
440
|
+
|
|
441
|
+
<dl>
|
|
442
|
+
<dd>
|
|
443
|
+
|
|
444
|
+
**request:** `Chrt.agent.OrderInformationConversationMessageReq`
|
|
445
|
+
|
|
446
|
+
</dd>
|
|
447
|
+
</dl>
|
|
448
|
+
|
|
449
|
+
<dl>
|
|
450
|
+
<dd>
|
|
451
|
+
|
|
452
|
+
**requestOptions:** `OrderInformation.RequestOptions`
|
|
453
|
+
|
|
454
|
+
</dd>
|
|
455
|
+
</dl>
|
|
456
|
+
</dd>
|
|
457
|
+
</dl>
|
|
458
|
+
|
|
459
|
+
</dd>
|
|
460
|
+
</dl>
|
|
461
|
+
</details>
|
|
462
|
+
|
|
463
|
+
<details><summary><code>client.agent.orderInformation.<a href="/src/api/resources/agent/resources/orderInformation/client/Client.ts">startV1</a>({ ...params }) -> Chrt.OrderInformationConversationRes</code></summary>
|
|
464
|
+
<dl>
|
|
465
|
+
<dd>
|
|
466
|
+
|
|
467
|
+
#### 📝 Description
|
|
468
|
+
|
|
469
|
+
<dl>
|
|
470
|
+
<dd>
|
|
471
|
+
|
|
472
|
+
<dl>
|
|
473
|
+
<dd>
|
|
474
|
+
|
|
475
|
+
Starts an order-information conversation for the authenticated operator. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (OrderInformationConversationStartReq) -> (OrderInformationConversationRes)
|
|
476
|
+
|
|
477
|
+
</dd>
|
|
478
|
+
</dl>
|
|
479
|
+
</dd>
|
|
480
|
+
</dl>
|
|
481
|
+
|
|
482
|
+
#### 🔌 Usage
|
|
483
|
+
|
|
484
|
+
<dl>
|
|
485
|
+
<dd>
|
|
486
|
+
|
|
487
|
+
<dl>
|
|
488
|
+
<dd>
|
|
489
|
+
|
|
490
|
+
```typescript
|
|
491
|
+
await client.agent.orderInformation.startV1({
|
|
492
|
+
message: "message",
|
|
493
|
+
});
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
</dd>
|
|
497
|
+
</dl>
|
|
498
|
+
</dd>
|
|
499
|
+
</dl>
|
|
500
|
+
|
|
501
|
+
#### ⚙️ Parameters
|
|
502
|
+
|
|
503
|
+
<dl>
|
|
504
|
+
<dd>
|
|
505
|
+
|
|
506
|
+
<dl>
|
|
507
|
+
<dd>
|
|
508
|
+
|
|
509
|
+
**request:** `Chrt.agent.OrderInformationConversationStartReq`
|
|
510
|
+
|
|
511
|
+
</dd>
|
|
512
|
+
</dl>
|
|
513
|
+
|
|
514
|
+
<dl>
|
|
515
|
+
<dd>
|
|
516
|
+
|
|
517
|
+
**requestOptions:** `OrderInformation.RequestOptions`
|
|
518
|
+
|
|
519
|
+
</dd>
|
|
520
|
+
</dl>
|
|
521
|
+
</dd>
|
|
522
|
+
</dl>
|
|
523
|
+
|
|
524
|
+
</dd>
|
|
525
|
+
</dl>
|
|
526
|
+
</details>
|
|
527
|
+
|
|
528
|
+
<details><summary><code>client.agent.orderInformation.<a href="/src/api/resources/agent/resources/orderInformation/client/Client.ts">updateV1</a>(conversationId, { ...params }) -> boolean</code></summary>
|
|
529
|
+
<dl>
|
|
530
|
+
<dd>
|
|
531
|
+
|
|
532
|
+
#### 📝 Description
|
|
533
|
+
|
|
534
|
+
<dl>
|
|
535
|
+
<dd>
|
|
536
|
+
|
|
537
|
+
<dl>
|
|
538
|
+
<dd>
|
|
539
|
+
|
|
540
|
+
Updates an order-information conversation's title for its owner. | authz: allowed_org_types=[shipper, provider], min_org_role=operator | (OrderInformationConversationClientUpdate1) -> (bool)
|
|
541
|
+
|
|
542
|
+
</dd>
|
|
543
|
+
</dl>
|
|
544
|
+
</dd>
|
|
545
|
+
</dl>
|
|
546
|
+
|
|
547
|
+
#### 🔌 Usage
|
|
548
|
+
|
|
549
|
+
<dl>
|
|
550
|
+
<dd>
|
|
551
|
+
|
|
552
|
+
<dl>
|
|
553
|
+
<dd>
|
|
554
|
+
|
|
555
|
+
```typescript
|
|
556
|
+
await client.agent.orderInformation.updateV1("conversation_id");
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
</dd>
|
|
560
|
+
</dl>
|
|
561
|
+
</dd>
|
|
562
|
+
</dl>
|
|
563
|
+
|
|
564
|
+
#### ⚙️ Parameters
|
|
565
|
+
|
|
566
|
+
<dl>
|
|
567
|
+
<dd>
|
|
568
|
+
|
|
569
|
+
<dl>
|
|
570
|
+
<dd>
|
|
571
|
+
|
|
572
|
+
**conversationId:** `string`
|
|
573
|
+
|
|
574
|
+
</dd>
|
|
575
|
+
</dl>
|
|
576
|
+
|
|
577
|
+
<dl>
|
|
578
|
+
<dd>
|
|
579
|
+
|
|
580
|
+
**request:** `Chrt.agent.OrderInformationConversationClientUpdate1`
|
|
581
|
+
|
|
582
|
+
</dd>
|
|
583
|
+
</dl>
|
|
584
|
+
|
|
585
|
+
<dl>
|
|
586
|
+
<dd>
|
|
587
|
+
|
|
588
|
+
**requestOptions:** `OrderInformation.RequestOptions`
|
|
589
|
+
|
|
590
|
+
</dd>
|
|
591
|
+
</dl>
|
|
592
|
+
</dd>
|
|
593
|
+
</dl>
|
|
594
|
+
|
|
595
|
+
</dd>
|
|
596
|
+
</dl>
|
|
597
|
+
</details>
|
|
598
|
+
|
|
388
599
|
## Analytics Shipping
|
|
389
600
|
|
|
390
601
|
<details><summary><code>client.analytics.shipping.<a href="/src/api/resources/analytics/resources/shipping/client/Client.ts">retrieveOrdersCountV1</a>({ ...params }) -> Chrt.AnalyticsTimeBucketRes</code></summary>
|
|
@@ -1478,7 +1689,6 @@ await client.billingNew.chrtGroundProviderRates.listV1({
|
|
|
1478
1689
|
filter_counterparty_off_chrt_org_data_id: "filter_counterparty_off_chrt_org_data_id",
|
|
1479
1690
|
filter_shipper_account_id: "filter_shipper_account_id",
|
|
1480
1691
|
filter_counterparty_driver_id: "filter_counterparty_driver_id",
|
|
1481
|
-
filter_counterparty_scope_driver_id: "filter_counterparty_scope_driver_id",
|
|
1482
1692
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
1483
1693
|
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
1484
1694
|
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -2385,7 +2595,7 @@ await client.billingNew.invoiceLineItems.previewFromRateSheetsV1({
|
|
|
2385
2595
|
<dl>
|
|
2386
2596
|
<dd>
|
|
2387
2597
|
|
|
2388
|
-
Lists owner-scoped invoice line items with
|
|
2598
|
+
Lists owner-scoped invoice line items with attached invoices expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceLineItemListRes)
|
|
2389
2599
|
|
|
2390
2600
|
</dd>
|
|
2391
2601
|
</dl>
|
|
@@ -2666,7 +2876,7 @@ await client.billingNew.invoices.approveV1("invoice_id");
|
|
|
2666
2876
|
<dl>
|
|
2667
2877
|
<dd>
|
|
2668
2878
|
|
|
2669
|
-
Returns the matching
|
|
2879
|
+
Returns the matching draft invoice period, or creates one with an optional rolling-month default. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceClientCreate1) -> (PydanticObjectId)
|
|
2670
2880
|
|
|
2671
2881
|
</dd>
|
|
2672
2882
|
</dl>
|
|
@@ -3147,7 +3357,7 @@ await client.billingNew.invoices.removeLineItemsV1("invoice_id", {
|
|
|
3147
3357
|
<dl>
|
|
3148
3358
|
<dd>
|
|
3149
3359
|
|
|
3150
|
-
Lists owner-scoped invoices with
|
|
3360
|
+
Lists owner-scoped invoices with related orders, counterparties, and accounts expanded. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (InvoiceListRes)
|
|
3151
3361
|
|
|
3152
3362
|
</dd>
|
|
3153
3363
|
</dl>
|
|
@@ -3283,7 +3493,7 @@ await client.billingNew.invoices.updateV1("invoice_id");
|
|
|
3283
3493
|
</dl>
|
|
3284
3494
|
</details>
|
|
3285
3495
|
|
|
3286
|
-
<details><summary><code>client.billingNew.invoices.<a href="/src/api/resources/billingNew/resources/invoices/client/Client.ts">
|
|
3496
|
+
<details><summary><code>client.billingNew.invoices.<a href="/src/api/resources/billingNew/resources/invoices/client/Client.ts">updatePeriodV1</a>(invoiceId, { ...params }) -> boolean</code></summary>
|
|
3287
3497
|
<dl>
|
|
3288
3498
|
<dd>
|
|
3289
3499
|
|
|
@@ -3295,7 +3505,7 @@ await client.billingNew.invoices.updateV1("invoice_id");
|
|
|
3295
3505
|
<dl>
|
|
3296
3506
|
<dd>
|
|
3297
3507
|
|
|
3298
|
-
|
|
3508
|
+
Updates the period of a draft invoice without changing its attached line items. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoicePeriodUpdateReq) -> (bool)
|
|
3299
3509
|
|
|
3300
3510
|
</dd>
|
|
3301
3511
|
</dl>
|
|
@@ -3311,7 +3521,10 @@ Retrieves an invoice owned by the caller's organization. | authz: allowed_org_ty
|
|
|
3311
3521
|
<dd>
|
|
3312
3522
|
|
|
3313
3523
|
```typescript
|
|
3314
|
-
await client.billingNew.invoices.
|
|
3524
|
+
await client.billingNew.invoices.updatePeriodV1("invoice_id", {
|
|
3525
|
+
period_end_at_timestamp: "2024-01-15T09:30:00Z",
|
|
3526
|
+
period_start_at_timestamp: "2024-01-15T09:30:00Z",
|
|
3527
|
+
});
|
|
3315
3528
|
```
|
|
3316
3529
|
|
|
3317
3530
|
</dd>
|
|
@@ -3335,6 +3548,14 @@ await client.billingNew.invoices.getV1("invoice_id");
|
|
|
3335
3548
|
<dl>
|
|
3336
3549
|
<dd>
|
|
3337
3550
|
|
|
3551
|
+
**request:** `Chrt.billingNew.InvoicePeriodUpdateReq`
|
|
3552
|
+
|
|
3553
|
+
</dd>
|
|
3554
|
+
</dl>
|
|
3555
|
+
|
|
3556
|
+
<dl>
|
|
3557
|
+
<dd>
|
|
3558
|
+
|
|
3338
3559
|
**requestOptions:** `Invoices.RequestOptions`
|
|
3339
3560
|
|
|
3340
3561
|
</dd>
|
|
@@ -3346,7 +3567,7 @@ await client.billingNew.invoices.getV1("invoice_id");
|
|
|
3346
3567
|
</dl>
|
|
3347
3568
|
</details>
|
|
3348
3569
|
|
|
3349
|
-
<details><summary><code>client.billingNew.invoices.<a href="/src/api/resources/billingNew/resources/invoices/client/Client.ts">
|
|
3570
|
+
<details><summary><code>client.billingNew.invoices.<a href="/src/api/resources/billingNew/resources/invoices/client/Client.ts">getV1</a>(invoiceId) -> Chrt.Invoice1</code></summary>
|
|
3350
3571
|
<dl>
|
|
3351
3572
|
<dd>
|
|
3352
3573
|
|
|
@@ -3358,7 +3579,7 @@ await client.billingNew.invoices.getV1("invoice_id");
|
|
|
3358
3579
|
<dl>
|
|
3359
3580
|
<dd>
|
|
3360
3581
|
|
|
3361
|
-
|
|
3582
|
+
Retrieves an invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (Invoice1)
|
|
3362
3583
|
|
|
3363
3584
|
</dd>
|
|
3364
3585
|
</dl>
|
|
@@ -3374,7 +3595,7 @@ Voids a draft or approved invoice owned by the caller's organization. | authz: a
|
|
|
3374
3595
|
<dd>
|
|
3375
3596
|
|
|
3376
3597
|
```typescript
|
|
3377
|
-
await client.billingNew.invoices.
|
|
3598
|
+
await client.billingNew.invoices.getV1("invoice_id");
|
|
3378
3599
|
```
|
|
3379
3600
|
|
|
3380
3601
|
</dd>
|
|
@@ -3398,14 +3619,6 @@ await client.billingNew.invoices.voidV1("invoice_id");
|
|
|
3398
3619
|
<dl>
|
|
3399
3620
|
<dd>
|
|
3400
3621
|
|
|
3401
|
-
**request:** `Chrt.billingNew.InvoiceVoidReq`
|
|
3402
|
-
|
|
3403
|
-
</dd>
|
|
3404
|
-
</dl>
|
|
3405
|
-
|
|
3406
|
-
<dl>
|
|
3407
|
-
<dd>
|
|
3408
|
-
|
|
3409
3622
|
**requestOptions:** `Invoices.RequestOptions`
|
|
3410
3623
|
|
|
3411
3624
|
</dd>
|
|
@@ -3417,9 +3630,7 @@ await client.billingNew.invoices.voidV1("invoice_id");
|
|
|
3417
3630
|
</dl>
|
|
3418
3631
|
</details>
|
|
3419
3632
|
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
<details><summary><code>client.billingNew.orders.<a href="/src/api/resources/billingNew/resources/orders/client/Client.ts">listAwbBillingForCoordinatorOperatorsV1</a>({ ...params }) -> Chrt.OrderAwbBillingListRes</code></summary>
|
|
3633
|
+
<details><summary><code>client.billingNew.invoices.<a href="/src/api/resources/billingNew/resources/invoices/client/Client.ts">voidV1</a>(invoiceId, { ...params }) -> Chrt.Invoice1</code></summary>
|
|
3423
3634
|
<dl>
|
|
3424
3635
|
<dd>
|
|
3425
3636
|
|
|
@@ -3431,7 +3642,7 @@ await client.billingNew.invoices.voidV1("invoice_id");
|
|
|
3431
3642
|
<dl>
|
|
3432
3643
|
<dd>
|
|
3433
3644
|
|
|
3434
|
-
|
|
3645
|
+
Voids a draft or approved invoice owned by the caller's organization. | authz: allowed_org_types=[provider], min_org_role=operator | (InvoiceVoidReq) -> (Invoice1)
|
|
3435
3646
|
|
|
3436
3647
|
</dd>
|
|
3437
3648
|
</dl>
|
|
@@ -3447,10 +3658,7 @@ Lists completed, unbilled AWBs with delivery account allocations. | authz: allow
|
|
|
3447
3658
|
<dd>
|
|
3448
3659
|
|
|
3449
3660
|
```typescript
|
|
3450
|
-
await client.billingNew.
|
|
3451
|
-
page: 1,
|
|
3452
|
-
page_size: 1,
|
|
3453
|
-
});
|
|
3661
|
+
await client.billingNew.invoices.voidV1("invoice_id");
|
|
3454
3662
|
```
|
|
3455
3663
|
|
|
3456
3664
|
</dd>
|
|
@@ -3466,7 +3674,7 @@ await client.billingNew.orders.listAwbBillingForCoordinatorOperatorsV1({
|
|
|
3466
3674
|
<dl>
|
|
3467
3675
|
<dd>
|
|
3468
3676
|
|
|
3469
|
-
**
|
|
3677
|
+
**invoiceId:** `string`
|
|
3470
3678
|
|
|
3471
3679
|
</dd>
|
|
3472
3680
|
</dl>
|
|
@@ -3474,7 +3682,15 @@ await client.billingNew.orders.listAwbBillingForCoordinatorOperatorsV1({
|
|
|
3474
3682
|
<dl>
|
|
3475
3683
|
<dd>
|
|
3476
3684
|
|
|
3477
|
-
**
|
|
3685
|
+
**request:** `Chrt.billingNew.InvoiceVoidReq`
|
|
3686
|
+
|
|
3687
|
+
</dd>
|
|
3688
|
+
</dl>
|
|
3689
|
+
|
|
3690
|
+
<dl>
|
|
3691
|
+
<dd>
|
|
3692
|
+
|
|
3693
|
+
**requestOptions:** `Invoices.RequestOptions`
|
|
3478
3694
|
|
|
3479
3695
|
</dd>
|
|
3480
3696
|
</dl>
|
|
@@ -3485,7 +3701,9 @@ await client.billingNew.orders.listAwbBillingForCoordinatorOperatorsV1({
|
|
|
3485
3701
|
</dl>
|
|
3486
3702
|
</details>
|
|
3487
3703
|
|
|
3488
|
-
|
|
3704
|
+
## BillingNew Orders
|
|
3705
|
+
|
|
3706
|
+
<details><summary><code>client.billingNew.orders.<a href="/src/api/resources/billingNew/resources/orders/client/Client.ts">listAwbBillingForCoordinatorOperatorsV1</a>({ ...params }) -> Chrt.OrderAwbBillingListRes</code></summary>
|
|
3489
3707
|
<dl>
|
|
3490
3708
|
<dd>
|
|
3491
3709
|
|
|
@@ -3497,7 +3715,7 @@ await client.billingNew.orders.listAwbBillingForCoordinatorOperatorsV1({
|
|
|
3497
3715
|
<dl>
|
|
3498
3716
|
<dd>
|
|
3499
3717
|
|
|
3500
|
-
Lists
|
|
3718
|
+
Lists completed, unbilled AWBs with delivery account allocations. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (OrderAwbBillingListRes)
|
|
3501
3719
|
|
|
3502
3720
|
</dd>
|
|
3503
3721
|
</dl>
|
|
@@ -3513,14 +3731,80 @@ Lists coordinator orders with billing summaries and optional party-name expansio
|
|
|
3513
3731
|
<dd>
|
|
3514
3732
|
|
|
3515
3733
|
```typescript
|
|
3516
|
-
await client.billingNew.orders.
|
|
3517
|
-
sort_by: "draft_started_at_timestamp",
|
|
3518
|
-
sort_order: "asc",
|
|
3734
|
+
await client.billingNew.orders.listAwbBillingForCoordinatorOperatorsV1({
|
|
3519
3735
|
page: 1,
|
|
3520
3736
|
page_size: 1,
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3737
|
+
});
|
|
3738
|
+
```
|
|
3739
|
+
|
|
3740
|
+
</dd>
|
|
3741
|
+
</dl>
|
|
3742
|
+
</dd>
|
|
3743
|
+
</dl>
|
|
3744
|
+
|
|
3745
|
+
#### ⚙️ Parameters
|
|
3746
|
+
|
|
3747
|
+
<dl>
|
|
3748
|
+
<dd>
|
|
3749
|
+
|
|
3750
|
+
<dl>
|
|
3751
|
+
<dd>
|
|
3752
|
+
|
|
3753
|
+
**request:** `Chrt.billingNew.OrdersListAwbBillingForCoordinatorOperatorsV1Request`
|
|
3754
|
+
|
|
3755
|
+
</dd>
|
|
3756
|
+
</dl>
|
|
3757
|
+
|
|
3758
|
+
<dl>
|
|
3759
|
+
<dd>
|
|
3760
|
+
|
|
3761
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
3762
|
+
|
|
3763
|
+
</dd>
|
|
3764
|
+
</dl>
|
|
3765
|
+
</dd>
|
|
3766
|
+
</dl>
|
|
3767
|
+
|
|
3768
|
+
</dd>
|
|
3769
|
+
</dl>
|
|
3770
|
+
</details>
|
|
3771
|
+
|
|
3772
|
+
<details><summary><code>client.billingNew.orders.<a href="/src/api/resources/billingNew/resources/orders/client/Client.ts">listExpandedForCoordinatorOperatorsV1</a>({ ...params }) -> Chrt.OrderBillingExpandedListRes</code></summary>
|
|
3773
|
+
<dl>
|
|
3774
|
+
<dd>
|
|
3775
|
+
|
|
3776
|
+
#### 📝 Description
|
|
3777
|
+
|
|
3778
|
+
<dl>
|
|
3779
|
+
<dd>
|
|
3780
|
+
|
|
3781
|
+
<dl>
|
|
3782
|
+
<dd>
|
|
3783
|
+
|
|
3784
|
+
Lists coordinator orders with billing summaries and optional party-name expansion. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderBillingExpandedListReq) -> (OrderBillingExpandedListRes)
|
|
3785
|
+
|
|
3786
|
+
</dd>
|
|
3787
|
+
</dl>
|
|
3788
|
+
</dd>
|
|
3789
|
+
</dl>
|
|
3790
|
+
|
|
3791
|
+
#### 🔌 Usage
|
|
3792
|
+
|
|
3793
|
+
<dl>
|
|
3794
|
+
<dd>
|
|
3795
|
+
|
|
3796
|
+
<dl>
|
|
3797
|
+
<dd>
|
|
3798
|
+
|
|
3799
|
+
```typescript
|
|
3800
|
+
await client.billingNew.orders.listExpandedForCoordinatorOperatorsV1({
|
|
3801
|
+
sort_by: "draft_started_at_timestamp",
|
|
3802
|
+
sort_order: "asc",
|
|
3803
|
+
page: 1,
|
|
3804
|
+
page_size: 1,
|
|
3805
|
+
search: "search",
|
|
3806
|
+
filter_awb_number: "filter_awb_number",
|
|
3807
|
+
filter_shipper_org_id: "filter_shipper_org_id",
|
|
3524
3808
|
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
3525
3809
|
filter_executor_org_id: "filter_executor_org_id",
|
|
3526
3810
|
filter_coordinator_label: "filter_coordinator_label",
|
|
@@ -3571,6 +3855,73 @@ await client.billingNew.orders.listExpandedForCoordinatorOperatorsV1({
|
|
|
3571
3855
|
</dl>
|
|
3572
3856
|
</details>
|
|
3573
3857
|
|
|
3858
|
+
## BillingNew Orders RateSheetLineItems
|
|
3859
|
+
|
|
3860
|
+
<details><summary><code>client.billingNew.orders.rateSheetLineItems.<a href="/src/api/resources/billingNew/resources/orders/resources/rateSheetLineItems/client/Client.ts">generateManyV1</a>({ ...params }) -> Chrt.OrderRateSheetLineItemsGenerateManyRes</code></summary>
|
|
3861
|
+
<dl>
|
|
3862
|
+
<dd>
|
|
3863
|
+
|
|
3864
|
+
#### 📝 Description
|
|
3865
|
+
|
|
3866
|
+
<dl>
|
|
3867
|
+
<dd>
|
|
3868
|
+
|
|
3869
|
+
<dl>
|
|
3870
|
+
<dd>
|
|
3871
|
+
|
|
3872
|
+
Resolves all matching CHRT-ground provider rate sheets for each unique Order and independently replaces that Order's rate-sheet-derived line items on draft invoices. Orders without matching rate sheets are skipped, expected per-Order failures are returned without stopping later Orders, and invoice approval or finalization is not performed. | authz: allowed_org_types=[provider], min_org_role=operator | authz_personas=[coordinator_org_operators] | (OrderRateSheetLineItemsGenerateManyReq) -> (OrderRateSheetLineItemsGenerateManyRes)
|
|
3873
|
+
|
|
3874
|
+
</dd>
|
|
3875
|
+
</dl>
|
|
3876
|
+
</dd>
|
|
3877
|
+
</dl>
|
|
3878
|
+
|
|
3879
|
+
#### 🔌 Usage
|
|
3880
|
+
|
|
3881
|
+
<dl>
|
|
3882
|
+
<dd>
|
|
3883
|
+
|
|
3884
|
+
<dl>
|
|
3885
|
+
<dd>
|
|
3886
|
+
|
|
3887
|
+
```typescript
|
|
3888
|
+
await client.billingNew.orders.rateSheetLineItems.generateManyV1({
|
|
3889
|
+
order_ids: ["order_ids"],
|
|
3890
|
+
});
|
|
3891
|
+
```
|
|
3892
|
+
|
|
3893
|
+
</dd>
|
|
3894
|
+
</dl>
|
|
3895
|
+
</dd>
|
|
3896
|
+
</dl>
|
|
3897
|
+
|
|
3898
|
+
#### ⚙️ Parameters
|
|
3899
|
+
|
|
3900
|
+
<dl>
|
|
3901
|
+
<dd>
|
|
3902
|
+
|
|
3903
|
+
<dl>
|
|
3904
|
+
<dd>
|
|
3905
|
+
|
|
3906
|
+
**request:** `Chrt.billingNew.orders.OrderRateSheetLineItemsGenerateManyReq`
|
|
3907
|
+
|
|
3908
|
+
</dd>
|
|
3909
|
+
</dl>
|
|
3910
|
+
|
|
3911
|
+
<dl>
|
|
3912
|
+
<dd>
|
|
3913
|
+
|
|
3914
|
+
**requestOptions:** `RateSheetLineItems.RequestOptions`
|
|
3915
|
+
|
|
3916
|
+
</dd>
|
|
3917
|
+
</dl>
|
|
3918
|
+
</dd>
|
|
3919
|
+
</dl>
|
|
3920
|
+
|
|
3921
|
+
</dd>
|
|
3922
|
+
</dl>
|
|
3923
|
+
</details>
|
|
3924
|
+
|
|
3574
3925
|
## Integrations AirWaybills
|
|
3575
3926
|
|
|
3576
3927
|
<details><summary><code>client.integrations.airWaybills.<a href="/src/api/resources/integrations/resources/airWaybills/client/Client.ts">confirmationsV1</a>(taskGroupId) -> Chrt.ChampConfirmationReceipt1[]</code></summary>
|
|
@@ -10190,7 +10541,7 @@ await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id")
|
|
|
10190
10541
|
<dl>
|
|
10191
10542
|
<dd>
|
|
10192
10543
|
|
|
10193
|
-
Lists OperationsTasks with department and assigned-user details. | authz: min_org_role=operator | () -> (OperationsTaskExpandedListRes)
|
|
10544
|
+
Lists OperationsTasks with task-list, department, and assigned-user details. | authz: min_org_role=operator | () -> (OperationsTaskExpandedListRes)
|
|
10194
10545
|
|
|
10195
10546
|
</dd>
|
|
10196
10547
|
</dl>
|
|
@@ -10398,7 +10749,7 @@ await client.operations.operationsTasks.setDeadlineTimestampsV1({
|
|
|
10398
10749
|
</dl>
|
|
10399
10750
|
</details>
|
|
10400
10751
|
|
|
10401
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">
|
|
10752
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">setStatusV1</a>({ ...params }) -> Chrt.OperationsTasksStatusUpdateRes1</code></summary>
|
|
10402
10753
|
<dl>
|
|
10403
10754
|
<dd>
|
|
10404
10755
|
|
|
@@ -10410,7 +10761,7 @@ await client.operations.operationsTasks.setDeadlineTimestampsV1({
|
|
|
10410
10761
|
<dl>
|
|
10411
10762
|
<dd>
|
|
10412
10763
|
|
|
10413
|
-
Sets
|
|
10764
|
+
Sets the same status on each selected OperationsTask. Completing tasks stamps completed_at/by while other statuses clear them; missing or cross-org ids are skipped. | authz: min_org_role=operator | (OperationsTasksSetStatusReq1) -> (OperationsTasksStatusUpdateRes1)
|
|
10414
10765
|
|
|
10415
10766
|
</dd>
|
|
10416
10767
|
</dl>
|
|
@@ -10426,7 +10777,8 @@ Sets an OperationsTask's status (not_started / in_progress / completed / skipped
|
|
|
10426
10777
|
<dd>
|
|
10427
10778
|
|
|
10428
10779
|
```typescript
|
|
10429
|
-
await client.operations.operationsTasks.
|
|
10780
|
+
await client.operations.operationsTasks.setStatusV1({
|
|
10781
|
+
operations_task_ids: ["operations_task_ids"],
|
|
10430
10782
|
status: "not_started",
|
|
10431
10783
|
});
|
|
10432
10784
|
```
|
|
@@ -10444,15 +10796,7 @@ await client.operations.operationsTasks.updateStatusV1("task_id", {
|
|
|
10444
10796
|
<dl>
|
|
10445
10797
|
<dd>
|
|
10446
10798
|
|
|
10447
|
-
**
|
|
10448
|
-
|
|
10449
|
-
</dd>
|
|
10450
|
-
</dl>
|
|
10451
|
-
|
|
10452
|
-
<dl>
|
|
10453
|
-
<dd>
|
|
10454
|
-
|
|
10455
|
-
**request:** `Chrt.operations.OperationsTaskStatusReq`
|
|
10799
|
+
**request:** `Chrt.operations.OperationsTasksSetStatusReq1`
|
|
10456
10800
|
|
|
10457
10801
|
</dd>
|
|
10458
10802
|
</dl>
|
|
@@ -12779,7 +13123,7 @@ await client.orgs.contacts.deleteV1("contact_id");
|
|
|
12779
13123
|
<dl>
|
|
12780
13124
|
<dd>
|
|
12781
13125
|
|
|
12782
|
-
Lists organization-created contacts with
|
|
13126
|
+
Lists organization-created contacts with associated organizations and accounts expanded. | authz: min_org_role=operator | () -> (ContactListRes)
|
|
12783
13127
|
|
|
12784
13128
|
</dd>
|
|
12785
13129
|
</dl>
|
|
@@ -19008,6 +19352,77 @@ await client.shipping.drivers.complianceDocuments.s3Object.getV1("driver_complia
|
|
|
19008
19352
|
|
|
19009
19353
|
## Shipping OrderTemplatesNew Cargos
|
|
19010
19354
|
|
|
19355
|
+
<details><summary><code>client.shipping.orderTemplatesNew.cargos.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.ts">postDuplicateV1</a>(orderTemplateId, cargoKey) -> Chrt.OrderTemplateNew1</code></summary>
|
|
19356
|
+
<dl>
|
|
19357
|
+
<dd>
|
|
19358
|
+
|
|
19359
|
+
#### 📝 Description
|
|
19360
|
+
|
|
19361
|
+
<dl>
|
|
19362
|
+
<dd>
|
|
19363
|
+
|
|
19364
|
+
<dl>
|
|
19365
|
+
<dd>
|
|
19366
|
+
|
|
19367
|
+
Duplicates cargo and its task associations in an active order template. | authz: min_org_role=operator | () -> (OrderTemplateNew1)
|
|
19368
|
+
|
|
19369
|
+
</dd>
|
|
19370
|
+
</dl>
|
|
19371
|
+
</dd>
|
|
19372
|
+
</dl>
|
|
19373
|
+
|
|
19374
|
+
#### 🔌 Usage
|
|
19375
|
+
|
|
19376
|
+
<dl>
|
|
19377
|
+
<dd>
|
|
19378
|
+
|
|
19379
|
+
<dl>
|
|
19380
|
+
<dd>
|
|
19381
|
+
|
|
19382
|
+
```typescript
|
|
19383
|
+
await client.shipping.orderTemplatesNew.cargos.postDuplicateV1("order_template_id", "cargo_key");
|
|
19384
|
+
```
|
|
19385
|
+
|
|
19386
|
+
</dd>
|
|
19387
|
+
</dl>
|
|
19388
|
+
</dd>
|
|
19389
|
+
</dl>
|
|
19390
|
+
|
|
19391
|
+
#### ⚙️ Parameters
|
|
19392
|
+
|
|
19393
|
+
<dl>
|
|
19394
|
+
<dd>
|
|
19395
|
+
|
|
19396
|
+
<dl>
|
|
19397
|
+
<dd>
|
|
19398
|
+
|
|
19399
|
+
**orderTemplateId:** `string`
|
|
19400
|
+
|
|
19401
|
+
</dd>
|
|
19402
|
+
</dl>
|
|
19403
|
+
|
|
19404
|
+
<dl>
|
|
19405
|
+
<dd>
|
|
19406
|
+
|
|
19407
|
+
**cargoKey:** `string`
|
|
19408
|
+
|
|
19409
|
+
</dd>
|
|
19410
|
+
</dl>
|
|
19411
|
+
|
|
19412
|
+
<dl>
|
|
19413
|
+
<dd>
|
|
19414
|
+
|
|
19415
|
+
**requestOptions:** `Cargos.RequestOptions`
|
|
19416
|
+
|
|
19417
|
+
</dd>
|
|
19418
|
+
</dl>
|
|
19419
|
+
</dd>
|
|
19420
|
+
</dl>
|
|
19421
|
+
|
|
19422
|
+
</dd>
|
|
19423
|
+
</dl>
|
|
19424
|
+
</details>
|
|
19425
|
+
|
|
19011
19426
|
<details><summary><code>client.shipping.orderTemplatesNew.cargos.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/resources/cargos/client/Client.ts">putReorderV1</a>(orderTemplateId, { ...params }) -> Chrt.OrderTemplateNew1</code></summary>
|
|
19012
19427
|
<dl>
|
|
19013
19428
|
<dd>
|
|
@@ -20599,7 +21014,7 @@ await client.shipping.orders.cargo.associateWithTaskV1({
|
|
|
20599
21014
|
</dl>
|
|
20600
21015
|
</details>
|
|
20601
21016
|
|
|
20602
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">
|
|
21017
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">duplicateV1</a>(cargoId) -> string</code></summary>
|
|
20603
21018
|
<dl>
|
|
20604
21019
|
<dd>
|
|
20605
21020
|
|
|
@@ -20611,7 +21026,7 @@ await client.shipping.orders.cargo.associateWithTaskV1({
|
|
|
20611
21026
|
<dl>
|
|
20612
21027
|
<dd>
|
|
20613
21028
|
|
|
20614
|
-
|
|
21029
|
+
Duplicates cargo and all of its task associations within an order. | () -> (PydanticObjectId)
|
|
20615
21030
|
|
|
20616
21031
|
</dd>
|
|
20617
21032
|
</dl>
|
|
@@ -20627,11 +21042,7 @@ Removes cargo from an order task and updates operational cargo status when appli
|
|
|
20627
21042
|
<dd>
|
|
20628
21043
|
|
|
20629
21044
|
```typescript
|
|
20630
|
-
await client.shipping.orders.cargo.
|
|
20631
|
-
cargo_id: "cargo_id",
|
|
20632
|
-
order_id: "order_id",
|
|
20633
|
-
task_id: "task_id",
|
|
20634
|
-
});
|
|
21045
|
+
await client.shipping.orders.cargo.duplicateV1("cargo_id");
|
|
20635
21046
|
```
|
|
20636
21047
|
|
|
20637
21048
|
</dd>
|
|
@@ -20647,7 +21058,7 @@ await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
|
20647
21058
|
<dl>
|
|
20648
21059
|
<dd>
|
|
20649
21060
|
|
|
20650
|
-
**
|
|
21061
|
+
**cargoId:** `string`
|
|
20651
21062
|
|
|
20652
21063
|
</dd>
|
|
20653
21064
|
</dl>
|
|
@@ -20666,7 +21077,7 @@ await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
|
20666
21077
|
</dl>
|
|
20667
21078
|
</details>
|
|
20668
21079
|
|
|
20669
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">
|
|
21080
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">unassociateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
20670
21081
|
<dl>
|
|
20671
21082
|
<dd>
|
|
20672
21083
|
|
|
@@ -20678,7 +21089,7 @@ await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
|
20678
21089
|
<dl>
|
|
20679
21090
|
<dd>
|
|
20680
21091
|
|
|
20681
|
-
|
|
21092
|
+
Removes cargo from an order task and updates operational cargo status when applicable. | (OrdersUnassociateCargoWithTaskReq) -> (bool)
|
|
20682
21093
|
|
|
20683
21094
|
</dd>
|
|
20684
21095
|
</dl>
|
|
@@ -20694,7 +21105,11 @@ Updates cargo details and synchronizes the parent order's AWB list. | (CargoClie
|
|
|
20694
21105
|
<dd>
|
|
20695
21106
|
|
|
20696
21107
|
```typescript
|
|
20697
|
-
await client.shipping.orders.cargo.
|
|
21108
|
+
await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
21109
|
+
cargo_id: "cargo_id",
|
|
21110
|
+
order_id: "order_id",
|
|
21111
|
+
task_id: "task_id",
|
|
21112
|
+
});
|
|
20698
21113
|
```
|
|
20699
21114
|
|
|
20700
21115
|
</dd>
|
|
@@ -20710,15 +21125,7 @@ await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
|
20710
21125
|
<dl>
|
|
20711
21126
|
<dd>
|
|
20712
21127
|
|
|
20713
|
-
**
|
|
20714
|
-
|
|
20715
|
-
</dd>
|
|
20716
|
-
</dl>
|
|
20717
|
-
|
|
20718
|
-
<dl>
|
|
20719
|
-
<dd>
|
|
20720
|
-
|
|
20721
|
-
**request:** `Chrt.shipping.orders.CargoClientUpdate1`
|
|
21128
|
+
**request:** `Chrt.shipping.orders.OrdersUnassociateCargoWithTaskReq`
|
|
20722
21129
|
|
|
20723
21130
|
</dd>
|
|
20724
21131
|
</dl>
|
|
@@ -20737,9 +21144,7 @@ await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
|
20737
21144
|
</dl>
|
|
20738
21145
|
</details>
|
|
20739
21146
|
|
|
20740
|
-
|
|
20741
|
-
|
|
20742
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">addCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId, { ...params }) -> boolean</code></summary>
|
|
21147
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
20743
21148
|
<dl>
|
|
20744
21149
|
<dd>
|
|
20745
21150
|
|
|
@@ -20751,7 +21156,7 @@ await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
|
20751
21156
|
<dl>
|
|
20752
21157
|
<dd>
|
|
20753
21158
|
|
|
20754
|
-
|
|
21159
|
+
Updates cargo details and synchronizes the parent order's AWB list. | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
20755
21160
|
|
|
20756
21161
|
</dd>
|
|
20757
21162
|
</dl>
|
|
@@ -20767,10 +21172,7 @@ Adds a coordinator task list with an optional department override to apply when
|
|
|
20767
21172
|
<dd>
|
|
20768
21173
|
|
|
20769
21174
|
```typescript
|
|
20770
|
-
await client.shipping.orders.
|
|
20771
|
-
department_id: "department_id",
|
|
20772
|
-
body: "2024-01-15T09:30:00Z",
|
|
20773
|
-
});
|
|
21175
|
+
await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
20774
21176
|
```
|
|
20775
21177
|
|
|
20776
21178
|
</dd>
|
|
@@ -20786,7 +21188,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
20786
21188
|
<dl>
|
|
20787
21189
|
<dd>
|
|
20788
21190
|
|
|
20789
|
-
**
|
|
21191
|
+
**cargoId:** `string`
|
|
20790
21192
|
|
|
20791
21193
|
</dd>
|
|
20792
21194
|
</dl>
|
|
@@ -20794,7 +21196,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
20794
21196
|
<dl>
|
|
20795
21197
|
<dd>
|
|
20796
21198
|
|
|
20797
|
-
**
|
|
21199
|
+
**request:** `Chrt.shipping.orders.CargoClientUpdate1`
|
|
20798
21200
|
|
|
20799
21201
|
</dd>
|
|
20800
21202
|
</dl>
|
|
@@ -20802,15 +21204,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
20802
21204
|
<dl>
|
|
20803
21205
|
<dd>
|
|
20804
21206
|
|
|
20805
|
-
**
|
|
20806
|
-
|
|
20807
|
-
</dd>
|
|
20808
|
-
</dl>
|
|
20809
|
-
|
|
20810
|
-
<dl>
|
|
20811
|
-
<dd>
|
|
20812
|
-
|
|
20813
|
-
**requestOptions:** `Drafts.RequestOptions`
|
|
21207
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
20814
21208
|
|
|
20815
21209
|
</dd>
|
|
20816
21210
|
</dl>
|
|
@@ -20821,7 +21215,9 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
20821
21215
|
</dl>
|
|
20822
21216
|
</details>
|
|
20823
21217
|
|
|
20824
|
-
|
|
21218
|
+
## Shipping Orders Drafts
|
|
21219
|
+
|
|
21220
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">addCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId, { ...params }) -> boolean</code></summary>
|
|
20825
21221
|
<dl>
|
|
20826
21222
|
<dd>
|
|
20827
21223
|
|
|
@@ -20833,7 +21229,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
20833
21229
|
<dl>
|
|
20834
21230
|
<dd>
|
|
20835
21231
|
|
|
20836
|
-
|
|
21232
|
+
Adds a coordinator task list with an optional department override to apply when the draft order is staged. | authz_personas=[coordinator_org_operators] | (UTCDatetime | None) -> (bool)
|
|
20837
21233
|
|
|
20838
21234
|
</dd>
|
|
20839
21235
|
</dl>
|
|
@@ -20849,7 +21245,10 @@ Removes a pending coordinator staging task list from a draft order. | authz_pers
|
|
|
20849
21245
|
<dd>
|
|
20850
21246
|
|
|
20851
21247
|
```typescript
|
|
20852
|
-
await client.shipping.orders.drafts.
|
|
21248
|
+
await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id", {
|
|
21249
|
+
department_id: "department_id",
|
|
21250
|
+
body: "2024-01-15T09:30:00Z",
|
|
21251
|
+
});
|
|
20853
21252
|
```
|
|
20854
21253
|
|
|
20855
21254
|
</dd>
|
|
@@ -20881,62 +21280,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
20881
21280
|
<dl>
|
|
20882
21281
|
<dd>
|
|
20883
21282
|
|
|
20884
|
-
**
|
|
20885
|
-
|
|
20886
|
-
</dd>
|
|
20887
|
-
</dl>
|
|
20888
|
-
</dd>
|
|
20889
|
-
</dl>
|
|
20890
|
-
|
|
20891
|
-
</dd>
|
|
20892
|
-
</dl>
|
|
20893
|
-
</details>
|
|
20894
|
-
|
|
20895
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">createFromOrderTemplateNewV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
20896
|
-
<dl>
|
|
20897
|
-
<dd>
|
|
20898
|
-
|
|
20899
|
-
#### 📝 Description
|
|
20900
|
-
|
|
20901
|
-
<dl>
|
|
20902
|
-
<dd>
|
|
20903
|
-
|
|
20904
|
-
<dl>
|
|
20905
|
-
<dd>
|
|
20906
|
-
|
|
20907
|
-
Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
20908
|
-
|
|
20909
|
-
</dd>
|
|
20910
|
-
</dl>
|
|
20911
|
-
</dd>
|
|
20912
|
-
</dl>
|
|
20913
|
-
|
|
20914
|
-
#### 🔌 Usage
|
|
20915
|
-
|
|
20916
|
-
<dl>
|
|
20917
|
-
<dd>
|
|
20918
|
-
|
|
20919
|
-
<dl>
|
|
20920
|
-
<dd>
|
|
20921
|
-
|
|
20922
|
-
```typescript
|
|
20923
|
-
await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
20924
|
-
```
|
|
20925
|
-
|
|
20926
|
-
</dd>
|
|
20927
|
-
</dl>
|
|
20928
|
-
</dd>
|
|
20929
|
-
</dl>
|
|
20930
|
-
|
|
20931
|
-
#### ⚙️ Parameters
|
|
20932
|
-
|
|
20933
|
-
<dl>
|
|
20934
|
-
<dd>
|
|
20935
|
-
|
|
20936
|
-
<dl>
|
|
20937
|
-
<dd>
|
|
20938
|
-
|
|
20939
|
-
**request:** `Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq`
|
|
21283
|
+
**request:** `Chrt.shipping.orders.DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request`
|
|
20940
21284
|
|
|
20941
21285
|
</dd>
|
|
20942
21286
|
</dl>
|
|
@@ -20955,7 +21299,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
20955
21299
|
</dl>
|
|
20956
21300
|
</details>
|
|
20957
21301
|
|
|
20958
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21302
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">removeCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId) -> boolean</code></summary>
|
|
20959
21303
|
<dl>
|
|
20960
21304
|
<dd>
|
|
20961
21305
|
|
|
@@ -20967,7 +21311,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
20967
21311
|
<dl>
|
|
20968
21312
|
<dd>
|
|
20969
21313
|
|
|
20970
|
-
|
|
21314
|
+
Removes a pending coordinator staging task list from a draft order. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
20971
21315
|
|
|
20972
21316
|
</dd>
|
|
20973
21317
|
</dl>
|
|
@@ -20983,7 +21327,7 @@ Deletes a draft order and all associated entities. | authz_personas=[draft_creat
|
|
|
20983
21327
|
<dd>
|
|
20984
21328
|
|
|
20985
21329
|
```typescript
|
|
20986
|
-
await client.shipping.orders.drafts.
|
|
21330
|
+
await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id");
|
|
20987
21331
|
```
|
|
20988
21332
|
|
|
20989
21333
|
</dd>
|
|
@@ -21007,64 +21351,7 @@ await client.shipping.orders.drafts.deleteV1("order_id");
|
|
|
21007
21351
|
<dl>
|
|
21008
21352
|
<dd>
|
|
21009
21353
|
|
|
21010
|
-
**
|
|
21011
|
-
|
|
21012
|
-
</dd>
|
|
21013
|
-
</dl>
|
|
21014
|
-
</dd>
|
|
21015
|
-
</dl>
|
|
21016
|
-
|
|
21017
|
-
</dd>
|
|
21018
|
-
</dl>
|
|
21019
|
-
</details>
|
|
21020
|
-
|
|
21021
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> Chrt.OrdersDraftDeleteManyRes</code></summary>
|
|
21022
|
-
<dl>
|
|
21023
|
-
<dd>
|
|
21024
|
-
|
|
21025
|
-
#### 📝 Description
|
|
21026
|
-
|
|
21027
|
-
<dl>
|
|
21028
|
-
<dd>
|
|
21029
|
-
|
|
21030
|
-
<dl>
|
|
21031
|
-
<dd>
|
|
21032
|
-
|
|
21033
|
-
Deletes multiple draft orders and associated entities. | authz_personas=[draft_creator_org_operator] | (OrdersDraftDeleteManyReq) -> (OrdersDraftDeleteManyRes)
|
|
21034
|
-
|
|
21035
|
-
</dd>
|
|
21036
|
-
</dl>
|
|
21037
|
-
</dd>
|
|
21038
|
-
</dl>
|
|
21039
|
-
|
|
21040
|
-
#### 🔌 Usage
|
|
21041
|
-
|
|
21042
|
-
<dl>
|
|
21043
|
-
<dd>
|
|
21044
|
-
|
|
21045
|
-
<dl>
|
|
21046
|
-
<dd>
|
|
21047
|
-
|
|
21048
|
-
```typescript
|
|
21049
|
-
await client.shipping.orders.drafts.deleteManyV1({
|
|
21050
|
-
order_ids: ["order_ids"],
|
|
21051
|
-
});
|
|
21052
|
-
```
|
|
21053
|
-
|
|
21054
|
-
</dd>
|
|
21055
|
-
</dl>
|
|
21056
|
-
</dd>
|
|
21057
|
-
</dl>
|
|
21058
|
-
|
|
21059
|
-
#### ⚙️ Parameters
|
|
21060
|
-
|
|
21061
|
-
<dl>
|
|
21062
|
-
<dd>
|
|
21063
|
-
|
|
21064
|
-
<dl>
|
|
21065
|
-
<dd>
|
|
21066
|
-
|
|
21067
|
-
**request:** `Chrt.shipping.orders.OrdersDraftDeleteManyReq`
|
|
21354
|
+
**taskListId:** `string`
|
|
21068
21355
|
|
|
21069
21356
|
</dd>
|
|
21070
21357
|
</dl>
|
|
@@ -21083,7 +21370,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21083
21370
|
</dl>
|
|
21084
21371
|
</details>
|
|
21085
21372
|
|
|
21086
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21373
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">createFromOrderTemplateNewV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
21087
21374
|
<dl>
|
|
21088
21375
|
<dd>
|
|
21089
21376
|
|
|
@@ -21095,7 +21382,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21095
21382
|
<dl>
|
|
21096
21383
|
<dd>
|
|
21097
21384
|
|
|
21098
|
-
|
|
21385
|
+
Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
21099
21386
|
|
|
21100
21387
|
</dd>
|
|
21101
21388
|
</dl>
|
|
@@ -21111,7 +21398,7 @@ Opens a new draft order shell with org assignments based on caller's organizatio
|
|
|
21111
21398
|
<dd>
|
|
21112
21399
|
|
|
21113
21400
|
```typescript
|
|
21114
|
-
await client.shipping.orders.drafts.
|
|
21401
|
+
await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
21115
21402
|
```
|
|
21116
21403
|
|
|
21117
21404
|
</dd>
|
|
@@ -21127,7 +21414,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21127
21414
|
<dl>
|
|
21128
21415
|
<dd>
|
|
21129
21416
|
|
|
21130
|
-
**request:** `Chrt.shipping.orders.
|
|
21417
|
+
**request:** `Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq`
|
|
21131
21418
|
|
|
21132
21419
|
</dd>
|
|
21133
21420
|
</dl>
|
|
@@ -21146,7 +21433,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21146
21433
|
</dl>
|
|
21147
21434
|
</details>
|
|
21148
21435
|
|
|
21149
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21436
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
21150
21437
|
<dl>
|
|
21151
21438
|
<dd>
|
|
21152
21439
|
|
|
@@ -21158,7 +21445,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21158
21445
|
<dl>
|
|
21159
21446
|
<dd>
|
|
21160
21447
|
|
|
21161
|
-
|
|
21448
|
+
Deletes a draft order and all associated entities. | authz_personas=[draft_creator_org_operator] | () -> (bool)
|
|
21162
21449
|
|
|
21163
21450
|
</dd>
|
|
21164
21451
|
</dl>
|
|
@@ -21174,9 +21461,7 @@ Sets the ordering of task groups within a draft order. Must provide all task gro
|
|
|
21174
21461
|
<dd>
|
|
21175
21462
|
|
|
21176
21463
|
```typescript
|
|
21177
|
-
await client.shipping.orders.drafts.
|
|
21178
|
-
task_group_ids: ["task_group_ids"],
|
|
21179
|
-
});
|
|
21464
|
+
await client.shipping.orders.drafts.deleteV1("order_id");
|
|
21180
21465
|
```
|
|
21181
21466
|
|
|
21182
21467
|
</dd>
|
|
@@ -21200,14 +21485,6 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21200
21485
|
<dl>
|
|
21201
21486
|
<dd>
|
|
21202
21487
|
|
|
21203
|
-
**request:** `Chrt.shipping.orders.SetTaskGroupOrderingDraftReq`
|
|
21204
|
-
|
|
21205
|
-
</dd>
|
|
21206
|
-
</dl>
|
|
21207
|
-
|
|
21208
|
-
<dl>
|
|
21209
|
-
<dd>
|
|
21210
|
-
|
|
21211
21488
|
**requestOptions:** `Drafts.RequestOptions`
|
|
21212
21489
|
|
|
21213
21490
|
</dd>
|
|
@@ -21219,7 +21496,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21219
21496
|
</dl>
|
|
21220
21497
|
</details>
|
|
21221
21498
|
|
|
21222
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21499
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> Chrt.OrdersDraftDeleteManyRes</code></summary>
|
|
21223
21500
|
<dl>
|
|
21224
21501
|
<dd>
|
|
21225
21502
|
|
|
@@ -21231,7 +21508,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21231
21508
|
<dl>
|
|
21232
21509
|
<dd>
|
|
21233
21510
|
|
|
21234
|
-
|
|
21511
|
+
Deletes multiple draft orders and associated entities. | authz_personas=[draft_creator_org_operator] | (OrdersDraftDeleteManyReq) -> (OrdersDraftDeleteManyRes)
|
|
21235
21512
|
|
|
21236
21513
|
</dd>
|
|
21237
21514
|
</dl>
|
|
@@ -21247,7 +21524,9 @@ Updates coordinator and/or shipper org assignments for a draft order. | authz_pe
|
|
|
21247
21524
|
<dd>
|
|
21248
21525
|
|
|
21249
21526
|
```typescript
|
|
21250
|
-
await client.shipping.orders.drafts.
|
|
21527
|
+
await client.shipping.orders.drafts.deleteManyV1({
|
|
21528
|
+
order_ids: ["order_ids"],
|
|
21529
|
+
});
|
|
21251
21530
|
```
|
|
21252
21531
|
|
|
21253
21532
|
</dd>
|
|
@@ -21263,15 +21542,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21263
21542
|
<dl>
|
|
21264
21543
|
<dd>
|
|
21265
21544
|
|
|
21266
|
-
**
|
|
21267
|
-
|
|
21268
|
-
</dd>
|
|
21269
|
-
</dl>
|
|
21270
|
-
|
|
21271
|
-
<dl>
|
|
21272
|
-
<dd>
|
|
21273
|
-
|
|
21274
|
-
**request:** `Chrt.shipping.orders.OrdersDraftUpdateReq`
|
|
21545
|
+
**request:** `Chrt.shipping.orders.OrdersDraftDeleteManyReq`
|
|
21275
21546
|
|
|
21276
21547
|
</dd>
|
|
21277
21548
|
</dl>
|
|
@@ -21290,7 +21561,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21290
21561
|
</dl>
|
|
21291
21562
|
</details>
|
|
21292
21563
|
|
|
21293
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21564
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">openV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
21294
21565
|
<dl>
|
|
21295
21566
|
<dd>
|
|
21296
21567
|
|
|
@@ -21302,7 +21573,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21302
21573
|
<dl>
|
|
21303
21574
|
<dd>
|
|
21304
21575
|
|
|
21305
|
-
|
|
21576
|
+
Opens a new draft order shell with org assignments based on caller's organization type. | authz: min_org_role=operator | (OrdersOpenDraftReq) -> (OrdersOpenDraftRes)
|
|
21306
21577
|
|
|
21307
21578
|
</dd>
|
|
21308
21579
|
</dl>
|
|
@@ -21318,7 +21589,7 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
21318
21589
|
<dd>
|
|
21319
21590
|
|
|
21320
21591
|
```typescript
|
|
21321
|
-
await client.shipping.orders.drafts.
|
|
21592
|
+
await client.shipping.orders.drafts.openV1();
|
|
21322
21593
|
```
|
|
21323
21594
|
|
|
21324
21595
|
</dd>
|
|
@@ -21334,7 +21605,7 @@ await client.shipping.orders.drafts.validateV1("order_id");
|
|
|
21334
21605
|
<dl>
|
|
21335
21606
|
<dd>
|
|
21336
21607
|
|
|
21337
|
-
**
|
|
21608
|
+
**request:** `Chrt.shipping.orders.OrdersOpenDraftReq`
|
|
21338
21609
|
|
|
21339
21610
|
</dd>
|
|
21340
21611
|
</dl>
|
|
@@ -21353,9 +21624,7 @@ await client.shipping.orders.drafts.validateV1("order_id");
|
|
|
21353
21624
|
</dl>
|
|
21354
21625
|
</details>
|
|
21355
21626
|
|
|
21356
|
-
|
|
21357
|
-
|
|
21358
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forCoordinatorOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpandedForCoordinator</code></summary>
|
|
21627
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">setTaskGroupOrderingV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
21359
21628
|
<dl>
|
|
21360
21629
|
<dd>
|
|
21361
21630
|
|
|
@@ -21367,7 +21636,7 @@ await client.shipping.orders.drafts.validateV1("order_id");
|
|
|
21367
21636
|
<dl>
|
|
21368
21637
|
<dd>
|
|
21369
21638
|
|
|
21370
|
-
|
|
21639
|
+
Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)
|
|
21371
21640
|
|
|
21372
21641
|
</dd>
|
|
21373
21642
|
</dl>
|
|
@@ -21383,7 +21652,9 @@ Retrieves an expanded order with optional related data for coordinator operators
|
|
|
21383
21652
|
<dd>
|
|
21384
21653
|
|
|
21385
21654
|
```typescript
|
|
21386
|
-
await client.shipping.orders.
|
|
21655
|
+
await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
21656
|
+
task_group_ids: ["task_group_ids"],
|
|
21657
|
+
});
|
|
21387
21658
|
```
|
|
21388
21659
|
|
|
21389
21660
|
</dd>
|
|
@@ -21399,7 +21670,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
21399
21670
|
<dl>
|
|
21400
21671
|
<dd>
|
|
21401
21672
|
|
|
21402
|
-
**
|
|
21673
|
+
**orderId:** `string`
|
|
21403
21674
|
|
|
21404
21675
|
</dd>
|
|
21405
21676
|
</dl>
|
|
@@ -21407,7 +21678,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
21407
21678
|
<dl>
|
|
21408
21679
|
<dd>
|
|
21409
21680
|
|
|
21410
|
-
**request:** `Chrt.
|
|
21681
|
+
**request:** `Chrt.shipping.orders.SetTaskGroupOrderingDraftReq`
|
|
21411
21682
|
|
|
21412
21683
|
</dd>
|
|
21413
21684
|
</dl>
|
|
@@ -21415,7 +21686,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
21415
21686
|
<dl>
|
|
21416
21687
|
<dd>
|
|
21417
21688
|
|
|
21418
|
-
**requestOptions:** `
|
|
21689
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
21419
21690
|
|
|
21420
21691
|
</dd>
|
|
21421
21692
|
</dl>
|
|
@@ -21426,7 +21697,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
21426
21697
|
</dl>
|
|
21427
21698
|
</details>
|
|
21428
21699
|
|
|
21429
|
-
<details><summary><code>client.shipping.orders.
|
|
21700
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
21430
21701
|
<dl>
|
|
21431
21702
|
<dd>
|
|
21432
21703
|
|
|
@@ -21438,7 +21709,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
21438
21709
|
<dl>
|
|
21439
21710
|
<dd>
|
|
21440
21711
|
|
|
21441
|
-
|
|
21712
|
+
Updates coordinator and/or shipper org assignments for a draft order. | authz_personas=[draft_creator_org_operator] | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
21442
21713
|
|
|
21443
21714
|
</dd>
|
|
21444
21715
|
</dl>
|
|
@@ -21454,7 +21725,7 @@ Retrieves an expanded order containing only task groups executed by the caller's
|
|
|
21454
21725
|
<dd>
|
|
21455
21726
|
|
|
21456
21727
|
```typescript
|
|
21457
|
-
await client.shipping.orders.
|
|
21728
|
+
await client.shipping.orders.drafts.updateV1("order_id");
|
|
21458
21729
|
```
|
|
21459
21730
|
|
|
21460
21731
|
</dd>
|
|
@@ -21470,7 +21741,7 @@ await client.shipping.orders.expanded.forExecutorOperatorsV1("order_ref", {});
|
|
|
21470
21741
|
<dl>
|
|
21471
21742
|
<dd>
|
|
21472
21743
|
|
|
21473
|
-
**
|
|
21744
|
+
**orderId:** `string`
|
|
21474
21745
|
|
|
21475
21746
|
</dd>
|
|
21476
21747
|
</dl>
|
|
@@ -21478,7 +21749,7 @@ await client.shipping.orders.expanded.forExecutorOperatorsV1("order_ref", {});
|
|
|
21478
21749
|
<dl>
|
|
21479
21750
|
<dd>
|
|
21480
21751
|
|
|
21481
|
-
**request:** `Chrt.
|
|
21752
|
+
**request:** `Chrt.shipping.orders.OrdersDraftUpdateReq`
|
|
21482
21753
|
|
|
21483
21754
|
</dd>
|
|
21484
21755
|
</dl>
|
|
@@ -21486,7 +21757,7 @@ await client.shipping.orders.expanded.forExecutorOperatorsV1("order_ref", {});
|
|
|
21486
21757
|
<dl>
|
|
21487
21758
|
<dd>
|
|
21488
21759
|
|
|
21489
|
-
**requestOptions:** `
|
|
21760
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
21490
21761
|
|
|
21491
21762
|
</dd>
|
|
21492
21763
|
</dl>
|
|
@@ -21497,7 +21768,7 @@ await client.shipping.orders.expanded.forExecutorOperatorsV1("order_ref", {});
|
|
|
21497
21768
|
</dl>
|
|
21498
21769
|
</details>
|
|
21499
21770
|
|
|
21500
|
-
<details><summary><code>client.shipping.orders.
|
|
21771
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
21501
21772
|
<dl>
|
|
21502
21773
|
<dd>
|
|
21503
21774
|
|
|
@@ -21509,7 +21780,7 @@ await client.shipping.orders.expanded.forExecutorOperatorsV1("order_ref", {});
|
|
|
21509
21780
|
<dl>
|
|
21510
21781
|
<dd>
|
|
21511
21782
|
|
|
21512
|
-
|
|
21783
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
21513
21784
|
|
|
21514
21785
|
</dd>
|
|
21515
21786
|
</dl>
|
|
@@ -21525,7 +21796,7 @@ Retrieves an expanded order for a provider org that is the coordinator, an execu
|
|
|
21525
21796
|
<dd>
|
|
21526
21797
|
|
|
21527
21798
|
```typescript
|
|
21528
|
-
await client.shipping.orders.
|
|
21799
|
+
await client.shipping.orders.drafts.validateV1("order_id");
|
|
21529
21800
|
```
|
|
21530
21801
|
|
|
21531
21802
|
</dd>
|
|
@@ -21541,15 +21812,7 @@ await client.shipping.orders.expanded.forProviderOperatorsV1("order_ref", {});
|
|
|
21541
21812
|
<dl>
|
|
21542
21813
|
<dd>
|
|
21543
21814
|
|
|
21544
|
-
**
|
|
21545
|
-
|
|
21546
|
-
</dd>
|
|
21547
|
-
</dl>
|
|
21548
|
-
|
|
21549
|
-
<dl>
|
|
21550
|
-
<dd>
|
|
21551
|
-
|
|
21552
|
-
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
21815
|
+
**orderId:** `string`
|
|
21553
21816
|
|
|
21554
21817
|
</dd>
|
|
21555
21818
|
</dl>
|
|
@@ -21557,7 +21820,7 @@ await client.shipping.orders.expanded.forProviderOperatorsV1("order_ref", {});
|
|
|
21557
21820
|
<dl>
|
|
21558
21821
|
<dd>
|
|
21559
21822
|
|
|
21560
|
-
**requestOptions:** `
|
|
21823
|
+
**requestOptions:** `Drafts.RequestOptions`
|
|
21561
21824
|
|
|
21562
21825
|
</dd>
|
|
21563
21826
|
</dl>
|
|
@@ -21568,7 +21831,9 @@ await client.shipping.orders.expanded.forProviderOperatorsV1("order_ref", {});
|
|
|
21568
21831
|
</dl>
|
|
21569
21832
|
</details>
|
|
21570
21833
|
|
|
21571
|
-
|
|
21834
|
+
## Shipping Orders Expanded
|
|
21835
|
+
|
|
21836
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forProviderOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpandedForProvider</code></summary>
|
|
21572
21837
|
<dl>
|
|
21573
21838
|
<dd>
|
|
21574
21839
|
|
|
@@ -21580,7 +21845,7 @@ await client.shipping.orders.expanded.forProviderOperatorsV1("order_ref", {});
|
|
|
21580
21845
|
<dl>
|
|
21581
21846
|
<dd>
|
|
21582
21847
|
|
|
21583
|
-
Retrieves an expanded order
|
|
21848
|
+
Retrieves an expanded order for a provider org that is the coordinator, an executor, or both. Executor-only callers receive only their task groups. Drafts are visible only to operators in the creating provider org; coordinator responses include unassigned_cargos when expand_cargos is requested. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForProvider)
|
|
21584
21849
|
|
|
21585
21850
|
</dd>
|
|
21586
21851
|
</dl>
|
|
@@ -21596,7 +21861,7 @@ Retrieves an expanded order with optional related data for shipper operators. Dr
|
|
|
21596
21861
|
<dd>
|
|
21597
21862
|
|
|
21598
21863
|
```typescript
|
|
21599
|
-
await client.shipping.orders.expanded.
|
|
21864
|
+
await client.shipping.orders.expanded.forProviderOperatorsV1("order_ref", {});
|
|
21600
21865
|
```
|
|
21601
21866
|
|
|
21602
21867
|
</dd>
|
|
@@ -21639,7 +21904,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
21639
21904
|
</dl>
|
|
21640
21905
|
</details>
|
|
21641
21906
|
|
|
21642
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">
|
|
21907
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpandedForShipper</code></summary>
|
|
21643
21908
|
<dl>
|
|
21644
21909
|
<dd>
|
|
21645
21910
|
|
|
@@ -21651,7 +21916,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
21651
21916
|
<dl>
|
|
21652
21917
|
<dd>
|
|
21653
21918
|
|
|
21654
|
-
|
|
21919
|
+
Retrieves an expanded order with optional related data for shipper operators. Drafts are visible only to operators in the creating shipper org; when expand_cargos is requested, the response includes unassigned_cargos. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpandedForShipper)
|
|
21655
21920
|
|
|
21656
21921
|
</dd>
|
|
21657
21922
|
</dl>
|
|
@@ -21667,33 +21932,7 @@ Lists expanded orders where the caller's provider org is the coordinator. Filter
|
|
|
21667
21932
|
<dd>
|
|
21668
21933
|
|
|
21669
21934
|
```typescript
|
|
21670
|
-
await client.shipping.orders.expanded.
|
|
21671
|
-
sort_by: "draft_started_at_timestamp",
|
|
21672
|
-
sort_order: "asc",
|
|
21673
|
-
page: 1,
|
|
21674
|
-
page_size: 1,
|
|
21675
|
-
search: "search",
|
|
21676
|
-
filter_awb_number: "filter_awb_number",
|
|
21677
|
-
filter_has_invoice: true,
|
|
21678
|
-
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21679
|
-
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21680
|
-
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21681
|
-
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21682
|
-
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21683
|
-
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21684
|
-
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21685
|
-
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21686
|
-
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21687
|
-
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21688
|
-
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21689
|
-
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21690
|
-
filter_executor_org_id: "filter_executor_org_id",
|
|
21691
|
-
filter_shipper_org_id: "filter_shipper_org_id",
|
|
21692
|
-
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
21693
|
-
filter_coordinator_department_id: "filter_coordinator_department_id",
|
|
21694
|
-
filter_coordinator_label: "filter_coordinator_label",
|
|
21695
|
-
body: {},
|
|
21696
|
-
});
|
|
21935
|
+
await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
21697
21936
|
```
|
|
21698
21937
|
|
|
21699
21938
|
</dd>
|
|
@@ -21709,94 +21948,15 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
21709
21948
|
<dl>
|
|
21710
21949
|
<dd>
|
|
21711
21950
|
|
|
21712
|
-
**
|
|
21713
|
-
|
|
21714
|
-
</dd>
|
|
21715
|
-
</dl>
|
|
21716
|
-
|
|
21717
|
-
<dl>
|
|
21718
|
-
<dd>
|
|
21719
|
-
|
|
21720
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
21721
|
-
|
|
21722
|
-
</dd>
|
|
21723
|
-
</dl>
|
|
21724
|
-
</dd>
|
|
21725
|
-
</dl>
|
|
21726
|
-
|
|
21727
|
-
</dd>
|
|
21728
|
-
</dl>
|
|
21729
|
-
</details>
|
|
21730
|
-
|
|
21731
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">listForExecutorOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListForExecutorRes</code></summary>
|
|
21732
|
-
<dl>
|
|
21733
|
-
<dd>
|
|
21734
|
-
|
|
21735
|
-
#### 📝 Description
|
|
21736
|
-
|
|
21737
|
-
<dl>
|
|
21738
|
-
<dd>
|
|
21739
|
-
|
|
21740
|
-
<dl>
|
|
21741
|
-
<dd>
|
|
21742
|
-
|
|
21743
|
-
Lists expanded orders where the caller's provider org executes at least one task group. Each result contains only that org's task groups. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListForExecutorRes)
|
|
21744
|
-
|
|
21745
|
-
</dd>
|
|
21746
|
-
</dl>
|
|
21747
|
-
</dd>
|
|
21748
|
-
</dl>
|
|
21749
|
-
|
|
21750
|
-
#### 🔌 Usage
|
|
21751
|
-
|
|
21752
|
-
<dl>
|
|
21753
|
-
<dd>
|
|
21754
|
-
|
|
21755
|
-
<dl>
|
|
21756
|
-
<dd>
|
|
21757
|
-
|
|
21758
|
-
```typescript
|
|
21759
|
-
await client.shipping.orders.expanded.listForExecutorOperatorsV1({
|
|
21760
|
-
sort_by: "draft_started_at_timestamp",
|
|
21761
|
-
sort_order: "asc",
|
|
21762
|
-
page: 1,
|
|
21763
|
-
page_size: 1,
|
|
21764
|
-
search: "search",
|
|
21765
|
-
filter_awb_number: "filter_awb_number",
|
|
21766
|
-
filter_has_invoice: true,
|
|
21767
|
-
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21768
|
-
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21769
|
-
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21770
|
-
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21771
|
-
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21772
|
-
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21773
|
-
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21774
|
-
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21775
|
-
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21776
|
-
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21777
|
-
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21778
|
-
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21779
|
-
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
21780
|
-
filter_shipper_org_id: "filter_shipper_org_id",
|
|
21781
|
-
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
21782
|
-
body: {},
|
|
21783
|
-
});
|
|
21784
|
-
```
|
|
21951
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
21785
21952
|
|
|
21786
|
-
</dd>
|
|
21787
|
-
</dl>
|
|
21788
21953
|
</dd>
|
|
21789
21954
|
</dl>
|
|
21790
21955
|
|
|
21791
|
-
#### ⚙️ Parameters
|
|
21792
|
-
|
|
21793
|
-
<dl>
|
|
21794
|
-
<dd>
|
|
21795
|
-
|
|
21796
21956
|
<dl>
|
|
21797
21957
|
<dd>
|
|
21798
21958
|
|
|
21799
|
-
**request:** `Chrt.
|
|
21959
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
21800
21960
|
|
|
21801
21961
|
</dd>
|
|
21802
21962
|
</dl>
|
|
@@ -21865,6 +22025,7 @@ await client.shipping.orders.expanded.listForProviderOperatorsV1({
|
|
|
21865
22025
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
21866
22026
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
21867
22027
|
filter_executor_org_id: "filter_executor_org_id",
|
|
22028
|
+
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
21868
22029
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
21869
22030
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
21870
22031
|
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
@@ -23210,7 +23371,7 @@ await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_art
|
|
|
23210
23371
|
dispute_defensibility: "dispute_defensibility",
|
|
23211
23372
|
location_description: "location_description",
|
|
23212
23373
|
location_identifiers: ["location_identifiers"],
|
|
23213
|
-
model: "gpt-5.
|
|
23374
|
+
model: "gpt-5.6-terra",
|
|
23214
23375
|
package_appearance: "package_appearance",
|
|
23215
23376
|
package_types: ["package_types"],
|
|
23216
23377
|
proof_notes: ["proof_notes"],
|
|
@@ -23600,7 +23761,7 @@ await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
|
|
|
23600
23761
|
|
|
23601
23762
|
## Shipping TaskGroups Expanded
|
|
23602
23763
|
|
|
23603
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">
|
|
23764
|
+
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">forDriverV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
23604
23765
|
<dl>
|
|
23605
23766
|
<dd>
|
|
23606
23767
|
|
|
@@ -23612,7 +23773,7 @@ await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
|
|
|
23612
23773
|
<dl>
|
|
23613
23774
|
<dd>
|
|
23614
23775
|
|
|
23615
|
-
Retrieves an expanded task group with optional related data for
|
|
23776
|
+
Retrieves an expanded task group with optional related data for its assigned driver. | authz_personas=[driver_for_executor] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
23616
23777
|
|
|
23617
23778
|
</dd>
|
|
23618
23779
|
</dl>
|
|
@@ -23628,7 +23789,7 @@ Retrieves an expanded task group with optional related data for coordinator oper
|
|
|
23628
23789
|
<dd>
|
|
23629
23790
|
|
|
23630
23791
|
```typescript
|
|
23631
|
-
await client.shipping.taskGroups.expanded.
|
|
23792
|
+
await client.shipping.taskGroups.expanded.forDriverV1("task_group_id", {});
|
|
23632
23793
|
```
|
|
23633
23794
|
|
|
23634
23795
|
</dd>
|
|
@@ -23671,7 +23832,7 @@ await client.shipping.taskGroups.expanded.forCoordinatorOperatorsV1("task_group_
|
|
|
23671
23832
|
</dl>
|
|
23672
23833
|
</details>
|
|
23673
23834
|
|
|
23674
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">
|
|
23835
|
+
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">forProviderOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
23675
23836
|
<dl>
|
|
23676
23837
|
<dd>
|
|
23677
23838
|
|
|
@@ -23683,7 +23844,7 @@ await client.shipping.taskGroups.expanded.forCoordinatorOperatorsV1("task_group_
|
|
|
23683
23844
|
<dl>
|
|
23684
23845
|
<dd>
|
|
23685
23846
|
|
|
23686
|
-
Retrieves an expanded task group
|
|
23847
|
+
Retrieves an expanded task group when the caller's provider org is its coordinator, executor, or both. Coordinator-only callers receive empty executor_org_notes; executor-only callers receive empty coordinator_shipper_account_ids. Executor notes are limited to the caller's org. | authz_personas=[coordinator_org_operators, executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
23687
23848
|
|
|
23688
23849
|
</dd>
|
|
23689
23850
|
</dl>
|
|
@@ -23699,78 +23860,7 @@ Retrieves an expanded task group with optional related data for the driver assig
|
|
|
23699
23860
|
<dd>
|
|
23700
23861
|
|
|
23701
23862
|
```typescript
|
|
23702
|
-
await client.shipping.taskGroups.expanded.
|
|
23703
|
-
```
|
|
23704
|
-
|
|
23705
|
-
</dd>
|
|
23706
|
-
</dl>
|
|
23707
|
-
</dd>
|
|
23708
|
-
</dl>
|
|
23709
|
-
|
|
23710
|
-
#### ⚙️ Parameters
|
|
23711
|
-
|
|
23712
|
-
<dl>
|
|
23713
|
-
<dd>
|
|
23714
|
-
|
|
23715
|
-
<dl>
|
|
23716
|
-
<dd>
|
|
23717
|
-
|
|
23718
|
-
**taskGroupId:** `string`
|
|
23719
|
-
|
|
23720
|
-
</dd>
|
|
23721
|
-
</dl>
|
|
23722
|
-
|
|
23723
|
-
<dl>
|
|
23724
|
-
<dd>
|
|
23725
|
-
|
|
23726
|
-
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
23727
|
-
|
|
23728
|
-
</dd>
|
|
23729
|
-
</dl>
|
|
23730
|
-
|
|
23731
|
-
<dl>
|
|
23732
|
-
<dd>
|
|
23733
|
-
|
|
23734
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
23735
|
-
|
|
23736
|
-
</dd>
|
|
23737
|
-
</dl>
|
|
23738
|
-
</dd>
|
|
23739
|
-
</dl>
|
|
23740
|
-
|
|
23741
|
-
</dd>
|
|
23742
|
-
</dl>
|
|
23743
|
-
</details>
|
|
23744
|
-
|
|
23745
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">forExecutorOperatorsV1</a>(taskGroupId, { ...params }) -> Chrt.TaskGroupExpanded</code></summary>
|
|
23746
|
-
<dl>
|
|
23747
|
-
<dd>
|
|
23748
|
-
|
|
23749
|
-
#### 📝 Description
|
|
23750
|
-
|
|
23751
|
-
<dl>
|
|
23752
|
-
<dd>
|
|
23753
|
-
|
|
23754
|
-
<dl>
|
|
23755
|
-
<dd>
|
|
23756
|
-
|
|
23757
|
-
Retrieves an expanded task group with optional related data for executor operators (the provider org doing the work on this task group). | authz_personas=[executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)
|
|
23758
|
-
|
|
23759
|
-
</dd>
|
|
23760
|
-
</dl>
|
|
23761
|
-
</dd>
|
|
23762
|
-
</dl>
|
|
23763
|
-
|
|
23764
|
-
#### 🔌 Usage
|
|
23765
|
-
|
|
23766
|
-
<dl>
|
|
23767
|
-
<dd>
|
|
23768
|
-
|
|
23769
|
-
<dl>
|
|
23770
|
-
<dd>
|
|
23771
|
-
|
|
23772
|
-
```typescript
|
|
23773
|
-
await client.shipping.taskGroups.expanded.forExecutorOperatorsV1("task_group_id", {});
|
|
23863
|
+
await client.shipping.taskGroups.expanded.forProviderOperatorsV1("task_group_id", {});
|
|
23774
23864
|
```
|
|
23775
23865
|
|
|
23776
23866
|
</dd>
|
|
@@ -23884,7 +23974,7 @@ await client.shipping.taskGroups.expanded.forShipperOperatorsV1("task_group_id",
|
|
|
23884
23974
|
</dl>
|
|
23885
23975
|
</details>
|
|
23886
23976
|
|
|
23887
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">
|
|
23977
|
+
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">listForDriverV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
23888
23978
|
<dl>
|
|
23889
23979
|
<dd>
|
|
23890
23980
|
|
|
@@ -23912,7 +24002,7 @@ Lists expanded task groups assigned to the caller (a driver of the executor prov
|
|
|
23912
24002
|
<dd>
|
|
23913
24003
|
|
|
23914
24004
|
```typescript
|
|
23915
|
-
await client.shipping.taskGroups.expanded.
|
|
24005
|
+
await client.shipping.taskGroups.expanded.listForDriverV1({
|
|
23916
24006
|
sort_by: "draft_started_at_timestamp",
|
|
23917
24007
|
sort_order: "asc",
|
|
23918
24008
|
page: 1,
|
|
@@ -23952,7 +24042,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
23952
24042
|
<dl>
|
|
23953
24043
|
<dd>
|
|
23954
24044
|
|
|
23955
|
-
**request:** `Chrt.shipping.taskGroups.
|
|
24045
|
+
**request:** `Chrt.shipping.taskGroups.ExpandedListForDriverV1Request`
|
|
23956
24046
|
|
|
23957
24047
|
</dd>
|
|
23958
24048
|
</dl>
|
|
@@ -23971,7 +24061,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
23971
24061
|
</dl>
|
|
23972
24062
|
</details>
|
|
23973
24063
|
|
|
23974
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">
|
|
24064
|
+
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">listForProviderOperatorsV1</a>({ ...params }) -> Chrt.TaskGroupExpandedListRes</code></summary>
|
|
23975
24065
|
<dl>
|
|
23976
24066
|
<dd>
|
|
23977
24067
|
|
|
@@ -23983,7 +24073,7 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
23983
24073
|
<dl>
|
|
23984
24074
|
<dd>
|
|
23985
24075
|
|
|
23986
|
-
Lists expanded task groups where the caller's provider org is the executor. Filtering, sorting, pagination, optional full-text search. |
|
|
24076
|
+
Lists expanded task groups where the caller's provider org is the coordinator, executor, or both. Filtering, sorting, pagination, optional full-text search. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpandedListRes)
|
|
23987
24077
|
|
|
23988
24078
|
</dd>
|
|
23989
24079
|
</dl>
|
|
@@ -23999,7 +24089,8 @@ Lists expanded task groups where the caller's provider org is the executor. Filt
|
|
|
23999
24089
|
<dd>
|
|
24000
24090
|
|
|
24001
24091
|
```typescript
|
|
24002
|
-
await client.shipping.taskGroups.expanded.
|
|
24092
|
+
await client.shipping.taskGroups.expanded.listForProviderOperatorsV1({
|
|
24093
|
+
provider_role: "all",
|
|
24003
24094
|
sort_by: "draft_started_at_timestamp",
|
|
24004
24095
|
sort_order: "asc",
|
|
24005
24096
|
page: 1,
|
|
@@ -24040,7 +24131,7 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
24040
24131
|
<dl>
|
|
24041
24132
|
<dd>
|
|
24042
24133
|
|
|
24043
|
-
**request:** `Chrt.shipping.taskGroups.
|
|
24134
|
+
**request:** `Chrt.shipping.taskGroups.ExpandedListForProviderOperatorsV1Request`
|
|
24044
24135
|
|
|
24045
24136
|
</dd>
|
|
24046
24137
|
</dl>
|
|
@@ -24325,7 +24416,7 @@ await client.shipping.taskGroups.s3Object.getV1("task_group_s3_object_metadata_i
|
|
|
24325
24416
|
|
|
24326
24417
|
## Shipping TaskGroups TaskGroupId
|
|
24327
24418
|
|
|
24328
|
-
<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">
|
|
24419
|
+
<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forDriverV1</a>(orderRef) -> string[]</code></summary>
|
|
24329
24420
|
<dl>
|
|
24330
24421
|
<dd>
|
|
24331
24422
|
|
|
@@ -24353,7 +24444,7 @@ Retrieves the task group IDs assigned to the caller (a driver of the executor pr
|
|
|
24353
24444
|
<dd>
|
|
24354
24445
|
|
|
24355
24446
|
```typescript
|
|
24356
|
-
await client.shipping.taskGroups.taskGroupId.
|
|
24447
|
+
await client.shipping.taskGroups.taskGroupId.forDriverV1("order_ref");
|
|
24357
24448
|
```
|
|
24358
24449
|
|
|
24359
24450
|
</dd>
|
|
@@ -24388,7 +24479,7 @@ await client.shipping.taskGroups.taskGroupId.forDriverForExecutorV1("order_ref")
|
|
|
24388
24479
|
</dl>
|
|
24389
24480
|
</details>
|
|
24390
24481
|
|
|
24391
|
-
<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">
|
|
24482
|
+
<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forProviderOperatorsV1</a>(orderRef, { ...params }) -> string[]</code></summary>
|
|
24392
24483
|
<dl>
|
|
24393
24484
|
<dd>
|
|
24394
24485
|
|
|
@@ -24400,7 +24491,7 @@ await client.shipping.taskGroups.taskGroupId.forDriverForExecutorV1("order_ref")
|
|
|
24400
24491
|
<dl>
|
|
24401
24492
|
<dd>
|
|
24402
24493
|
|
|
24403
|
-
Retrieves
|
|
24494
|
+
Retrieves task group IDs where the caller's provider org is the coordinator, executor, or both. | authz_personas=[coordinator_org_operators, executor_org_operators] | () -> (list[PydanticObjectId])
|
|
24404
24495
|
|
|
24405
24496
|
</dd>
|
|
24406
24497
|
</dl>
|
|
@@ -24416,7 +24507,9 @@ Retrieves the task group IDs where the caller's provider org is the executor for
|
|
|
24416
24507
|
<dd>
|
|
24417
24508
|
|
|
24418
24509
|
```typescript
|
|
24419
|
-
await client.shipping.taskGroups.taskGroupId.
|
|
24510
|
+
await client.shipping.taskGroups.taskGroupId.forProviderOperatorsV1("order_ref", {
|
|
24511
|
+
provider_role: "all",
|
|
24512
|
+
});
|
|
24420
24513
|
```
|
|
24421
24514
|
|
|
24422
24515
|
</dd>
|
|
@@ -24440,6 +24533,14 @@ await client.shipping.taskGroups.taskGroupId.forExecutorOperatorsV1("order_ref")
|
|
|
24440
24533
|
<dl>
|
|
24441
24534
|
<dd>
|
|
24442
24535
|
|
|
24536
|
+
**request:** `Chrt.shipping.taskGroups.TaskGroupIdForProviderOperatorsV1Request`
|
|
24537
|
+
|
|
24538
|
+
</dd>
|
|
24539
|
+
</dl>
|
|
24540
|
+
|
|
24541
|
+
<dl>
|
|
24542
|
+
<dd>
|
|
24543
|
+
|
|
24443
24544
|
**requestOptions:** `TaskGroupId.RequestOptions`
|
|
24444
24545
|
|
|
24445
24546
|
</dd>
|
|
@@ -27106,7 +27207,7 @@ await client.tracking.timeseries.sessionByDevice.outlierV1({
|
|
|
27106
27207
|
|
|
27107
27208
|
## Tracking Timeseries TaskGroupByDriver
|
|
27108
27209
|
|
|
27109
|
-
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.
|
|
27210
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">dataPointsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverDataPointsRes</code></summary>
|
|
27110
27211
|
<dl>
|
|
27111
27212
|
<dd>
|
|
27112
27213
|
|
|
@@ -27118,7 +27219,7 @@ await client.tracking.timeseries.sessionByDevice.outlierV1({
|
|
|
27118
27219
|
<dl>
|
|
27119
27220
|
<dd>
|
|
27120
27221
|
|
|
27121
|
-
Returns sampled driver location data points for a task group. Excludes outliers. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (
|
|
27222
|
+
Returns sampled driver location data points and the unique drivers for a task group. Excludes outliers. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (TaskGroupByDriverDataPointsRes)
|
|
27122
27223
|
|
|
27123
27224
|
</dd>
|
|
27124
27225
|
</dl>
|
|
@@ -27238,7 +27339,7 @@ await client.tracking.timeseries.taskGroupByDriver.dataPointsPublicV1({
|
|
|
27238
27339
|
</dl>
|
|
27239
27340
|
</details>
|
|
27240
27341
|
|
|
27241
|
-
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.
|
|
27342
|
+
<details><summary><code>client.tracking.timeseries.taskGroupByDriver.<a href="/src/api/resources/tracking/resources/timeseries/resources/taskGroupByDriver/client/Client.ts">lastSeenV1</a>({ ...params }) -> (Chrt.TaskGroupByDriverLastSeenRes | null) | undefined</code></summary>
|
|
27242
27343
|
<dl>
|
|
27243
27344
|
<dd>
|
|
27244
27345
|
|
|
@@ -27250,7 +27351,7 @@ await client.tracking.timeseries.taskGroupByDriver.dataPointsPublicV1({
|
|
|
27250
27351
|
<dl>
|
|
27251
27352
|
<dd>
|
|
27252
27353
|
|
|
27253
|
-
Returns the most recent driver location data point for a task group. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (
|
|
27354
|
+
Returns the most recent driver location data point and driver for a task group. | auth: api_key | authz_personas=[coordinator_org_operators, shipper_org_operators, executor_org_operators, driver_for_executor] | () -> (TaskGroupByDriverLastSeenRes | None)
|
|
27254
27355
|
|
|
27255
27356
|
</dd>
|
|
27256
27357
|
</dl>
|