@chrt-inc/typescript-sdk 1.723.0 → 1.733.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/analytics/resources/shipping/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/analytics/resources/shipping/client/Client.js +2 -2
- package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/{AnalyticsTimePeriodRequest.d.ts → AnalyticsTimePeriodReq.d.ts} +1 -1
- package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/Client.js +22 -14
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.d.ts +3 -5
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRulesDeleteV1Request.d.ts +14 -0
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.js +21 -21
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesRemove1.d.ts → OperationsTaskListReorderEntries1.d.ts} +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesAdd1.d.ts → OperationsTaskListSetEntries1.d.ts} +1 -1
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.d.ts +3 -3
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +66 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +31 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +129 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.d.ts +12 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/SetTaskGroupOrderingDraftReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/SetTaskGroupOrderingDraftReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.d.ts +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.js +66 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftUnassociateCargoWithTaskReq.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftUnassociateCargoWithTaskReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.ts +57 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.js +247 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +16 -1
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +65 -1
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.d.ts +12 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +4 -6
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +26 -34
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.ts +4 -6
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.ts +4 -6
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +26 -18
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.ts +4 -2
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.ts +4 -2
- package/dist/cjs/api/types/{AnalyticsTimeBucketResponse.d.ts → AnalyticsTimeBucketRes.d.ts} +1 -1
- package/dist/cjs/api/types/AnalyticsTimeBucketRes.js +5 -0
- package/dist/cjs/api/types/Cargo1.d.ts +1 -0
- package/dist/cjs/api/types/CargoStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/CargoStatusEnum1.js +1 -0
- package/dist/cjs/api/types/DeadlineAnchorEnum.d.ts +13 -0
- package/dist/cjs/api/types/DeadlineAnchorEnum.js +10 -0
- package/dist/cjs/api/types/DepartmentRoutingRule1.d.ts +3 -3
- package/dist/cjs/api/types/DriverStatsRes.d.ts +11 -0
- package/dist/cjs/api/types/DriverStatsRes.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListEntry1.d.ts +9 -7
- package/dist/cjs/api/types/OperationsTaskTypeEnum.d.ts +16 -8
- package/dist/cjs/api/types/OperationsTaskTypeEnum.js +6 -7
- package/dist/cjs/api/types/Order1.d.ts +1 -2
- package/dist/cjs/api/types/OrderDraftValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderManifestValidationRequirements.d.ts +1 -0
- package/dist/cjs/api/types/OrderSortByEnum.d.ts +2 -2
- package/dist/cjs/api/types/OrderSortByEnum.js +1 -1
- package/dist/cjs/api/types/OrderStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/OrderStatusEnum1.js +1 -0
- package/dist/cjs/api/types/Task1.d.ts +1 -1
- package/dist/cjs/api/types/TaskArtifact1.d.ts +1 -0
- package/dist/cjs/api/types/TaskArtifactStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskArtifactStatusEnum1.js +1 -0
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroupSortByEnum.d.ts +2 -1
- package/dist/cjs/api/types/TaskGroupSortByEnum.js +1 -0
- package/dist/cjs/api/types/TaskGroupStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskGroupStatusEnum1.js +1 -0
- package/dist/cjs/api/types/TaskStatusEnum1.d.ts +2 -1
- package/dist/cjs/api/types/TaskStatusEnum1.js +1 -0
- package/dist/cjs/api/types/index.d.ts +3 -2
- package/dist/cjs/api/types/index.js +3 -2
- 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/analytics/resources/shipping/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/analytics/resources/shipping/client/Client.mjs +2 -2
- package/dist/esm/api/resources/analytics/resources/shipping/client/requests/{AnalyticsTimePeriodRequest.d.mts → AnalyticsTimePeriodReq.d.mts} +1 -1
- package/dist/esm/api/resources/analytics/resources/shipping/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/Client.mjs +22 -14
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.d.mts +3 -5
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRulesDeleteV1Request.d.mts +14 -0
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.mjs +21 -21
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesRemove1.d.mts → OperationsTaskListReorderEntries1.d.mts} +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesAdd1.d.mts → OperationsTaskListSetEntries1.d.mts} +1 -1
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.d.mts +3 -3
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +17 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +66 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriverStatsReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +31 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +129 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.d.mts +12 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/SetTaskGroupOrderingDraftReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/SetTaskGroupOrderingDraftReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.d.mts +17 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.mjs +66 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftUnassociateCargoWithTaskReq.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftUnassociateCargoWithTaskReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.d.mts +57 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.mjs +247 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +16 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +65 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.d.mts +12 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +4 -6
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +26 -34
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForCoordinatorOperatorsV1Request.d.mts +4 -6
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedListForShipperOperatorsV1Request.d.mts +4 -6
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +26 -18
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForDriverForExecutorV1Request.d.mts +4 -2
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedListForExecutorOperatorsV1Request.d.mts +4 -2
- package/dist/esm/api/types/{AnalyticsTimeBucketResponse.d.mts → AnalyticsTimeBucketRes.d.mts} +1 -1
- package/dist/esm/api/types/AnalyticsTimeBucketRes.mjs +4 -0
- package/dist/esm/api/types/Cargo1.d.mts +1 -0
- package/dist/esm/api/types/CargoStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/CargoStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/DeadlineAnchorEnum.d.mts +13 -0
- package/dist/esm/api/types/DeadlineAnchorEnum.mjs +7 -0
- package/dist/esm/api/types/DepartmentRoutingRule1.d.mts +3 -3
- package/dist/esm/api/types/DriverStatsRes.d.mts +11 -0
- package/dist/esm/api/types/DriverStatsRes.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListEntry1.d.mts +9 -7
- package/dist/esm/api/types/OperationsTaskTypeEnum.d.mts +16 -8
- package/dist/esm/api/types/OperationsTaskTypeEnum.mjs +6 -7
- package/dist/esm/api/types/Order1.d.mts +1 -2
- package/dist/esm/api/types/OrderDraftValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderManifestValidationRequirements.d.mts +1 -0
- package/dist/esm/api/types/OrderSortByEnum.d.mts +2 -2
- package/dist/esm/api/types/OrderSortByEnum.mjs +1 -1
- package/dist/esm/api/types/OrderStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/OrderStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/Task1.d.mts +1 -1
- package/dist/esm/api/types/TaskArtifact1.d.mts +1 -0
- package/dist/esm/api/types/TaskArtifactStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskArtifactStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -1
- package/dist/esm/api/types/TaskGroupSortByEnum.d.mts +2 -1
- package/dist/esm/api/types/TaskGroupSortByEnum.mjs +1 -0
- package/dist/esm/api/types/TaskGroupStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskGroupStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/TaskStatusEnum1.d.mts +2 -1
- package/dist/esm/api/types/TaskStatusEnum1.mjs +1 -0
- package/dist/esm/api/types/index.d.mts +3 -2
- package/dist/esm/api/types/index.mjs +3 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +736 -129
- package/dist/cjs/api/types/RoutingCounterpartyTypeEnum.d.ts +0 -8
- package/dist/cjs/api/types/RoutingCounterpartyTypeEnum.js +0 -10
- package/dist/esm/api/types/RoutingCounterpartyTypeEnum.d.mts +0 -8
- package/dist/esm/api/types/RoutingCounterpartyTypeEnum.mjs +0 -7
- /package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/{AnalyticsTimePeriodRequest.js → AnalyticsTimePeriodReq.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.js → departmentRoutingRules/client/requests/DepartmentRoutingRulesDeleteV1Request.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesRemove1.js → OperationsTaskListReorderEntries1.js} +0 -0
- /package/dist/cjs/api/{types/AnalyticsTimeBucketResponse.js → resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.js} +0 -0
- /package/dist/esm/api/resources/analytics/resources/shipping/client/requests/{AnalyticsTimePeriodRequest.mjs → AnalyticsTimePeriodReq.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.mjs → departmentRoutingRules/client/requests/DepartmentRoutingRulesDeleteV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/{OperationsTaskListEntriesRemove1.mjs → OperationsTaskListReorderEntries1.mjs} +0 -0
- /package/dist/esm/api/{types/AnalyticsTimeBucketResponse.mjs → resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListSetEntries1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -316,7 +316,7 @@ await client.utils.getTimezoneV1({
|
|
|
316
316
|
|
|
317
317
|
## Analytics Shipping
|
|
318
318
|
|
|
319
|
-
<details><summary><code>client.analytics.shipping.<a href="/src/api/resources/analytics/resources/shipping/client/Client.ts">retrieveOrdersCountV1</a>({ ...params }) -> Chrt.
|
|
319
|
+
<details><summary><code>client.analytics.shipping.<a href="/src/api/resources/analytics/resources/shipping/client/Client.ts">retrieveOrdersCountV1</a>({ ...params }) -> Chrt.AnalyticsTimeBucketRes</code></summary>
|
|
320
320
|
<dl>
|
|
321
321
|
<dd>
|
|
322
322
|
|
|
@@ -328,7 +328,7 @@ await client.utils.getTimezoneV1({
|
|
|
328
328
|
<dl>
|
|
329
329
|
<dd>
|
|
330
330
|
|
|
331
|
-
Retrieves order counts bucketed by time period. | (
|
|
331
|
+
Retrieves order counts bucketed by time period. | (AnalyticsTimePeriodReq) -> (AnalyticsTimeBucketRes)
|
|
332
332
|
|
|
333
333
|
</dd>
|
|
334
334
|
</dl>
|
|
@@ -363,7 +363,7 @@ await client.analytics.shipping.retrieveOrdersCountV1({
|
|
|
363
363
|
<dl>
|
|
364
364
|
<dd>
|
|
365
365
|
|
|
366
|
-
**request:** `Chrt.analytics.
|
|
366
|
+
**request:** `Chrt.analytics.AnalyticsTimePeriodReq`
|
|
367
367
|
|
|
368
368
|
</dd>
|
|
369
369
|
</dl>
|
|
@@ -11577,7 +11577,7 @@ await client.operations.departmentRoutingRules.listV1();
|
|
|
11577
11577
|
<dl>
|
|
11578
11578
|
<dd>
|
|
11579
11579
|
|
|
11580
|
-
Sets the caller org's default operations desk for a counterparty (on-chrt shipper
|
|
11580
|
+
Sets the caller org's default operations desk for a counterparty. The body must set exactly one of shipper_org_id (on-chrt shipper) / off_chrt_shipper_org_id (off-chrt shipper shell) (XOR). Upsert: one rule per (owner, counterparty). Returns the rule id. The mapping is a non-binding suggestion surfaced at Case creation. | authz: min_org_role=administrator | (DepartmentRoutingRuleClientCreate1) -> (PydanticObjectId)
|
|
11581
11581
|
|
|
11582
11582
|
</dd>
|
|
11583
11583
|
</dl>
|
|
@@ -11595,8 +11595,6 @@ Sets the caller org's default operations desk for a counterparty (on-chrt shippe
|
|
|
11595
11595
|
```typescript
|
|
11596
11596
|
await client.operations.departmentRoutingRules.upsertV1({
|
|
11597
11597
|
schema_version: 1,
|
|
11598
|
-
counterparty_type: "shipper_org",
|
|
11599
|
-
counterparty_id: "counterparty_id",
|
|
11600
11598
|
department_id: "department_id",
|
|
11601
11599
|
});
|
|
11602
11600
|
```
|
|
@@ -11633,7 +11631,7 @@ await client.operations.departmentRoutingRules.upsertV1({
|
|
|
11633
11631
|
</dl>
|
|
11634
11632
|
</details>
|
|
11635
11633
|
|
|
11636
|
-
<details><summary><code>client.operations.departmentRoutingRules.<a href="/src/api/resources/operations/resources/departmentRoutingRules/client/Client.ts">deleteV1</a>(
|
|
11634
|
+
<details><summary><code>client.operations.departmentRoutingRules.<a href="/src/api/resources/operations/resources/departmentRoutingRules/client/Client.ts">deleteV1</a>({ ...params }) -> boolean</code></summary>
|
|
11637
11635
|
<dl>
|
|
11638
11636
|
<dd>
|
|
11639
11637
|
|
|
@@ -11645,7 +11643,7 @@ await client.operations.departmentRoutingRules.upsertV1({
|
|
|
11645
11643
|
<dl>
|
|
11646
11644
|
<dd>
|
|
11647
11645
|
|
|
11648
|
-
Clears the caller org's default operations desk for a counterparty. | authz: min_org_role=administrator | () -> (bool)
|
|
11646
|
+
Clears the caller org's default operations desk for a counterparty, keyed by exactly one of the shipper_org_id / off_chrt_shipper_org_id query params. | authz: min_org_role=administrator | () -> (bool)
|
|
11649
11647
|
|
|
11650
11648
|
</dd>
|
|
11651
11649
|
</dl>
|
|
@@ -11661,7 +11659,10 @@ Clears the caller org's default operations desk for a counterparty. | authz: min
|
|
|
11661
11659
|
<dd>
|
|
11662
11660
|
|
|
11663
11661
|
```typescript
|
|
11664
|
-
await client.operations.departmentRoutingRules.deleteV1(
|
|
11662
|
+
await client.operations.departmentRoutingRules.deleteV1({
|
|
11663
|
+
shipper_org_id: "shipper_org_id",
|
|
11664
|
+
off_chrt_shipper_org_id: "off_chrt_shipper_org_id",
|
|
11665
|
+
});
|
|
11665
11666
|
```
|
|
11666
11667
|
|
|
11667
11668
|
</dd>
|
|
@@ -11677,15 +11678,7 @@ await client.operations.departmentRoutingRules.deleteV1("shipper_org", "counterp
|
|
|
11677
11678
|
<dl>
|
|
11678
11679
|
<dd>
|
|
11679
11680
|
|
|
11680
|
-
**
|
|
11681
|
-
|
|
11682
|
-
</dd>
|
|
11683
|
-
</dl>
|
|
11684
|
-
|
|
11685
|
-
<dl>
|
|
11686
|
-
<dd>
|
|
11687
|
-
|
|
11688
|
-
**counterpartyId:** `string`
|
|
11681
|
+
**request:** `Chrt.operations.DepartmentRoutingRulesDeleteV1Request`
|
|
11689
11682
|
|
|
11690
11683
|
</dd>
|
|
11691
11684
|
</dl>
|
|
@@ -12451,7 +12444,7 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12451
12444
|
</dl>
|
|
12452
12445
|
</details>
|
|
12453
12446
|
|
|
12454
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
12447
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">setEntriesV1</a>(taskListId, { ...params }) -> boolean</code></summary>
|
|
12455
12448
|
<dl>
|
|
12456
12449
|
<dd>
|
|
12457
12450
|
|
|
@@ -12463,7 +12456,7 @@ await client.operations.operationsTaskLists.createV1({
|
|
|
12463
12456
|
<dl>
|
|
12464
12457
|
<dd>
|
|
12465
12458
|
|
|
12466
|
-
|
|
12459
|
+
Replaces an OperationsTaskList's `entries` array wholesale — covering add, remove, reorder, and edit in one operation. Order is load-bearing for from_previous_task-anchored deadlines. | authz: min_org_role=operator | (OperationsTaskListSetEntries1) -> (bool)
|
|
12467
12460
|
|
|
12468
12461
|
</dd>
|
|
12469
12462
|
</dl>
|
|
@@ -12479,7 +12472,7 @@ Appends entries to an OperationsTaskList's `entries` array. | authz: min_org_rol
|
|
|
12479
12472
|
<dd>
|
|
12480
12473
|
|
|
12481
12474
|
```typescript
|
|
12482
|
-
await client.operations.operationsTaskLists.
|
|
12475
|
+
await client.operations.operationsTaskLists.setEntriesV1("task_list_id");
|
|
12483
12476
|
```
|
|
12484
12477
|
|
|
12485
12478
|
</dd>
|
|
@@ -12503,7 +12496,7 @@ await client.operations.operationsTaskLists.addEntriesV1("task_list_id");
|
|
|
12503
12496
|
<dl>
|
|
12504
12497
|
<dd>
|
|
12505
12498
|
|
|
12506
|
-
**request:** `Chrt.operations.
|
|
12499
|
+
**request:** `Chrt.operations.OperationsTaskListSetEntries1`
|
|
12507
12500
|
|
|
12508
12501
|
</dd>
|
|
12509
12502
|
</dl>
|
|
@@ -12522,7 +12515,7 @@ await client.operations.operationsTaskLists.addEntriesV1("task_list_id");
|
|
|
12522
12515
|
</dl>
|
|
12523
12516
|
</details>
|
|
12524
12517
|
|
|
12525
|
-
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">
|
|
12518
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">reorderEntriesV1</a>(taskListId, { ...params }) -> boolean</code></summary>
|
|
12526
12519
|
<dl>
|
|
12527
12520
|
<dd>
|
|
12528
12521
|
|
|
@@ -12534,7 +12527,7 @@ await client.operations.operationsTaskLists.addEntriesV1("task_list_id");
|
|
|
12534
12527
|
<dl>
|
|
12535
12528
|
<dd>
|
|
12536
12529
|
|
|
12537
|
-
|
|
12530
|
+
Reorders an OperationsTaskList's existing entries. `entry_ids` must be an exact permutation of the list's current entry ids (every id present, no extras, no duplicates), so a reorder can never drop, add, or mutate an entry. | authz: min_org_role=operator | (OperationsTaskListReorderEntries1) -> (bool)
|
|
12538
12531
|
|
|
12539
12532
|
</dd>
|
|
12540
12533
|
</dl>
|
|
@@ -12550,7 +12543,7 @@ Removes entries from an OperationsTaskList by entry id. | authz: min_org_role=op
|
|
|
12550
12543
|
<dd>
|
|
12551
12544
|
|
|
12552
12545
|
```typescript
|
|
12553
|
-
await client.operations.operationsTaskLists.
|
|
12546
|
+
await client.operations.operationsTaskLists.reorderEntriesV1("task_list_id");
|
|
12554
12547
|
```
|
|
12555
12548
|
|
|
12556
12549
|
</dd>
|
|
@@ -12574,7 +12567,7 @@ await client.operations.operationsTaskLists.removeEntriesV1("task_list_id");
|
|
|
12574
12567
|
<dl>
|
|
12575
12568
|
<dd>
|
|
12576
12569
|
|
|
12577
|
-
**request:** `Chrt.operations.
|
|
12570
|
+
**request:** `Chrt.operations.OperationsTaskListReorderEntries1`
|
|
12578
12571
|
|
|
12579
12572
|
</dd>
|
|
12580
12573
|
</dl>
|
|
@@ -12731,7 +12724,7 @@ await client.operations.operationsTaskLists.unarchiveV1("task_list_id");
|
|
|
12731
12724
|
<dl>
|
|
12732
12725
|
<dd>
|
|
12733
12726
|
|
|
12734
|
-
Materializes each entry of an OperationsTaskList into an OperationsTask on the Case (status=not_started, source_task_list_id set). Deadlines
|
|
12727
|
+
Materializes each entry of an OperationsTaskList into an OperationsTask on the Case (status=not_started, source_task_list_id set). Deadlines resolve per-entry from its anchor+offset; initial_deadline_timestamp, if set, pins the first entry and the chain follows. No dedup — applying twice creates duplicate tasks. | authz: min_org_role=operator | () -> (list[PydanticObjectId])
|
|
12735
12728
|
|
|
12736
12729
|
</dd>
|
|
12737
12730
|
</dl>
|
|
@@ -12748,7 +12741,7 @@ Materializes each entry of an OperationsTaskList into an OperationsTask on the C
|
|
|
12748
12741
|
|
|
12749
12742
|
```typescript
|
|
12750
12743
|
await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_id", {
|
|
12751
|
-
|
|
12744
|
+
initial_deadline_timestamp: "2024-01-15T09:30:00Z",
|
|
12752
12745
|
});
|
|
12753
12746
|
```
|
|
12754
12747
|
|
|
@@ -16451,6 +16444,80 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16451
16444
|
|
|
16452
16445
|
## Shipping Drivers
|
|
16453
16446
|
|
|
16447
|
+
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getStatsV1</a>(driverId, { ...params }) -> Chrt.DriverStatsRes</code></summary>
|
|
16448
|
+
<dl>
|
|
16449
|
+
<dd>
|
|
16450
|
+
|
|
16451
|
+
#### 📝 Description
|
|
16452
|
+
|
|
16453
|
+
<dl>
|
|
16454
|
+
<dd>
|
|
16455
|
+
|
|
16456
|
+
<dl>
|
|
16457
|
+
<dd>
|
|
16458
|
+
|
|
16459
|
+
Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
16460
|
+
|
|
16461
|
+
</dd>
|
|
16462
|
+
</dl>
|
|
16463
|
+
</dd>
|
|
16464
|
+
</dl>
|
|
16465
|
+
|
|
16466
|
+
#### 🔌 Usage
|
|
16467
|
+
|
|
16468
|
+
<dl>
|
|
16469
|
+
<dd>
|
|
16470
|
+
|
|
16471
|
+
<dl>
|
|
16472
|
+
<dd>
|
|
16473
|
+
|
|
16474
|
+
```typescript
|
|
16475
|
+
await client.shipping.drivers.getStatsV1("driver_id", {
|
|
16476
|
+
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16477
|
+
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16478
|
+
});
|
|
16479
|
+
```
|
|
16480
|
+
|
|
16481
|
+
</dd>
|
|
16482
|
+
</dl>
|
|
16483
|
+
</dd>
|
|
16484
|
+
</dl>
|
|
16485
|
+
|
|
16486
|
+
#### ⚙️ Parameters
|
|
16487
|
+
|
|
16488
|
+
<dl>
|
|
16489
|
+
<dd>
|
|
16490
|
+
|
|
16491
|
+
<dl>
|
|
16492
|
+
<dd>
|
|
16493
|
+
|
|
16494
|
+
**driverId:** `string`
|
|
16495
|
+
|
|
16496
|
+
</dd>
|
|
16497
|
+
</dl>
|
|
16498
|
+
|
|
16499
|
+
<dl>
|
|
16500
|
+
<dd>
|
|
16501
|
+
|
|
16502
|
+
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16503
|
+
|
|
16504
|
+
</dd>
|
|
16505
|
+
</dl>
|
|
16506
|
+
|
|
16507
|
+
<dl>
|
|
16508
|
+
<dd>
|
|
16509
|
+
|
|
16510
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16511
|
+
|
|
16512
|
+
</dd>
|
|
16513
|
+
</dl>
|
|
16514
|
+
</dd>
|
|
16515
|
+
</dl>
|
|
16516
|
+
|
|
16517
|
+
</dd>
|
|
16518
|
+
</dl>
|
|
16519
|
+
</details>
|
|
16520
|
+
|
|
16454
16521
|
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
16455
16522
|
<dl>
|
|
16456
16523
|
<dd>
|
|
@@ -17667,7 +17734,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
17667
17734
|
<dl>
|
|
17668
17735
|
<dd>
|
|
17669
17736
|
|
|
17670
|
-
Cancels an order and
|
|
17737
|
+
Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17671
17738
|
|
|
17672
17739
|
</dd>
|
|
17673
17740
|
</dl>
|
|
@@ -17718,9 +17785,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17718
17785
|
</dl>
|
|
17719
17786
|
</details>
|
|
17720
17787
|
|
|
17721
|
-
|
|
17722
|
-
|
|
17723
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
17788
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
17724
17789
|
<dl>
|
|
17725
17790
|
<dd>
|
|
17726
17791
|
|
|
@@ -17732,7 +17797,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17732
17797
|
<dl>
|
|
17733
17798
|
<dd>
|
|
17734
17799
|
|
|
17735
|
-
|
|
17800
|
+
Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)
|
|
17736
17801
|
|
|
17737
17802
|
</dd>
|
|
17738
17803
|
</dl>
|
|
@@ -17748,7 +17813,9 @@ Creates a new draft order with org assignments based on caller's organization ty
|
|
|
17748
17813
|
<dd>
|
|
17749
17814
|
|
|
17750
17815
|
```typescript
|
|
17751
|
-
await client.shipping.
|
|
17816
|
+
await client.shipping.orders.cancelManyV1({
|
|
17817
|
+
order_ids: ["order_ids"],
|
|
17818
|
+
});
|
|
17752
17819
|
```
|
|
17753
17820
|
|
|
17754
17821
|
</dd>
|
|
@@ -17764,7 +17831,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
17764
17831
|
<dl>
|
|
17765
17832
|
<dd>
|
|
17766
17833
|
|
|
17767
|
-
**request:** `Chrt.shipping.
|
|
17834
|
+
**request:** `Chrt.shipping.OrdersCancelManyReq`
|
|
17768
17835
|
|
|
17769
17836
|
</dd>
|
|
17770
17837
|
</dl>
|
|
@@ -17772,7 +17839,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
17772
17839
|
<dl>
|
|
17773
17840
|
<dd>
|
|
17774
17841
|
|
|
17775
|
-
**requestOptions:** `
|
|
17842
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17776
17843
|
|
|
17777
17844
|
</dd>
|
|
17778
17845
|
</dl>
|
|
@@ -17783,7 +17850,9 @@ await client.shipping.orderDrafts.newV1();
|
|
|
17783
17850
|
</dl>
|
|
17784
17851
|
</details>
|
|
17785
17852
|
|
|
17786
|
-
|
|
17853
|
+
## Shipping OrderDrafts
|
|
17854
|
+
|
|
17855
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
17787
17856
|
<dl>
|
|
17788
17857
|
<dd>
|
|
17789
17858
|
|
|
@@ -17795,7 +17864,7 @@ await client.shipping.orderDrafts.newV1();
|
|
|
17795
17864
|
<dl>
|
|
17796
17865
|
<dd>
|
|
17797
17866
|
|
|
17798
|
-
|
|
17867
|
+
Creates a new draft order with org assignments based on caller's organization type. | (OrdersNewDraftReq) -> (OrdersNewDraftRes)
|
|
17799
17868
|
|
|
17800
17869
|
</dd>
|
|
17801
17870
|
</dl>
|
|
@@ -17811,7 +17880,7 @@ Updates coordinator and/or shipper org assignments for a draft order. | (OrdersD
|
|
|
17811
17880
|
<dd>
|
|
17812
17881
|
|
|
17813
17882
|
```typescript
|
|
17814
|
-
await client.shipping.orderDrafts.
|
|
17883
|
+
await client.shipping.orderDrafts.newV1();
|
|
17815
17884
|
```
|
|
17816
17885
|
|
|
17817
17886
|
</dd>
|
|
@@ -17827,15 +17896,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
17827
17896
|
<dl>
|
|
17828
17897
|
<dd>
|
|
17829
17898
|
|
|
17830
|
-
**
|
|
17831
|
-
|
|
17832
|
-
</dd>
|
|
17833
|
-
</dl>
|
|
17834
|
-
|
|
17835
|
-
<dl>
|
|
17836
|
-
<dd>
|
|
17837
|
-
|
|
17838
|
-
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
17899
|
+
**request:** `Chrt.shipping.OrdersNewDraftReq`
|
|
17839
17900
|
|
|
17840
17901
|
</dd>
|
|
17841
17902
|
</dl>
|
|
@@ -17854,7 +17915,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
17854
17915
|
</dl>
|
|
17855
17916
|
</details>
|
|
17856
17917
|
|
|
17857
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">
|
|
17918
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">updateV1</a>(orderId, { ...params }) -> Chrt.OrdersDraftUpdateRes</code></summary>
|
|
17858
17919
|
<dl>
|
|
17859
17920
|
<dd>
|
|
17860
17921
|
|
|
@@ -17866,7 +17927,7 @@ await client.shipping.orderDrafts.updateV1("order_id");
|
|
|
17866
17927
|
<dl>
|
|
17867
17928
|
<dd>
|
|
17868
17929
|
|
|
17869
|
-
|
|
17930
|
+
Updates coordinator and/or shipper org assignments for a draft order. | (OrdersDraftUpdateReq) -> (OrdersDraftUpdateRes)
|
|
17870
17931
|
|
|
17871
17932
|
</dd>
|
|
17872
17933
|
</dl>
|
|
@@ -17882,7 +17943,7 @@ Deletes a draft order and all associated entities. | () -> (bool)
|
|
|
17882
17943
|
<dd>
|
|
17883
17944
|
|
|
17884
17945
|
```typescript
|
|
17885
|
-
await client.shipping.orderDrafts.
|
|
17946
|
+
await client.shipping.orderDrafts.updateV1("order_id");
|
|
17886
17947
|
```
|
|
17887
17948
|
|
|
17888
17949
|
</dd>
|
|
@@ -17906,6 +17967,14 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
17906
17967
|
<dl>
|
|
17907
17968
|
<dd>
|
|
17908
17969
|
|
|
17970
|
+
**request:** `Chrt.shipping.OrdersDraftUpdateReq`
|
|
17971
|
+
|
|
17972
|
+
</dd>
|
|
17973
|
+
</dl>
|
|
17974
|
+
|
|
17975
|
+
<dl>
|
|
17976
|
+
<dd>
|
|
17977
|
+
|
|
17909
17978
|
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
17910
17979
|
|
|
17911
17980
|
</dd>
|
|
@@ -17917,7 +17986,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
17917
17986
|
</dl>
|
|
17918
17987
|
</details>
|
|
17919
17988
|
|
|
17920
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">
|
|
17989
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">setTaskGroupOrderingV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17921
17990
|
<dl>
|
|
17922
17991
|
<dd>
|
|
17923
17992
|
|
|
@@ -17929,7 +17998,7 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
17929
17998
|
<dl>
|
|
17930
17999
|
<dd>
|
|
17931
18000
|
|
|
17932
|
-
|
|
18001
|
+
Sets the ordering of task groups within a draft order. Must provide all task group IDs with no duplicates. | (SetTaskGroupOrderingDraftReq) -> (bool)
|
|
17933
18002
|
|
|
17934
18003
|
</dd>
|
|
17935
18004
|
</dl>
|
|
@@ -17945,8 +18014,8 @@ Converts an order screenshot into lightly structured text for the AI order build
|
|
|
17945
18014
|
<dd>
|
|
17946
18015
|
|
|
17947
18016
|
```typescript
|
|
17948
|
-
await client.shipping.orderDrafts.
|
|
17949
|
-
|
|
18017
|
+
await client.shipping.orderDrafts.setTaskGroupOrderingV1("order_id", {
|
|
18018
|
+
task_group_ids: ["task_group_ids"],
|
|
17950
18019
|
});
|
|
17951
18020
|
```
|
|
17952
18021
|
|
|
@@ -17963,7 +18032,15 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
17963
18032
|
<dl>
|
|
17964
18033
|
<dd>
|
|
17965
18034
|
|
|
17966
|
-
**
|
|
18035
|
+
**orderId:** `string`
|
|
18036
|
+
|
|
18037
|
+
</dd>
|
|
18038
|
+
</dl>
|
|
18039
|
+
|
|
18040
|
+
<dl>
|
|
18041
|
+
<dd>
|
|
18042
|
+
|
|
18043
|
+
**request:** `Chrt.shipping.SetTaskGroupOrderingDraftReq`
|
|
17967
18044
|
|
|
17968
18045
|
</dd>
|
|
17969
18046
|
</dl>
|
|
@@ -17982,7 +18059,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
17982
18059
|
</dl>
|
|
17983
18060
|
</details>
|
|
17984
18061
|
|
|
17985
|
-
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">
|
|
18062
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteV1</a>(orderId) -> boolean</code></summary>
|
|
17986
18063
|
<dl>
|
|
17987
18064
|
<dd>
|
|
17988
18065
|
|
|
@@ -17994,7 +18071,7 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
17994
18071
|
<dl>
|
|
17995
18072
|
<dd>
|
|
17996
18073
|
|
|
17997
|
-
|
|
18074
|
+
Deletes a draft order and all associated entities. | () -> (bool)
|
|
17998
18075
|
|
|
17999
18076
|
</dd>
|
|
18000
18077
|
</dl>
|
|
@@ -18010,7 +18087,7 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
18010
18087
|
<dd>
|
|
18011
18088
|
|
|
18012
18089
|
```typescript
|
|
18013
|
-
await client.shipping.orderDrafts.
|
|
18090
|
+
await client.shipping.orderDrafts.deleteV1("order_id");
|
|
18014
18091
|
```
|
|
18015
18092
|
|
|
18016
18093
|
</dd>
|
|
@@ -18045,9 +18122,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
18045
18122
|
</dl>
|
|
18046
18123
|
</details>
|
|
18047
18124
|
|
|
18048
|
-
|
|
18049
|
-
|
|
18050
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
|
|
18125
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18051
18126
|
<dl>
|
|
18052
18127
|
<dd>
|
|
18053
18128
|
|
|
@@ -18059,7 +18134,7 @@ await client.shipping.orderDrafts.validateV1("order_id");
|
|
|
18059
18134
|
<dl>
|
|
18060
18135
|
<dd>
|
|
18061
18136
|
|
|
18062
|
-
|
|
18137
|
+
Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)
|
|
18063
18138
|
|
|
18064
18139
|
</dd>
|
|
18065
18140
|
</dl>
|
|
@@ -18075,16 +18150,8 @@ Lists order schedules for the caller's organization with filtering, sorting, and
|
|
|
18075
18150
|
<dd>
|
|
18076
18151
|
|
|
18077
18152
|
```typescript
|
|
18078
|
-
await client.shipping.
|
|
18079
|
-
|
|
18080
|
-
sort_order: "asc",
|
|
18081
|
-
page: 1,
|
|
18082
|
-
page_size: 1,
|
|
18083
|
-
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
18084
|
-
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
18085
|
-
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18086
|
-
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
18087
|
-
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18153
|
+
await client.shipping.orderDrafts.deleteManyV1({
|
|
18154
|
+
order_ids: ["order_ids"],
|
|
18088
18155
|
});
|
|
18089
18156
|
```
|
|
18090
18157
|
|
|
@@ -18101,7 +18168,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
18101
18168
|
<dl>
|
|
18102
18169
|
<dd>
|
|
18103
18170
|
|
|
18104
|
-
**request:** `Chrt.shipping.
|
|
18171
|
+
**request:** `Chrt.shipping.OrdersDraftDeleteManyReq`
|
|
18105
18172
|
|
|
18106
18173
|
</dd>
|
|
18107
18174
|
</dl>
|
|
@@ -18109,7 +18176,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
18109
18176
|
<dl>
|
|
18110
18177
|
<dd>
|
|
18111
18178
|
|
|
18112
|
-
**requestOptions:** `
|
|
18179
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18113
18180
|
|
|
18114
18181
|
</dd>
|
|
18115
18182
|
</dl>
|
|
@@ -18120,7 +18187,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
18120
18187
|
</dl>
|
|
18121
18188
|
</details>
|
|
18122
18189
|
|
|
18123
|
-
<details><summary><code>client.shipping.
|
|
18190
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
18124
18191
|
<dl>
|
|
18125
18192
|
<dd>
|
|
18126
18193
|
|
|
@@ -18132,7 +18199,7 @@ await client.shipping.orderSchedules.listV1({
|
|
|
18132
18199
|
<dl>
|
|
18133
18200
|
<dd>
|
|
18134
18201
|
|
|
18135
|
-
|
|
18202
|
+
Converts an order screenshot into lightly structured text for the AI order builder. | (UploadFile) -> (str)
|
|
18136
18203
|
|
|
18137
18204
|
</dd>
|
|
18138
18205
|
</dl>
|
|
@@ -18148,7 +18215,9 @@ Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (Order
|
|
|
18148
18215
|
<dd>
|
|
18149
18216
|
|
|
18150
18217
|
```typescript
|
|
18151
|
-
await client.shipping.
|
|
18218
|
+
await client.shipping.orderDrafts.imageToTextV1({
|
|
18219
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
18220
|
+
});
|
|
18152
18221
|
```
|
|
18153
18222
|
|
|
18154
18223
|
</dd>
|
|
@@ -18164,7 +18233,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
18164
18233
|
<dl>
|
|
18165
18234
|
<dd>
|
|
18166
18235
|
|
|
18167
|
-
**
|
|
18236
|
+
**request:** `Chrt.shipping.BodyPostShippingOrderDraftsImageToTextV1ShippingOrderDraftsImageToTextV1Post`
|
|
18168
18237
|
|
|
18169
18238
|
</dd>
|
|
18170
18239
|
</dl>
|
|
@@ -18172,7 +18241,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
18172
18241
|
<dl>
|
|
18173
18242
|
<dd>
|
|
18174
18243
|
|
|
18175
|
-
**requestOptions:** `
|
|
18244
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18176
18245
|
|
|
18177
18246
|
</dd>
|
|
18178
18247
|
</dl>
|
|
@@ -18183,7 +18252,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
18183
18252
|
</dl>
|
|
18184
18253
|
</details>
|
|
18185
18254
|
|
|
18186
|
-
<details><summary><code>client.shipping.
|
|
18255
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
18187
18256
|
<dl>
|
|
18188
18257
|
<dd>
|
|
18189
18258
|
|
|
@@ -18195,7 +18264,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
18195
18264
|
<dl>
|
|
18196
18265
|
<dd>
|
|
18197
18266
|
|
|
18198
|
-
|
|
18267
|
+
Validates the draft order for staging and returns requirement results. | () -> (OrderDraftValidationResult)
|
|
18199
18268
|
|
|
18200
18269
|
</dd>
|
|
18201
18270
|
</dl>
|
|
@@ -18211,7 +18280,7 @@ Retrieves schedule metadata, generated order count, and live orchestrator status
|
|
|
18211
18280
|
<dd>
|
|
18212
18281
|
|
|
18213
18282
|
```typescript
|
|
18214
|
-
await client.shipping.
|
|
18283
|
+
await client.shipping.orderDrafts.validateV1("order_id");
|
|
18215
18284
|
```
|
|
18216
18285
|
|
|
18217
18286
|
</dd>
|
|
@@ -18227,7 +18296,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18227
18296
|
<dl>
|
|
18228
18297
|
<dd>
|
|
18229
18298
|
|
|
18230
|
-
**
|
|
18299
|
+
**orderId:** `string`
|
|
18231
18300
|
|
|
18232
18301
|
</dd>
|
|
18233
18302
|
</dl>
|
|
@@ -18235,7 +18304,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18235
18304
|
<dl>
|
|
18236
18305
|
<dd>
|
|
18237
18306
|
|
|
18238
|
-
**requestOptions:** `
|
|
18307
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18239
18308
|
|
|
18240
18309
|
</dd>
|
|
18241
18310
|
</dl>
|
|
@@ -18246,7 +18315,9 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18246
18315
|
</dl>
|
|
18247
18316
|
</details>
|
|
18248
18317
|
|
|
18249
|
-
|
|
18318
|
+
## Shipping OrderSchedules
|
|
18319
|
+
|
|
18320
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderScheduleListRes</code></summary>
|
|
18250
18321
|
<dl>
|
|
18251
18322
|
<dd>
|
|
18252
18323
|
|
|
@@ -18258,7 +18329,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18258
18329
|
<dl>
|
|
18259
18330
|
<dd>
|
|
18260
18331
|
|
|
18261
|
-
|
|
18332
|
+
Lists order schedules for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OrderScheduleListRes)
|
|
18262
18333
|
|
|
18263
18334
|
</dd>
|
|
18264
18335
|
</dl>
|
|
@@ -18274,11 +18345,16 @@ Creates a new draft order schedule. | authz: min_org_role=operator | (OrderSched
|
|
|
18274
18345
|
<dd>
|
|
18275
18346
|
|
|
18276
18347
|
```typescript
|
|
18277
|
-
await client.shipping.orderSchedules.
|
|
18278
|
-
|
|
18279
|
-
|
|
18280
|
-
|
|
18281
|
-
|
|
18348
|
+
await client.shipping.orderSchedules.listV1({
|
|
18349
|
+
sort_by: "created_at_timestamp",
|
|
18350
|
+
sort_order: "asc",
|
|
18351
|
+
page: 1,
|
|
18352
|
+
page_size: 1,
|
|
18353
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
18354
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
18355
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18356
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
18357
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
18282
18358
|
});
|
|
18283
18359
|
```
|
|
18284
18360
|
|
|
@@ -18295,7 +18371,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18295
18371
|
<dl>
|
|
18296
18372
|
<dd>
|
|
18297
18373
|
|
|
18298
|
-
**request:** `Chrt.shipping.
|
|
18374
|
+
**request:** `Chrt.shipping.OrderSchedulesListV1Request`
|
|
18299
18375
|
|
|
18300
18376
|
</dd>
|
|
18301
18377
|
</dl>
|
|
@@ -18314,7 +18390,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18314
18390
|
</dl>
|
|
18315
18391
|
</details>
|
|
18316
18392
|
|
|
18317
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18393
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">getByIdV1</a>(orderScheduleId) -> Chrt.OrderSchedule1</code></summary>
|
|
18318
18394
|
<dl>
|
|
18319
18395
|
<dd>
|
|
18320
18396
|
|
|
@@ -18326,7 +18402,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18326
18402
|
<dl>
|
|
18327
18403
|
<dd>
|
|
18328
18404
|
|
|
18329
|
-
|
|
18405
|
+
Retrieves an order schedule by ID. | authz: min_org_role=operator | () -> (OrderSchedule1)
|
|
18330
18406
|
|
|
18331
18407
|
</dd>
|
|
18332
18408
|
</dl>
|
|
@@ -18342,7 +18418,7 @@ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClient
|
|
|
18342
18418
|
<dd>
|
|
18343
18419
|
|
|
18344
18420
|
```typescript
|
|
18345
|
-
await client.shipping.orderSchedules.
|
|
18421
|
+
await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
18346
18422
|
```
|
|
18347
18423
|
|
|
18348
18424
|
</dd>
|
|
@@ -18366,14 +18442,6 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18366
18442
|
<dl>
|
|
18367
18443
|
<dd>
|
|
18368
18444
|
|
|
18369
|
-
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
18370
|
-
|
|
18371
|
-
</dd>
|
|
18372
|
-
</dl>
|
|
18373
|
-
|
|
18374
|
-
<dl>
|
|
18375
|
-
<dd>
|
|
18376
|
-
|
|
18377
18445
|
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18378
18446
|
|
|
18379
18447
|
</dd>
|
|
@@ -18385,7 +18453,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18385
18453
|
</dl>
|
|
18386
18454
|
</details>
|
|
18387
18455
|
|
|
18388
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18456
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">aboutV1</a>(orderScheduleId) -> Chrt.OrderScheduleAboutRes</code></summary>
|
|
18389
18457
|
<dl>
|
|
18390
18458
|
<dd>
|
|
18391
18459
|
|
|
@@ -18397,7 +18465,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18397
18465
|
<dl>
|
|
18398
18466
|
<dd>
|
|
18399
18467
|
|
|
18400
|
-
|
|
18468
|
+
Retrieves schedule metadata, generated order count, and live orchestrator status. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
18401
18469
|
|
|
18402
18470
|
</dd>
|
|
18403
18471
|
</dl>
|
|
@@ -18413,7 +18481,7 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
|
|
|
18413
18481
|
<dd>
|
|
18414
18482
|
|
|
18415
18483
|
```typescript
|
|
18416
|
-
await client.shipping.orderSchedules.
|
|
18484
|
+
await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
18417
18485
|
```
|
|
18418
18486
|
|
|
18419
18487
|
</dd>
|
|
@@ -18448,7 +18516,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
18448
18516
|
</dl>
|
|
18449
18517
|
</details>
|
|
18450
18518
|
|
|
18451
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18519
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
18452
18520
|
<dl>
|
|
18453
18521
|
<dd>
|
|
18454
18522
|
|
|
@@ -18460,7 +18528,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
18460
18528
|
<dl>
|
|
18461
18529
|
<dd>
|
|
18462
18530
|
|
|
18463
|
-
|
|
18531
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
18464
18532
|
|
|
18465
18533
|
</dd>
|
|
18466
18534
|
</dl>
|
|
@@ -18476,7 +18544,12 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
|
|
|
18476
18544
|
<dd>
|
|
18477
18545
|
|
|
18478
18546
|
```typescript
|
|
18479
|
-
await client.shipping.orderSchedules.
|
|
18547
|
+
await client.shipping.orderSchedules.newV1({
|
|
18548
|
+
schema_version: 1,
|
|
18549
|
+
name: "name",
|
|
18550
|
+
order_manifest: {},
|
|
18551
|
+
schedule_spec: {},
|
|
18552
|
+
});
|
|
18480
18553
|
```
|
|
18481
18554
|
|
|
18482
18555
|
</dd>
|
|
@@ -18492,7 +18565,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
18492
18565
|
<dl>
|
|
18493
18566
|
<dd>
|
|
18494
18567
|
|
|
18495
|
-
**
|
|
18568
|
+
**request:** `Chrt.shipping.OrderScheduleClientCreate1`
|
|
18496
18569
|
|
|
18497
18570
|
</dd>
|
|
18498
18571
|
</dl>
|
|
@@ -18511,7 +18584,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
18511
18584
|
</dl>
|
|
18512
18585
|
</details>
|
|
18513
18586
|
|
|
18514
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18587
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
|
|
18515
18588
|
<dl>
|
|
18516
18589
|
<dd>
|
|
18517
18590
|
|
|
@@ -18523,7 +18596,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
18523
18596
|
<dl>
|
|
18524
18597
|
<dd>
|
|
18525
18598
|
|
|
18526
|
-
|
|
18599
|
+
Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
18527
18600
|
|
|
18528
18601
|
</dd>
|
|
18529
18602
|
</dl>
|
|
@@ -18539,7 +18612,7 @@ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
18539
18612
|
<dd>
|
|
18540
18613
|
|
|
18541
18614
|
```typescript
|
|
18542
|
-
await client.shipping.orderSchedules.
|
|
18615
|
+
await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
18543
18616
|
```
|
|
18544
18617
|
|
|
18545
18618
|
</dd>
|
|
@@ -18563,6 +18636,14 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
18563
18636
|
<dl>
|
|
18564
18637
|
<dd>
|
|
18565
18638
|
|
|
18639
|
+
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
18640
|
+
|
|
18641
|
+
</dd>
|
|
18642
|
+
</dl>
|
|
18643
|
+
|
|
18644
|
+
<dl>
|
|
18645
|
+
<dd>
|
|
18646
|
+
|
|
18566
18647
|
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18567
18648
|
|
|
18568
18649
|
</dd>
|
|
@@ -18574,7 +18655,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
18574
18655
|
</dl>
|
|
18575
18656
|
</details>
|
|
18576
18657
|
|
|
18577
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18658
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18578
18659
|
<dl>
|
|
18579
18660
|
<dd>
|
|
18580
18661
|
|
|
@@ -18586,7 +18667,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
18586
18667
|
<dl>
|
|
18587
18668
|
<dd>
|
|
18588
18669
|
|
|
18589
|
-
|
|
18670
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
18590
18671
|
|
|
18591
18672
|
</dd>
|
|
18592
18673
|
</dl>
|
|
@@ -18602,7 +18683,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
18602
18683
|
<dd>
|
|
18603
18684
|
|
|
18604
18685
|
```typescript
|
|
18605
|
-
await client.shipping.orderSchedules.
|
|
18686
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
18606
18687
|
```
|
|
18607
18688
|
|
|
18608
18689
|
</dd>
|
|
@@ -18637,7 +18718,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
18637
18718
|
</dl>
|
|
18638
18719
|
</details>
|
|
18639
18720
|
|
|
18640
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18721
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18641
18722
|
<dl>
|
|
18642
18723
|
<dd>
|
|
18643
18724
|
|
|
@@ -18649,7 +18730,196 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
18649
18730
|
<dl>
|
|
18650
18731
|
<dd>
|
|
18651
18732
|
|
|
18652
|
-
|
|
18733
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
18734
|
+
|
|
18735
|
+
</dd>
|
|
18736
|
+
</dl>
|
|
18737
|
+
</dd>
|
|
18738
|
+
</dl>
|
|
18739
|
+
|
|
18740
|
+
#### 🔌 Usage
|
|
18741
|
+
|
|
18742
|
+
<dl>
|
|
18743
|
+
<dd>
|
|
18744
|
+
|
|
18745
|
+
<dl>
|
|
18746
|
+
<dd>
|
|
18747
|
+
|
|
18748
|
+
```typescript
|
|
18749
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
18750
|
+
```
|
|
18751
|
+
|
|
18752
|
+
</dd>
|
|
18753
|
+
</dl>
|
|
18754
|
+
</dd>
|
|
18755
|
+
</dl>
|
|
18756
|
+
|
|
18757
|
+
#### ⚙️ Parameters
|
|
18758
|
+
|
|
18759
|
+
<dl>
|
|
18760
|
+
<dd>
|
|
18761
|
+
|
|
18762
|
+
<dl>
|
|
18763
|
+
<dd>
|
|
18764
|
+
|
|
18765
|
+
**orderScheduleId:** `string`
|
|
18766
|
+
|
|
18767
|
+
</dd>
|
|
18768
|
+
</dl>
|
|
18769
|
+
|
|
18770
|
+
<dl>
|
|
18771
|
+
<dd>
|
|
18772
|
+
|
|
18773
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18774
|
+
|
|
18775
|
+
</dd>
|
|
18776
|
+
</dl>
|
|
18777
|
+
</dd>
|
|
18778
|
+
</dl>
|
|
18779
|
+
|
|
18780
|
+
</dd>
|
|
18781
|
+
</dl>
|
|
18782
|
+
</details>
|
|
18783
|
+
|
|
18784
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18785
|
+
<dl>
|
|
18786
|
+
<dd>
|
|
18787
|
+
|
|
18788
|
+
#### 📝 Description
|
|
18789
|
+
|
|
18790
|
+
<dl>
|
|
18791
|
+
<dd>
|
|
18792
|
+
|
|
18793
|
+
<dl>
|
|
18794
|
+
<dd>
|
|
18795
|
+
|
|
18796
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
18797
|
+
|
|
18798
|
+
</dd>
|
|
18799
|
+
</dl>
|
|
18800
|
+
</dd>
|
|
18801
|
+
</dl>
|
|
18802
|
+
|
|
18803
|
+
#### 🔌 Usage
|
|
18804
|
+
|
|
18805
|
+
<dl>
|
|
18806
|
+
<dd>
|
|
18807
|
+
|
|
18808
|
+
<dl>
|
|
18809
|
+
<dd>
|
|
18810
|
+
|
|
18811
|
+
```typescript
|
|
18812
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
18813
|
+
```
|
|
18814
|
+
|
|
18815
|
+
</dd>
|
|
18816
|
+
</dl>
|
|
18817
|
+
</dd>
|
|
18818
|
+
</dl>
|
|
18819
|
+
|
|
18820
|
+
#### ⚙️ Parameters
|
|
18821
|
+
|
|
18822
|
+
<dl>
|
|
18823
|
+
<dd>
|
|
18824
|
+
|
|
18825
|
+
<dl>
|
|
18826
|
+
<dd>
|
|
18827
|
+
|
|
18828
|
+
**orderScheduleId:** `string`
|
|
18829
|
+
|
|
18830
|
+
</dd>
|
|
18831
|
+
</dl>
|
|
18832
|
+
|
|
18833
|
+
<dl>
|
|
18834
|
+
<dd>
|
|
18835
|
+
|
|
18836
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18837
|
+
|
|
18838
|
+
</dd>
|
|
18839
|
+
</dl>
|
|
18840
|
+
</dd>
|
|
18841
|
+
</dl>
|
|
18842
|
+
|
|
18843
|
+
</dd>
|
|
18844
|
+
</dl>
|
|
18845
|
+
</details>
|
|
18846
|
+
|
|
18847
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18848
|
+
<dl>
|
|
18849
|
+
<dd>
|
|
18850
|
+
|
|
18851
|
+
#### 📝 Description
|
|
18852
|
+
|
|
18853
|
+
<dl>
|
|
18854
|
+
<dd>
|
|
18855
|
+
|
|
18856
|
+
<dl>
|
|
18857
|
+
<dd>
|
|
18858
|
+
|
|
18859
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
18860
|
+
|
|
18861
|
+
</dd>
|
|
18862
|
+
</dl>
|
|
18863
|
+
</dd>
|
|
18864
|
+
</dl>
|
|
18865
|
+
|
|
18866
|
+
#### 🔌 Usage
|
|
18867
|
+
|
|
18868
|
+
<dl>
|
|
18869
|
+
<dd>
|
|
18870
|
+
|
|
18871
|
+
<dl>
|
|
18872
|
+
<dd>
|
|
18873
|
+
|
|
18874
|
+
```typescript
|
|
18875
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
18876
|
+
```
|
|
18877
|
+
|
|
18878
|
+
</dd>
|
|
18879
|
+
</dl>
|
|
18880
|
+
</dd>
|
|
18881
|
+
</dl>
|
|
18882
|
+
|
|
18883
|
+
#### ⚙️ Parameters
|
|
18884
|
+
|
|
18885
|
+
<dl>
|
|
18886
|
+
<dd>
|
|
18887
|
+
|
|
18888
|
+
<dl>
|
|
18889
|
+
<dd>
|
|
18890
|
+
|
|
18891
|
+
**orderScheduleId:** `string`
|
|
18892
|
+
|
|
18893
|
+
</dd>
|
|
18894
|
+
</dl>
|
|
18895
|
+
|
|
18896
|
+
<dl>
|
|
18897
|
+
<dd>
|
|
18898
|
+
|
|
18899
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18900
|
+
|
|
18901
|
+
</dd>
|
|
18902
|
+
</dl>
|
|
18903
|
+
</dd>
|
|
18904
|
+
</dl>
|
|
18905
|
+
|
|
18906
|
+
</dd>
|
|
18907
|
+
</dl>
|
|
18908
|
+
</details>
|
|
18909
|
+
|
|
18910
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18911
|
+
<dl>
|
|
18912
|
+
<dd>
|
|
18913
|
+
|
|
18914
|
+
#### 📝 Description
|
|
18915
|
+
|
|
18916
|
+
<dl>
|
|
18917
|
+
<dd>
|
|
18918
|
+
|
|
18919
|
+
<dl>
|
|
18920
|
+
<dd>
|
|
18921
|
+
|
|
18922
|
+
Archives an order schedule and prevents future runs. | authz: min_org_role=operator | () -> (bool)
|
|
18653
18923
|
|
|
18654
18924
|
</dd>
|
|
18655
18925
|
</dl>
|
|
@@ -19120,7 +19390,7 @@ await client.shipping.taskGroups.addExecutorV1("task_group_id");
|
|
|
19120
19390
|
<dl>
|
|
19121
19391
|
<dd>
|
|
19122
19392
|
|
|
19123
|
-
Clears the executor on a task group
|
|
19393
|
+
Clears the executor and assigned driver on a task group. Refuses while PPP or PPD billing is attached; detach billing explicitly first. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
19124
19394
|
|
|
19125
19395
|
</dd>
|
|
19126
19396
|
</dl>
|
|
@@ -21835,7 +22105,7 @@ for await (const item of response) {
|
|
|
21835
22105
|
<dl>
|
|
21836
22106
|
<dd>
|
|
21837
22107
|
|
|
21838
|
-
Adds a task group to an existing order draft.
|
|
22108
|
+
Adds a task group to an existing order draft. The task group is created without an executor; use draft assignment routes to assign executor or driver before staging. | (OrderDraftAddTaskGroupReq) -> (PydanticObjectId)
|
|
21839
22109
|
|
|
21840
22110
|
</dd>
|
|
21841
22111
|
</dl>
|
|
@@ -22031,6 +22301,276 @@ await client.shipping.orderDrafts.taskGroup.setVehicleTypeV1("task_group_id");
|
|
|
22031
22301
|
</dl>
|
|
22032
22302
|
</details>
|
|
22033
22303
|
|
|
22304
|
+
<details><summary><code>client.shipping.orderDrafts.taskGroup.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.ts">addExecutorV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
22305
|
+
<dl>
|
|
22306
|
+
<dd>
|
|
22307
|
+
|
|
22308
|
+
#### 📝 Description
|
|
22309
|
+
|
|
22310
|
+
<dl>
|
|
22311
|
+
<dd>
|
|
22312
|
+
|
|
22313
|
+
<dl>
|
|
22314
|
+
<dd>
|
|
22315
|
+
|
|
22316
|
+
Assigns an executor organization to a draft task group. Coordinator-only; provider-provider direct assignments require auto-assign consent. | authz_personas=[task_group_coordinator_operators] | (OrderDraftAddExecutorReq) -> (bool)
|
|
22317
|
+
|
|
22318
|
+
</dd>
|
|
22319
|
+
</dl>
|
|
22320
|
+
</dd>
|
|
22321
|
+
</dl>
|
|
22322
|
+
|
|
22323
|
+
#### 🔌 Usage
|
|
22324
|
+
|
|
22325
|
+
<dl>
|
|
22326
|
+
<dd>
|
|
22327
|
+
|
|
22328
|
+
<dl>
|
|
22329
|
+
<dd>
|
|
22330
|
+
|
|
22331
|
+
```typescript
|
|
22332
|
+
await client.shipping.orderDrafts.taskGroup.addExecutorV1("task_group_id");
|
|
22333
|
+
```
|
|
22334
|
+
|
|
22335
|
+
</dd>
|
|
22336
|
+
</dl>
|
|
22337
|
+
</dd>
|
|
22338
|
+
</dl>
|
|
22339
|
+
|
|
22340
|
+
#### ⚙️ Parameters
|
|
22341
|
+
|
|
22342
|
+
<dl>
|
|
22343
|
+
<dd>
|
|
22344
|
+
|
|
22345
|
+
<dl>
|
|
22346
|
+
<dd>
|
|
22347
|
+
|
|
22348
|
+
**taskGroupId:** `string`
|
|
22349
|
+
|
|
22350
|
+
</dd>
|
|
22351
|
+
</dl>
|
|
22352
|
+
|
|
22353
|
+
<dl>
|
|
22354
|
+
<dd>
|
|
22355
|
+
|
|
22356
|
+
**request:** `Chrt.shipping.orderDrafts.OrderDraftAddExecutorReq`
|
|
22357
|
+
|
|
22358
|
+
</dd>
|
|
22359
|
+
</dl>
|
|
22360
|
+
|
|
22361
|
+
<dl>
|
|
22362
|
+
<dd>
|
|
22363
|
+
|
|
22364
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22365
|
+
|
|
22366
|
+
</dd>
|
|
22367
|
+
</dl>
|
|
22368
|
+
</dd>
|
|
22369
|
+
</dl>
|
|
22370
|
+
|
|
22371
|
+
</dd>
|
|
22372
|
+
</dl>
|
|
22373
|
+
</details>
|
|
22374
|
+
|
|
22375
|
+
<details><summary><code>client.shipping.orderDrafts.taskGroup.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
|
|
22376
|
+
<dl>
|
|
22377
|
+
<dd>
|
|
22378
|
+
|
|
22379
|
+
#### 📝 Description
|
|
22380
|
+
|
|
22381
|
+
<dl>
|
|
22382
|
+
<dd>
|
|
22383
|
+
|
|
22384
|
+
<dl>
|
|
22385
|
+
<dd>
|
|
22386
|
+
|
|
22387
|
+
Clears the executor, driver, and PPP/PPD billing attachments from a draft task group. Coordinator-only; executor Cases are preserved. | authz_personas=[task_group_coordinator_operators] | () -> (bool)
|
|
22388
|
+
|
|
22389
|
+
</dd>
|
|
22390
|
+
</dl>
|
|
22391
|
+
</dd>
|
|
22392
|
+
</dl>
|
|
22393
|
+
|
|
22394
|
+
#### 🔌 Usage
|
|
22395
|
+
|
|
22396
|
+
<dl>
|
|
22397
|
+
<dd>
|
|
22398
|
+
|
|
22399
|
+
<dl>
|
|
22400
|
+
<dd>
|
|
22401
|
+
|
|
22402
|
+
```typescript
|
|
22403
|
+
await client.shipping.orderDrafts.taskGroup.removeExecutorV1("task_group_id");
|
|
22404
|
+
```
|
|
22405
|
+
|
|
22406
|
+
</dd>
|
|
22407
|
+
</dl>
|
|
22408
|
+
</dd>
|
|
22409
|
+
</dl>
|
|
22410
|
+
|
|
22411
|
+
#### ⚙️ Parameters
|
|
22412
|
+
|
|
22413
|
+
<dl>
|
|
22414
|
+
<dd>
|
|
22415
|
+
|
|
22416
|
+
<dl>
|
|
22417
|
+
<dd>
|
|
22418
|
+
|
|
22419
|
+
**taskGroupId:** `string`
|
|
22420
|
+
|
|
22421
|
+
</dd>
|
|
22422
|
+
</dl>
|
|
22423
|
+
|
|
22424
|
+
<dl>
|
|
22425
|
+
<dd>
|
|
22426
|
+
|
|
22427
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22428
|
+
|
|
22429
|
+
</dd>
|
|
22430
|
+
</dl>
|
|
22431
|
+
</dd>
|
|
22432
|
+
</dl>
|
|
22433
|
+
|
|
22434
|
+
</dd>
|
|
22435
|
+
</dl>
|
|
22436
|
+
</details>
|
|
22437
|
+
|
|
22438
|
+
<details><summary><code>client.shipping.orderDrafts.taskGroup.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
22439
|
+
<dl>
|
|
22440
|
+
<dd>
|
|
22441
|
+
|
|
22442
|
+
#### 📝 Description
|
|
22443
|
+
|
|
22444
|
+
<dl>
|
|
22445
|
+
<dd>
|
|
22446
|
+
|
|
22447
|
+
<dl>
|
|
22448
|
+
<dd>
|
|
22449
|
+
|
|
22450
|
+
Assigns or swaps the driver on a draft task group. Only the executor org may assign drivers. | authz_personas=[executor_org_operators] | (OrderDraftUpdateDriverReq) -> (bool)
|
|
22451
|
+
|
|
22452
|
+
</dd>
|
|
22453
|
+
</dl>
|
|
22454
|
+
</dd>
|
|
22455
|
+
</dl>
|
|
22456
|
+
|
|
22457
|
+
#### 🔌 Usage
|
|
22458
|
+
|
|
22459
|
+
<dl>
|
|
22460
|
+
<dd>
|
|
22461
|
+
|
|
22462
|
+
<dl>
|
|
22463
|
+
<dd>
|
|
22464
|
+
|
|
22465
|
+
```typescript
|
|
22466
|
+
await client.shipping.orderDrafts.taskGroup.updateDriverV1("task_group_id", {
|
|
22467
|
+
driver_id: "driver_id",
|
|
22468
|
+
});
|
|
22469
|
+
```
|
|
22470
|
+
|
|
22471
|
+
</dd>
|
|
22472
|
+
</dl>
|
|
22473
|
+
</dd>
|
|
22474
|
+
</dl>
|
|
22475
|
+
|
|
22476
|
+
#### ⚙️ Parameters
|
|
22477
|
+
|
|
22478
|
+
<dl>
|
|
22479
|
+
<dd>
|
|
22480
|
+
|
|
22481
|
+
<dl>
|
|
22482
|
+
<dd>
|
|
22483
|
+
|
|
22484
|
+
**taskGroupId:** `string`
|
|
22485
|
+
|
|
22486
|
+
</dd>
|
|
22487
|
+
</dl>
|
|
22488
|
+
|
|
22489
|
+
<dl>
|
|
22490
|
+
<dd>
|
|
22491
|
+
|
|
22492
|
+
**request:** `Chrt.shipping.orderDrafts.OrderDraftUpdateDriverReq`
|
|
22493
|
+
|
|
22494
|
+
</dd>
|
|
22495
|
+
</dl>
|
|
22496
|
+
|
|
22497
|
+
<dl>
|
|
22498
|
+
<dd>
|
|
22499
|
+
|
|
22500
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22501
|
+
|
|
22502
|
+
</dd>
|
|
22503
|
+
</dl>
|
|
22504
|
+
</dd>
|
|
22505
|
+
</dl>
|
|
22506
|
+
|
|
22507
|
+
</dd>
|
|
22508
|
+
</dl>
|
|
22509
|
+
</details>
|
|
22510
|
+
|
|
22511
|
+
<details><summary><code>client.shipping.orderDrafts.taskGroup.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
22512
|
+
<dl>
|
|
22513
|
+
<dd>
|
|
22514
|
+
|
|
22515
|
+
#### 📝 Description
|
|
22516
|
+
|
|
22517
|
+
<dl>
|
|
22518
|
+
<dd>
|
|
22519
|
+
|
|
22520
|
+
<dl>
|
|
22521
|
+
<dd>
|
|
22522
|
+
|
|
22523
|
+
Clears the driver on a draft task group. Only the executor org may remove drivers. | authz_personas=[executor_org_operators] | () -> (bool)
|
|
22524
|
+
|
|
22525
|
+
</dd>
|
|
22526
|
+
</dl>
|
|
22527
|
+
</dd>
|
|
22528
|
+
</dl>
|
|
22529
|
+
|
|
22530
|
+
#### 🔌 Usage
|
|
22531
|
+
|
|
22532
|
+
<dl>
|
|
22533
|
+
<dd>
|
|
22534
|
+
|
|
22535
|
+
<dl>
|
|
22536
|
+
<dd>
|
|
22537
|
+
|
|
22538
|
+
```typescript
|
|
22539
|
+
await client.shipping.orderDrafts.taskGroup.removeDriverV1("task_group_id");
|
|
22540
|
+
```
|
|
22541
|
+
|
|
22542
|
+
</dd>
|
|
22543
|
+
</dl>
|
|
22544
|
+
</dd>
|
|
22545
|
+
</dl>
|
|
22546
|
+
|
|
22547
|
+
#### ⚙️ Parameters
|
|
22548
|
+
|
|
22549
|
+
<dl>
|
|
22550
|
+
<dd>
|
|
22551
|
+
|
|
22552
|
+
<dl>
|
|
22553
|
+
<dd>
|
|
22554
|
+
|
|
22555
|
+
**taskGroupId:** `string`
|
|
22556
|
+
|
|
22557
|
+
</dd>
|
|
22558
|
+
</dl>
|
|
22559
|
+
|
|
22560
|
+
<dl>
|
|
22561
|
+
<dd>
|
|
22562
|
+
|
|
22563
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22564
|
+
|
|
22565
|
+
</dd>
|
|
22566
|
+
</dl>
|
|
22567
|
+
</dd>
|
|
22568
|
+
</dl>
|
|
22569
|
+
|
|
22570
|
+
</dd>
|
|
22571
|
+
</dl>
|
|
22572
|
+
</details>
|
|
22573
|
+
|
|
22034
22574
|
<details><summary><code>client.shipping.orderDrafts.taskGroup.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
22035
22575
|
<dl>
|
|
22036
22576
|
<dd>
|
|
@@ -22706,6 +23246,73 @@ await client.shipping.orderDrafts.cargo.associateWithTaskV1({
|
|
|
22706
23246
|
</dl>
|
|
22707
23247
|
</details>
|
|
22708
23248
|
|
|
23249
|
+
<details><summary><code>client.shipping.orderDrafts.cargo.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.ts">unassociateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
23250
|
+
<dl>
|
|
23251
|
+
<dd>
|
|
23252
|
+
|
|
23253
|
+
#### 📝 Description
|
|
23254
|
+
|
|
23255
|
+
<dl>
|
|
23256
|
+
<dd>
|
|
23257
|
+
|
|
23258
|
+
<dl>
|
|
23259
|
+
<dd>
|
|
23260
|
+
|
|
23261
|
+
Removes an existing cargo association from a task in a draft order (e.g. when the wrong cargo was selected). | (OrderDraftUnassociateCargoWithTaskReq) -> (bool)
|
|
23262
|
+
|
|
23263
|
+
</dd>
|
|
23264
|
+
</dl>
|
|
23265
|
+
</dd>
|
|
23266
|
+
</dl>
|
|
23267
|
+
|
|
23268
|
+
#### 🔌 Usage
|
|
23269
|
+
|
|
23270
|
+
<dl>
|
|
23271
|
+
<dd>
|
|
23272
|
+
|
|
23273
|
+
<dl>
|
|
23274
|
+
<dd>
|
|
23275
|
+
|
|
23276
|
+
```typescript
|
|
23277
|
+
await client.shipping.orderDrafts.cargo.unassociateWithTaskV1({
|
|
23278
|
+
order_id: "order_id",
|
|
23279
|
+
task_id: "task_id",
|
|
23280
|
+
cargo_id: "cargo_id",
|
|
23281
|
+
});
|
|
23282
|
+
```
|
|
23283
|
+
|
|
23284
|
+
</dd>
|
|
23285
|
+
</dl>
|
|
23286
|
+
</dd>
|
|
23287
|
+
</dl>
|
|
23288
|
+
|
|
23289
|
+
#### ⚙️ Parameters
|
|
23290
|
+
|
|
23291
|
+
<dl>
|
|
23292
|
+
<dd>
|
|
23293
|
+
|
|
23294
|
+
<dl>
|
|
23295
|
+
<dd>
|
|
23296
|
+
|
|
23297
|
+
**request:** `Chrt.shipping.orderDrafts.OrderDraftUnassociateCargoWithTaskReq`
|
|
23298
|
+
|
|
23299
|
+
</dd>
|
|
23300
|
+
</dl>
|
|
23301
|
+
|
|
23302
|
+
<dl>
|
|
23303
|
+
<dd>
|
|
23304
|
+
|
|
23305
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
23306
|
+
|
|
23307
|
+
</dd>
|
|
23308
|
+
</dl>
|
|
23309
|
+
</dd>
|
|
23310
|
+
</dl>
|
|
23311
|
+
|
|
23312
|
+
</dd>
|
|
23313
|
+
</dl>
|
|
23314
|
+
</details>
|
|
23315
|
+
|
|
22709
23316
|
<details><summary><code>client.shipping.orderDrafts.cargo.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/cargo/client/Client.ts">updateV1</a>({ ...params }) -> string</code></summary>
|
|
22710
23317
|
<dl>
|
|
22711
23318
|
<dd>
|
|
@@ -23301,11 +23908,10 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
23301
23908
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23302
23909
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23303
23910
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23911
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23912
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23304
23913
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23305
23914
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23306
|
-
filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23307
|
-
filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23308
|
-
filter_order_cancelled: true,
|
|
23309
23915
|
filter_executor_org_id: "filter_executor_org_id",
|
|
23310
23916
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
23311
23917
|
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|
|
@@ -23387,11 +23993,10 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
23387
23993
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23388
23994
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23389
23995
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23996
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23997
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23390
23998
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23391
23999
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23392
|
-
filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23393
|
-
filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23394
|
-
filter_order_cancelled: true,
|
|
23395
24000
|
filter_executor_org_id: "filter_executor_org_id",
|
|
23396
24001
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
23397
24002
|
body: {},
|
|
@@ -24715,9 +25320,10 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
24715
25320
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24716
25321
|
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24717
25322
|
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25323
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25324
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24718
25325
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24719
25326
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24720
|
-
filter_order_cancelled: true,
|
|
24721
25327
|
filter_driver_id: "filter_driver_id",
|
|
24722
25328
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
24723
25329
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
@@ -24802,9 +25408,10 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
24802
25408
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24803
25409
|
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24804
25410
|
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25411
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25412
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24805
25413
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24806
25414
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24807
|
-
filter_order_cancelled: true,
|
|
24808
25415
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
24809
25416
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
24810
25417
|
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|