@chrt-inc/typescript-sdk 1.641.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/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/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/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/index.d.ts +16 -5
- package/dist/cjs/api/types/index.js +16 -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/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/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/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/index.d.mts +16 -5
- package/dist/esm/api/types/index.mjs +16 -5
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +561 -223
- 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/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/ReadOrderAgentRes.d.ts +0 -8
- 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/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/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/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/{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/{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/{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
|
@@ -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>
|
|
@@ -15097,7 +15097,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
15097
15097
|
|
|
15098
15098
|
## Shipping OrderSchedules
|
|
15099
15099
|
|
|
15100
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
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
15101
|
<dl>
|
|
15102
15102
|
<dd>
|
|
15103
15103
|
|
|
@@ -15109,7 +15109,80 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
15109
15109
|
<dl>
|
|
15110
15110
|
<dd>
|
|
15111
15111
|
|
|
15112
|
-
|
|
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)
|
|
15113
15186
|
|
|
15114
15187
|
</dd>
|
|
15115
15188
|
</dl>
|
|
@@ -15160,7 +15233,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
15160
15233
|
</dl>
|
|
15161
15234
|
</details>
|
|
15162
15235
|
|
|
15163
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
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>
|
|
15164
15237
|
<dl>
|
|
15165
15238
|
<dd>
|
|
15166
15239
|
|
|
@@ -15172,7 +15245,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
15172
15245
|
<dl>
|
|
15173
15246
|
<dd>
|
|
15174
15247
|
|
|
15175
|
-
|
|
15248
|
+
Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
15176
15249
|
|
|
15177
15250
|
</dd>
|
|
15178
15251
|
</dl>
|
|
@@ -15188,7 +15261,7 @@ Lists order schedules for the caller's organization. | () -> (list[OrderSchedule
|
|
|
15188
15261
|
<dd>
|
|
15189
15262
|
|
|
15190
15263
|
```typescript
|
|
15191
|
-
await client.shipping.orderSchedules.
|
|
15264
|
+
await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
15192
15265
|
```
|
|
15193
15266
|
|
|
15194
15267
|
</dd>
|
|
@@ -15204,6 +15277,14 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15204
15277
|
<dl>
|
|
15205
15278
|
<dd>
|
|
15206
15279
|
|
|
15280
|
+
**orderScheduleId:** `string`
|
|
15281
|
+
|
|
15282
|
+
</dd>
|
|
15283
|
+
</dl>
|
|
15284
|
+
|
|
15285
|
+
<dl>
|
|
15286
|
+
<dd>
|
|
15287
|
+
|
|
15207
15288
|
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
15208
15289
|
|
|
15209
15290
|
</dd>
|
|
@@ -15215,7 +15296,7 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15215
15296
|
</dl>
|
|
15216
15297
|
</details>
|
|
15217
15298
|
|
|
15218
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15299
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
15219
15300
|
<dl>
|
|
15220
15301
|
<dd>
|
|
15221
15302
|
|
|
@@ -15227,7 +15308,7 @@ await client.shipping.orderSchedules.listV1();
|
|
|
15227
15308
|
<dl>
|
|
15228
15309
|
<dd>
|
|
15229
15310
|
|
|
15230
|
-
Creates
|
|
15311
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
15231
15312
|
|
|
15232
15313
|
</dd>
|
|
15233
15314
|
</dl>
|
|
@@ -15243,8 +15324,11 @@ Creates an order schedule. | (OrderScheduleCreateReq) -> (PydanticObjectId)
|
|
|
15243
15324
|
<dd>
|
|
15244
15325
|
|
|
15245
15326
|
```typescript
|
|
15246
|
-
await client.shipping.orderSchedules.
|
|
15327
|
+
await client.shipping.orderSchedules.newV1({
|
|
15328
|
+
schema_version: 1,
|
|
15247
15329
|
name: "name",
|
|
15330
|
+
order_manifest: {},
|
|
15331
|
+
schedule_spec: {},
|
|
15248
15332
|
});
|
|
15249
15333
|
```
|
|
15250
15334
|
|
|
@@ -15261,7 +15345,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15261
15345
|
<dl>
|
|
15262
15346
|
<dd>
|
|
15263
15347
|
|
|
15264
|
-
**request:** `Chrt.shipping.
|
|
15348
|
+
**request:** `Chrt.shipping.OrderScheduleClientCreate1`
|
|
15265
15349
|
|
|
15266
15350
|
</dd>
|
|
15267
15351
|
</dl>
|
|
@@ -15280,7 +15364,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15280
15364
|
</dl>
|
|
15281
15365
|
</details>
|
|
15282
15366
|
|
|
15283
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
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>
|
|
15284
15368
|
<dl>
|
|
15285
15369
|
<dd>
|
|
15286
15370
|
|
|
@@ -15292,7 +15376,7 @@ await client.shipping.orderSchedules.createV1({
|
|
|
15292
15376
|
<dl>
|
|
15293
15377
|
<dd>
|
|
15294
15378
|
|
|
15295
|
-
|
|
15379
|
+
Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
15296
15380
|
|
|
15297
15381
|
</dd>
|
|
15298
15382
|
</dl>
|
|
@@ -15308,7 +15392,7 @@ Echoes Temporal schedule specs to test SDK round trips. | (OrderScheduleRoundTri
|
|
|
15308
15392
|
<dd>
|
|
15309
15393
|
|
|
15310
15394
|
```typescript
|
|
15311
|
-
await client.shipping.orderSchedules.
|
|
15395
|
+
await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
15312
15396
|
```
|
|
15313
15397
|
|
|
15314
15398
|
</dd>
|
|
@@ -15324,7 +15408,15 @@ await client.shipping.orderSchedules.roundTripModelTestV1();
|
|
|
15324
15408
|
<dl>
|
|
15325
15409
|
<dd>
|
|
15326
15410
|
|
|
15327
|
-
**
|
|
15411
|
+
**orderScheduleId:** `string`
|
|
15412
|
+
|
|
15413
|
+
</dd>
|
|
15414
|
+
</dl>
|
|
15415
|
+
|
|
15416
|
+
<dl>
|
|
15417
|
+
<dd>
|
|
15418
|
+
|
|
15419
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
15328
15420
|
|
|
15329
15421
|
</dd>
|
|
15330
15422
|
</dl>
|
|
@@ -15343,7 +15435,7 @@ await client.shipping.orderSchedules.roundTripModelTestV1();
|
|
|
15343
15435
|
</dl>
|
|
15344
15436
|
</details>
|
|
15345
15437
|
|
|
15346
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15438
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15347
15439
|
<dl>
|
|
15348
15440
|
<dd>
|
|
15349
15441
|
|
|
@@ -15355,7 +15447,7 @@ await client.shipping.orderSchedules.roundTripModelTestV1();
|
|
|
15355
15447
|
<dl>
|
|
15356
15448
|
<dd>
|
|
15357
15449
|
|
|
15358
|
-
|
|
15450
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
15359
15451
|
|
|
15360
15452
|
</dd>
|
|
15361
15453
|
</dl>
|
|
@@ -15371,7 +15463,70 @@ Updates an order schedule. | (OrderScheduleUpdateReq) -> (bool)
|
|
|
15371
15463
|
<dd>
|
|
15372
15464
|
|
|
15373
15465
|
```typescript
|
|
15374
|
-
await client.shipping.orderSchedules.
|
|
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");
|
|
15375
15530
|
```
|
|
15376
15531
|
|
|
15377
15532
|
</dd>
|
|
@@ -15395,7 +15550,62 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15395
15550
|
<dl>
|
|
15396
15551
|
<dd>
|
|
15397
15552
|
|
|
15398
|
-
**
|
|
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`
|
|
15399
15609
|
|
|
15400
15610
|
</dd>
|
|
15401
15611
|
</dl>
|
|
@@ -15414,7 +15624,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15414
15624
|
</dl>
|
|
15415
15625
|
</details>
|
|
15416
15626
|
|
|
15417
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
15627
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
15418
15628
|
<dl>
|
|
15419
15629
|
<dd>
|
|
15420
15630
|
|
|
@@ -15426,7 +15636,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
15426
15636
|
<dl>
|
|
15427
15637
|
<dd>
|
|
15428
15638
|
|
|
15429
|
-
|
|
15639
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
15430
15640
|
|
|
15431
15641
|
</dd>
|
|
15432
15642
|
</dl>
|
|
@@ -15442,7 +15652,133 @@ Deletes an order schedule. | () -> (bool)
|
|
|
15442
15652
|
<dd>
|
|
15443
15653
|
|
|
15444
15654
|
```typescript
|
|
15445
|
-
await client.shipping.orderSchedules.
|
|
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");
|
|
15446
15782
|
```
|
|
15447
15783
|
|
|
15448
15784
|
</dd>
|
|
@@ -17378,7 +17714,144 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
17378
17714
|
<dl>
|
|
17379
17715
|
<dd>
|
|
17380
17716
|
|
|
17381
|
-
**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`
|
|
17382
17855
|
|
|
17383
17856
|
</dd>
|
|
17384
17857
|
</dl>
|
|
@@ -17386,7 +17859,7 @@ await client.shipping.tasks.deleteV1("task_id");
|
|
|
17386
17859
|
<dl>
|
|
17387
17860
|
<dd>
|
|
17388
17861
|
|
|
17389
|
-
**requestOptions:** `
|
|
17862
|
+
**requestOptions:** `Agentic.RequestOptions`
|
|
17390
17863
|
|
|
17391
17864
|
</dd>
|
|
17392
17865
|
</dl>
|
|
@@ -18555,6 +19028,71 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
18555
19028
|
</dl>
|
|
18556
19029
|
</details>
|
|
18557
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
|
+
|
|
18558
19096
|
## Shipping Orders Expanded
|
|
18559
19097
|
|
|
18560
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>
|
|
@@ -24256,206 +24794,6 @@ await client.utils.dev.postAgentPingV1();
|
|
|
24256
24794
|
</dl>
|
|
24257
24795
|
</details>
|
|
24258
24796
|
|
|
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
24797
|
<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">getUserIdV1</a>() -> string</code></summary>
|
|
24460
24798
|
<dl>
|
|
24461
24799
|
<dd>
|