@chrt-inc/typescript-sdk 1.641.0 → 1.651.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/README.md +8 -8
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billing/resources/rateSheetMappings/client/Client.d.ts +19 -0
- package/dist/cjs/api/resources/billing/resources/rateSheetMappings/client/Client.js +79 -0
- package/dist/cjs/api/resources/billing/resources/rateSheetMappings/client/requests/RateSheetMappingsListRateSheetIdsByCounterpartyV1Request.d.ts +18 -0
- package/dist/cjs/api/resources/billing/resources/rateSheetMappings/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/stripe/client/Client.d.ts +7 -6
- package/dist/cjs/api/resources/billing/resources/stripe/client/Client.js +11 -10
- package/dist/cjs/api/resources/billing/resources/stripe/client/requests/CreateCheckoutSessionReq.d.ts +4 -3
- package/dist/cjs/api/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/index.js +2 -2
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/orgs/client/Client.js +8 -8
- package/dist/{esm/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.mts → cjs/api/resources/orgs/client/requests/SetupOrgReq.d.ts} +6 -2
- package/dist/cjs/api/resources/orgs/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.d.ts +0 -13
- package/dist/cjs/api/resources/orgs/resources/publicData/client/Client.js +0 -62
- package/dist/cjs/api/resources/orgs/resources/publicData/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/index.js +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +4 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +16 -11
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/index.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/index.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.d.ts +55 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.js +199 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/client/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/agentic/index.js +18 -0
- package/dist/cjs/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/OrderBuilderStreamEvent.d.ts +1 -3
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +110 -26
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +416 -56
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleClientCreate1.d.ts +20 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleClientUpdate1.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +40 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/index.js +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.js +37 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.d.ts +47 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.js +130 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/orderManifest/index.js +17 -0
- package/dist/cjs/api/resources/utils/index.d.ts +1 -1
- package/dist/cjs/api/resources/utils/index.js +1 -1
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.d.ts +0 -36
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.js +0 -195
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/utils/resources/dev/index.d.ts +0 -1
- package/dist/cjs/api/resources/utils/resources/dev/index.js +0 -1
- package/dist/cjs/api/resources/utils/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/utils/resources/index.js +0 -1
- package/dist/cjs/api/types/Cargo1.d.ts +4 -1
- package/dist/cjs/api/types/CargoManifest1.d.ts +19 -0
- package/dist/cjs/api/types/CreateCustomerPortalSessionRes.d.ts +6 -0
- package/dist/cjs/api/types/Order1.d.ts +3 -1
- package/dist/cjs/api/types/OrderDraftValidationRequirements.d.ts +13 -0
- package/dist/cjs/api/types/OrderDraftValidationResult.d.ts +1 -1
- package/dist/cjs/api/types/OrderManifest1.d.ts +19 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.d.ts +12 -0
- package/dist/cjs/api/types/OrderManifestValidationResult.d.ts +8 -0
- package/dist/cjs/api/types/OrderSchedule1.d.ts +24 -0
- package/dist/cjs/api/types/OrderSchedule1.js +5 -0
- package/dist/cjs/api/types/OrderScheduleAboutRes.d.ts +9 -0
- package/dist/cjs/api/types/OrderScheduleAboutRes.js +5 -0
- package/dist/cjs/api/types/OrderScheduleListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderScheduleListRes.js +5 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleActionResult.d.ts +8 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleActionResult.js +5 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatus.d.ts +12 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatus.js +5 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.ts +10 -0
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.js +12 -0
- package/dist/cjs/api/types/OrderScheduleSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/OrderScheduleSortByEnum.js +12 -0
- package/dist/cjs/api/types/OrderScheduleStatusEnum1.d.ts +10 -0
- package/dist/cjs/api/types/OrderScheduleStatusEnum1.js +12 -0
- package/dist/cjs/api/types/OrgPrivateData1.d.ts +1 -0
- package/dist/cjs/api/types/ScheduledOrdersNewDraftReq.d.ts +9 -0
- package/dist/cjs/api/types/ScheduledOrdersNewDraftReq.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +4 -1
- package/dist/cjs/api/types/TaskArtifact1.d.ts +4 -1
- package/dist/cjs/api/types/TaskGroup1.d.ts +4 -1
- package/dist/cjs/api/types/TaskGroupManifest1.d.ts +14 -0
- package/dist/cjs/api/types/TaskGroupManifest1.js +5 -0
- package/dist/cjs/api/types/TaskManifest1.d.ts +17 -0
- package/dist/cjs/api/types/TaskManifest1.js +5 -0
- package/dist/cjs/api/types/UserPrivateData1.d.ts +0 -1
- package/dist/cjs/api/types/index.d.ts +17 -7
- package/dist/cjs/api/types/index.js +17 -7
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/billing/resources/rateSheetMappings/client/Client.d.mts +19 -0
- package/dist/esm/api/resources/billing/resources/rateSheetMappings/client/Client.mjs +79 -0
- package/dist/esm/api/resources/billing/resources/rateSheetMappings/client/requests/RateSheetMappingsListRateSheetIdsByCounterpartyV1Request.d.mts +18 -0
- package/dist/esm/api/resources/billing/resources/rateSheetMappings/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/stripe/client/Client.d.mts +7 -6
- package/dist/esm/api/resources/billing/resources/stripe/client/Client.mjs +11 -10
- package/dist/esm/api/resources/billing/resources/stripe/client/requests/CreateCheckoutSessionReq.d.mts +4 -3
- package/dist/esm/api/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/index.mjs +1 -1
- package/dist/esm/api/resources/orgs/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/orgs/client/Client.mjs +8 -8
- package/dist/{cjs/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.ts → esm/api/resources/orgs/client/requests/SetupOrgReq.d.mts} +6 -2
- package/dist/esm/api/resources/orgs/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.d.mts +0 -13
- package/dist/esm/api/resources/orgs/resources/publicData/client/Client.mjs +0 -62
- package/dist/esm/api/resources/orgs/resources/publicData/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +4 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +6 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/index.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.d.mts +55 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.mjs +162 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/agentic/index.mjs +2 -0
- package/dist/esm/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/OrderBuilderStreamEvent.d.mts +1 -3
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +110 -26
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +416 -56
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleClientCreate1.d.mts +20 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleClientUpdate1.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +40 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/orderSchedules/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.d.mts +47 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.mjs +93 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/orderManifest/index.mjs +1 -0
- package/dist/esm/api/resources/utils/index.d.mts +1 -1
- package/dist/esm/api/resources/utils/index.mjs +1 -1
- package/dist/esm/api/resources/utils/resources/dev/client/Client.d.mts +0 -36
- package/dist/esm/api/resources/utils/resources/dev/client/Client.mjs +0 -195
- package/dist/esm/api/resources/utils/resources/dev/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/utils/resources/dev/index.d.mts +0 -1
- package/dist/esm/api/resources/utils/resources/dev/index.mjs +0 -1
- package/dist/esm/api/resources/utils/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/utils/resources/index.mjs +0 -1
- package/dist/esm/api/types/Cargo1.d.mts +4 -1
- package/dist/esm/api/types/CargoManifest1.d.mts +19 -0
- package/dist/esm/api/types/CreateCustomerPortalSessionRes.d.mts +6 -0
- package/dist/esm/api/types/Order1.d.mts +3 -1
- package/dist/esm/api/types/OrderDraftValidationRequirements.d.mts +13 -0
- package/dist/esm/api/types/OrderDraftValidationResult.d.mts +1 -1
- package/dist/esm/api/types/OrderManifest1.d.mts +19 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.d.mts +12 -0
- package/dist/esm/api/types/OrderManifestValidationResult.d.mts +8 -0
- package/dist/esm/api/types/OrderSchedule1.d.mts +24 -0
- package/dist/esm/api/types/OrderSchedule1.mjs +4 -0
- package/dist/esm/api/types/OrderScheduleAboutRes.d.mts +9 -0
- package/dist/esm/api/types/OrderScheduleAboutRes.mjs +4 -0
- package/dist/esm/api/types/OrderScheduleListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderScheduleListRes.mjs +4 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleActionResult.d.mts +8 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleActionResult.mjs +4 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatus.d.mts +12 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatus.mjs +4 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.mts +10 -0
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.mjs +9 -0
- package/dist/esm/api/types/OrderScheduleSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/OrderScheduleSortByEnum.mjs +9 -0
- package/dist/esm/api/types/OrderScheduleStatusEnum1.d.mts +10 -0
- package/dist/esm/api/types/OrderScheduleStatusEnum1.mjs +9 -0
- package/dist/esm/api/types/OrgPrivateData1.d.mts +1 -0
- package/dist/esm/api/types/ScheduledOrdersNewDraftReq.d.mts +9 -0
- package/dist/esm/api/types/ScheduledOrdersNewDraftReq.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +4 -1
- package/dist/esm/api/types/TaskArtifact1.d.mts +4 -1
- package/dist/esm/api/types/TaskGroup1.d.mts +4 -1
- package/dist/esm/api/types/TaskGroupManifest1.d.mts +14 -0
- package/dist/esm/api/types/TaskGroupManifest1.mjs +4 -0
- package/dist/esm/api/types/TaskManifest1.d.mts +17 -0
- package/dist/esm/api/types/TaskManifest1.mjs +4 -0
- package/dist/esm/api/types/UserPrivateData1.d.mts +0 -1
- package/dist/esm/api/types/index.d.mts +17 -7
- package/dist/esm/api/types/index.mjs +17 -7
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +722 -370
- package/dist/cjs/api/resources/orgs/client/requests/SetOrgTypeReq.d.ts +0 -13
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleCreateReq.d.ts +0 -12
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleRoundTripModelTestReq.d.ts +0 -12
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleUpdateReq.d.ts +0 -10
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/ReadOrderAgentReq.d.ts +0 -12
- package/dist/cjs/api/types/CreateOrgPublicDataRes.d.ts +0 -7
- package/dist/cjs/api/types/OrderDraftIssueCategoryEnum.d.ts +0 -11
- package/dist/cjs/api/types/OrderDraftIssueCategoryEnum.js +0 -13
- package/dist/cjs/api/types/OrderDraftValidationIssue.d.ts +0 -12
- package/dist/cjs/api/types/OrderScheduleRoundTripModelTestRes.d.ts +0 -11
- package/dist/cjs/api/types/OrderScheduleStub.d.ts +0 -7
- package/dist/cjs/api/types/PriceNameEnum.d.ts +0 -9
- package/dist/cjs/api/types/PriceNameEnum.js +0 -11
- package/dist/cjs/api/types/ReadOrderAgentRes.d.ts +0 -8
- package/dist/esm/api/resources/orgs/client/requests/SetOrgTypeReq.d.mts +0 -13
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleCreateReq.d.mts +0 -12
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleRoundTripModelTestReq.d.mts +0 -12
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderScheduleUpdateReq.d.mts +0 -10
- package/dist/esm/api/resources/utils/resources/dev/client/requests/ReadOrderAgentReq.d.mts +0 -12
- package/dist/esm/api/types/CreateOrgPublicDataRes.d.mts +0 -7
- package/dist/esm/api/types/OrderDraftIssueCategoryEnum.d.mts +0 -11
- package/dist/esm/api/types/OrderDraftIssueCategoryEnum.mjs +0 -10
- package/dist/esm/api/types/OrderDraftValidationIssue.d.mts +0 -12
- package/dist/esm/api/types/OrderScheduleRoundTripModelTestRes.d.mts +0 -11
- package/dist/esm/api/types/OrderScheduleStub.d.mts +0 -7
- package/dist/esm/api/types/PriceNameEnum.d.mts +0 -9
- package/dist/esm/api/types/PriceNameEnum.mjs +0 -8
- package/dist/esm/api/types/ReadOrderAgentRes.d.mts +0 -8
- /package/dist/cjs/api/resources/{orgs/client/requests/SetOrgTypeReq.js → billing/resources/rateSheetMappings/client/requests/RateSheetMappingsListRateSheetIdsByCounterpartyV1Request.js} +0 -0
- /package/dist/cjs/api/resources/orgs/{resources/publicData/client/requests/CreateOrgPublicDataReq.js → client/requests/SetupOrgReq.js} +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/OrderBuilderStreamEvent.js +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/index.js +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleCreateReq.js → OrderScheduleClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleRoundTripModelTestReq.js → OrderScheduleClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleUpdateReq.js → OrderSchedulesListV1Request.js} +0 -0
- /package/dist/cjs/api/{resources/utils/resources/dev/client/requests/ReadOrderAgentReq.js → types/CargoManifest1.js} +0 -0
- /package/dist/cjs/api/types/{CreateOrgPublicDataRes.js → CreateCustomerPortalSessionRes.js} +0 -0
- /package/dist/cjs/api/types/{OrderDraftValidationIssue.js → OrderDraftValidationRequirements.js} +0 -0
- /package/dist/cjs/api/types/{OrderScheduleRoundTripModelTestRes.js → OrderManifest1.js} +0 -0
- /package/dist/cjs/api/types/{OrderScheduleStub.js → OrderManifestValidationRequirements.js} +0 -0
- /package/dist/cjs/api/types/{ReadOrderAgentRes.js → OrderManifestValidationResult.js} +0 -0
- /package/dist/esm/api/resources/{orgs/client/requests/SetOrgTypeReq.mjs → billing/resources/rateSheetMappings/client/requests/RateSheetMappingsListRateSheetIdsByCounterpartyV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/orgs/{resources/publicData/client/requests/CreateOrgPublicDataReq.mjs → client/requests/SetupOrgReq.mjs} +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/OrderBuilderStreamEvent.mjs +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/index.d.mts +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev → shipping/resources/orderDrafts/resources/agentic}/types/index.mjs +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleCreateReq.mjs → OrderScheduleClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleRoundTripModelTestReq.mjs → OrderScheduleClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/{OrderScheduleUpdateReq.mjs → OrderSchedulesListV1Request.mjs} +0 -0
- /package/dist/esm/api/{resources/utils/resources/dev/client/requests/ReadOrderAgentReq.mjs → types/CargoManifest1.mjs} +0 -0
- /package/dist/esm/api/types/{CreateOrgPublicDataRes.mjs → CreateCustomerPortalSessionRes.mjs} +0 -0
- /package/dist/esm/api/types/{OrderDraftValidationIssue.mjs → OrderDraftValidationRequirements.mjs} +0 -0
- /package/dist/esm/api/types/{OrderScheduleRoundTripModelTestRes.mjs → OrderManifest1.mjs} +0 -0
- /package/dist/esm/api/types/{OrderScheduleStub.mjs → OrderManifestValidationRequirements.mjs} +0 -0
- /package/dist/esm/api/types/{ReadOrderAgentRes.mjs → OrderManifestValidationResult.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -126,7 +126,7 @@ await client.orgs.listMembersV1({
|
|
|
126
126
|
</dl>
|
|
127
127
|
</details>
|
|
128
128
|
|
|
129
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">
|
|
129
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setupOrgV1</a>({ ...params }) -> boolean</code></summary>
|
|
130
130
|
<dl>
|
|
131
131
|
<dd>
|
|
132
132
|
|
|
@@ -138,7 +138,7 @@ await client.orgs.listMembersV1({
|
|
|
138
138
|
<dl>
|
|
139
139
|
<dd>
|
|
140
140
|
|
|
141
|
-
Sets
|
|
141
|
+
Single onboarding entry point. Sets `org_type` in Clerk's JWT public metadata (immutable once set) and idempotently creates `org_private_data` + `org_public_data` for the caller's organization. Optional `handle` and `company_name` populate the public doc on first call; later updates go through PATCH /orgs/org_public_data/v1. Returns True on success (including idempotent retries), 400 on org_type conflict or handle collision. | (SetupOrgReq) -> (bool)
|
|
142
142
|
|
|
143
143
|
</dd>
|
|
144
144
|
</dl>
|
|
@@ -154,7 +154,7 @@ Sets the org_type in Clerk's JWT public metadata. Returns True if already set an
|
|
|
154
154
|
<dd>
|
|
155
155
|
|
|
156
156
|
```typescript
|
|
157
|
-
await client.orgs.
|
|
157
|
+
await client.orgs.setupOrgV1({
|
|
158
158
|
org_type: "provider",
|
|
159
159
|
});
|
|
160
160
|
```
|
|
@@ -172,7 +172,7 @@ await client.orgs.setOrgTypeV1({
|
|
|
172
172
|
<dl>
|
|
173
173
|
<dd>
|
|
174
174
|
|
|
175
|
-
**request:** `Chrt.
|
|
175
|
+
**request:** `Chrt.SetupOrgReq`
|
|
176
176
|
|
|
177
177
|
</dd>
|
|
178
178
|
</dl>
|
|
@@ -3529,6 +3529,82 @@ await client.billing.rateSheetMappings.listV1({
|
|
|
3529
3529
|
</dl>
|
|
3530
3530
|
</details>
|
|
3531
3531
|
|
|
3532
|
+
<details><summary><code>client.billing.rateSheetMappings.<a href="/src/api/resources/billing/resources/rateSheetMappings/client/Client.ts">listRateSheetIdsByCounterpartyV1</a>(tgType, { ...params }) -> string[]</code></summary>
|
|
3533
|
+
<dl>
|
|
3534
|
+
<dd>
|
|
3535
|
+
|
|
3536
|
+
#### 📝 Description
|
|
3537
|
+
|
|
3538
|
+
<dl>
|
|
3539
|
+
<dd>
|
|
3540
|
+
|
|
3541
|
+
<dl>
|
|
3542
|
+
<dd>
|
|
3543
|
+
|
|
3544
|
+
Lists rate sheet IDs mapped to a counterparty for the requested task group type. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[PydanticObjectId])
|
|
3545
|
+
|
|
3546
|
+
</dd>
|
|
3547
|
+
</dl>
|
|
3548
|
+
</dd>
|
|
3549
|
+
</dl>
|
|
3550
|
+
|
|
3551
|
+
#### 🔌 Usage
|
|
3552
|
+
|
|
3553
|
+
<dl>
|
|
3554
|
+
<dd>
|
|
3555
|
+
|
|
3556
|
+
<dl>
|
|
3557
|
+
<dd>
|
|
3558
|
+
|
|
3559
|
+
```typescript
|
|
3560
|
+
await client.billing.rateSheetMappings.listRateSheetIdsByCounterpartyV1("chrt_ground_provider", {
|
|
3561
|
+
counterparty_org_id: "counterparty_org_id",
|
|
3562
|
+
counterparty_driver_id: "counterparty_driver_id",
|
|
3563
|
+
counterparty_off_chrt_provider_org_id: "counterparty_off_chrt_provider_org_id",
|
|
3564
|
+
counterparty_off_chrt_shipper_org_id: "counterparty_off_chrt_shipper_org_id",
|
|
3565
|
+
});
|
|
3566
|
+
```
|
|
3567
|
+
|
|
3568
|
+
</dd>
|
|
3569
|
+
</dl>
|
|
3570
|
+
</dd>
|
|
3571
|
+
</dl>
|
|
3572
|
+
|
|
3573
|
+
#### ⚙️ Parameters
|
|
3574
|
+
|
|
3575
|
+
<dl>
|
|
3576
|
+
<dd>
|
|
3577
|
+
|
|
3578
|
+
<dl>
|
|
3579
|
+
<dd>
|
|
3580
|
+
|
|
3581
|
+
**tgType:** `Chrt.TaskGroupTypeEnum1`
|
|
3582
|
+
|
|
3583
|
+
</dd>
|
|
3584
|
+
</dl>
|
|
3585
|
+
|
|
3586
|
+
<dl>
|
|
3587
|
+
<dd>
|
|
3588
|
+
|
|
3589
|
+
**request:** `Chrt.billing.RateSheetMappingsListRateSheetIdsByCounterpartyV1Request`
|
|
3590
|
+
|
|
3591
|
+
</dd>
|
|
3592
|
+
</dl>
|
|
3593
|
+
|
|
3594
|
+
<dl>
|
|
3595
|
+
<dd>
|
|
3596
|
+
|
|
3597
|
+
**requestOptions:** `RateSheetMappings.RequestOptions`
|
|
3598
|
+
|
|
3599
|
+
</dd>
|
|
3600
|
+
</dl>
|
|
3601
|
+
</dd>
|
|
3602
|
+
</dl>
|
|
3603
|
+
|
|
3604
|
+
</dd>
|
|
3605
|
+
</dl>
|
|
3606
|
+
</details>
|
|
3607
|
+
|
|
3532
3608
|
<details><summary><code>client.billing.rateSheetMappings.<a href="/src/api/resources/billing/resources/rateSheetMappings/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
3533
3609
|
<dl>
|
|
3534
3610
|
<dd>
|
|
@@ -5132,7 +5208,7 @@ await client.billing.statements.deleteV1("statement_id");
|
|
|
5132
5208
|
<dl>
|
|
5133
5209
|
<dd>
|
|
5134
5210
|
|
|
5135
|
-
Creates a Stripe checkout session for a subscription
|
|
5211
|
+
Creates a Stripe checkout session for a subscription against the Stripe product+price chosen by the frontend. Stripe rejects unknown/archived/mode-mismatched price IDs. Returns 409 `use_create_customer_portal_session` if the org already has an active subscription in Stripe (source of truth -- bypasses any JWT staleness). FE should route those users to POST /billing/create-customer-portal-session/v1 to manage. authz: allowed_org_types=[provider] (shippers cannot subscribe -- they are never gated, paying would be a no-op), min_org_role=administrator (committing the company to recurring charges is a finance decision, not an operator one). | (CreateCheckoutSessionReq) -> (CreateCheckoutSessionRes)
|
|
5136
5212
|
|
|
5137
5213
|
</dd>
|
|
5138
5214
|
</dl>
|
|
@@ -5149,7 +5225,8 @@ Creates a Stripe checkout session for a subscription with pricing based on the s
|
|
|
5149
5225
|
|
|
5150
5226
|
```typescript
|
|
5151
5227
|
await client.billing.stripe.createCheckoutSessionV1({
|
|
5152
|
-
|
|
5228
|
+
product_id: "product_id",
|
|
5229
|
+
price_id: "price_id",
|
|
5153
5230
|
});
|
|
5154
5231
|
```
|
|
5155
5232
|
|
|
@@ -5185,7 +5262,7 @@ await client.billing.stripe.createCheckoutSessionV1({
|
|
|
5185
5262
|
</dl>
|
|
5186
5263
|
</details>
|
|
5187
5264
|
|
|
5188
|
-
<details><summary><code>client.billing.stripe.<a href="/src/api/resources/billing/resources/stripe/client/Client.ts">
|
|
5265
|
+
<details><summary><code>client.billing.stripe.<a href="/src/api/resources/billing/resources/stripe/client/Client.ts">createCustomerPortalSessionV1</a>() -> Chrt.CreateCustomerPortalSessionRes</code></summary>
|
|
5189
5266
|
<dl>
|
|
5190
5267
|
<dd>
|
|
5191
5268
|
|
|
@@ -5197,7 +5274,7 @@ await client.billing.stripe.createCheckoutSessionV1({
|
|
|
5197
5274
|
<dl>
|
|
5198
5275
|
<dd>
|
|
5199
5276
|
|
|
5200
|
-
|
|
5277
|
+
Creates a Stripe customer-portal session so the org's admin can self-serve update card / view invoices / cancel subscription. authz: allowed_org_types=[provider], min_org_role=administrator (same gate as create-checkout-session — cancelling/updating-card has the same financial weight as subscribing). Returns 404 `use_create_checkout_session` if the org has no Stripe customer. POST /billing/create-checkout-session/v1 first. | (no body) -> (CreateCustomerPortalSessionRes)
|
|
5201
5278
|
|
|
5202
5279
|
</dd>
|
|
5203
5280
|
</dl>
|
|
@@ -5213,7 +5290,7 @@ Synchronizes subscription data from Stripe to the authentication service for the
|
|
|
5213
5290
|
<dd>
|
|
5214
5291
|
|
|
5215
5292
|
```typescript
|
|
5216
|
-
await client.billing.stripe.
|
|
5293
|
+
await client.billing.stripe.createCustomerPortalSessionV1();
|
|
5217
5294
|
```
|
|
5218
5295
|
|
|
5219
5296
|
</dd>
|
|
@@ -12885,69 +12962,6 @@ await client.orgs.publicData.getV1();
|
|
|
12885
12962
|
</dl>
|
|
12886
12963
|
</details>
|
|
12887
12964
|
|
|
12888
|
-
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">createV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
|
|
12889
|
-
<dl>
|
|
12890
|
-
<dd>
|
|
12891
|
-
|
|
12892
|
-
#### 📝 Description
|
|
12893
|
-
|
|
12894
|
-
<dl>
|
|
12895
|
-
<dd>
|
|
12896
|
-
|
|
12897
|
-
<dl>
|
|
12898
|
-
<dd>
|
|
12899
|
-
|
|
12900
|
-
Creates org_public_data and org_private_data documents for the caller's organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
|
|
12901
|
-
|
|
12902
|
-
</dd>
|
|
12903
|
-
</dl>
|
|
12904
|
-
</dd>
|
|
12905
|
-
</dl>
|
|
12906
|
-
|
|
12907
|
-
#### 🔌 Usage
|
|
12908
|
-
|
|
12909
|
-
<dl>
|
|
12910
|
-
<dd>
|
|
12911
|
-
|
|
12912
|
-
<dl>
|
|
12913
|
-
<dd>
|
|
12914
|
-
|
|
12915
|
-
```typescript
|
|
12916
|
-
await client.orgs.publicData.createV1();
|
|
12917
|
-
```
|
|
12918
|
-
|
|
12919
|
-
</dd>
|
|
12920
|
-
</dl>
|
|
12921
|
-
</dd>
|
|
12922
|
-
</dl>
|
|
12923
|
-
|
|
12924
|
-
#### ⚙️ Parameters
|
|
12925
|
-
|
|
12926
|
-
<dl>
|
|
12927
|
-
<dd>
|
|
12928
|
-
|
|
12929
|
-
<dl>
|
|
12930
|
-
<dd>
|
|
12931
|
-
|
|
12932
|
-
**request:** `Chrt.orgs.CreateOrgPublicDataReq`
|
|
12933
|
-
|
|
12934
|
-
</dd>
|
|
12935
|
-
</dl>
|
|
12936
|
-
|
|
12937
|
-
<dl>
|
|
12938
|
-
<dd>
|
|
12939
|
-
|
|
12940
|
-
**requestOptions:** `PublicData.RequestOptions`
|
|
12941
|
-
|
|
12942
|
-
</dd>
|
|
12943
|
-
</dl>
|
|
12944
|
-
</dd>
|
|
12945
|
-
</dl>
|
|
12946
|
-
|
|
12947
|
-
</dd>
|
|
12948
|
-
</dl>
|
|
12949
|
-
</details>
|
|
12950
|
-
|
|
12951
12965
|
<details><summary><code>client.orgs.publicData.<a href="/src/api/resources/orgs/resources/publicData/client/Client.ts">updateV1</a>({ ...params }) -> boolean</code></summary>
|
|
12952
12966
|
<dl>
|
|
12953
12967
|
<dd>
|
|
@@ -15044,7 +15058,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
15044
15058
|
<dl>
|
|
15045
15059
|
<dd>
|
|
15046
15060
|
|
|
15047
|
-
Validates the draft order for staging and returns
|
|
15061
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
15048
15062
|
|
|
15049
15063
|
</dd>
|
|
15050
15064
|
</dl>
|
|
@@ -15097,7 +15111,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
15097
15111
|
|
|
15098
15112
|
## Shipping OrderSchedules
|
|
15099
15113
|
|
|
15100
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15114
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
|
|
15101
15115
|
<dl>
|
|
15102
15116
|
<dd>
|
|
15103
15117
|
|
|
@@ -15109,7 +15123,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
15109
15123
|
<dl>
|
|
15110
15124
|
<dd>
|
|
15111
15125
|
|
|
15112
|
-
|
|
15126
|
+
Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
|
|
15113
15127
|
|
|
15114
15128
|
</dd>
|
|
15115
15129
|
</dl>
|
|
@@ -15125,7 +15139,17 @@ Retrieves an order schedule by ID. | () -> (OrderScheduleStub)
|
|
|
15125
15139
|
<dd>
|
|
15126
15140
|
|
|
15127
15141
|
```typescript
|
|
15128
|
-
await client.shipping.orderSchedules.
|
|
15142
|
+
await client.shipping.orderSchedules.listV1({
|
|
15143
|
+
sort_by: "created_at_timestamp",
|
|
15144
|
+
sort_order: "asc",
|
|
15145
|
+
page: 1,
|
|
15146
|
+
page_size: 1,
|
|
15147
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
15148
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
15149
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15150
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
15151
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15152
|
+
});
|
|
15129
15153
|
```
|
|
15130
15154
|
|
|
15131
15155
|
</dd>
|
|
@@ -15141,7 +15165,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
15141
15165
|
<dl>
|
|
15142
15166
|
<dd>
|
|
15143
15167
|
|
|
15144
|
-
**
|
|
15168
|
+
**request:** `Chrt.shipping.OrderSchedulesListV1Request`
|
|
15145
15169
|
|
|
15146
15170
|
</dd>
|
|
15147
15171
|
</dl>
|
|
@@ -15160,7 +15184,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
15160
15184
|
</dl>
|
|
15161
15185
|
</details>
|
|
15162
15186
|
|
|
15163
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15187
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
|
|
15164
15188
|
<dl>
|
|
15165
15189
|
<dd>
|
|
15166
15190
|
|
|
@@ -15172,7 +15196,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
15172
15196
|
<dl>
|
|
15173
15197
|
<dd>
|
|
15174
15198
|
|
|
15175
|
-
|
|
15199
|
+
Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
|
|
15176
15200
|
|
|
15177
15201
|
</dd>
|
|
15178
15202
|
</dl>
|
|
@@ -15188,7 +15212,7 @@ Lists order schedules for the caller's organization. | () -> (list[OrderSchedule
|
|
|
15188
15212
|
<dd>
|
|
15189
15213
|
|
|
15190
15214
|
```typescript
|
|
15191
|
-
await client.shipping.orderSchedules.
|
|
15215
|
+
await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
15192
15216
|
```
|
|
15193
15217
|
|
|
15194
15218
|
</dd>
|
|
@@ -15204,6 +15228,14 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15204
15228
|
<dl>
|
|
15205
15229
|
<dd>
|
|
15206
15230
|
|
|
15231
|
+
**orderScheduleId:** `string`
|
|
15232
|
+
|
|
15233
|
+
</dd>
|
|
15234
|
+
</dl>
|
|
15235
|
+
|
|
15236
|
+
<dl>
|
|
15237
|
+
<dd>
|
|
15238
|
+
|
|
15207
15239
|
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15208
15240
|
|
|
15209
15241
|
</dd>
|
|
@@ -15215,7 +15247,7 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15215
15247
|
</dl>
|
|
15216
15248
|
</details>
|
|
15217
15249
|
|
|
15218
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15250
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
|
|
15219
15251
|
<dl>
|
|
15220
15252
|
<dd>
|
|
15221
15253
|
|
|
@@ -15227,7 +15259,7 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15227
15259
|
<dl>
|
|
15228
15260
|
<dd>
|
|
15229
15261
|
|
|
15230
|
-
|
|
15262
|
+
Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
15231
15263
|
|
|
15232
15264
|
</dd>
|
|
15233
15265
|
</dl>
|
|
@@ -15243,9 +15275,7 @@ Creates an order schedule. | (OrderScheduleCreateReq) -> (PydanticObjectId)
|
|
|
15243
15275
|
<dd>
|
|
15244
15276
|
|
|
15245
15277
|
```typescript
|
|
15246
|
-
await client.shipping.orderSchedules.
|
|
15247
|
-
name: "name",
|
|
15248
|
-
});
|
|
15278
|
+
await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
15249
15279
|
```
|
|
15250
15280
|
|
|
15251
15281
|
</dd>
|
|
@@ -15261,7 +15291,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15261
15291
|
<dl>
|
|
15262
15292
|
<dd>
|
|
15263
15293
|
|
|
15264
|
-
**
|
|
15294
|
+
**orderScheduleId:** `string`
|
|
15265
15295
|
|
|
15266
15296
|
</dd>
|
|
15267
15297
|
</dl>
|
|
@@ -15280,7 +15310,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15280
15310
|
</dl>
|
|
15281
15311
|
</details>
|
|
15282
15312
|
|
|
15283
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15313
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
15284
15314
|
<dl>
|
|
15285
15315
|
<dd>
|
|
15286
15316
|
|
|
@@ -15292,7 +15322,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15292
15322
|
<dl>
|
|
15293
15323
|
<dd>
|
|
15294
15324
|
|
|
15295
|
-
|
|
15325
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
15296
15326
|
|
|
15297
15327
|
</dd>
|
|
15298
15328
|
</dl>
|
|
@@ -15308,7 +15338,12 @@ Echoes Temporal schedule specs to test SDK round trips. | (OrderScheduleRoundTri
|
|
|
15308
15338
|
<dd>
|
|
15309
15339
|
|
|
15310
15340
|
```typescript
|
|
15311
|
-
await client.shipping.orderSchedules.
|
|
15341
|
+
await client.shipping.orderSchedules.newV1({
|
|
15342
|
+
schema_version: 1,
|
|
15343
|
+
name: "name",
|
|
15344
|
+
order_manifest: {},
|
|
15345
|
+
schedule_spec: {},
|
|
15346
|
+
});
|
|
15312
15347
|
```
|
|
15313
15348
|
|
|
15314
15349
|
</dd>
|
|
@@ -15324,7 +15359,7 @@ await client.shipping.orderSchedules.roundTripModelTestV1();
|
|
|
15324
15359
|
<dl>
|
|
15325
15360
|
<dd>
|
|
15326
15361
|
|
|
15327
|
-
**request:** `Chrt.shipping.
|
|
15362
|
+
**request:** `Chrt.shipping.OrderScheduleClientCreate1`
|
|
15328
15363
|
|
|
15329
15364
|
</dd>
|
|
15330
15365
|
</dl>
|
|
@@ -15355,7 +15390,7 @@ await client.shipping.orderSchedules.roundTripModelTestV1();
|
|
|
15355
15390
|
<dl>
|
|
15356
15391
|
<dd>
|
|
15357
15392
|
|
|
15358
|
-
Updates an order schedule. | (
|
|
15393
|
+
Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
15359
15394
|
|
|
15360
15395
|
</dd>
|
|
15361
15396
|
</dl>
|
|
@@ -15395,7 +15430,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15395
15430
|
<dl>
|
|
15396
15431
|
<dd>
|
|
15397
15432
|
|
|
15398
|
-
**request:** `Chrt.shipping.
|
|
15433
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
15399
15434
|
|
|
15400
15435
|
</dd>
|
|
15401
15436
|
</dl>
|
|
@@ -15414,7 +15449,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15414
15449
|
</dl>
|
|
15415
15450
|
</details>
|
|
15416
15451
|
|
|
15417
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15452
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15418
15453
|
<dl>
|
|
15419
15454
|
<dd>
|
|
15420
15455
|
|
|
@@ -15426,7 +15461,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15426
15461
|
<dl>
|
|
15427
15462
|
<dd>
|
|
15428
15463
|
|
|
15429
|
-
|
|
15464
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
15430
15465
|
|
|
15431
15466
|
</dd>
|
|
15432
15467
|
</dl>
|
|
@@ -15442,7 +15477,7 @@ Deletes an order schedule. | () -> (bool)
|
|
|
15442
15477
|
<dd>
|
|
15443
15478
|
|
|
15444
15479
|
```typescript
|
|
15445
|
-
await client.shipping.orderSchedules.
|
|
15480
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
15446
15481
|
```
|
|
15447
15482
|
|
|
15448
15483
|
</dd>
|
|
@@ -15477,9 +15512,7 @@ await client.shipping.orderSchedules.deleteV1("order_schedule_id");
|
|
|
15477
15512
|
</dl>
|
|
15478
15513
|
</details>
|
|
15479
15514
|
|
|
15480
|
-
|
|
15481
|
-
|
|
15482
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
15515
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15483
15516
|
<dl>
|
|
15484
15517
|
<dd>
|
|
15485
15518
|
|
|
@@ -15491,7 +15524,7 @@ await client.shipping.orderSchedules.deleteV1("order_schedule_id");
|
|
|
15491
15524
|
<dl>
|
|
15492
15525
|
<dd>
|
|
15493
15526
|
|
|
15494
|
-
|
|
15527
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
15495
15528
|
|
|
15496
15529
|
</dd>
|
|
15497
15530
|
</dl>
|
|
@@ -15507,7 +15540,7 @@ Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing r
|
|
|
15507
15540
|
<dd>
|
|
15508
15541
|
|
|
15509
15542
|
```typescript
|
|
15510
|
-
await client.shipping.
|
|
15543
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
15511
15544
|
```
|
|
15512
15545
|
|
|
15513
15546
|
</dd>
|
|
@@ -15523,7 +15556,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
15523
15556
|
<dl>
|
|
15524
15557
|
<dd>
|
|
15525
15558
|
|
|
15526
|
-
**
|
|
15559
|
+
**orderScheduleId:** `string`
|
|
15527
15560
|
|
|
15528
15561
|
</dd>
|
|
15529
15562
|
</dl>
|
|
@@ -15531,7 +15564,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
15531
15564
|
<dl>
|
|
15532
15565
|
<dd>
|
|
15533
15566
|
|
|
15534
|
-
**requestOptions:** `
|
|
15567
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15535
15568
|
|
|
15536
15569
|
</dd>
|
|
15537
15570
|
</dl>
|
|
@@ -15542,7 +15575,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
15542
15575
|
</dl>
|
|
15543
15576
|
</details>
|
|
15544
15577
|
|
|
15545
|
-
<details><summary><code>client.shipping.
|
|
15578
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15546
15579
|
<dl>
|
|
15547
15580
|
<dd>
|
|
15548
15581
|
|
|
@@ -15554,7 +15587,7 @@ await client.shipping.taskGroups.startV1("task_group_id");
|
|
|
15554
15587
|
<dl>
|
|
15555
15588
|
<dd>
|
|
15556
15589
|
|
|
15557
|
-
|
|
15590
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
15558
15591
|
|
|
15559
15592
|
</dd>
|
|
15560
15593
|
</dl>
|
|
@@ -15570,9 +15603,7 @@ Sets the ordering of tasks within a task group. Requires complete list of task I
|
|
|
15570
15603
|
<dd>
|
|
15571
15604
|
|
|
15572
15605
|
```typescript
|
|
15573
|
-
await client.shipping.
|
|
15574
|
-
task_ids: ["task_ids"],
|
|
15575
|
-
});
|
|
15606
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
15576
15607
|
```
|
|
15577
15608
|
|
|
15578
15609
|
</dd>
|
|
@@ -15588,15 +15619,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
15588
15619
|
<dl>
|
|
15589
15620
|
<dd>
|
|
15590
15621
|
|
|
15591
|
-
**
|
|
15592
|
-
|
|
15593
|
-
</dd>
|
|
15594
|
-
</dl>
|
|
15595
|
-
|
|
15596
|
-
<dl>
|
|
15597
|
-
<dd>
|
|
15598
|
-
|
|
15599
|
-
**request:** `Chrt.shipping.SetTaskOrderingReq`
|
|
15622
|
+
**orderScheduleId:** `string`
|
|
15600
15623
|
|
|
15601
15624
|
</dd>
|
|
15602
15625
|
</dl>
|
|
@@ -15604,7 +15627,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
15604
15627
|
<dl>
|
|
15605
15628
|
<dd>
|
|
15606
15629
|
|
|
15607
|
-
**requestOptions:** `
|
|
15630
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15608
15631
|
|
|
15609
15632
|
</dd>
|
|
15610
15633
|
</dl>
|
|
@@ -15615,7 +15638,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
15615
15638
|
</dl>
|
|
15616
15639
|
</details>
|
|
15617
15640
|
|
|
15618
|
-
<details><summary><code>client.shipping.
|
|
15641
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15619
15642
|
<dl>
|
|
15620
15643
|
<dd>
|
|
15621
15644
|
|
|
@@ -15627,7 +15650,7 @@ await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
|
15627
15650
|
<dl>
|
|
15628
15651
|
<dd>
|
|
15629
15652
|
|
|
15630
|
-
|
|
15653
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
15631
15654
|
|
|
15632
15655
|
</dd>
|
|
15633
15656
|
</dl>
|
|
@@ -15643,9 +15666,7 @@ Assigns or swaps the driver on a task group. Driver must belong to the task grou
|
|
|
15643
15666
|
<dd>
|
|
15644
15667
|
|
|
15645
15668
|
```typescript
|
|
15646
|
-
await client.shipping.
|
|
15647
|
-
driver_id: "driver_id",
|
|
15648
|
-
});
|
|
15669
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
15649
15670
|
```
|
|
15650
15671
|
|
|
15651
15672
|
</dd>
|
|
@@ -15661,15 +15682,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
15661
15682
|
<dl>
|
|
15662
15683
|
<dd>
|
|
15663
15684
|
|
|
15664
|
-
**
|
|
15665
|
-
|
|
15666
|
-
</dd>
|
|
15667
|
-
</dl>
|
|
15668
|
-
|
|
15669
|
-
<dl>
|
|
15670
|
-
<dd>
|
|
15671
|
-
|
|
15672
|
-
**request:** `Chrt.shipping.UpdateDriverReq`
|
|
15685
|
+
**orderScheduleId:** `string`
|
|
15673
15686
|
|
|
15674
15687
|
</dd>
|
|
15675
15688
|
</dl>
|
|
@@ -15677,7 +15690,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
15677
15690
|
<dl>
|
|
15678
15691
|
<dd>
|
|
15679
15692
|
|
|
15680
|
-
**requestOptions:** `
|
|
15693
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15681
15694
|
|
|
15682
15695
|
</dd>
|
|
15683
15696
|
</dl>
|
|
@@ -15688,7 +15701,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
15688
15701
|
</dl>
|
|
15689
15702
|
</details>
|
|
15690
15703
|
|
|
15691
|
-
<details><summary><code>client.shipping.
|
|
15704
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15692
15705
|
<dl>
|
|
15693
15706
|
<dd>
|
|
15694
15707
|
|
|
@@ -15700,7 +15713,7 @@ await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
|
15700
15713
|
<dl>
|
|
15701
15714
|
<dd>
|
|
15702
15715
|
|
|
15703
|
-
|
|
15716
|
+
Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
|
|
15704
15717
|
|
|
15705
15718
|
</dd>
|
|
15706
15719
|
</dl>
|
|
@@ -15716,7 +15729,7 @@ Removes the driver from a task group (sets driver_id to null). Allowed when STAG
|
|
|
15716
15729
|
<dd>
|
|
15717
15730
|
|
|
15718
15731
|
```typescript
|
|
15719
|
-
await client.shipping.
|
|
15732
|
+
await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
15720
15733
|
```
|
|
15721
15734
|
|
|
15722
15735
|
</dd>
|
|
@@ -15732,7 +15745,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
15732
15745
|
<dl>
|
|
15733
15746
|
<dd>
|
|
15734
15747
|
|
|
15735
|
-
**
|
|
15748
|
+
**orderScheduleId:** `string`
|
|
15736
15749
|
|
|
15737
15750
|
</dd>
|
|
15738
15751
|
</dl>
|
|
@@ -15740,7 +15753,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
15740
15753
|
<dl>
|
|
15741
15754
|
<dd>
|
|
15742
15755
|
|
|
15743
|
-
**requestOptions:** `
|
|
15756
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15744
15757
|
|
|
15745
15758
|
</dd>
|
|
15746
15759
|
</dl>
|
|
@@ -15751,7 +15764,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
15751
15764
|
</dl>
|
|
15752
15765
|
</details>
|
|
15753
15766
|
|
|
15754
|
-
<details><summary><code>client.shipping.
|
|
15767
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15755
15768
|
<dl>
|
|
15756
15769
|
<dd>
|
|
15757
15770
|
|
|
@@ -15763,7 +15776,7 @@ await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
|
15763
15776
|
<dl>
|
|
15764
15777
|
<dd>
|
|
15765
15778
|
|
|
15766
|
-
|
|
15779
|
+
Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
15767
15780
|
|
|
15768
15781
|
</dd>
|
|
15769
15782
|
</dl>
|
|
@@ -15779,7 +15792,7 @@ Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordina
|
|
|
15779
15792
|
<dd>
|
|
15780
15793
|
|
|
15781
15794
|
```typescript
|
|
15782
|
-
await client.shipping.
|
|
15795
|
+
await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
15783
15796
|
```
|
|
15784
15797
|
|
|
15785
15798
|
</dd>
|
|
@@ -15795,15 +15808,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
15795
15808
|
<dl>
|
|
15796
15809
|
<dd>
|
|
15797
15810
|
|
|
15798
|
-
**
|
|
15799
|
-
|
|
15800
|
-
</dd>
|
|
15801
|
-
</dl>
|
|
15802
|
-
|
|
15803
|
-
<dl>
|
|
15804
|
-
<dd>
|
|
15805
|
-
|
|
15806
|
-
**request:** `Chrt.shipping.AddExecutorReq`
|
|
15811
|
+
**orderScheduleId:** `string`
|
|
15807
15812
|
|
|
15808
15813
|
</dd>
|
|
15809
15814
|
</dl>
|
|
@@ -15811,7 +15816,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
15811
15816
|
<dl>
|
|
15812
15817
|
<dd>
|
|
15813
15818
|
|
|
15814
|
-
**requestOptions:** `
|
|
15819
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15815
15820
|
|
|
15816
15821
|
</dd>
|
|
15817
15822
|
</dl>
|
|
@@ -15822,7 +15827,9 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
15822
15827
|
</dl>
|
|
15823
15828
|
</details>
|
|
15824
15829
|
|
|
15825
|
-
|
|
15830
|
+
## Shipping TaskGroups
|
|
15831
|
+
|
|
15832
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
15826
15833
|
<dl>
|
|
15827
15834
|
<dd>
|
|
15828
15835
|
|
|
@@ -15834,7 +15841,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
15834
15841
|
<dl>
|
|
15835
15842
|
<dd>
|
|
15836
15843
|
|
|
15837
|
-
|
|
15844
|
+
Starts a task group by transitioning it from STAGED to IN_PROGRESS and syncing related order state. | authz_personas=[driver_for_executor, executor_org_operators, coordinator_org_operators] | () -> (bool)
|
|
15838
15845
|
|
|
15839
15846
|
</dd>
|
|
15840
15847
|
</dl>
|
|
@@ -15850,7 +15857,7 @@ Clears the executor on a task group along with the assigned driver and all PPP/P
|
|
|
15850
15857
|
<dd>
|
|
15851
15858
|
|
|
15852
15859
|
```typescript
|
|
15853
|
-
await client.shipping.taskGroups.
|
|
15860
|
+
await client.shipping.taskGroups.startV1("task_group_id");
|
|
15854
15861
|
```
|
|
15855
15862
|
|
|
15856
15863
|
</dd>
|
|
@@ -15885,7 +15892,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
|
15885
15892
|
</dl>
|
|
15886
15893
|
</details>
|
|
15887
15894
|
|
|
15888
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
15895
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
15889
15896
|
<dl>
|
|
15890
15897
|
<dd>
|
|
15891
15898
|
|
|
@@ -15897,7 +15904,7 @@ await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
|
15897
15904
|
<dl>
|
|
15898
15905
|
<dd>
|
|
15899
15906
|
|
|
15900
|
-
Sets the
|
|
15907
|
+
Sets the ordering of tasks within a task group. Requires complete list of task IDs in desired order. Completed tasks must be before staged tasks. | authz_personas=[lig_owner_operators] | (SetTaskOrderingReq) -> (bool)
|
|
15901
15908
|
|
|
15902
15909
|
</dd>
|
|
15903
15910
|
</dl>
|
|
@@ -15913,7 +15920,9 @@ Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[l
|
|
|
15913
15920
|
<dd>
|
|
15914
15921
|
|
|
15915
15922
|
```typescript
|
|
15916
|
-
await client.shipping.taskGroups.
|
|
15923
|
+
await client.shipping.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
15924
|
+
task_ids: ["task_ids"],
|
|
15925
|
+
});
|
|
15917
15926
|
```
|
|
15918
15927
|
|
|
15919
15928
|
</dd>
|
|
@@ -15937,7 +15946,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
15937
15946
|
<dl>
|
|
15938
15947
|
<dd>
|
|
15939
15948
|
|
|
15940
|
-
**request:** `Chrt.
|
|
15949
|
+
**request:** `Chrt.shipping.SetTaskOrderingReq`
|
|
15941
15950
|
|
|
15942
15951
|
</dd>
|
|
15943
15952
|
</dl>
|
|
@@ -15956,7 +15965,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
15956
15965
|
</dl>
|
|
15957
15966
|
</details>
|
|
15958
15967
|
|
|
15959
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
15968
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
15960
15969
|
<dl>
|
|
15961
15970
|
<dd>
|
|
15962
15971
|
|
|
@@ -15968,7 +15977,7 @@ await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
|
15968
15977
|
<dl>
|
|
15969
15978
|
<dd>
|
|
15970
15979
|
|
|
15971
|
-
|
|
15980
|
+
Assigns or swaps the driver on a task group. Driver must belong to the task group's executor organization. | authz_personas=[executor_org_operators] | (UpdateDriverReq) -> (bool)
|
|
15972
15981
|
|
|
15973
15982
|
</dd>
|
|
15974
15983
|
</dl>
|
|
@@ -15984,8 +15993,8 @@ Adds a message to a task group's message log. | authz_personas=[courier_driver,
|
|
|
15984
15993
|
<dd>
|
|
15985
15994
|
|
|
15986
15995
|
```typescript
|
|
15987
|
-
await client.shipping.taskGroups.
|
|
15988
|
-
|
|
15996
|
+
await client.shipping.taskGroups.updateDriverV1("task_group_id", {
|
|
15997
|
+
driver_id: "driver_id",
|
|
15989
15998
|
});
|
|
15990
15999
|
```
|
|
15991
16000
|
|
|
@@ -16010,7 +16019,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
16010
16019
|
<dl>
|
|
16011
16020
|
<dd>
|
|
16012
16021
|
|
|
16013
|
-
**request:** `Chrt.shipping.
|
|
16022
|
+
**request:** `Chrt.shipping.UpdateDriverReq`
|
|
16014
16023
|
|
|
16015
16024
|
</dd>
|
|
16016
16025
|
</dl>
|
|
@@ -16029,7 +16038,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
16029
16038
|
</dl>
|
|
16030
16039
|
</details>
|
|
16031
16040
|
|
|
16032
|
-
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">
|
|
16041
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
16033
16042
|
<dl>
|
|
16034
16043
|
<dd>
|
|
16035
16044
|
|
|
@@ -16041,7 +16050,7 @@ await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
|
16041
16050
|
<dl>
|
|
16042
16051
|
<dd>
|
|
16043
16052
|
|
|
16044
|
-
|
|
16053
|
+
Removes the driver from a task group (sets driver_id to null). Allowed when STAGED or IN_PROGRESS (if no tasks have reached a terminal status). | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
|
|
16045
16054
|
|
|
16046
16055
|
</dd>
|
|
16047
16056
|
</dl>
|
|
@@ -16057,9 +16066,7 @@ Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vec
|
|
|
16057
16066
|
<dd>
|
|
16058
16067
|
|
|
16059
16068
|
```typescript
|
|
16060
|
-
await client.shipping.taskGroups.
|
|
16061
|
-
billing_ledger_period_id: "billing_ledger_period_id",
|
|
16062
|
-
});
|
|
16069
|
+
await client.shipping.taskGroups.removeDriverV1("task_group_id");
|
|
16063
16070
|
```
|
|
16064
16071
|
|
|
16065
16072
|
</dd>
|
|
@@ -16083,7 +16090,350 @@ await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1
|
|
|
16083
16090
|
<dl>
|
|
16084
16091
|
<dd>
|
|
16085
16092
|
|
|
16086
|
-
**
|
|
16093
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16094
|
+
|
|
16095
|
+
</dd>
|
|
16096
|
+
</dl>
|
|
16097
|
+
</dd>
|
|
16098
|
+
</dl>
|
|
16099
|
+
|
|
16100
|
+
</dd>
|
|
16101
|
+
</dl>
|
|
16102
|
+
</details>
|
|
16103
|
+
|
|
16104
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addExecutorV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16105
|
+
<dl>
|
|
16106
|
+
<dd>
|
|
16107
|
+
|
|
16108
|
+
#### 📝 Description
|
|
16109
|
+
|
|
16110
|
+
<dl>
|
|
16111
|
+
<dd>
|
|
16112
|
+
|
|
16113
|
+
<dl>
|
|
16114
|
+
<dd>
|
|
16115
|
+
|
|
16116
|
+
Assigns an executor organization (on-chrt or off-chrt) to a task group. Coordinator-only. Requires both executor_org_id and off_chrt_executor_org_id to be None (use remove_executor/v1 first to swap). | authz_personas=[coordinator_org_operators] | (AddExecutorReq) -> (bool)
|
|
16117
|
+
|
|
16118
|
+
</dd>
|
|
16119
|
+
</dl>
|
|
16120
|
+
</dd>
|
|
16121
|
+
</dl>
|
|
16122
|
+
|
|
16123
|
+
#### 🔌 Usage
|
|
16124
|
+
|
|
16125
|
+
<dl>
|
|
16126
|
+
<dd>
|
|
16127
|
+
|
|
16128
|
+
<dl>
|
|
16129
|
+
<dd>
|
|
16130
|
+
|
|
16131
|
+
```typescript
|
|
16132
|
+
await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
16133
|
+
```
|
|
16134
|
+
|
|
16135
|
+
</dd>
|
|
16136
|
+
</dl>
|
|
16137
|
+
</dd>
|
|
16138
|
+
</dl>
|
|
16139
|
+
|
|
16140
|
+
#### ⚙️ Parameters
|
|
16141
|
+
|
|
16142
|
+
<dl>
|
|
16143
|
+
<dd>
|
|
16144
|
+
|
|
16145
|
+
<dl>
|
|
16146
|
+
<dd>
|
|
16147
|
+
|
|
16148
|
+
**taskGroupId:** `string`
|
|
16149
|
+
|
|
16150
|
+
</dd>
|
|
16151
|
+
</dl>
|
|
16152
|
+
|
|
16153
|
+
<dl>
|
|
16154
|
+
<dd>
|
|
16155
|
+
|
|
16156
|
+
**request:** `Chrt.shipping.AddExecutorReq`
|
|
16157
|
+
|
|
16158
|
+
</dd>
|
|
16159
|
+
</dl>
|
|
16160
|
+
|
|
16161
|
+
<dl>
|
|
16162
|
+
<dd>
|
|
16163
|
+
|
|
16164
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16165
|
+
|
|
16166
|
+
</dd>
|
|
16167
|
+
</dl>
|
|
16168
|
+
</dd>
|
|
16169
|
+
</dl>
|
|
16170
|
+
|
|
16171
|
+
</dd>
|
|
16172
|
+
</dl>
|
|
16173
|
+
</details>
|
|
16174
|
+
|
|
16175
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
|
|
16176
|
+
<dl>
|
|
16177
|
+
<dd>
|
|
16178
|
+
|
|
16179
|
+
#### 📝 Description
|
|
16180
|
+
|
|
16181
|
+
<dl>
|
|
16182
|
+
<dd>
|
|
16183
|
+
|
|
16184
|
+
<dl>
|
|
16185
|
+
<dd>
|
|
16186
|
+
|
|
16187
|
+
Clears the executor on a task group along with the assigned driver and all PPP/PPD billing attachments, returning the TG to executor-less state. Coordinator-only. PPP/PPD LineItemGroup1 and BillingLedgerPeriod1 documents stay alive (orphaned-but-alive); the (ex-)executor disposes of them via their own routes. SPP is unaffected. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
16188
|
+
|
|
16189
|
+
</dd>
|
|
16190
|
+
</dl>
|
|
16191
|
+
</dd>
|
|
16192
|
+
</dl>
|
|
16193
|
+
|
|
16194
|
+
#### 🔌 Usage
|
|
16195
|
+
|
|
16196
|
+
<dl>
|
|
16197
|
+
<dd>
|
|
16198
|
+
|
|
16199
|
+
<dl>
|
|
16200
|
+
<dd>
|
|
16201
|
+
|
|
16202
|
+
```typescript
|
|
16203
|
+
await client.shipping.taskGroups.removeExecutorV1("task_group_id");
|
|
16204
|
+
```
|
|
16205
|
+
|
|
16206
|
+
</dd>
|
|
16207
|
+
</dl>
|
|
16208
|
+
</dd>
|
|
16209
|
+
</dl>
|
|
16210
|
+
|
|
16211
|
+
#### ⚙️ Parameters
|
|
16212
|
+
|
|
16213
|
+
<dl>
|
|
16214
|
+
<dd>
|
|
16215
|
+
|
|
16216
|
+
<dl>
|
|
16217
|
+
<dd>
|
|
16218
|
+
|
|
16219
|
+
**taskGroupId:** `string`
|
|
16220
|
+
|
|
16221
|
+
</dd>
|
|
16222
|
+
</dl>
|
|
16223
|
+
|
|
16224
|
+
<dl>
|
|
16225
|
+
<dd>
|
|
16226
|
+
|
|
16227
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16228
|
+
|
|
16229
|
+
</dd>
|
|
16230
|
+
</dl>
|
|
16231
|
+
</dd>
|
|
16232
|
+
</dl>
|
|
16233
|
+
|
|
16234
|
+
</dd>
|
|
16235
|
+
</dl>
|
|
16236
|
+
</details>
|
|
16237
|
+
|
|
16238
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16239
|
+
<dl>
|
|
16240
|
+
<dd>
|
|
16241
|
+
|
|
16242
|
+
#### 📝 Description
|
|
16243
|
+
|
|
16244
|
+
<dl>
|
|
16245
|
+
<dd>
|
|
16246
|
+
|
|
16247
|
+
<dl>
|
|
16248
|
+
<dd>
|
|
16249
|
+
|
|
16250
|
+
Sets the flight number and/or fa_flight_ids on a task group. | authz_personas=[lig_owner_operators] | (SetFlightInfoReq) -> (bool)
|
|
16251
|
+
|
|
16252
|
+
</dd>
|
|
16253
|
+
</dl>
|
|
16254
|
+
</dd>
|
|
16255
|
+
</dl>
|
|
16256
|
+
|
|
16257
|
+
#### 🔌 Usage
|
|
16258
|
+
|
|
16259
|
+
<dl>
|
|
16260
|
+
<dd>
|
|
16261
|
+
|
|
16262
|
+
<dl>
|
|
16263
|
+
<dd>
|
|
16264
|
+
|
|
16265
|
+
```typescript
|
|
16266
|
+
await client.shipping.taskGroups.setFlightInfoV1("task_group_id", {});
|
|
16267
|
+
```
|
|
16268
|
+
|
|
16269
|
+
</dd>
|
|
16270
|
+
</dl>
|
|
16271
|
+
</dd>
|
|
16272
|
+
</dl>
|
|
16273
|
+
|
|
16274
|
+
#### ⚙️ Parameters
|
|
16275
|
+
|
|
16276
|
+
<dl>
|
|
16277
|
+
<dd>
|
|
16278
|
+
|
|
16279
|
+
<dl>
|
|
16280
|
+
<dd>
|
|
16281
|
+
|
|
16282
|
+
**taskGroupId:** `string`
|
|
16283
|
+
|
|
16284
|
+
</dd>
|
|
16285
|
+
</dl>
|
|
16286
|
+
|
|
16287
|
+
<dl>
|
|
16288
|
+
<dd>
|
|
16289
|
+
|
|
16290
|
+
**request:** `Chrt.SetFlightInfoReq`
|
|
16291
|
+
|
|
16292
|
+
</dd>
|
|
16293
|
+
</dl>
|
|
16294
|
+
|
|
16295
|
+
<dl>
|
|
16296
|
+
<dd>
|
|
16297
|
+
|
|
16298
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16299
|
+
|
|
16300
|
+
</dd>
|
|
16301
|
+
</dl>
|
|
16302
|
+
</dd>
|
|
16303
|
+
</dl>
|
|
16304
|
+
|
|
16305
|
+
</dd>
|
|
16306
|
+
</dl>
|
|
16307
|
+
</details>
|
|
16308
|
+
|
|
16309
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">addMessageV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
16310
|
+
<dl>
|
|
16311
|
+
<dd>
|
|
16312
|
+
|
|
16313
|
+
#### 📝 Description
|
|
16314
|
+
|
|
16315
|
+
<dl>
|
|
16316
|
+
<dd>
|
|
16317
|
+
|
|
16318
|
+
<dl>
|
|
16319
|
+
<dd>
|
|
16320
|
+
|
|
16321
|
+
Adds a message to a task group's message log. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (AddMessageReq) -> (bool)
|
|
16322
|
+
|
|
16323
|
+
</dd>
|
|
16324
|
+
</dl>
|
|
16325
|
+
</dd>
|
|
16326
|
+
</dl>
|
|
16327
|
+
|
|
16328
|
+
#### 🔌 Usage
|
|
16329
|
+
|
|
16330
|
+
<dl>
|
|
16331
|
+
<dd>
|
|
16332
|
+
|
|
16333
|
+
<dl>
|
|
16334
|
+
<dd>
|
|
16335
|
+
|
|
16336
|
+
```typescript
|
|
16337
|
+
await client.shipping.taskGroups.addMessageV1("task_group_id", {
|
|
16338
|
+
message: "message",
|
|
16339
|
+
});
|
|
16340
|
+
```
|
|
16341
|
+
|
|
16342
|
+
</dd>
|
|
16343
|
+
</dl>
|
|
16344
|
+
</dd>
|
|
16345
|
+
</dl>
|
|
16346
|
+
|
|
16347
|
+
#### ⚙️ Parameters
|
|
16348
|
+
|
|
16349
|
+
<dl>
|
|
16350
|
+
<dd>
|
|
16351
|
+
|
|
16352
|
+
<dl>
|
|
16353
|
+
<dd>
|
|
16354
|
+
|
|
16355
|
+
**taskGroupId:** `string`
|
|
16356
|
+
|
|
16357
|
+
</dd>
|
|
16358
|
+
</dl>
|
|
16359
|
+
|
|
16360
|
+
<dl>
|
|
16361
|
+
<dd>
|
|
16362
|
+
|
|
16363
|
+
**request:** `Chrt.shipping.AddMessageReq`
|
|
16364
|
+
|
|
16365
|
+
</dd>
|
|
16366
|
+
</dl>
|
|
16367
|
+
|
|
16368
|
+
<dl>
|
|
16369
|
+
<dd>
|
|
16370
|
+
|
|
16371
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
16372
|
+
|
|
16373
|
+
</dd>
|
|
16374
|
+
</dl>
|
|
16375
|
+
</dd>
|
|
16376
|
+
</dl>
|
|
16377
|
+
|
|
16378
|
+
</dd>
|
|
16379
|
+
</dl>
|
|
16380
|
+
</details>
|
|
16381
|
+
|
|
16382
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">attachBillingLedgerPeriodToShipperPayProviderV1</a>(taskGroupId, { ...params }) -> Chrt.BillingLedgerPeriod1</code></summary>
|
|
16383
|
+
<dl>
|
|
16384
|
+
<dd>
|
|
16385
|
+
|
|
16386
|
+
#### 📝 Description
|
|
16387
|
+
|
|
16388
|
+
<dl>
|
|
16389
|
+
<dd>
|
|
16390
|
+
|
|
16391
|
+
<dl>
|
|
16392
|
+
<dd>
|
|
16393
|
+
|
|
16394
|
+
Links the operator-supplied OPEN BillingLedgerPeriod to this TaskGroup's SPP vector. Period parties must match the TG's SPP parties. The SPP vector must have no ledger attached and no rate sheet (rate-sheet/ledger exclusivity). Ad-hoc LIGs without a rate sheet may coexist. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (AttachBillingLedgerPeriodReq) -> (BillingLedgerPeriod1)
|
|
16395
|
+
|
|
16396
|
+
</dd>
|
|
16397
|
+
</dl>
|
|
16398
|
+
</dd>
|
|
16399
|
+
</dl>
|
|
16400
|
+
|
|
16401
|
+
#### 🔌 Usage
|
|
16402
|
+
|
|
16403
|
+
<dl>
|
|
16404
|
+
<dd>
|
|
16405
|
+
|
|
16406
|
+
<dl>
|
|
16407
|
+
<dd>
|
|
16408
|
+
|
|
16409
|
+
```typescript
|
|
16410
|
+
await client.shipping.taskGroups.attachBillingLedgerPeriodToShipperPayProviderV1("task_group_id", {
|
|
16411
|
+
billing_ledger_period_id: "billing_ledger_period_id",
|
|
16412
|
+
});
|
|
16413
|
+
```
|
|
16414
|
+
|
|
16415
|
+
</dd>
|
|
16416
|
+
</dl>
|
|
16417
|
+
</dd>
|
|
16418
|
+
</dl>
|
|
16419
|
+
|
|
16420
|
+
#### ⚙️ Parameters
|
|
16421
|
+
|
|
16422
|
+
<dl>
|
|
16423
|
+
<dd>
|
|
16424
|
+
|
|
16425
|
+
<dl>
|
|
16426
|
+
<dd>
|
|
16427
|
+
|
|
16428
|
+
**taskGroupId:** `string`
|
|
16429
|
+
|
|
16430
|
+
</dd>
|
|
16431
|
+
</dl>
|
|
16432
|
+
|
|
16433
|
+
<dl>
|
|
16434
|
+
<dd>
|
|
16435
|
+
|
|
16436
|
+
**request:** `Chrt.AttachBillingLedgerPeriodReq`
|
|
16087
16437
|
|
|
16088
16438
|
</dd>
|
|
16089
16439
|
</dl>
|
|
@@ -17378,7 +17728,144 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
17378
17728
|
<dl>
|
|
17379
17729
|
<dd>
|
|
17380
17730
|
|
|
17381
|
-
**taskId:** `string`
|
|
17731
|
+
**taskId:** `string`
|
|
17732
|
+
|
|
17733
|
+
</dd>
|
|
17734
|
+
</dl>
|
|
17735
|
+
|
|
17736
|
+
<dl>
|
|
17737
|
+
<dd>
|
|
17738
|
+
|
|
17739
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
17740
|
+
|
|
17741
|
+
</dd>
|
|
17742
|
+
</dl>
|
|
17743
|
+
</dd>
|
|
17744
|
+
</dl>
|
|
17745
|
+
|
|
17746
|
+
</dd>
|
|
17747
|
+
</dl>
|
|
17748
|
+
</details>
|
|
17749
|
+
|
|
17750
|
+
## Shipping OrderDrafts Agentic
|
|
17751
|
+
|
|
17752
|
+
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrderBuilderRes</code></summary>
|
|
17753
|
+
<dl>
|
|
17754
|
+
<dd>
|
|
17755
|
+
|
|
17756
|
+
#### 📝 Description
|
|
17757
|
+
|
|
17758
|
+
<dl>
|
|
17759
|
+
<dd>
|
|
17760
|
+
|
|
17761
|
+
<dl>
|
|
17762
|
+
<dd>
|
|
17763
|
+
|
|
17764
|
+
Populates an existing draft order with cargo, task groups, and tasks parsed from natural language. | (OrderBuilderReq) -> (OrderBuilderRes)
|
|
17765
|
+
|
|
17766
|
+
</dd>
|
|
17767
|
+
</dl>
|
|
17768
|
+
</dd>
|
|
17769
|
+
</dl>
|
|
17770
|
+
|
|
17771
|
+
#### 🔌 Usage
|
|
17772
|
+
|
|
17773
|
+
<dl>
|
|
17774
|
+
<dd>
|
|
17775
|
+
|
|
17776
|
+
<dl>
|
|
17777
|
+
<dd>
|
|
17778
|
+
|
|
17779
|
+
```typescript
|
|
17780
|
+
await client.shipping.orderDrafts.agentic.newV1({
|
|
17781
|
+
order_short_id: "order_short_id",
|
|
17782
|
+
text: "text",
|
|
17783
|
+
});
|
|
17784
|
+
```
|
|
17785
|
+
|
|
17786
|
+
</dd>
|
|
17787
|
+
</dl>
|
|
17788
|
+
</dd>
|
|
17789
|
+
</dl>
|
|
17790
|
+
|
|
17791
|
+
#### ⚙️ Parameters
|
|
17792
|
+
|
|
17793
|
+
<dl>
|
|
17794
|
+
<dd>
|
|
17795
|
+
|
|
17796
|
+
<dl>
|
|
17797
|
+
<dd>
|
|
17798
|
+
|
|
17799
|
+
**request:** `Chrt.OrderBuilderReq`
|
|
17800
|
+
|
|
17801
|
+
</dd>
|
|
17802
|
+
</dl>
|
|
17803
|
+
|
|
17804
|
+
<dl>
|
|
17805
|
+
<dd>
|
|
17806
|
+
|
|
17807
|
+
**requestOptions:** `Agentic.RequestOptions`
|
|
17808
|
+
|
|
17809
|
+
</dd>
|
|
17810
|
+
</dl>
|
|
17811
|
+
</dd>
|
|
17812
|
+
</dl>
|
|
17813
|
+
|
|
17814
|
+
</dd>
|
|
17815
|
+
</dl>
|
|
17816
|
+
</details>
|
|
17817
|
+
|
|
17818
|
+
<details><summary><code>client.shipping.orderDrafts.agentic.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/agentic/client/Client.ts">newWithStreamingV1</a>({ ...params }) -> core.Stream<Chrt.OrderBuilderStreamEvent></code></summary>
|
|
17819
|
+
<dl>
|
|
17820
|
+
<dd>
|
|
17821
|
+
|
|
17822
|
+
#### 📝 Description
|
|
17823
|
+
|
|
17824
|
+
<dl>
|
|
17825
|
+
<dd>
|
|
17826
|
+
|
|
17827
|
+
<dl>
|
|
17828
|
+
<dd>
|
|
17829
|
+
|
|
17830
|
+
Populates an existing draft order from natural language and streams progress events via SSE. | (OrderBuilderReq) -> (OrderBuilderStreamEvent)
|
|
17831
|
+
|
|
17832
|
+
</dd>
|
|
17833
|
+
</dl>
|
|
17834
|
+
</dd>
|
|
17835
|
+
</dl>
|
|
17836
|
+
|
|
17837
|
+
#### 🔌 Usage
|
|
17838
|
+
|
|
17839
|
+
<dl>
|
|
17840
|
+
<dd>
|
|
17841
|
+
|
|
17842
|
+
<dl>
|
|
17843
|
+
<dd>
|
|
17844
|
+
|
|
17845
|
+
```typescript
|
|
17846
|
+
const response = await client.shipping.orderDrafts.agentic.newWithStreamingV1({
|
|
17847
|
+
order_short_id: "order_short_id",
|
|
17848
|
+
text: "text",
|
|
17849
|
+
});
|
|
17850
|
+
for await (const item of response) {
|
|
17851
|
+
console.log(item);
|
|
17852
|
+
}
|
|
17853
|
+
```
|
|
17854
|
+
|
|
17855
|
+
</dd>
|
|
17856
|
+
</dl>
|
|
17857
|
+
</dd>
|
|
17858
|
+
</dl>
|
|
17859
|
+
|
|
17860
|
+
#### ⚙️ Parameters
|
|
17861
|
+
|
|
17862
|
+
<dl>
|
|
17863
|
+
<dd>
|
|
17864
|
+
|
|
17865
|
+
<dl>
|
|
17866
|
+
<dd>
|
|
17867
|
+
|
|
17868
|
+
**request:** `Chrt.OrderBuilderReq`
|
|
17382
17869
|
|
|
17383
17870
|
</dd>
|
|
17384
17871
|
</dl>
|
|
@@ -17386,7 +17873,7 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
17386
17873
|
<dl>
|
|
17387
17874
|
<dd>
|
|
17388
17875
|
|
|
17389
|
-
**requestOptions:** `
|
|
17876
|
+
**requestOptions:** `Agentic.RequestOptions`
|
|
17390
17877
|
|
|
17391
17878
|
</dd>
|
|
17392
17879
|
</dl>
|
|
@@ -18555,6 +19042,71 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
18555
19042
|
</dl>
|
|
18556
19043
|
</details>
|
|
18557
19044
|
|
|
19045
|
+
## Shipping OrderSchedules OrderManifest
|
|
19046
|
+
|
|
19047
|
+
<details><summary><code>client.shipping.orderSchedules.orderManifest.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/orderManifest/client/Client.ts">validateV1</a>({ ...params }) -> Chrt.OrderManifestValidationResult</code></summary>
|
|
19048
|
+
<dl>
|
|
19049
|
+
<dd>
|
|
19050
|
+
|
|
19051
|
+
#### 📝 Description
|
|
19052
|
+
|
|
19053
|
+
<dl>
|
|
19054
|
+
<dd>
|
|
19055
|
+
|
|
19056
|
+
<dl>
|
|
19057
|
+
<dd>
|
|
19058
|
+
|
|
19059
|
+
Validates an order manifest for scheduled order creation. | authz: min_org_role=operator | (OrderManifest1) -> (OrderManifestValidationResult)
|
|
19060
|
+
|
|
19061
|
+
</dd>
|
|
19062
|
+
</dl>
|
|
19063
|
+
</dd>
|
|
19064
|
+
</dl>
|
|
19065
|
+
|
|
19066
|
+
#### 🔌 Usage
|
|
19067
|
+
|
|
19068
|
+
<dl>
|
|
19069
|
+
<dd>
|
|
19070
|
+
|
|
19071
|
+
<dl>
|
|
19072
|
+
<dd>
|
|
19073
|
+
|
|
19074
|
+
```typescript
|
|
19075
|
+
await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
19076
|
+
```
|
|
19077
|
+
|
|
19078
|
+
</dd>
|
|
19079
|
+
</dl>
|
|
19080
|
+
</dd>
|
|
19081
|
+
</dl>
|
|
19082
|
+
|
|
19083
|
+
#### ⚙️ Parameters
|
|
19084
|
+
|
|
19085
|
+
<dl>
|
|
19086
|
+
<dd>
|
|
19087
|
+
|
|
19088
|
+
<dl>
|
|
19089
|
+
<dd>
|
|
19090
|
+
|
|
19091
|
+
**request:** `Chrt.OrderManifest1`
|
|
19092
|
+
|
|
19093
|
+
</dd>
|
|
19094
|
+
</dl>
|
|
19095
|
+
|
|
19096
|
+
<dl>
|
|
19097
|
+
<dd>
|
|
19098
|
+
|
|
19099
|
+
**requestOptions:** `OrderManifest.RequestOptions`
|
|
19100
|
+
|
|
19101
|
+
</dd>
|
|
19102
|
+
</dl>
|
|
19103
|
+
</dd>
|
|
19104
|
+
</dl>
|
|
19105
|
+
|
|
19106
|
+
</dd>
|
|
19107
|
+
</dl>
|
|
19108
|
+
</details>
|
|
19109
|
+
|
|
18558
19110
|
## Shipping Orders Expanded
|
|
18559
19111
|
|
|
18560
19112
|
<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.OrderExpanded</code></summary>
|
|
@@ -24256,206 +24808,6 @@ await client.utils.dev.postAgentPingV1();
|
|
|
24256
24808
|
</dl>
|
|
24257
24809
|
</details>
|
|
24258
24810
|
|
|
24259
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderV1</a>({ ...params }) -> Chrt.ReadOrderAgentRes</code></summary>
|
|
24260
|
-
<dl>
|
|
24261
|
-
<dd>
|
|
24262
|
-
|
|
24263
|
-
#### 📝 Description
|
|
24264
|
-
|
|
24265
|
-
<dl>
|
|
24266
|
-
<dd>
|
|
24267
|
-
|
|
24268
|
-
<dl>
|
|
24269
|
-
<dd>
|
|
24270
|
-
|
|
24271
|
-
Fetches expanded order data and returns an AI-generated natural-language summary. | (ReadOrderAgentReq) -> (ReadOrderAgentRes)
|
|
24272
|
-
|
|
24273
|
-
</dd>
|
|
24274
|
-
</dl>
|
|
24275
|
-
</dd>
|
|
24276
|
-
</dl>
|
|
24277
|
-
|
|
24278
|
-
#### 🔌 Usage
|
|
24279
|
-
|
|
24280
|
-
<dl>
|
|
24281
|
-
<dd>
|
|
24282
|
-
|
|
24283
|
-
<dl>
|
|
24284
|
-
<dd>
|
|
24285
|
-
|
|
24286
|
-
```typescript
|
|
24287
|
-
await client.utils.dev.postAgentOrderV1({
|
|
24288
|
-
order_id: "order_id",
|
|
24289
|
-
});
|
|
24290
|
-
```
|
|
24291
|
-
|
|
24292
|
-
</dd>
|
|
24293
|
-
</dl>
|
|
24294
|
-
</dd>
|
|
24295
|
-
</dl>
|
|
24296
|
-
|
|
24297
|
-
#### ⚙️ Parameters
|
|
24298
|
-
|
|
24299
|
-
<dl>
|
|
24300
|
-
<dd>
|
|
24301
|
-
|
|
24302
|
-
<dl>
|
|
24303
|
-
<dd>
|
|
24304
|
-
|
|
24305
|
-
**request:** `Chrt.utils.ReadOrderAgentReq`
|
|
24306
|
-
|
|
24307
|
-
</dd>
|
|
24308
|
-
</dl>
|
|
24309
|
-
|
|
24310
|
-
<dl>
|
|
24311
|
-
<dd>
|
|
24312
|
-
|
|
24313
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
24314
|
-
|
|
24315
|
-
</dd>
|
|
24316
|
-
</dl>
|
|
24317
|
-
</dd>
|
|
24318
|
-
</dl>
|
|
24319
|
-
|
|
24320
|
-
</dd>
|
|
24321
|
-
</dl>
|
|
24322
|
-
</details>
|
|
24323
|
-
|
|
24324
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderV1</a>({ ...params }) -> Chrt.OrderBuilderRes</code></summary>
|
|
24325
|
-
<dl>
|
|
24326
|
-
<dd>
|
|
24327
|
-
|
|
24328
|
-
#### 📝 Description
|
|
24329
|
-
|
|
24330
|
-
<dl>
|
|
24331
|
-
<dd>
|
|
24332
|
-
|
|
24333
|
-
<dl>
|
|
24334
|
-
<dd>
|
|
24335
|
-
|
|
24336
|
-
Populates an existing order draft with cargo, task groups, and tasks parsed from natural language. The frontend must create the draft first via /shipping/order_drafts/new/v1. | (OrderBuilderReq) -> (OrderBuilderRes)
|
|
24337
|
-
|
|
24338
|
-
</dd>
|
|
24339
|
-
</dl>
|
|
24340
|
-
</dd>
|
|
24341
|
-
</dl>
|
|
24342
|
-
|
|
24343
|
-
#### 🔌 Usage
|
|
24344
|
-
|
|
24345
|
-
<dl>
|
|
24346
|
-
<dd>
|
|
24347
|
-
|
|
24348
|
-
<dl>
|
|
24349
|
-
<dd>
|
|
24350
|
-
|
|
24351
|
-
```typescript
|
|
24352
|
-
await client.utils.dev.postAgentOrderBuilderV1({
|
|
24353
|
-
order_short_id: "order_short_id",
|
|
24354
|
-
text: "text",
|
|
24355
|
-
});
|
|
24356
|
-
```
|
|
24357
|
-
|
|
24358
|
-
</dd>
|
|
24359
|
-
</dl>
|
|
24360
|
-
</dd>
|
|
24361
|
-
</dl>
|
|
24362
|
-
|
|
24363
|
-
#### ⚙️ Parameters
|
|
24364
|
-
|
|
24365
|
-
<dl>
|
|
24366
|
-
<dd>
|
|
24367
|
-
|
|
24368
|
-
<dl>
|
|
24369
|
-
<dd>
|
|
24370
|
-
|
|
24371
|
-
**request:** `Chrt.OrderBuilderReq`
|
|
24372
|
-
|
|
24373
|
-
</dd>
|
|
24374
|
-
</dl>
|
|
24375
|
-
|
|
24376
|
-
<dl>
|
|
24377
|
-
<dd>
|
|
24378
|
-
|
|
24379
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
24380
|
-
|
|
24381
|
-
</dd>
|
|
24382
|
-
</dl>
|
|
24383
|
-
</dd>
|
|
24384
|
-
</dl>
|
|
24385
|
-
|
|
24386
|
-
</dd>
|
|
24387
|
-
</dl>
|
|
24388
|
-
</details>
|
|
24389
|
-
|
|
24390
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderStreamV1</a>({ ...params }) -> core.Stream<Chrt.OrderBuilderStreamEvent></code></summary>
|
|
24391
|
-
<dl>
|
|
24392
|
-
<dd>
|
|
24393
|
-
|
|
24394
|
-
#### 📝 Description
|
|
24395
|
-
|
|
24396
|
-
<dl>
|
|
24397
|
-
<dd>
|
|
24398
|
-
|
|
24399
|
-
<dl>
|
|
24400
|
-
<dd>
|
|
24401
|
-
|
|
24402
|
-
Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderStreamEvent
|
|
24403
|
-
|
|
24404
|
-
</dd>
|
|
24405
|
-
</dl>
|
|
24406
|
-
</dd>
|
|
24407
|
-
</dl>
|
|
24408
|
-
|
|
24409
|
-
#### 🔌 Usage
|
|
24410
|
-
|
|
24411
|
-
<dl>
|
|
24412
|
-
<dd>
|
|
24413
|
-
|
|
24414
|
-
<dl>
|
|
24415
|
-
<dd>
|
|
24416
|
-
|
|
24417
|
-
```typescript
|
|
24418
|
-
const response = await client.utils.dev.postAgentOrderBuilderStreamV1({
|
|
24419
|
-
order_short_id: "order_short_id",
|
|
24420
|
-
text: "text",
|
|
24421
|
-
});
|
|
24422
|
-
for await (const item of response) {
|
|
24423
|
-
console.log(item);
|
|
24424
|
-
}
|
|
24425
|
-
```
|
|
24426
|
-
|
|
24427
|
-
</dd>
|
|
24428
|
-
</dl>
|
|
24429
|
-
</dd>
|
|
24430
|
-
</dl>
|
|
24431
|
-
|
|
24432
|
-
#### ⚙️ Parameters
|
|
24433
|
-
|
|
24434
|
-
<dl>
|
|
24435
|
-
<dd>
|
|
24436
|
-
|
|
24437
|
-
<dl>
|
|
24438
|
-
<dd>
|
|
24439
|
-
|
|
24440
|
-
**request:** `Chrt.OrderBuilderReq`
|
|
24441
|
-
|
|
24442
|
-
</dd>
|
|
24443
|
-
</dl>
|
|
24444
|
-
|
|
24445
|
-
<dl>
|
|
24446
|
-
<dd>
|
|
24447
|
-
|
|
24448
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
24449
|
-
|
|
24450
|
-
</dd>
|
|
24451
|
-
</dl>
|
|
24452
|
-
</dd>
|
|
24453
|
-
</dl>
|
|
24454
|
-
|
|
24455
|
-
</dd>
|
|
24456
|
-
</dl>
|
|
24457
|
-
</details>
|
|
24458
|
-
|
|
24459
24811
|
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">getUserIdV1</a>() -> string</code></summary>
|
|
24460
24812
|
<dl>
|
|
24461
24813
|
<dd>
|