@chrt-inc/typescript-sdk 1.640.0 → 1.647.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/index.d.ts +1 -1
- package/dist/cjs/api/resources/index.js +2 -2
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +9 -4
- 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 +3 -1
- package/dist/cjs/api/resources/shipping/resources/index.js +4 -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 +196 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +789 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/index.js +17 -0
- 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 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/index.js +18 -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 +12 -48
- package/dist/cjs/api/resources/utils/resources/dev/client/Client.js +20 -215
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/{ReadOrderAgentReq.d.ts → PingOpenAiReq.d.ts} +3 -3
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/{ScheduledHelloPocReq.d.ts → ScheduledPingReq.d.ts} +3 -5
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/index.d.ts +2 -3
- 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/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/OrderManifest1.js +5 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.d.ts +12 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.js +5 -0
- package/dist/cjs/api/types/OrderManifestValidationResult.d.ts +8 -0
- package/dist/cjs/api/types/OrderManifestValidationResult.js +5 -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/PingOpenAiRes.d.ts +6 -0
- package/dist/cjs/api/types/PingOpenAiRes.js +5 -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/{ScheduledHelloPocRes.d.ts → ScheduledPingRes.d.ts} +3 -3
- package/dist/cjs/api/types/ScheduledPingRes.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/index.d.ts +18 -5
- package/dist/cjs/api/types/index.js +18 -5
- 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/index.d.mts +1 -1
- package/dist/esm/api/resources/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +5 -0
- 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 +3 -1
- package/dist/esm/api/resources/shipping/resources/index.mjs +3 -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 +196 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +752 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/index.mjs +1 -0
- 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 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/index.mjs +2 -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 +12 -48
- package/dist/esm/api/resources/utils/resources/dev/client/Client.mjs +20 -215
- package/dist/esm/api/resources/utils/resources/dev/client/requests/{ReadOrderAgentReq.d.mts → PingOpenAiReq.d.mts} +3 -3
- package/dist/esm/api/resources/utils/resources/dev/client/requests/{ScheduledHelloPocReq.d.mts → ScheduledPingReq.d.mts} +3 -5
- package/dist/esm/api/resources/utils/resources/dev/client/requests/index.d.mts +2 -3
- 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/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/OrderManifest1.mjs +4 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.d.mts +12 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.mjs +4 -0
- package/dist/esm/api/types/OrderManifestValidationResult.d.mts +8 -0
- package/dist/esm/api/types/OrderManifestValidationResult.mjs +4 -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/PingOpenAiRes.d.mts +6 -0
- package/dist/esm/api/types/PingOpenAiRes.mjs +4 -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/{ScheduledHelloPocRes.d.mts → ScheduledPingRes.d.mts} +3 -3
- package/dist/esm/api/types/ScheduledPingRes.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/index.d.mts +18 -5
- package/dist/esm/api/types/index.mjs +18 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +933 -213
- package/dist/cjs/api/resources/utils/resources/dev/client/requests/AgentReq.d.ts +0 -10
- package/dist/cjs/api/types/AgentRes.d.ts +0 -8
- 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/ReadOrderAgentRes.d.ts +0 -8
- package/dist/esm/api/resources/utils/resources/dev/client/requests/AgentReq.d.mts +0 -10
- package/dist/esm/api/types/AgentRes.d.mts +0 -8
- 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/ReadOrderAgentRes.d.mts +0 -8
- /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/{utils/resources/dev/client/requests/AgentReq.js → shipping/resources/orderSchedules/client/requests/OrderScheduleClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev/client/requests/ReadOrderAgentReq.js → shipping/resources/orderSchedules/client/requests/OrderScheduleClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/{utils/resources/dev/client/requests/ScheduledHelloPocReq.js → shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.js} +0 -0
- /package/dist/cjs/api/{types/AgentRes.js → resources/utils/resources/dev/client/requests/PingOpenAiReq.js} +0 -0
- /package/dist/cjs/api/{types/OrderDraftValidationIssue.js → resources/utils/resources/dev/client/requests/ScheduledPingReq.js} +0 -0
- /package/dist/cjs/api/types/{ReadOrderAgentRes.js → CargoManifest1.js} +0 -0
- /package/dist/cjs/api/types/{ScheduledHelloPocRes.js → OrderDraftValidationRequirements.js} +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/{utils/resources/dev/client/requests/AgentReq.mjs → shipping/resources/orderSchedules/client/requests/OrderScheduleClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev/client/requests/ReadOrderAgentReq.mjs → shipping/resources/orderSchedules/client/requests/OrderScheduleClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/{utils/resources/dev/client/requests/ScheduledHelloPocReq.mjs → shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.mjs} +0 -0
- /package/dist/esm/api/{types/AgentRes.mjs → resources/utils/resources/dev/client/requests/PingOpenAiReq.mjs} +0 -0
- /package/dist/esm/api/{types/OrderDraftValidationIssue.mjs → resources/utils/resources/dev/client/requests/ScheduledPingReq.mjs} +0 -0
- /package/dist/esm/api/types/{ReadOrderAgentRes.mjs → CargoManifest1.mjs} +0 -0
- /package/dist/esm/api/types/{ScheduledHelloPocRes.mjs → OrderDraftValidationRequirements.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -15044,7 +15044,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
15044
15044
|
<dl>
|
|
15045
15045
|
<dd>
|
|
15046
15046
|
|
|
15047
|
-
Validates the draft order for staging and returns
|
|
15047
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
15048
15048
|
|
|
15049
15049
|
</dd>
|
|
15050
15050
|
</dl>
|
|
@@ -15095,6 +15095,724 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
15095
15095
|
</dl>
|
|
15096
15096
|
</details>
|
|
15097
15097
|
|
|
15098
|
+
## Shipping OrderSchedules
|
|
15099
|
+
|
|
15100
|
+
<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
|
+
<dl>
|
|
15102
|
+
<dd>
|
|
15103
|
+
|
|
15104
|
+
#### 📝 Description
|
|
15105
|
+
|
|
15106
|
+
<dl>
|
|
15107
|
+
<dd>
|
|
15108
|
+
|
|
15109
|
+
<dl>
|
|
15110
|
+
<dd>
|
|
15111
|
+
|
|
15112
|
+
Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
|
|
15113
|
+
|
|
15114
|
+
</dd>
|
|
15115
|
+
</dl>
|
|
15116
|
+
</dd>
|
|
15117
|
+
</dl>
|
|
15118
|
+
|
|
15119
|
+
#### 🔌 Usage
|
|
15120
|
+
|
|
15121
|
+
<dl>
|
|
15122
|
+
<dd>
|
|
15123
|
+
|
|
15124
|
+
<dl>
|
|
15125
|
+
<dd>
|
|
15126
|
+
|
|
15127
|
+
```typescript
|
|
15128
|
+
await client.shipping.orderSchedules.listV1({
|
|
15129
|
+
sort_by: "created_at_timestamp",
|
|
15130
|
+
sort_order: "asc",
|
|
15131
|
+
page: 1,
|
|
15132
|
+
page_size: 1,
|
|
15133
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
15134
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
15135
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15136
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
15137
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
15138
|
+
});
|
|
15139
|
+
```
|
|
15140
|
+
|
|
15141
|
+
</dd>
|
|
15142
|
+
</dl>
|
|
15143
|
+
</dd>
|
|
15144
|
+
</dl>
|
|
15145
|
+
|
|
15146
|
+
#### ⚙️ Parameters
|
|
15147
|
+
|
|
15148
|
+
<dl>
|
|
15149
|
+
<dd>
|
|
15150
|
+
|
|
15151
|
+
<dl>
|
|
15152
|
+
<dd>
|
|
15153
|
+
|
|
15154
|
+
**request:** `Chrt.shipping.OrderSchedulesListV1Request`
|
|
15155
|
+
|
|
15156
|
+
</dd>
|
|
15157
|
+
</dl>
|
|
15158
|
+
|
|
15159
|
+
<dl>
|
|
15160
|
+
<dd>
|
|
15161
|
+
|
|
15162
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15163
|
+
|
|
15164
|
+
</dd>
|
|
15165
|
+
</dl>
|
|
15166
|
+
</dd>
|
|
15167
|
+
</dl>
|
|
15168
|
+
|
|
15169
|
+
</dd>
|
|
15170
|
+
</dl>
|
|
15171
|
+
</details>
|
|
15172
|
+
|
|
15173
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
|
|
15174
|
+
<dl>
|
|
15175
|
+
<dd>
|
|
15176
|
+
|
|
15177
|
+
#### 📝 Description
|
|
15178
|
+
|
|
15179
|
+
<dl>
|
|
15180
|
+
<dd>
|
|
15181
|
+
|
|
15182
|
+
<dl>
|
|
15183
|
+
<dd>
|
|
15184
|
+
|
|
15185
|
+
Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
|
|
15186
|
+
|
|
15187
|
+
</dd>
|
|
15188
|
+
</dl>
|
|
15189
|
+
</dd>
|
|
15190
|
+
</dl>
|
|
15191
|
+
|
|
15192
|
+
#### 🔌 Usage
|
|
15193
|
+
|
|
15194
|
+
<dl>
|
|
15195
|
+
<dd>
|
|
15196
|
+
|
|
15197
|
+
<dl>
|
|
15198
|
+
<dd>
|
|
15199
|
+
|
|
15200
|
+
```typescript
|
|
15201
|
+
await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
15202
|
+
```
|
|
15203
|
+
|
|
15204
|
+
</dd>
|
|
15205
|
+
</dl>
|
|
15206
|
+
</dd>
|
|
15207
|
+
</dl>
|
|
15208
|
+
|
|
15209
|
+
#### ⚙️ Parameters
|
|
15210
|
+
|
|
15211
|
+
<dl>
|
|
15212
|
+
<dd>
|
|
15213
|
+
|
|
15214
|
+
<dl>
|
|
15215
|
+
<dd>
|
|
15216
|
+
|
|
15217
|
+
**orderScheduleId:** `string`
|
|
15218
|
+
|
|
15219
|
+
</dd>
|
|
15220
|
+
</dl>
|
|
15221
|
+
|
|
15222
|
+
<dl>
|
|
15223
|
+
<dd>
|
|
15224
|
+
|
|
15225
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15226
|
+
|
|
15227
|
+
</dd>
|
|
15228
|
+
</dl>
|
|
15229
|
+
</dd>
|
|
15230
|
+
</dl>
|
|
15231
|
+
|
|
15232
|
+
</dd>
|
|
15233
|
+
</dl>
|
|
15234
|
+
</details>
|
|
15235
|
+
|
|
15236
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
|
|
15237
|
+
<dl>
|
|
15238
|
+
<dd>
|
|
15239
|
+
|
|
15240
|
+
#### 📝 Description
|
|
15241
|
+
|
|
15242
|
+
<dl>
|
|
15243
|
+
<dd>
|
|
15244
|
+
|
|
15245
|
+
<dl>
|
|
15246
|
+
<dd>
|
|
15247
|
+
|
|
15248
|
+
Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
15249
|
+
|
|
15250
|
+
</dd>
|
|
15251
|
+
</dl>
|
|
15252
|
+
</dd>
|
|
15253
|
+
</dl>
|
|
15254
|
+
|
|
15255
|
+
#### 🔌 Usage
|
|
15256
|
+
|
|
15257
|
+
<dl>
|
|
15258
|
+
<dd>
|
|
15259
|
+
|
|
15260
|
+
<dl>
|
|
15261
|
+
<dd>
|
|
15262
|
+
|
|
15263
|
+
```typescript
|
|
15264
|
+
await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
15265
|
+
```
|
|
15266
|
+
|
|
15267
|
+
</dd>
|
|
15268
|
+
</dl>
|
|
15269
|
+
</dd>
|
|
15270
|
+
</dl>
|
|
15271
|
+
|
|
15272
|
+
#### ⚙️ Parameters
|
|
15273
|
+
|
|
15274
|
+
<dl>
|
|
15275
|
+
<dd>
|
|
15276
|
+
|
|
15277
|
+
<dl>
|
|
15278
|
+
<dd>
|
|
15279
|
+
|
|
15280
|
+
**orderScheduleId:** `string`
|
|
15281
|
+
|
|
15282
|
+
</dd>
|
|
15283
|
+
</dl>
|
|
15284
|
+
|
|
15285
|
+
<dl>
|
|
15286
|
+
<dd>
|
|
15287
|
+
|
|
15288
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15289
|
+
|
|
15290
|
+
</dd>
|
|
15291
|
+
</dl>
|
|
15292
|
+
</dd>
|
|
15293
|
+
</dl>
|
|
15294
|
+
|
|
15295
|
+
</dd>
|
|
15296
|
+
</dl>
|
|
15297
|
+
</details>
|
|
15298
|
+
|
|
15299
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
15300
|
+
<dl>
|
|
15301
|
+
<dd>
|
|
15302
|
+
|
|
15303
|
+
#### 📝 Description
|
|
15304
|
+
|
|
15305
|
+
<dl>
|
|
15306
|
+
<dd>
|
|
15307
|
+
|
|
15308
|
+
<dl>
|
|
15309
|
+
<dd>
|
|
15310
|
+
|
|
15311
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
15312
|
+
|
|
15313
|
+
</dd>
|
|
15314
|
+
</dl>
|
|
15315
|
+
</dd>
|
|
15316
|
+
</dl>
|
|
15317
|
+
|
|
15318
|
+
#### 🔌 Usage
|
|
15319
|
+
|
|
15320
|
+
<dl>
|
|
15321
|
+
<dd>
|
|
15322
|
+
|
|
15323
|
+
<dl>
|
|
15324
|
+
<dd>
|
|
15325
|
+
|
|
15326
|
+
```typescript
|
|
15327
|
+
await client.shipping.orderSchedules.newV1({
|
|
15328
|
+
schema_version: 1,
|
|
15329
|
+
name: "name",
|
|
15330
|
+
order_manifest: {},
|
|
15331
|
+
schedule_spec: {},
|
|
15332
|
+
});
|
|
15333
|
+
```
|
|
15334
|
+
|
|
15335
|
+
</dd>
|
|
15336
|
+
</dl>
|
|
15337
|
+
</dd>
|
|
15338
|
+
</dl>
|
|
15339
|
+
|
|
15340
|
+
#### ⚙️ Parameters
|
|
15341
|
+
|
|
15342
|
+
<dl>
|
|
15343
|
+
<dd>
|
|
15344
|
+
|
|
15345
|
+
<dl>
|
|
15346
|
+
<dd>
|
|
15347
|
+
|
|
15348
|
+
**request:** `Chrt.shipping.OrderScheduleClientCreate1`
|
|
15349
|
+
|
|
15350
|
+
</dd>
|
|
15351
|
+
</dl>
|
|
15352
|
+
|
|
15353
|
+
<dl>
|
|
15354
|
+
<dd>
|
|
15355
|
+
|
|
15356
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15357
|
+
|
|
15358
|
+
</dd>
|
|
15359
|
+
</dl>
|
|
15360
|
+
</dd>
|
|
15361
|
+
</dl>
|
|
15362
|
+
|
|
15363
|
+
</dd>
|
|
15364
|
+
</dl>
|
|
15365
|
+
</details>
|
|
15366
|
+
|
|
15367
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
|
|
15368
|
+
<dl>
|
|
15369
|
+
<dd>
|
|
15370
|
+
|
|
15371
|
+
#### 📝 Description
|
|
15372
|
+
|
|
15373
|
+
<dl>
|
|
15374
|
+
<dd>
|
|
15375
|
+
|
|
15376
|
+
<dl>
|
|
15377
|
+
<dd>
|
|
15378
|
+
|
|
15379
|
+
Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
15380
|
+
|
|
15381
|
+
</dd>
|
|
15382
|
+
</dl>
|
|
15383
|
+
</dd>
|
|
15384
|
+
</dl>
|
|
15385
|
+
|
|
15386
|
+
#### 🔌 Usage
|
|
15387
|
+
|
|
15388
|
+
<dl>
|
|
15389
|
+
<dd>
|
|
15390
|
+
|
|
15391
|
+
<dl>
|
|
15392
|
+
<dd>
|
|
15393
|
+
|
|
15394
|
+
```typescript
|
|
15395
|
+
await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
15396
|
+
```
|
|
15397
|
+
|
|
15398
|
+
</dd>
|
|
15399
|
+
</dl>
|
|
15400
|
+
</dd>
|
|
15401
|
+
</dl>
|
|
15402
|
+
|
|
15403
|
+
#### ⚙️ Parameters
|
|
15404
|
+
|
|
15405
|
+
<dl>
|
|
15406
|
+
<dd>
|
|
15407
|
+
|
|
15408
|
+
<dl>
|
|
15409
|
+
<dd>
|
|
15410
|
+
|
|
15411
|
+
**orderScheduleId:** `string`
|
|
15412
|
+
|
|
15413
|
+
</dd>
|
|
15414
|
+
</dl>
|
|
15415
|
+
|
|
15416
|
+
<dl>
|
|
15417
|
+
<dd>
|
|
15418
|
+
|
|
15419
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
15420
|
+
|
|
15421
|
+
</dd>
|
|
15422
|
+
</dl>
|
|
15423
|
+
|
|
15424
|
+
<dl>
|
|
15425
|
+
<dd>
|
|
15426
|
+
|
|
15427
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15428
|
+
|
|
15429
|
+
</dd>
|
|
15430
|
+
</dl>
|
|
15431
|
+
</dd>
|
|
15432
|
+
</dl>
|
|
15433
|
+
|
|
15434
|
+
</dd>
|
|
15435
|
+
</dl>
|
|
15436
|
+
</details>
|
|
15437
|
+
|
|
15438
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15439
|
+
<dl>
|
|
15440
|
+
<dd>
|
|
15441
|
+
|
|
15442
|
+
#### 📝 Description
|
|
15443
|
+
|
|
15444
|
+
<dl>
|
|
15445
|
+
<dd>
|
|
15446
|
+
|
|
15447
|
+
<dl>
|
|
15448
|
+
<dd>
|
|
15449
|
+
|
|
15450
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
15451
|
+
|
|
15452
|
+
</dd>
|
|
15453
|
+
</dl>
|
|
15454
|
+
</dd>
|
|
15455
|
+
</dl>
|
|
15456
|
+
|
|
15457
|
+
#### 🔌 Usage
|
|
15458
|
+
|
|
15459
|
+
<dl>
|
|
15460
|
+
<dd>
|
|
15461
|
+
|
|
15462
|
+
<dl>
|
|
15463
|
+
<dd>
|
|
15464
|
+
|
|
15465
|
+
```typescript
|
|
15466
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
15467
|
+
```
|
|
15468
|
+
|
|
15469
|
+
</dd>
|
|
15470
|
+
</dl>
|
|
15471
|
+
</dd>
|
|
15472
|
+
</dl>
|
|
15473
|
+
|
|
15474
|
+
#### ⚙️ Parameters
|
|
15475
|
+
|
|
15476
|
+
<dl>
|
|
15477
|
+
<dd>
|
|
15478
|
+
|
|
15479
|
+
<dl>
|
|
15480
|
+
<dd>
|
|
15481
|
+
|
|
15482
|
+
**orderScheduleId:** `string`
|
|
15483
|
+
|
|
15484
|
+
</dd>
|
|
15485
|
+
</dl>
|
|
15486
|
+
|
|
15487
|
+
<dl>
|
|
15488
|
+
<dd>
|
|
15489
|
+
|
|
15490
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15491
|
+
|
|
15492
|
+
</dd>
|
|
15493
|
+
</dl>
|
|
15494
|
+
</dd>
|
|
15495
|
+
</dl>
|
|
15496
|
+
|
|
15497
|
+
</dd>
|
|
15498
|
+
</dl>
|
|
15499
|
+
</details>
|
|
15500
|
+
|
|
15501
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15502
|
+
<dl>
|
|
15503
|
+
<dd>
|
|
15504
|
+
|
|
15505
|
+
#### 📝 Description
|
|
15506
|
+
|
|
15507
|
+
<dl>
|
|
15508
|
+
<dd>
|
|
15509
|
+
|
|
15510
|
+
<dl>
|
|
15511
|
+
<dd>
|
|
15512
|
+
|
|
15513
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
15514
|
+
|
|
15515
|
+
</dd>
|
|
15516
|
+
</dl>
|
|
15517
|
+
</dd>
|
|
15518
|
+
</dl>
|
|
15519
|
+
|
|
15520
|
+
#### 🔌 Usage
|
|
15521
|
+
|
|
15522
|
+
<dl>
|
|
15523
|
+
<dd>
|
|
15524
|
+
|
|
15525
|
+
<dl>
|
|
15526
|
+
<dd>
|
|
15527
|
+
|
|
15528
|
+
```typescript
|
|
15529
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
15530
|
+
```
|
|
15531
|
+
|
|
15532
|
+
</dd>
|
|
15533
|
+
</dl>
|
|
15534
|
+
</dd>
|
|
15535
|
+
</dl>
|
|
15536
|
+
|
|
15537
|
+
#### ⚙️ Parameters
|
|
15538
|
+
|
|
15539
|
+
<dl>
|
|
15540
|
+
<dd>
|
|
15541
|
+
|
|
15542
|
+
<dl>
|
|
15543
|
+
<dd>
|
|
15544
|
+
|
|
15545
|
+
**orderScheduleId:** `string`
|
|
15546
|
+
|
|
15547
|
+
</dd>
|
|
15548
|
+
</dl>
|
|
15549
|
+
|
|
15550
|
+
<dl>
|
|
15551
|
+
<dd>
|
|
15552
|
+
|
|
15553
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15554
|
+
|
|
15555
|
+
</dd>
|
|
15556
|
+
</dl>
|
|
15557
|
+
</dd>
|
|
15558
|
+
</dl>
|
|
15559
|
+
|
|
15560
|
+
</dd>
|
|
15561
|
+
</dl>
|
|
15562
|
+
</details>
|
|
15563
|
+
|
|
15564
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15565
|
+
<dl>
|
|
15566
|
+
<dd>
|
|
15567
|
+
|
|
15568
|
+
#### 📝 Description
|
|
15569
|
+
|
|
15570
|
+
<dl>
|
|
15571
|
+
<dd>
|
|
15572
|
+
|
|
15573
|
+
<dl>
|
|
15574
|
+
<dd>
|
|
15575
|
+
|
|
15576
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
15577
|
+
|
|
15578
|
+
</dd>
|
|
15579
|
+
</dl>
|
|
15580
|
+
</dd>
|
|
15581
|
+
</dl>
|
|
15582
|
+
|
|
15583
|
+
#### 🔌 Usage
|
|
15584
|
+
|
|
15585
|
+
<dl>
|
|
15586
|
+
<dd>
|
|
15587
|
+
|
|
15588
|
+
<dl>
|
|
15589
|
+
<dd>
|
|
15590
|
+
|
|
15591
|
+
```typescript
|
|
15592
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
15593
|
+
```
|
|
15594
|
+
|
|
15595
|
+
</dd>
|
|
15596
|
+
</dl>
|
|
15597
|
+
</dd>
|
|
15598
|
+
</dl>
|
|
15599
|
+
|
|
15600
|
+
#### ⚙️ Parameters
|
|
15601
|
+
|
|
15602
|
+
<dl>
|
|
15603
|
+
<dd>
|
|
15604
|
+
|
|
15605
|
+
<dl>
|
|
15606
|
+
<dd>
|
|
15607
|
+
|
|
15608
|
+
**orderScheduleId:** `string`
|
|
15609
|
+
|
|
15610
|
+
</dd>
|
|
15611
|
+
</dl>
|
|
15612
|
+
|
|
15613
|
+
<dl>
|
|
15614
|
+
<dd>
|
|
15615
|
+
|
|
15616
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15617
|
+
|
|
15618
|
+
</dd>
|
|
15619
|
+
</dl>
|
|
15620
|
+
</dd>
|
|
15621
|
+
</dl>
|
|
15622
|
+
|
|
15623
|
+
</dd>
|
|
15624
|
+
</dl>
|
|
15625
|
+
</details>
|
|
15626
|
+
|
|
15627
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15628
|
+
<dl>
|
|
15629
|
+
<dd>
|
|
15630
|
+
|
|
15631
|
+
#### 📝 Description
|
|
15632
|
+
|
|
15633
|
+
<dl>
|
|
15634
|
+
<dd>
|
|
15635
|
+
|
|
15636
|
+
<dl>
|
|
15637
|
+
<dd>
|
|
15638
|
+
|
|
15639
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
15640
|
+
|
|
15641
|
+
</dd>
|
|
15642
|
+
</dl>
|
|
15643
|
+
</dd>
|
|
15644
|
+
</dl>
|
|
15645
|
+
|
|
15646
|
+
#### 🔌 Usage
|
|
15647
|
+
|
|
15648
|
+
<dl>
|
|
15649
|
+
<dd>
|
|
15650
|
+
|
|
15651
|
+
<dl>
|
|
15652
|
+
<dd>
|
|
15653
|
+
|
|
15654
|
+
```typescript
|
|
15655
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
15656
|
+
```
|
|
15657
|
+
|
|
15658
|
+
</dd>
|
|
15659
|
+
</dl>
|
|
15660
|
+
</dd>
|
|
15661
|
+
</dl>
|
|
15662
|
+
|
|
15663
|
+
#### ⚙️ Parameters
|
|
15664
|
+
|
|
15665
|
+
<dl>
|
|
15666
|
+
<dd>
|
|
15667
|
+
|
|
15668
|
+
<dl>
|
|
15669
|
+
<dd>
|
|
15670
|
+
|
|
15671
|
+
**orderScheduleId:** `string`
|
|
15672
|
+
|
|
15673
|
+
</dd>
|
|
15674
|
+
</dl>
|
|
15675
|
+
|
|
15676
|
+
<dl>
|
|
15677
|
+
<dd>
|
|
15678
|
+
|
|
15679
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15680
|
+
|
|
15681
|
+
</dd>
|
|
15682
|
+
</dl>
|
|
15683
|
+
</dd>
|
|
15684
|
+
</dl>
|
|
15685
|
+
|
|
15686
|
+
</dd>
|
|
15687
|
+
</dl>
|
|
15688
|
+
</details>
|
|
15689
|
+
|
|
15690
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15691
|
+
<dl>
|
|
15692
|
+
<dd>
|
|
15693
|
+
|
|
15694
|
+
#### 📝 Description
|
|
15695
|
+
|
|
15696
|
+
<dl>
|
|
15697
|
+
<dd>
|
|
15698
|
+
|
|
15699
|
+
<dl>
|
|
15700
|
+
<dd>
|
|
15701
|
+
|
|
15702
|
+
Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
|
|
15703
|
+
|
|
15704
|
+
</dd>
|
|
15705
|
+
</dl>
|
|
15706
|
+
</dd>
|
|
15707
|
+
</dl>
|
|
15708
|
+
|
|
15709
|
+
#### 🔌 Usage
|
|
15710
|
+
|
|
15711
|
+
<dl>
|
|
15712
|
+
<dd>
|
|
15713
|
+
|
|
15714
|
+
<dl>
|
|
15715
|
+
<dd>
|
|
15716
|
+
|
|
15717
|
+
```typescript
|
|
15718
|
+
await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
15719
|
+
```
|
|
15720
|
+
|
|
15721
|
+
</dd>
|
|
15722
|
+
</dl>
|
|
15723
|
+
</dd>
|
|
15724
|
+
</dl>
|
|
15725
|
+
|
|
15726
|
+
#### ⚙️ Parameters
|
|
15727
|
+
|
|
15728
|
+
<dl>
|
|
15729
|
+
<dd>
|
|
15730
|
+
|
|
15731
|
+
<dl>
|
|
15732
|
+
<dd>
|
|
15733
|
+
|
|
15734
|
+
**orderScheduleId:** `string`
|
|
15735
|
+
|
|
15736
|
+
</dd>
|
|
15737
|
+
</dl>
|
|
15738
|
+
|
|
15739
|
+
<dl>
|
|
15740
|
+
<dd>
|
|
15741
|
+
|
|
15742
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15743
|
+
|
|
15744
|
+
</dd>
|
|
15745
|
+
</dl>
|
|
15746
|
+
</dd>
|
|
15747
|
+
</dl>
|
|
15748
|
+
|
|
15749
|
+
</dd>
|
|
15750
|
+
</dl>
|
|
15751
|
+
</details>
|
|
15752
|
+
|
|
15753
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15754
|
+
<dl>
|
|
15755
|
+
<dd>
|
|
15756
|
+
|
|
15757
|
+
#### 📝 Description
|
|
15758
|
+
|
|
15759
|
+
<dl>
|
|
15760
|
+
<dd>
|
|
15761
|
+
|
|
15762
|
+
<dl>
|
|
15763
|
+
<dd>
|
|
15764
|
+
|
|
15765
|
+
Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
15766
|
+
|
|
15767
|
+
</dd>
|
|
15768
|
+
</dl>
|
|
15769
|
+
</dd>
|
|
15770
|
+
</dl>
|
|
15771
|
+
|
|
15772
|
+
#### 🔌 Usage
|
|
15773
|
+
|
|
15774
|
+
<dl>
|
|
15775
|
+
<dd>
|
|
15776
|
+
|
|
15777
|
+
<dl>
|
|
15778
|
+
<dd>
|
|
15779
|
+
|
|
15780
|
+
```typescript
|
|
15781
|
+
await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
15782
|
+
```
|
|
15783
|
+
|
|
15784
|
+
</dd>
|
|
15785
|
+
</dl>
|
|
15786
|
+
</dd>
|
|
15787
|
+
</dl>
|
|
15788
|
+
|
|
15789
|
+
#### ⚙️ Parameters
|
|
15790
|
+
|
|
15791
|
+
<dl>
|
|
15792
|
+
<dd>
|
|
15793
|
+
|
|
15794
|
+
<dl>
|
|
15795
|
+
<dd>
|
|
15796
|
+
|
|
15797
|
+
**orderScheduleId:** `string`
|
|
15798
|
+
|
|
15799
|
+
</dd>
|
|
15800
|
+
</dl>
|
|
15801
|
+
|
|
15802
|
+
<dl>
|
|
15803
|
+
<dd>
|
|
15804
|
+
|
|
15805
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15806
|
+
|
|
15807
|
+
</dd>
|
|
15808
|
+
</dl>
|
|
15809
|
+
</dd>
|
|
15810
|
+
</dl>
|
|
15811
|
+
|
|
15812
|
+
</dd>
|
|
15813
|
+
</dl>
|
|
15814
|
+
</details>
|
|
15815
|
+
|
|
15098
15816
|
## Shipping TaskGroups
|
|
15099
15817
|
|
|
15100
15818
|
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
@@ -16996,7 +17714,144 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
16996
17714
|
<dl>
|
|
16997
17715
|
<dd>
|
|
16998
17716
|
|
|
16999
|
-
**taskId:** `string`
|
|
17717
|
+
**taskId:** `string`
|
|
17718
|
+
|
|
17719
|
+
</dd>
|
|
17720
|
+
</dl>
|
|
17721
|
+
|
|
17722
|
+
<dl>
|
|
17723
|
+
<dd>
|
|
17724
|
+
|
|
17725
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
17726
|
+
|
|
17727
|
+
</dd>
|
|
17728
|
+
</dl>
|
|
17729
|
+
</dd>
|
|
17730
|
+
</dl>
|
|
17731
|
+
|
|
17732
|
+
</dd>
|
|
17733
|
+
</dl>
|
|
17734
|
+
</details>
|
|
17735
|
+
|
|
17736
|
+
## Shipping OrderDrafts Agentic
|
|
17737
|
+
|
|
17738
|
+
<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>
|
|
17739
|
+
<dl>
|
|
17740
|
+
<dd>
|
|
17741
|
+
|
|
17742
|
+
#### 📝 Description
|
|
17743
|
+
|
|
17744
|
+
<dl>
|
|
17745
|
+
<dd>
|
|
17746
|
+
|
|
17747
|
+
<dl>
|
|
17748
|
+
<dd>
|
|
17749
|
+
|
|
17750
|
+
Populates an existing draft order with cargo, task groups, and tasks parsed from natural language. | (OrderBuilderReq) -> (OrderBuilderRes)
|
|
17751
|
+
|
|
17752
|
+
</dd>
|
|
17753
|
+
</dl>
|
|
17754
|
+
</dd>
|
|
17755
|
+
</dl>
|
|
17756
|
+
|
|
17757
|
+
#### 🔌 Usage
|
|
17758
|
+
|
|
17759
|
+
<dl>
|
|
17760
|
+
<dd>
|
|
17761
|
+
|
|
17762
|
+
<dl>
|
|
17763
|
+
<dd>
|
|
17764
|
+
|
|
17765
|
+
```typescript
|
|
17766
|
+
await client.shipping.orderDrafts.agentic.newV1({
|
|
17767
|
+
order_short_id: "order_short_id",
|
|
17768
|
+
text: "text",
|
|
17769
|
+
});
|
|
17770
|
+
```
|
|
17771
|
+
|
|
17772
|
+
</dd>
|
|
17773
|
+
</dl>
|
|
17774
|
+
</dd>
|
|
17775
|
+
</dl>
|
|
17776
|
+
|
|
17777
|
+
#### ⚙️ Parameters
|
|
17778
|
+
|
|
17779
|
+
<dl>
|
|
17780
|
+
<dd>
|
|
17781
|
+
|
|
17782
|
+
<dl>
|
|
17783
|
+
<dd>
|
|
17784
|
+
|
|
17785
|
+
**request:** `Chrt.OrderBuilderReq`
|
|
17786
|
+
|
|
17787
|
+
</dd>
|
|
17788
|
+
</dl>
|
|
17789
|
+
|
|
17790
|
+
<dl>
|
|
17791
|
+
<dd>
|
|
17792
|
+
|
|
17793
|
+
**requestOptions:** `Agentic.RequestOptions`
|
|
17794
|
+
|
|
17795
|
+
</dd>
|
|
17796
|
+
</dl>
|
|
17797
|
+
</dd>
|
|
17798
|
+
</dl>
|
|
17799
|
+
|
|
17800
|
+
</dd>
|
|
17801
|
+
</dl>
|
|
17802
|
+
</details>
|
|
17803
|
+
|
|
17804
|
+
<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>
|
|
17805
|
+
<dl>
|
|
17806
|
+
<dd>
|
|
17807
|
+
|
|
17808
|
+
#### 📝 Description
|
|
17809
|
+
|
|
17810
|
+
<dl>
|
|
17811
|
+
<dd>
|
|
17812
|
+
|
|
17813
|
+
<dl>
|
|
17814
|
+
<dd>
|
|
17815
|
+
|
|
17816
|
+
Populates an existing draft order from natural language and streams progress events via SSE. | (OrderBuilderReq) -> (OrderBuilderStreamEvent)
|
|
17817
|
+
|
|
17818
|
+
</dd>
|
|
17819
|
+
</dl>
|
|
17820
|
+
</dd>
|
|
17821
|
+
</dl>
|
|
17822
|
+
|
|
17823
|
+
#### 🔌 Usage
|
|
17824
|
+
|
|
17825
|
+
<dl>
|
|
17826
|
+
<dd>
|
|
17827
|
+
|
|
17828
|
+
<dl>
|
|
17829
|
+
<dd>
|
|
17830
|
+
|
|
17831
|
+
```typescript
|
|
17832
|
+
const response = await client.shipping.orderDrafts.agentic.newWithStreamingV1({
|
|
17833
|
+
order_short_id: "order_short_id",
|
|
17834
|
+
text: "text",
|
|
17835
|
+
});
|
|
17836
|
+
for await (const item of response) {
|
|
17837
|
+
console.log(item);
|
|
17838
|
+
}
|
|
17839
|
+
```
|
|
17840
|
+
|
|
17841
|
+
</dd>
|
|
17842
|
+
</dl>
|
|
17843
|
+
</dd>
|
|
17844
|
+
</dl>
|
|
17845
|
+
|
|
17846
|
+
#### ⚙️ Parameters
|
|
17847
|
+
|
|
17848
|
+
<dl>
|
|
17849
|
+
<dd>
|
|
17850
|
+
|
|
17851
|
+
<dl>
|
|
17852
|
+
<dd>
|
|
17853
|
+
|
|
17854
|
+
**request:** `Chrt.OrderBuilderReq`
|
|
17000
17855
|
|
|
17001
17856
|
</dd>
|
|
17002
17857
|
</dl>
|
|
@@ -17004,7 +17859,7 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
17004
17859
|
<dl>
|
|
17005
17860
|
<dd>
|
|
17006
17861
|
|
|
17007
|
-
**requestOptions:** `
|
|
17862
|
+
**requestOptions:** `Agentic.RequestOptions`
|
|
17008
17863
|
|
|
17009
17864
|
</dd>
|
|
17010
17865
|
</dl>
|
|
@@ -18173,6 +19028,71 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
18173
19028
|
</dl>
|
|
18174
19029
|
</details>
|
|
18175
19030
|
|
|
19031
|
+
## Shipping OrderSchedules OrderManifest
|
|
19032
|
+
|
|
19033
|
+
<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>
|
|
19034
|
+
<dl>
|
|
19035
|
+
<dd>
|
|
19036
|
+
|
|
19037
|
+
#### 📝 Description
|
|
19038
|
+
|
|
19039
|
+
<dl>
|
|
19040
|
+
<dd>
|
|
19041
|
+
|
|
19042
|
+
<dl>
|
|
19043
|
+
<dd>
|
|
19044
|
+
|
|
19045
|
+
Validates an order manifest for scheduled order creation. | authz: min_org_role=operator | (OrderManifest1) -> (OrderManifestValidationResult)
|
|
19046
|
+
|
|
19047
|
+
</dd>
|
|
19048
|
+
</dl>
|
|
19049
|
+
</dd>
|
|
19050
|
+
</dl>
|
|
19051
|
+
|
|
19052
|
+
#### 🔌 Usage
|
|
19053
|
+
|
|
19054
|
+
<dl>
|
|
19055
|
+
<dd>
|
|
19056
|
+
|
|
19057
|
+
<dl>
|
|
19058
|
+
<dd>
|
|
19059
|
+
|
|
19060
|
+
```typescript
|
|
19061
|
+
await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
19062
|
+
```
|
|
19063
|
+
|
|
19064
|
+
</dd>
|
|
19065
|
+
</dl>
|
|
19066
|
+
</dd>
|
|
19067
|
+
</dl>
|
|
19068
|
+
|
|
19069
|
+
#### ⚙️ Parameters
|
|
19070
|
+
|
|
19071
|
+
<dl>
|
|
19072
|
+
<dd>
|
|
19073
|
+
|
|
19074
|
+
<dl>
|
|
19075
|
+
<dd>
|
|
19076
|
+
|
|
19077
|
+
**request:** `Chrt.OrderManifest1`
|
|
19078
|
+
|
|
19079
|
+
</dd>
|
|
19080
|
+
</dl>
|
|
19081
|
+
|
|
19082
|
+
<dl>
|
|
19083
|
+
<dd>
|
|
19084
|
+
|
|
19085
|
+
**requestOptions:** `OrderManifest.RequestOptions`
|
|
19086
|
+
|
|
19087
|
+
</dd>
|
|
19088
|
+
</dl>
|
|
19089
|
+
</dd>
|
|
19090
|
+
</dl>
|
|
19091
|
+
|
|
19092
|
+
</dd>
|
|
19093
|
+
</dl>
|
|
19094
|
+
</details>
|
|
19095
|
+
|
|
18176
19096
|
## Shipping Orders Expanded
|
|
18177
19097
|
|
|
18178
19098
|
<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>
|
|
@@ -23683,7 +24603,7 @@ await client.users.directoryEntries.deleteV1("directory_entry_id");
|
|
|
23683
24603
|
|
|
23684
24604
|
## Utils Dev
|
|
23685
24605
|
|
|
23686
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">
|
|
24606
|
+
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentPingScheduleV1</a>({ ...params }) -> Chrt.ScheduledPingRes</code></summary>
|
|
23687
24607
|
<dl>
|
|
23688
24608
|
<dd>
|
|
23689
24609
|
|
|
@@ -23695,7 +24615,7 @@ await client.users.directoryEntries.deleteV1("directory_entry_id");
|
|
|
23695
24615
|
<dl>
|
|
23696
24616
|
<dd>
|
|
23697
24617
|
|
|
23698
|
-
Creates or updates a Temporal Schedule that runs the scheduled
|
|
24618
|
+
Creates or updates a Temporal Schedule that runs the scheduled ping workflow for developer diagnostics. | authz: min_org_role=administrator | (ScheduledPingReq) -> (ScheduledPingRes)
|
|
23699
24619
|
|
|
23700
24620
|
</dd>
|
|
23701
24621
|
</dl>
|
|
@@ -23711,9 +24631,7 @@ Creates or updates a Temporal Schedule that runs the scheduled hello workflow fo
|
|
|
23711
24631
|
<dd>
|
|
23712
24632
|
|
|
23713
24633
|
```typescript
|
|
23714
|
-
await client.utils.dev.
|
|
23715
|
-
driver_name: "driver_name",
|
|
23716
|
-
});
|
|
24634
|
+
await client.utils.dev.postAgentPingScheduleV1();
|
|
23717
24635
|
```
|
|
23718
24636
|
|
|
23719
24637
|
</dd>
|
|
@@ -23729,7 +24647,7 @@ await client.utils.dev.postAgentScheduledHelloPocV1({
|
|
|
23729
24647
|
<dl>
|
|
23730
24648
|
<dd>
|
|
23731
24649
|
|
|
23732
|
-
**request:** `Chrt.utils.
|
|
24650
|
+
**request:** `Chrt.utils.ScheduledPingReq`
|
|
23733
24651
|
|
|
23734
24652
|
</dd>
|
|
23735
24653
|
</dl>
|
|
@@ -23748,7 +24666,7 @@ await client.utils.dev.postAgentScheduledHelloPocV1({
|
|
|
23748
24666
|
</dl>
|
|
23749
24667
|
</details>
|
|
23750
24668
|
|
|
23751
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">
|
|
24669
|
+
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOpenaiPingV1</a>({ ...params }) -> Chrt.PingOpenAiRes</code></summary>
|
|
23752
24670
|
<dl>
|
|
23753
24671
|
<dd>
|
|
23754
24672
|
|
|
@@ -23760,7 +24678,7 @@ await client.utils.dev.postAgentScheduledHelloPocV1({
|
|
|
23760
24678
|
<dl>
|
|
23761
24679
|
<dd>
|
|
23762
24680
|
|
|
23763
|
-
Runs a
|
|
24681
|
+
Runs a minimal Temporal workflow that sends a prompt to OpenAI and returns the response. | (PingOpenAIReq) -> (PingOpenAIRes)
|
|
23764
24682
|
|
|
23765
24683
|
</dd>
|
|
23766
24684
|
</dl>
|
|
@@ -23776,7 +24694,9 @@ Runs a customer service agent that responds with logistics fun facts (real order
|
|
|
23776
24694
|
<dd>
|
|
23777
24695
|
|
|
23778
24696
|
```typescript
|
|
23779
|
-
await client.utils.dev.
|
|
24697
|
+
await client.utils.dev.postAgentOpenaiPingV1({
|
|
24698
|
+
prompt: "prompt",
|
|
24699
|
+
});
|
|
23780
24700
|
```
|
|
23781
24701
|
|
|
23782
24702
|
</dd>
|
|
@@ -23792,7 +24712,7 @@ await client.utils.dev.postAgentV1();
|
|
|
23792
24712
|
<dl>
|
|
23793
24713
|
<dd>
|
|
23794
24714
|
|
|
23795
|
-
**request:** `Chrt.utils.
|
|
24715
|
+
**request:** `Chrt.utils.PingOpenAiReq`
|
|
23796
24716
|
|
|
23797
24717
|
</dd>
|
|
23798
24718
|
</dl>
|
|
@@ -23874,206 +24794,6 @@ await client.utils.dev.postAgentPingV1();
|
|
|
23874
24794
|
</dl>
|
|
23875
24795
|
</details>
|
|
23876
24796
|
|
|
23877
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderV1</a>({ ...params }) -> Chrt.ReadOrderAgentRes</code></summary>
|
|
23878
|
-
<dl>
|
|
23879
|
-
<dd>
|
|
23880
|
-
|
|
23881
|
-
#### 📝 Description
|
|
23882
|
-
|
|
23883
|
-
<dl>
|
|
23884
|
-
<dd>
|
|
23885
|
-
|
|
23886
|
-
<dl>
|
|
23887
|
-
<dd>
|
|
23888
|
-
|
|
23889
|
-
Fetches expanded order data and returns an AI-generated natural-language summary. | (ReadOrderAgentReq) -> (ReadOrderAgentRes)
|
|
23890
|
-
|
|
23891
|
-
</dd>
|
|
23892
|
-
</dl>
|
|
23893
|
-
</dd>
|
|
23894
|
-
</dl>
|
|
23895
|
-
|
|
23896
|
-
#### 🔌 Usage
|
|
23897
|
-
|
|
23898
|
-
<dl>
|
|
23899
|
-
<dd>
|
|
23900
|
-
|
|
23901
|
-
<dl>
|
|
23902
|
-
<dd>
|
|
23903
|
-
|
|
23904
|
-
```typescript
|
|
23905
|
-
await client.utils.dev.postAgentOrderV1({
|
|
23906
|
-
order_id: "order_id",
|
|
23907
|
-
});
|
|
23908
|
-
```
|
|
23909
|
-
|
|
23910
|
-
</dd>
|
|
23911
|
-
</dl>
|
|
23912
|
-
</dd>
|
|
23913
|
-
</dl>
|
|
23914
|
-
|
|
23915
|
-
#### ⚙️ Parameters
|
|
23916
|
-
|
|
23917
|
-
<dl>
|
|
23918
|
-
<dd>
|
|
23919
|
-
|
|
23920
|
-
<dl>
|
|
23921
|
-
<dd>
|
|
23922
|
-
|
|
23923
|
-
**request:** `Chrt.utils.ReadOrderAgentReq`
|
|
23924
|
-
|
|
23925
|
-
</dd>
|
|
23926
|
-
</dl>
|
|
23927
|
-
|
|
23928
|
-
<dl>
|
|
23929
|
-
<dd>
|
|
23930
|
-
|
|
23931
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
23932
|
-
|
|
23933
|
-
</dd>
|
|
23934
|
-
</dl>
|
|
23935
|
-
</dd>
|
|
23936
|
-
</dl>
|
|
23937
|
-
|
|
23938
|
-
</dd>
|
|
23939
|
-
</dl>
|
|
23940
|
-
</details>
|
|
23941
|
-
|
|
23942
|
-
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderV1</a>({ ...params }) -> Chrt.OrderBuilderRes</code></summary>
|
|
23943
|
-
<dl>
|
|
23944
|
-
<dd>
|
|
23945
|
-
|
|
23946
|
-
#### 📝 Description
|
|
23947
|
-
|
|
23948
|
-
<dl>
|
|
23949
|
-
<dd>
|
|
23950
|
-
|
|
23951
|
-
<dl>
|
|
23952
|
-
<dd>
|
|
23953
|
-
|
|
23954
|
-
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)
|
|
23955
|
-
|
|
23956
|
-
</dd>
|
|
23957
|
-
</dl>
|
|
23958
|
-
</dd>
|
|
23959
|
-
</dl>
|
|
23960
|
-
|
|
23961
|
-
#### 🔌 Usage
|
|
23962
|
-
|
|
23963
|
-
<dl>
|
|
23964
|
-
<dd>
|
|
23965
|
-
|
|
23966
|
-
<dl>
|
|
23967
|
-
<dd>
|
|
23968
|
-
|
|
23969
|
-
```typescript
|
|
23970
|
-
await client.utils.dev.postAgentOrderBuilderV1({
|
|
23971
|
-
order_short_id: "order_short_id",
|
|
23972
|
-
text: "text",
|
|
23973
|
-
});
|
|
23974
|
-
```
|
|
23975
|
-
|
|
23976
|
-
</dd>
|
|
23977
|
-
</dl>
|
|
23978
|
-
</dd>
|
|
23979
|
-
</dl>
|
|
23980
|
-
|
|
23981
|
-
#### ⚙️ Parameters
|
|
23982
|
-
|
|
23983
|
-
<dl>
|
|
23984
|
-
<dd>
|
|
23985
|
-
|
|
23986
|
-
<dl>
|
|
23987
|
-
<dd>
|
|
23988
|
-
|
|
23989
|
-
**request:** `Chrt.OrderBuilderReq`
|
|
23990
|
-
|
|
23991
|
-
</dd>
|
|
23992
|
-
</dl>
|
|
23993
|
-
|
|
23994
|
-
<dl>
|
|
23995
|
-
<dd>
|
|
23996
|
-
|
|
23997
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
23998
|
-
|
|
23999
|
-
</dd>
|
|
24000
|
-
</dl>
|
|
24001
|
-
</dd>
|
|
24002
|
-
</dl>
|
|
24003
|
-
|
|
24004
|
-
</dd>
|
|
24005
|
-
</dl>
|
|
24006
|
-
</details>
|
|
24007
|
-
|
|
24008
|
-
<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>
|
|
24009
|
-
<dl>
|
|
24010
|
-
<dd>
|
|
24011
|
-
|
|
24012
|
-
#### 📝 Description
|
|
24013
|
-
|
|
24014
|
-
<dl>
|
|
24015
|
-
<dd>
|
|
24016
|
-
|
|
24017
|
-
<dl>
|
|
24018
|
-
<dd>
|
|
24019
|
-
|
|
24020
|
-
Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderStreamEvent
|
|
24021
|
-
|
|
24022
|
-
</dd>
|
|
24023
|
-
</dl>
|
|
24024
|
-
</dd>
|
|
24025
|
-
</dl>
|
|
24026
|
-
|
|
24027
|
-
#### 🔌 Usage
|
|
24028
|
-
|
|
24029
|
-
<dl>
|
|
24030
|
-
<dd>
|
|
24031
|
-
|
|
24032
|
-
<dl>
|
|
24033
|
-
<dd>
|
|
24034
|
-
|
|
24035
|
-
```typescript
|
|
24036
|
-
const response = await client.utils.dev.postAgentOrderBuilderStreamV1({
|
|
24037
|
-
order_short_id: "order_short_id",
|
|
24038
|
-
text: "text",
|
|
24039
|
-
});
|
|
24040
|
-
for await (const item of response) {
|
|
24041
|
-
console.log(item);
|
|
24042
|
-
}
|
|
24043
|
-
```
|
|
24044
|
-
|
|
24045
|
-
</dd>
|
|
24046
|
-
</dl>
|
|
24047
|
-
</dd>
|
|
24048
|
-
</dl>
|
|
24049
|
-
|
|
24050
|
-
#### ⚙️ Parameters
|
|
24051
|
-
|
|
24052
|
-
<dl>
|
|
24053
|
-
<dd>
|
|
24054
|
-
|
|
24055
|
-
<dl>
|
|
24056
|
-
<dd>
|
|
24057
|
-
|
|
24058
|
-
**request:** `Chrt.OrderBuilderReq`
|
|
24059
|
-
|
|
24060
|
-
</dd>
|
|
24061
|
-
</dl>
|
|
24062
|
-
|
|
24063
|
-
<dl>
|
|
24064
|
-
<dd>
|
|
24065
|
-
|
|
24066
|
-
**requestOptions:** `Dev.RequestOptions`
|
|
24067
|
-
|
|
24068
|
-
</dd>
|
|
24069
|
-
</dl>
|
|
24070
|
-
</dd>
|
|
24071
|
-
</dl>
|
|
24072
|
-
|
|
24073
|
-
</dd>
|
|
24074
|
-
</dl>
|
|
24075
|
-
</details>
|
|
24076
|
-
|
|
24077
24797
|
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">getUserIdV1</a>() -> string</code></summary>
|
|
24078
24798
|
<dl>
|
|
24079
24799
|
<dd>
|