@chrt-inc/typescript-sdk 1.734.0 → 1.749.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/operations/resources/operationsTasks/client/Client.d.ts +2 -29
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +10 -124
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +2 -3
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/shipping/client/Client.js +9 -4
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/index.js +3 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrderDraftsTypeaheadV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.d.ts +25 -41
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/Client.js +51 -125
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.ts +2 -4
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/client/requests/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.d.ts +64 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.js +196 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.d.ts +4 -6
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/draft/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderSchedules/resources/index.js +6 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.d.ts +170 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.js +662 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +23 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +24 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.ts +42 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/{orderDrafts/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → orders/client/requests/OrdersTypeaheadV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersTypeaheadV1Request.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 +0 -16
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +16 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +68 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/{resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → client/requests/TaskGroupsTypeaheadV1Request.d.ts} +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/requests/TaskGroupsTypeaheadV1Request.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.js +0 -68
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/types/Cargo1.d.ts +1 -3
- package/dist/cjs/api/types/CargoManifest1.d.ts +6 -0
- package/dist/cjs/api/types/OperationsTaskTypeEnum.d.ts +4 -2
- package/dist/cjs/api/types/OperationsTaskTypeEnum.js +3 -1
- package/dist/cjs/api/types/Order1.d.ts +1 -0
- package/dist/cjs/api/types/OrderManifest1.d.ts +2 -2
- package/dist/cjs/api/types/OrderSchedule1.d.ts +5 -7
- package/dist/cjs/api/types/OrderScheduleAboutRes.d.ts +0 -1
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatus.d.ts +0 -1
- package/dist/cjs/api/types/OrderScheduleSortByEnum.d.ts +2 -2
- package/dist/cjs/api/types/OrderScheduleSortByEnum.js +1 -1
- package/dist/cjs/api/types/OrderScheduleSpec1.d.ts +11 -0
- package/dist/cjs/api/types/OrderScheduleSpec1.js +5 -0
- package/dist/cjs/api/types/OrderTemplate1.d.ts +24 -0
- package/dist/cjs/api/types/OrderTemplate1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateExpanded.d.ts +12 -0
- package/dist/cjs/api/types/OrderTemplateExpanded.js +5 -0
- package/dist/cjs/api/types/OrderTemplateListRes.d.ts +8 -0
- package/dist/cjs/api/types/OrderTemplateListRes.js +5 -0
- package/dist/cjs/api/types/OrderTemplateOrgRef1.d.ts +10 -0
- package/dist/cjs/api/types/OrderTemplateOrgRef1.js +5 -0
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.d.ts +11 -0
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.js +13 -0
- package/dist/cjs/api/types/OrderTemplateSortByEnum.d.ts +9 -0
- package/dist/cjs/api/types/OrderTemplateSortByEnum.js +11 -0
- package/dist/cjs/api/types/OrderTypeaheadResult.d.ts +1 -1
- package/dist/cjs/api/types/OrderTypeaheadValue.d.ts +7 -0
- package/dist/cjs/api/types/OrderTypeaheadValue.js +5 -0
- package/dist/cjs/api/types/Task1.d.ts +2 -4
- package/dist/cjs/api/types/TaskArtifact1.d.ts +1 -3
- package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -1
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -3
- package/dist/cjs/api/types/TaskGroupManifest1.d.ts +1 -1
- package/dist/cjs/api/types/TaskManifest1.d.ts +13 -4
- package/dist/cjs/api/types/index.d.ts +8 -1
- package/dist/cjs/api/types/index.js +8 -1
- 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/operations/resources/operationsTasks/client/Client.d.mts +2 -29
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +10 -124
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +2 -3
- package/dist/esm/api/resources/shipping/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/shipping/client/Client.mjs +5 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +68 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrderDraftsTypeaheadV1Request.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/cargo/client/requests/OrderDraftAddCargoReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/task/client/requests/OrderDraftAddTaskReqV1.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddTaskGroupReq.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.d.mts +25 -41
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/Client.mjs +49 -123
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/OrderSchedulesListV1Request.d.mts +2 -4
- package/dist/esm/api/resources/shipping/resources/orderSchedules/client/requests/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.d.mts +64 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.mjs +159 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.d.mts +4 -6
- package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/draft/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderSchedules/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts +170 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.mjs +625 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +23 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +24 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.mts +42 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +68 -0
- package/dist/esm/api/resources/shipping/resources/{orderDrafts/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts → orders/client/requests/OrdersTypeaheadV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersTypeaheadV1Request.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 +0 -16
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +16 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +68 -0
- package/dist/{cjs/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.ts → esm/api/resources/shipping/resources/taskGroups/client/requests/TaskGroupsTypeaheadV1Request.d.mts} +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/requests/TaskGroupsTypeaheadV1Request.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.mjs +0 -68
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/index.d.mts +0 -1
- package/dist/esm/api/types/Cargo1.d.mts +1 -3
- package/dist/esm/api/types/CargoManifest1.d.mts +6 -0
- package/dist/esm/api/types/OperationsTaskTypeEnum.d.mts +4 -2
- package/dist/esm/api/types/OperationsTaskTypeEnum.mjs +3 -1
- package/dist/esm/api/types/Order1.d.mts +1 -0
- package/dist/esm/api/types/OrderManifest1.d.mts +2 -2
- package/dist/esm/api/types/OrderSchedule1.d.mts +5 -7
- package/dist/esm/api/types/OrderScheduleAboutRes.d.mts +0 -1
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatus.d.mts +0 -1
- package/dist/esm/api/types/OrderScheduleSortByEnum.d.mts +2 -2
- package/dist/esm/api/types/OrderScheduleSortByEnum.mjs +1 -1
- package/dist/esm/api/types/OrderScheduleSpec1.d.mts +11 -0
- package/dist/esm/api/types/OrderScheduleSpec1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplate1.d.mts +24 -0
- package/dist/esm/api/types/OrderTemplate1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateExpanded.d.mts +12 -0
- package/dist/esm/api/types/OrderTemplateExpanded.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateListRes.d.mts +8 -0
- package/dist/esm/api/types/OrderTemplateListRes.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateOrgRef1.d.mts +10 -0
- package/dist/esm/api/types/OrderTemplateOrgRef1.mjs +4 -0
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.d.mts +11 -0
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.mjs +10 -0
- package/dist/esm/api/types/OrderTemplateSortByEnum.d.mts +9 -0
- package/dist/esm/api/types/OrderTemplateSortByEnum.mjs +8 -0
- package/dist/esm/api/types/OrderTypeaheadResult.d.mts +1 -1
- package/dist/esm/api/types/OrderTypeaheadValue.d.mts +7 -0
- package/dist/esm/api/types/OrderTypeaheadValue.mjs +4 -0
- package/dist/esm/api/types/Task1.d.mts +2 -4
- package/dist/esm/api/types/TaskArtifact1.d.mts +1 -3
- package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -1
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -3
- package/dist/esm/api/types/TaskGroupManifest1.d.mts +1 -1
- package/dist/esm/api/types/TaskManifest1.d.mts +13 -4
- package/dist/esm/api/types/index.d.mts +8 -1
- package/dist/esm/api/types/index.mjs +8 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +857 -319
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.ts +0 -10
- package/dist/cjs/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.js +0 -12
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +0 -16
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.d.mts +0 -16
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.d.mts +0 -10
- package/dist/esm/api/types/OrderScheduleOrchestratorScheduleStatusEnum1.mjs +0 -9
- /package/dist/cjs/api/resources/shipping/resources/orderDrafts/{resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → client/requests/OrderDraftsTypeaheadV1Request.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.js +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.js +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → orderTemplates/client/requests/OrderTemplateClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.js → orderTemplates/client/requests/OrderTemplateClientUpdate1.js} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderDrafts/{resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → client/requests/OrderDraftsTypeaheadV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientCreate1.mjs +0 -0
- /package/dist/esm/api/resources/shipping/resources/orderSchedules/{client → resources/draft/client}/requests/OrderScheduleClientUpdate1.mjs +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orders/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → orderTemplates/client/requests/OrderTemplateClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{taskGroups/resources/expanded/client/requests/ExpandedTypeaheadV1Request.mjs → orderTemplates/client/requests/OrderTemplateClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -13197,7 +13197,7 @@ await client.operations.operationsTaskLists.removeFromCaseV1("task_list_id", "ca
|
|
|
13197
13197
|
<dl>
|
|
13198
13198
|
<dd>
|
|
13199
13199
|
|
|
13200
|
-
Lists OperationsTasks for the caller's organization, with order/department/type/status/tag/assignee/deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
13200
|
+
Lists OperationsTasks for the caller's organization, with order ids / department / type / status / tag / assignee / deadline filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
13201
13201
|
|
|
13202
13202
|
</dd>
|
|
13203
13203
|
</dl>
|
|
@@ -13218,7 +13218,6 @@ await client.operations.operationsTasks.listV1({
|
|
|
13218
13218
|
sort_order: "asc",
|
|
13219
13219
|
page: 1,
|
|
13220
13220
|
page_size: 1,
|
|
13221
|
-
filter_order_id: "filter_order_id",
|
|
13222
13221
|
filter_department_id: "filter_department_id",
|
|
13223
13222
|
filter_assigned_user_id: "filter_assigned_user_id",
|
|
13224
13223
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
@@ -13396,7 +13395,7 @@ await client.operations.operationsTasks.deleteV1("task_id");
|
|
|
13396
13395
|
<dl>
|
|
13397
13396
|
<dd>
|
|
13398
13397
|
|
|
13399
|
-
Updates
|
|
13398
|
+
Updates editable fields (task_type, title, description, deadline_timestamp, tags, assigned_user_ids) on an OperationsTask. | authz: min_org_role=operator | (OperationsTaskClientUpdate1) -> (bool)
|
|
13400
13399
|
|
|
13401
13400
|
</dd>
|
|
13402
13401
|
</dl>
|
|
@@ -13524,132 +13523,6 @@ await client.operations.operationsTasks.createV1({
|
|
|
13524
13523
|
</dl>
|
|
13525
13524
|
</details>
|
|
13526
13525
|
|
|
13527
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
13528
|
-
<dl>
|
|
13529
|
-
<dd>
|
|
13530
|
-
|
|
13531
|
-
#### 📝 Description
|
|
13532
|
-
|
|
13533
|
-
<dl>
|
|
13534
|
-
<dd>
|
|
13535
|
-
|
|
13536
|
-
<dl>
|
|
13537
|
-
<dd>
|
|
13538
|
-
|
|
13539
|
-
Marks an OperationsTask as completed. Idempotent — calling on an already-completed task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
13540
|
-
|
|
13541
|
-
</dd>
|
|
13542
|
-
</dl>
|
|
13543
|
-
</dd>
|
|
13544
|
-
</dl>
|
|
13545
|
-
|
|
13546
|
-
#### 🔌 Usage
|
|
13547
|
-
|
|
13548
|
-
<dl>
|
|
13549
|
-
<dd>
|
|
13550
|
-
|
|
13551
|
-
<dl>
|
|
13552
|
-
<dd>
|
|
13553
|
-
|
|
13554
|
-
```typescript
|
|
13555
|
-
await client.operations.operationsTasks.completeV1("task_id");
|
|
13556
|
-
```
|
|
13557
|
-
|
|
13558
|
-
</dd>
|
|
13559
|
-
</dl>
|
|
13560
|
-
</dd>
|
|
13561
|
-
</dl>
|
|
13562
|
-
|
|
13563
|
-
#### ⚙️ Parameters
|
|
13564
|
-
|
|
13565
|
-
<dl>
|
|
13566
|
-
<dd>
|
|
13567
|
-
|
|
13568
|
-
<dl>
|
|
13569
|
-
<dd>
|
|
13570
|
-
|
|
13571
|
-
**taskId:** `string`
|
|
13572
|
-
|
|
13573
|
-
</dd>
|
|
13574
|
-
</dl>
|
|
13575
|
-
|
|
13576
|
-
<dl>
|
|
13577
|
-
<dd>
|
|
13578
|
-
|
|
13579
|
-
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13580
|
-
|
|
13581
|
-
</dd>
|
|
13582
|
-
</dl>
|
|
13583
|
-
</dd>
|
|
13584
|
-
</dl>
|
|
13585
|
-
|
|
13586
|
-
</dd>
|
|
13587
|
-
</dl>
|
|
13588
|
-
</details>
|
|
13589
|
-
|
|
13590
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">uncompleteV1</a>(taskId) -> boolean</code></summary>
|
|
13591
|
-
<dl>
|
|
13592
|
-
<dd>
|
|
13593
|
-
|
|
13594
|
-
#### 📝 Description
|
|
13595
|
-
|
|
13596
|
-
<dl>
|
|
13597
|
-
<dd>
|
|
13598
|
-
|
|
13599
|
-
<dl>
|
|
13600
|
-
<dd>
|
|
13601
|
-
|
|
13602
|
-
Marks a previously-completed OperationsTask as incomplete and clears its completion timestamps. Idempotent — calling on an already-incomplete task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
13603
|
-
|
|
13604
|
-
</dd>
|
|
13605
|
-
</dl>
|
|
13606
|
-
</dd>
|
|
13607
|
-
</dl>
|
|
13608
|
-
|
|
13609
|
-
#### 🔌 Usage
|
|
13610
|
-
|
|
13611
|
-
<dl>
|
|
13612
|
-
<dd>
|
|
13613
|
-
|
|
13614
|
-
<dl>
|
|
13615
|
-
<dd>
|
|
13616
|
-
|
|
13617
|
-
```typescript
|
|
13618
|
-
await client.operations.operationsTasks.uncompleteV1("task_id");
|
|
13619
|
-
```
|
|
13620
|
-
|
|
13621
|
-
</dd>
|
|
13622
|
-
</dl>
|
|
13623
|
-
</dd>
|
|
13624
|
-
</dl>
|
|
13625
|
-
|
|
13626
|
-
#### ⚙️ Parameters
|
|
13627
|
-
|
|
13628
|
-
<dl>
|
|
13629
|
-
<dd>
|
|
13630
|
-
|
|
13631
|
-
<dl>
|
|
13632
|
-
<dd>
|
|
13633
|
-
|
|
13634
|
-
**taskId:** `string`
|
|
13635
|
-
|
|
13636
|
-
</dd>
|
|
13637
|
-
</dl>
|
|
13638
|
-
|
|
13639
|
-
<dl>
|
|
13640
|
-
<dd>
|
|
13641
|
-
|
|
13642
|
-
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13643
|
-
|
|
13644
|
-
</dd>
|
|
13645
|
-
</dl>
|
|
13646
|
-
</dd>
|
|
13647
|
-
</dl>
|
|
13648
|
-
|
|
13649
|
-
</dd>
|
|
13650
|
-
</dl>
|
|
13651
|
-
</details>
|
|
13652
|
-
|
|
13653
13526
|
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateStatusV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13654
13527
|
<dl>
|
|
13655
13528
|
<dd>
|
|
@@ -17907,6 +17780,72 @@ await client.shipping.taskArtifacts.deleteV1("task_artifact_id");
|
|
|
17907
17780
|
|
|
17908
17781
|
## Shipping Orders
|
|
17909
17782
|
|
|
17783
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
17784
|
+
<dl>
|
|
17785
|
+
<dd>
|
|
17786
|
+
|
|
17787
|
+
#### 📝 Description
|
|
17788
|
+
|
|
17789
|
+
<dl>
|
|
17790
|
+
<dd>
|
|
17791
|
+
|
|
17792
|
+
<dl>
|
|
17793
|
+
<dd>
|
|
17794
|
+
|
|
17795
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft orders visible to the caller's org. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
17796
|
+
|
|
17797
|
+
</dd>
|
|
17798
|
+
</dl>
|
|
17799
|
+
</dd>
|
|
17800
|
+
</dl>
|
|
17801
|
+
|
|
17802
|
+
#### 🔌 Usage
|
|
17803
|
+
|
|
17804
|
+
<dl>
|
|
17805
|
+
<dd>
|
|
17806
|
+
|
|
17807
|
+
<dl>
|
|
17808
|
+
<dd>
|
|
17809
|
+
|
|
17810
|
+
```typescript
|
|
17811
|
+
await client.shipping.orders.typeaheadV1({
|
|
17812
|
+
query: "query",
|
|
17813
|
+
limit: 1,
|
|
17814
|
+
});
|
|
17815
|
+
```
|
|
17816
|
+
|
|
17817
|
+
</dd>
|
|
17818
|
+
</dl>
|
|
17819
|
+
</dd>
|
|
17820
|
+
</dl>
|
|
17821
|
+
|
|
17822
|
+
#### ⚙️ Parameters
|
|
17823
|
+
|
|
17824
|
+
<dl>
|
|
17825
|
+
<dd>
|
|
17826
|
+
|
|
17827
|
+
<dl>
|
|
17828
|
+
<dd>
|
|
17829
|
+
|
|
17830
|
+
**request:** `Chrt.shipping.OrdersTypeaheadV1Request`
|
|
17831
|
+
|
|
17832
|
+
</dd>
|
|
17833
|
+
</dl>
|
|
17834
|
+
|
|
17835
|
+
<dl>
|
|
17836
|
+
<dd>
|
|
17837
|
+
|
|
17838
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17839
|
+
|
|
17840
|
+
</dd>
|
|
17841
|
+
</dl>
|
|
17842
|
+
</dd>
|
|
17843
|
+
</dl>
|
|
17844
|
+
|
|
17845
|
+
</dd>
|
|
17846
|
+
</dl>
|
|
17847
|
+
</details>
|
|
17848
|
+
|
|
17910
17849
|
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
17911
17850
|
<dl>
|
|
17912
17851
|
<dd>
|
|
@@ -18571,6 +18510,72 @@ await client.shipping.orderDrafts.imageToTextV1({
|
|
|
18571
18510
|
</dl>
|
|
18572
18511
|
</details>
|
|
18573
18512
|
|
|
18513
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
18514
|
+
<dl>
|
|
18515
|
+
<dd>
|
|
18516
|
+
|
|
18517
|
+
#### 📝 Description
|
|
18518
|
+
|
|
18519
|
+
<dl>
|
|
18520
|
+
<dd>
|
|
18521
|
+
|
|
18522
|
+
<dl>
|
|
18523
|
+
<dd>
|
|
18524
|
+
|
|
18525
|
+
Returns distinct short_id and off_chrt_reference_id values matching the query via case-insensitive regex. Searches draft orders created by the caller's org. | authz: min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
18526
|
+
|
|
18527
|
+
</dd>
|
|
18528
|
+
</dl>
|
|
18529
|
+
</dd>
|
|
18530
|
+
</dl>
|
|
18531
|
+
|
|
18532
|
+
#### 🔌 Usage
|
|
18533
|
+
|
|
18534
|
+
<dl>
|
|
18535
|
+
<dd>
|
|
18536
|
+
|
|
18537
|
+
<dl>
|
|
18538
|
+
<dd>
|
|
18539
|
+
|
|
18540
|
+
```typescript
|
|
18541
|
+
await client.shipping.orderDrafts.typeaheadV1({
|
|
18542
|
+
query: "query",
|
|
18543
|
+
limit: 1,
|
|
18544
|
+
});
|
|
18545
|
+
```
|
|
18546
|
+
|
|
18547
|
+
</dd>
|
|
18548
|
+
</dl>
|
|
18549
|
+
</dd>
|
|
18550
|
+
</dl>
|
|
18551
|
+
|
|
18552
|
+
#### ⚙️ Parameters
|
|
18553
|
+
|
|
18554
|
+
<dl>
|
|
18555
|
+
<dd>
|
|
18556
|
+
|
|
18557
|
+
<dl>
|
|
18558
|
+
<dd>
|
|
18559
|
+
|
|
18560
|
+
**request:** `Chrt.shipping.OrderDraftsTypeaheadV1Request`
|
|
18561
|
+
|
|
18562
|
+
</dd>
|
|
18563
|
+
</dl>
|
|
18564
|
+
|
|
18565
|
+
<dl>
|
|
18566
|
+
<dd>
|
|
18567
|
+
|
|
18568
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18569
|
+
|
|
18570
|
+
</dd>
|
|
18571
|
+
</dl>
|
|
18572
|
+
</dd>
|
|
18573
|
+
</dl>
|
|
18574
|
+
|
|
18575
|
+
</dd>
|
|
18576
|
+
</dl>
|
|
18577
|
+
</details>
|
|
18578
|
+
|
|
18574
18579
|
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">validateV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
18575
18580
|
<dl>
|
|
18576
18581
|
<dd>
|
|
@@ -18784,7 +18789,7 @@ await client.shipping.orderSchedules.getByIdV1("order_schedule_id");
|
|
|
18784
18789
|
<dl>
|
|
18785
18790
|
<dd>
|
|
18786
18791
|
|
|
18787
|
-
Retrieves
|
|
18792
|
+
Retrieves the generated order count and live orchestrator status from Temporal. | authz: min_org_role=operator | () -> (OrderScheduleAboutRes)
|
|
18788
18793
|
|
|
18789
18794
|
</dd>
|
|
18790
18795
|
</dl>
|
|
@@ -18835,7 +18840,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18835
18840
|
</dl>
|
|
18836
18841
|
</details>
|
|
18837
18842
|
|
|
18838
|
-
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">
|
|
18843
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">activateV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18839
18844
|
<dl>
|
|
18840
18845
|
<dd>
|
|
18841
18846
|
|
|
@@ -18847,7 +18852,7 @@ await client.shipping.orderSchedules.aboutV1("order_schedule_id");
|
|
|
18847
18852
|
<dl>
|
|
18848
18853
|
<dd>
|
|
18849
18854
|
|
|
18850
|
-
|
|
18855
|
+
Validates a draft order schedule, creates its Temporal orchestrator schedule, and activates it. | authz: min_org_role=operator | () -> (bool)
|
|
18851
18856
|
|
|
18852
18857
|
</dd>
|
|
18853
18858
|
</dl>
|
|
@@ -18863,12 +18868,588 @@ Creates a new draft order schedule. | authz: min_org_role=operator | (OrderSched
|
|
|
18863
18868
|
<dd>
|
|
18864
18869
|
|
|
18865
18870
|
```typescript
|
|
18866
|
-
await client.shipping.orderSchedules.
|
|
18867
|
-
|
|
18868
|
-
|
|
18869
|
-
|
|
18870
|
-
|
|
18871
|
-
|
|
18871
|
+
await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
18872
|
+
```
|
|
18873
|
+
|
|
18874
|
+
</dd>
|
|
18875
|
+
</dl>
|
|
18876
|
+
</dd>
|
|
18877
|
+
</dl>
|
|
18878
|
+
|
|
18879
|
+
#### ⚙️ Parameters
|
|
18880
|
+
|
|
18881
|
+
<dl>
|
|
18882
|
+
<dd>
|
|
18883
|
+
|
|
18884
|
+
<dl>
|
|
18885
|
+
<dd>
|
|
18886
|
+
|
|
18887
|
+
**orderScheduleId:** `string`
|
|
18888
|
+
|
|
18889
|
+
</dd>
|
|
18890
|
+
</dl>
|
|
18891
|
+
|
|
18892
|
+
<dl>
|
|
18893
|
+
<dd>
|
|
18894
|
+
|
|
18895
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18896
|
+
|
|
18897
|
+
</dd>
|
|
18898
|
+
</dl>
|
|
18899
|
+
</dd>
|
|
18900
|
+
</dl>
|
|
18901
|
+
|
|
18902
|
+
</dd>
|
|
18903
|
+
</dl>
|
|
18904
|
+
</details>
|
|
18905
|
+
|
|
18906
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">triggerV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18907
|
+
<dl>
|
|
18908
|
+
<dd>
|
|
18909
|
+
|
|
18910
|
+
#### 📝 Description
|
|
18911
|
+
|
|
18912
|
+
<dl>
|
|
18913
|
+
<dd>
|
|
18914
|
+
|
|
18915
|
+
<dl>
|
|
18916
|
+
<dd>
|
|
18917
|
+
|
|
18918
|
+
Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (bool)
|
|
18919
|
+
|
|
18920
|
+
</dd>
|
|
18921
|
+
</dl>
|
|
18922
|
+
</dd>
|
|
18923
|
+
</dl>
|
|
18924
|
+
|
|
18925
|
+
#### 🔌 Usage
|
|
18926
|
+
|
|
18927
|
+
<dl>
|
|
18928
|
+
<dd>
|
|
18929
|
+
|
|
18930
|
+
<dl>
|
|
18931
|
+
<dd>
|
|
18932
|
+
|
|
18933
|
+
```typescript
|
|
18934
|
+
await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
18935
|
+
```
|
|
18936
|
+
|
|
18937
|
+
</dd>
|
|
18938
|
+
</dl>
|
|
18939
|
+
</dd>
|
|
18940
|
+
</dl>
|
|
18941
|
+
|
|
18942
|
+
#### ⚙️ Parameters
|
|
18943
|
+
|
|
18944
|
+
<dl>
|
|
18945
|
+
<dd>
|
|
18946
|
+
|
|
18947
|
+
<dl>
|
|
18948
|
+
<dd>
|
|
18949
|
+
|
|
18950
|
+
**orderScheduleId:** `string`
|
|
18951
|
+
|
|
18952
|
+
</dd>
|
|
18953
|
+
</dl>
|
|
18954
|
+
|
|
18955
|
+
<dl>
|
|
18956
|
+
<dd>
|
|
18957
|
+
|
|
18958
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
18959
|
+
|
|
18960
|
+
</dd>
|
|
18961
|
+
</dl>
|
|
18962
|
+
</dd>
|
|
18963
|
+
</dl>
|
|
18964
|
+
|
|
18965
|
+
</dd>
|
|
18966
|
+
</dl>
|
|
18967
|
+
</details>
|
|
18968
|
+
|
|
18969
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">pauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
18970
|
+
<dl>
|
|
18971
|
+
<dd>
|
|
18972
|
+
|
|
18973
|
+
#### 📝 Description
|
|
18974
|
+
|
|
18975
|
+
<dl>
|
|
18976
|
+
<dd>
|
|
18977
|
+
|
|
18978
|
+
<dl>
|
|
18979
|
+
<dd>
|
|
18980
|
+
|
|
18981
|
+
Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
18982
|
+
|
|
18983
|
+
</dd>
|
|
18984
|
+
</dl>
|
|
18985
|
+
</dd>
|
|
18986
|
+
</dl>
|
|
18987
|
+
|
|
18988
|
+
#### 🔌 Usage
|
|
18989
|
+
|
|
18990
|
+
<dl>
|
|
18991
|
+
<dd>
|
|
18992
|
+
|
|
18993
|
+
<dl>
|
|
18994
|
+
<dd>
|
|
18995
|
+
|
|
18996
|
+
```typescript
|
|
18997
|
+
await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
18998
|
+
```
|
|
18999
|
+
|
|
19000
|
+
</dd>
|
|
19001
|
+
</dl>
|
|
19002
|
+
</dd>
|
|
19003
|
+
</dl>
|
|
19004
|
+
|
|
19005
|
+
#### ⚙️ Parameters
|
|
19006
|
+
|
|
19007
|
+
<dl>
|
|
19008
|
+
<dd>
|
|
19009
|
+
|
|
19010
|
+
<dl>
|
|
19011
|
+
<dd>
|
|
19012
|
+
|
|
19013
|
+
**orderScheduleId:** `string`
|
|
19014
|
+
|
|
19015
|
+
</dd>
|
|
19016
|
+
</dl>
|
|
19017
|
+
|
|
19018
|
+
<dl>
|
|
19019
|
+
<dd>
|
|
19020
|
+
|
|
19021
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19022
|
+
|
|
19023
|
+
</dd>
|
|
19024
|
+
</dl>
|
|
19025
|
+
</dd>
|
|
19026
|
+
</dl>
|
|
19027
|
+
|
|
19028
|
+
</dd>
|
|
19029
|
+
</dl>
|
|
19030
|
+
</details>
|
|
19031
|
+
|
|
19032
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">unpauseV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19033
|
+
<dl>
|
|
19034
|
+
<dd>
|
|
19035
|
+
|
|
19036
|
+
#### 📝 Description
|
|
19037
|
+
|
|
19038
|
+
<dl>
|
|
19039
|
+
<dd>
|
|
19040
|
+
|
|
19041
|
+
<dl>
|
|
19042
|
+
<dd>
|
|
19043
|
+
|
|
19044
|
+
Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
19045
|
+
|
|
19046
|
+
</dd>
|
|
19047
|
+
</dl>
|
|
19048
|
+
</dd>
|
|
19049
|
+
</dl>
|
|
19050
|
+
|
|
19051
|
+
#### 🔌 Usage
|
|
19052
|
+
|
|
19053
|
+
<dl>
|
|
19054
|
+
<dd>
|
|
19055
|
+
|
|
19056
|
+
<dl>
|
|
19057
|
+
<dd>
|
|
19058
|
+
|
|
19059
|
+
```typescript
|
|
19060
|
+
await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
19061
|
+
```
|
|
19062
|
+
|
|
19063
|
+
</dd>
|
|
19064
|
+
</dl>
|
|
19065
|
+
</dd>
|
|
19066
|
+
</dl>
|
|
19067
|
+
|
|
19068
|
+
#### ⚙️ Parameters
|
|
19069
|
+
|
|
19070
|
+
<dl>
|
|
19071
|
+
<dd>
|
|
19072
|
+
|
|
19073
|
+
<dl>
|
|
19074
|
+
<dd>
|
|
19075
|
+
|
|
19076
|
+
**orderScheduleId:** `string`
|
|
19077
|
+
|
|
19078
|
+
</dd>
|
|
19079
|
+
</dl>
|
|
19080
|
+
|
|
19081
|
+
<dl>
|
|
19082
|
+
<dd>
|
|
19083
|
+
|
|
19084
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19085
|
+
|
|
19086
|
+
</dd>
|
|
19087
|
+
</dl>
|
|
19088
|
+
</dd>
|
|
19089
|
+
</dl>
|
|
19090
|
+
|
|
19091
|
+
</dd>
|
|
19092
|
+
</dl>
|
|
19093
|
+
</details>
|
|
19094
|
+
|
|
19095
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">takeOwnershipV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19096
|
+
<dl>
|
|
19097
|
+
<dd>
|
|
19098
|
+
|
|
19099
|
+
#### 📝 Description
|
|
19100
|
+
|
|
19101
|
+
<dl>
|
|
19102
|
+
<dd>
|
|
19103
|
+
|
|
19104
|
+
<dl>
|
|
19105
|
+
<dd>
|
|
19106
|
+
|
|
19107
|
+
Transfers order schedule workflow ownership to the caller. | authz: min_org_role=operator | () -> (bool)
|
|
19108
|
+
|
|
19109
|
+
</dd>
|
|
19110
|
+
</dl>
|
|
19111
|
+
</dd>
|
|
19112
|
+
</dl>
|
|
19113
|
+
|
|
19114
|
+
#### 🔌 Usage
|
|
19115
|
+
|
|
19116
|
+
<dl>
|
|
19117
|
+
<dd>
|
|
19118
|
+
|
|
19119
|
+
<dl>
|
|
19120
|
+
<dd>
|
|
19121
|
+
|
|
19122
|
+
```typescript
|
|
19123
|
+
await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
19124
|
+
```
|
|
19125
|
+
|
|
19126
|
+
</dd>
|
|
19127
|
+
</dl>
|
|
19128
|
+
</dd>
|
|
19129
|
+
</dl>
|
|
19130
|
+
|
|
19131
|
+
#### ⚙️ Parameters
|
|
19132
|
+
|
|
19133
|
+
<dl>
|
|
19134
|
+
<dd>
|
|
19135
|
+
|
|
19136
|
+
<dl>
|
|
19137
|
+
<dd>
|
|
19138
|
+
|
|
19139
|
+
**orderScheduleId:** `string`
|
|
19140
|
+
|
|
19141
|
+
</dd>
|
|
19142
|
+
</dl>
|
|
19143
|
+
|
|
19144
|
+
<dl>
|
|
19145
|
+
<dd>
|
|
19146
|
+
|
|
19147
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19148
|
+
|
|
19149
|
+
</dd>
|
|
19150
|
+
</dl>
|
|
19151
|
+
</dd>
|
|
19152
|
+
</dl>
|
|
19153
|
+
|
|
19154
|
+
</dd>
|
|
19155
|
+
</dl>
|
|
19156
|
+
</details>
|
|
19157
|
+
|
|
19158
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">archiveV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19159
|
+
<dl>
|
|
19160
|
+
<dd>
|
|
19161
|
+
|
|
19162
|
+
#### 📝 Description
|
|
19163
|
+
|
|
19164
|
+
<dl>
|
|
19165
|
+
<dd>
|
|
19166
|
+
|
|
19167
|
+
<dl>
|
|
19168
|
+
<dd>
|
|
19169
|
+
|
|
19170
|
+
Archives an order schedule and deletes its Temporal schedule, preventing future runs. | authz: min_org_role=operator | () -> (bool)
|
|
19171
|
+
|
|
19172
|
+
</dd>
|
|
19173
|
+
</dl>
|
|
19174
|
+
</dd>
|
|
19175
|
+
</dl>
|
|
19176
|
+
|
|
19177
|
+
#### 🔌 Usage
|
|
19178
|
+
|
|
19179
|
+
<dl>
|
|
19180
|
+
<dd>
|
|
19181
|
+
|
|
19182
|
+
<dl>
|
|
19183
|
+
<dd>
|
|
19184
|
+
|
|
19185
|
+
```typescript
|
|
19186
|
+
await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
19187
|
+
```
|
|
19188
|
+
|
|
19189
|
+
</dd>
|
|
19190
|
+
</dl>
|
|
19191
|
+
</dd>
|
|
19192
|
+
</dl>
|
|
19193
|
+
|
|
19194
|
+
#### ⚙️ Parameters
|
|
19195
|
+
|
|
19196
|
+
<dl>
|
|
19197
|
+
<dd>
|
|
19198
|
+
|
|
19199
|
+
<dl>
|
|
19200
|
+
<dd>
|
|
19201
|
+
|
|
19202
|
+
**orderScheduleId:** `string`
|
|
19203
|
+
|
|
19204
|
+
</dd>
|
|
19205
|
+
</dl>
|
|
19206
|
+
|
|
19207
|
+
<dl>
|
|
19208
|
+
<dd>
|
|
19209
|
+
|
|
19210
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19211
|
+
|
|
19212
|
+
</dd>
|
|
19213
|
+
</dl>
|
|
19214
|
+
</dd>
|
|
19215
|
+
</dl>
|
|
19216
|
+
|
|
19217
|
+
</dd>
|
|
19218
|
+
</dl>
|
|
19219
|
+
</details>
|
|
19220
|
+
|
|
19221
|
+
<details><summary><code>client.shipping.orderSchedules.<a href="/src/api/resources/shipping/resources/orderSchedules/client/Client.ts">syncWithOrchestratorV1</a>(orderScheduleId) -> boolean</code></summary>
|
|
19222
|
+
<dl>
|
|
19223
|
+
<dd>
|
|
19224
|
+
|
|
19225
|
+
#### 📝 Description
|
|
19226
|
+
|
|
19227
|
+
<dl>
|
|
19228
|
+
<dd>
|
|
19229
|
+
|
|
19230
|
+
<dl>
|
|
19231
|
+
<dd>
|
|
19232
|
+
|
|
19233
|
+
Re-syncs the Temporal schedule to match the order schedule's intended status. | authz: min_org_role=operator | () -> (bool)
|
|
19234
|
+
|
|
19235
|
+
</dd>
|
|
19236
|
+
</dl>
|
|
19237
|
+
</dd>
|
|
19238
|
+
</dl>
|
|
19239
|
+
|
|
19240
|
+
#### 🔌 Usage
|
|
19241
|
+
|
|
19242
|
+
<dl>
|
|
19243
|
+
<dd>
|
|
19244
|
+
|
|
19245
|
+
<dl>
|
|
19246
|
+
<dd>
|
|
19247
|
+
|
|
19248
|
+
```typescript
|
|
19249
|
+
await client.shipping.orderSchedules.syncWithOrchestratorV1("order_schedule_id");
|
|
19250
|
+
```
|
|
19251
|
+
|
|
19252
|
+
</dd>
|
|
19253
|
+
</dl>
|
|
19254
|
+
</dd>
|
|
19255
|
+
</dl>
|
|
19256
|
+
|
|
19257
|
+
#### ⚙️ Parameters
|
|
19258
|
+
|
|
19259
|
+
<dl>
|
|
19260
|
+
<dd>
|
|
19261
|
+
|
|
19262
|
+
<dl>
|
|
19263
|
+
<dd>
|
|
19264
|
+
|
|
19265
|
+
**orderScheduleId:** `string`
|
|
19266
|
+
|
|
19267
|
+
</dd>
|
|
19268
|
+
</dl>
|
|
19269
|
+
|
|
19270
|
+
<dl>
|
|
19271
|
+
<dd>
|
|
19272
|
+
|
|
19273
|
+
**requestOptions:** `OrderSchedules.RequestOptions`
|
|
19274
|
+
|
|
19275
|
+
</dd>
|
|
19276
|
+
</dl>
|
|
19277
|
+
</dd>
|
|
19278
|
+
</dl>
|
|
19279
|
+
|
|
19280
|
+
</dd>
|
|
19281
|
+
</dl>
|
|
19282
|
+
</details>
|
|
19283
|
+
|
|
19284
|
+
## Shipping OrderTemplates
|
|
19285
|
+
|
|
19286
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getExpandedByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplateExpanded</code></summary>
|
|
19287
|
+
<dl>
|
|
19288
|
+
<dd>
|
|
19289
|
+
|
|
19290
|
+
#### 📝 Description
|
|
19291
|
+
|
|
19292
|
+
<dl>
|
|
19293
|
+
<dd>
|
|
19294
|
+
|
|
19295
|
+
<dl>
|
|
19296
|
+
<dd>
|
|
19297
|
+
|
|
19298
|
+
Retrieves an order template with its reference columns resolved (shipper, executor orgs, drivers, directory entries). Unresolvable list references are omitted so the caller can detect dangling ids. | authz: min_org_role=operator | () -> (OrderTemplateExpanded)
|
|
19299
|
+
|
|
19300
|
+
</dd>
|
|
19301
|
+
</dl>
|
|
19302
|
+
</dd>
|
|
19303
|
+
</dl>
|
|
19304
|
+
|
|
19305
|
+
#### 🔌 Usage
|
|
19306
|
+
|
|
19307
|
+
<dl>
|
|
19308
|
+
<dd>
|
|
19309
|
+
|
|
19310
|
+
<dl>
|
|
19311
|
+
<dd>
|
|
19312
|
+
|
|
19313
|
+
```typescript
|
|
19314
|
+
await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
19315
|
+
```
|
|
19316
|
+
|
|
19317
|
+
</dd>
|
|
19318
|
+
</dl>
|
|
19319
|
+
</dd>
|
|
19320
|
+
</dl>
|
|
19321
|
+
|
|
19322
|
+
#### ⚙️ Parameters
|
|
19323
|
+
|
|
19324
|
+
<dl>
|
|
19325
|
+
<dd>
|
|
19326
|
+
|
|
19327
|
+
<dl>
|
|
19328
|
+
<dd>
|
|
19329
|
+
|
|
19330
|
+
**orderTemplateId:** `string`
|
|
19331
|
+
|
|
19332
|
+
</dd>
|
|
19333
|
+
</dl>
|
|
19334
|
+
|
|
19335
|
+
<dl>
|
|
19336
|
+
<dd>
|
|
19337
|
+
|
|
19338
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19339
|
+
|
|
19340
|
+
</dd>
|
|
19341
|
+
</dl>
|
|
19342
|
+
</dd>
|
|
19343
|
+
</dl>
|
|
19344
|
+
|
|
19345
|
+
</dd>
|
|
19346
|
+
</dl>
|
|
19347
|
+
</details>
|
|
19348
|
+
|
|
19349
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderTemplateListRes</code></summary>
|
|
19350
|
+
<dl>
|
|
19351
|
+
<dd>
|
|
19352
|
+
|
|
19353
|
+
#### 📝 Description
|
|
19354
|
+
|
|
19355
|
+
<dl>
|
|
19356
|
+
<dd>
|
|
19357
|
+
|
|
19358
|
+
<dl>
|
|
19359
|
+
<dd>
|
|
19360
|
+
|
|
19361
|
+
Lists order templates for the caller's organization with filtering, sorting, pagination, and optional full-text search (name, description, order_input, off_chrt_reference_id_str). | authz: min_org_role=operator | () -> (OrderTemplateListRes)
|
|
19362
|
+
|
|
19363
|
+
</dd>
|
|
19364
|
+
</dl>
|
|
19365
|
+
</dd>
|
|
19366
|
+
</dl>
|
|
19367
|
+
|
|
19368
|
+
#### 🔌 Usage
|
|
19369
|
+
|
|
19370
|
+
<dl>
|
|
19371
|
+
<dd>
|
|
19372
|
+
|
|
19373
|
+
<dl>
|
|
19374
|
+
<dd>
|
|
19375
|
+
|
|
19376
|
+
```typescript
|
|
19377
|
+
await client.shipping.orderTemplates.listV1({
|
|
19378
|
+
sort_by: "created_at_timestamp",
|
|
19379
|
+
sort_order: "asc",
|
|
19380
|
+
page: 1,
|
|
19381
|
+
page_size: 1,
|
|
19382
|
+
search: "search",
|
|
19383
|
+
filter_archived: true,
|
|
19384
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
19385
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19386
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19387
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
19388
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
19389
|
+
});
|
|
19390
|
+
```
|
|
19391
|
+
|
|
19392
|
+
</dd>
|
|
19393
|
+
</dl>
|
|
19394
|
+
</dd>
|
|
19395
|
+
</dl>
|
|
19396
|
+
|
|
19397
|
+
#### ⚙️ Parameters
|
|
19398
|
+
|
|
19399
|
+
<dl>
|
|
19400
|
+
<dd>
|
|
19401
|
+
|
|
19402
|
+
<dl>
|
|
19403
|
+
<dd>
|
|
19404
|
+
|
|
19405
|
+
**request:** `Chrt.shipping.OrderTemplatesListV1Request`
|
|
19406
|
+
|
|
19407
|
+
</dd>
|
|
19408
|
+
</dl>
|
|
19409
|
+
|
|
19410
|
+
<dl>
|
|
19411
|
+
<dd>
|
|
19412
|
+
|
|
19413
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19414
|
+
|
|
19415
|
+
</dd>
|
|
19416
|
+
</dl>
|
|
19417
|
+
</dd>
|
|
19418
|
+
</dl>
|
|
19419
|
+
|
|
19420
|
+
</dd>
|
|
19421
|
+
</dl>
|
|
19422
|
+
</details>
|
|
19423
|
+
|
|
19424
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">getByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplate1</code></summary>
|
|
19425
|
+
<dl>
|
|
19426
|
+
<dd>
|
|
19427
|
+
|
|
19428
|
+
#### 📝 Description
|
|
19429
|
+
|
|
19430
|
+
<dl>
|
|
19431
|
+
<dd>
|
|
19432
|
+
|
|
19433
|
+
<dl>
|
|
19434
|
+
<dd>
|
|
19435
|
+
|
|
19436
|
+
Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplate1)
|
|
19437
|
+
|
|
19438
|
+
</dd>
|
|
19439
|
+
</dl>
|
|
19440
|
+
</dd>
|
|
19441
|
+
</dl>
|
|
19442
|
+
|
|
19443
|
+
#### 🔌 Usage
|
|
19444
|
+
|
|
19445
|
+
<dl>
|
|
19446
|
+
<dd>
|
|
19447
|
+
|
|
19448
|
+
<dl>
|
|
19449
|
+
<dd>
|
|
19450
|
+
|
|
19451
|
+
```typescript
|
|
19452
|
+
await client.shipping.orderTemplates.getByIdV1("order_template_id");
|
|
18872
19453
|
```
|
|
18873
19454
|
|
|
18874
19455
|
</dd>
|
|
@@ -18884,7 +19465,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18884
19465
|
<dl>
|
|
18885
19466
|
<dd>
|
|
18886
19467
|
|
|
18887
|
-
**
|
|
19468
|
+
**orderTemplateId:** `string`
|
|
18888
19469
|
|
|
18889
19470
|
</dd>
|
|
18890
19471
|
</dl>
|
|
@@ -18892,7 +19473,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18892
19473
|
<dl>
|
|
18893
19474
|
<dd>
|
|
18894
19475
|
|
|
18895
|
-
**requestOptions:** `
|
|
19476
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
18896
19477
|
|
|
18897
19478
|
</dd>
|
|
18898
19479
|
</dl>
|
|
@@ -18903,7 +19484,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18903
19484
|
</dl>
|
|
18904
19485
|
</details>
|
|
18905
19486
|
|
|
18906
|
-
<details><summary><code>client.shipping.
|
|
19487
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">deleteV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
18907
19488
|
<dl>
|
|
18908
19489
|
<dd>
|
|
18909
19490
|
|
|
@@ -18915,7 +19496,7 @@ await client.shipping.orderSchedules.newV1({
|
|
|
18915
19496
|
<dl>
|
|
18916
19497
|
<dd>
|
|
18917
19498
|
|
|
18918
|
-
|
|
19499
|
+
Deletes an order template, but only when no orders were built from it (otherwise archive instead). | authz: min_org_role=operator | () -> (bool)
|
|
18919
19500
|
|
|
18920
19501
|
</dd>
|
|
18921
19502
|
</dl>
|
|
@@ -18931,7 +19512,7 @@ Updates an order schedule. | authz: min_org_role=operator | (OrderScheduleClient
|
|
|
18931
19512
|
<dd>
|
|
18932
19513
|
|
|
18933
19514
|
```typescript
|
|
18934
|
-
await client.shipping.
|
|
19515
|
+
await client.shipping.orderTemplates.deleteV1("order_template_id");
|
|
18935
19516
|
```
|
|
18936
19517
|
|
|
18937
19518
|
</dd>
|
|
@@ -18947,15 +19528,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18947
19528
|
<dl>
|
|
18948
19529
|
<dd>
|
|
18949
19530
|
|
|
18950
|
-
**
|
|
18951
|
-
|
|
18952
|
-
</dd>
|
|
18953
|
-
</dl>
|
|
18954
|
-
|
|
18955
|
-
<dl>
|
|
18956
|
-
<dd>
|
|
18957
|
-
|
|
18958
|
-
**request:** `Chrt.shipping.OrderScheduleClientUpdate1`
|
|
19531
|
+
**orderTemplateId:** `string`
|
|
18959
19532
|
|
|
18960
19533
|
</dd>
|
|
18961
19534
|
</dl>
|
|
@@ -18963,7 +19536,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18963
19536
|
<dl>
|
|
18964
19537
|
<dd>
|
|
18965
19538
|
|
|
18966
|
-
**requestOptions:** `
|
|
19539
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
18967
19540
|
|
|
18968
19541
|
</dd>
|
|
18969
19542
|
</dl>
|
|
@@ -18974,7 +19547,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18974
19547
|
</dl>
|
|
18975
19548
|
</details>
|
|
18976
19549
|
|
|
18977
|
-
<details><summary><code>client.shipping.
|
|
19550
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
18978
19551
|
<dl>
|
|
18979
19552
|
<dd>
|
|
18980
19553
|
|
|
@@ -18986,7 +19559,7 @@ await client.shipping.orderSchedules.updateV1("order_schedule_id");
|
|
|
18986
19559
|
<dl>
|
|
18987
19560
|
<dd>
|
|
18988
19561
|
|
|
18989
|
-
|
|
19562
|
+
Creates a new order template. | authz: min_org_role=operator | (OrderTemplateClientCreate1) -> (PydanticObjectId)
|
|
18990
19563
|
|
|
18991
19564
|
</dd>
|
|
18992
19565
|
</dl>
|
|
@@ -19002,7 +19575,10 @@ Transfers order schedule workflow ownership to the caller. | authz: min_org_role
|
|
|
19002
19575
|
<dd>
|
|
19003
19576
|
|
|
19004
19577
|
```typescript
|
|
19005
|
-
await client.shipping.
|
|
19578
|
+
await client.shipping.orderTemplates.createV1({
|
|
19579
|
+
schema_version: 1,
|
|
19580
|
+
name: "name",
|
|
19581
|
+
});
|
|
19006
19582
|
```
|
|
19007
19583
|
|
|
19008
19584
|
</dd>
|
|
@@ -19018,7 +19594,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19018
19594
|
<dl>
|
|
19019
19595
|
<dd>
|
|
19020
19596
|
|
|
19021
|
-
**
|
|
19597
|
+
**request:** `Chrt.shipping.OrderTemplateClientCreate1`
|
|
19022
19598
|
|
|
19023
19599
|
</dd>
|
|
19024
19600
|
</dl>
|
|
@@ -19026,7 +19602,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19026
19602
|
<dl>
|
|
19027
19603
|
<dd>
|
|
19028
19604
|
|
|
19029
|
-
**requestOptions:** `
|
|
19605
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19030
19606
|
|
|
19031
19607
|
</dd>
|
|
19032
19608
|
</dl>
|
|
@@ -19037,7 +19613,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19037
19613
|
</dl>
|
|
19038
19614
|
</details>
|
|
19039
19615
|
|
|
19040
|
-
<details><summary><code>client.shipping.
|
|
19616
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">updateV1</a>(orderTemplateId, { ...params }) -> boolean</code></summary>
|
|
19041
19617
|
<dl>
|
|
19042
19618
|
<dd>
|
|
19043
19619
|
|
|
@@ -19049,7 +19625,7 @@ await client.shipping.orderSchedules.takeOwnershipV1("order_schedule_id");
|
|
|
19049
19625
|
<dl>
|
|
19050
19626
|
<dd>
|
|
19051
19627
|
|
|
19052
|
-
|
|
19628
|
+
Updates an order template. | authz: min_org_role=operator | (OrderTemplateClientUpdate1) -> (bool)
|
|
19053
19629
|
|
|
19054
19630
|
</dd>
|
|
19055
19631
|
</dl>
|
|
@@ -19065,7 +19641,7 @@ Validates a draft order schedule, creates its Temporal orchestrator schedule, an
|
|
|
19065
19641
|
<dd>
|
|
19066
19642
|
|
|
19067
19643
|
```typescript
|
|
19068
|
-
await client.shipping.
|
|
19644
|
+
await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
19069
19645
|
```
|
|
19070
19646
|
|
|
19071
19647
|
</dd>
|
|
@@ -19081,7 +19657,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19081
19657
|
<dl>
|
|
19082
19658
|
<dd>
|
|
19083
19659
|
|
|
19084
|
-
**
|
|
19660
|
+
**orderTemplateId:** `string`
|
|
19085
19661
|
|
|
19086
19662
|
</dd>
|
|
19087
19663
|
</dl>
|
|
@@ -19089,7 +19665,15 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19089
19665
|
<dl>
|
|
19090
19666
|
<dd>
|
|
19091
19667
|
|
|
19092
|
-
**
|
|
19668
|
+
**request:** `Chrt.shipping.OrderTemplateClientUpdate1`
|
|
19669
|
+
|
|
19670
|
+
</dd>
|
|
19671
|
+
</dl>
|
|
19672
|
+
|
|
19673
|
+
<dl>
|
|
19674
|
+
<dd>
|
|
19675
|
+
|
|
19676
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19093
19677
|
|
|
19094
19678
|
</dd>
|
|
19095
19679
|
</dl>
|
|
@@ -19100,7 +19684,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19100
19684
|
</dl>
|
|
19101
19685
|
</details>
|
|
19102
19686
|
|
|
19103
|
-
<details><summary><code>client.shipping.
|
|
19687
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">archiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
19104
19688
|
<dl>
|
|
19105
19689
|
<dd>
|
|
19106
19690
|
|
|
@@ -19112,7 +19696,7 @@ await client.shipping.orderSchedules.activateV1("order_schedule_id");
|
|
|
19112
19696
|
<dl>
|
|
19113
19697
|
<dd>
|
|
19114
19698
|
|
|
19115
|
-
|
|
19699
|
+
Archives an order template by setting archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
|
|
19116
19700
|
|
|
19117
19701
|
</dd>
|
|
19118
19702
|
</dl>
|
|
@@ -19128,7 +19712,7 @@ Unpauses a paused order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
19128
19712
|
<dd>
|
|
19129
19713
|
|
|
19130
19714
|
```typescript
|
|
19131
|
-
await client.shipping.
|
|
19715
|
+
await client.shipping.orderTemplates.archiveV1("order_template_id");
|
|
19132
19716
|
```
|
|
19133
19717
|
|
|
19134
19718
|
</dd>
|
|
@@ -19144,7 +19728,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19144
19728
|
<dl>
|
|
19145
19729
|
<dd>
|
|
19146
19730
|
|
|
19147
|
-
**
|
|
19731
|
+
**orderTemplateId:** `string`
|
|
19148
19732
|
|
|
19149
19733
|
</dd>
|
|
19150
19734
|
</dl>
|
|
@@ -19152,7 +19736,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19152
19736
|
<dl>
|
|
19153
19737
|
<dd>
|
|
19154
19738
|
|
|
19155
|
-
**requestOptions:** `
|
|
19739
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19156
19740
|
|
|
19157
19741
|
</dd>
|
|
19158
19742
|
</dl>
|
|
@@ -19163,7 +19747,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19163
19747
|
</dl>
|
|
19164
19748
|
</details>
|
|
19165
19749
|
|
|
19166
|
-
<details><summary><code>client.shipping.
|
|
19750
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">unarchiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
19167
19751
|
<dl>
|
|
19168
19752
|
<dd>
|
|
19169
19753
|
|
|
@@ -19175,7 +19759,7 @@ await client.shipping.orderSchedules.unpauseV1("order_schedule_id");
|
|
|
19175
19759
|
<dl>
|
|
19176
19760
|
<dd>
|
|
19177
19761
|
|
|
19178
|
-
|
|
19762
|
+
Restores an archived order template by clearing archived_at_timestamp. | authz: min_org_role=operator | () -> (bool)
|
|
19179
19763
|
|
|
19180
19764
|
</dd>
|
|
19181
19765
|
</dl>
|
|
@@ -19191,7 +19775,7 @@ Pauses an active order schedule. | authz: min_org_role=operator | () -> (bool)
|
|
|
19191
19775
|
<dd>
|
|
19192
19776
|
|
|
19193
19777
|
```typescript
|
|
19194
|
-
await client.shipping.
|
|
19778
|
+
await client.shipping.orderTemplates.unarchiveV1("order_template_id");
|
|
19195
19779
|
```
|
|
19196
19780
|
|
|
19197
19781
|
</dd>
|
|
@@ -19207,7 +19791,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19207
19791
|
<dl>
|
|
19208
19792
|
<dd>
|
|
19209
19793
|
|
|
19210
|
-
**
|
|
19794
|
+
**orderTemplateId:** `string`
|
|
19211
19795
|
|
|
19212
19796
|
</dd>
|
|
19213
19797
|
</dl>
|
|
@@ -19215,7 +19799,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19215
19799
|
<dl>
|
|
19216
19800
|
<dd>
|
|
19217
19801
|
|
|
19218
|
-
**requestOptions:** `
|
|
19802
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19219
19803
|
|
|
19220
19804
|
</dd>
|
|
19221
19805
|
</dl>
|
|
@@ -19226,7 +19810,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19226
19810
|
</dl>
|
|
19227
19811
|
</details>
|
|
19228
19812
|
|
|
19229
|
-
<details><summary><code>client.shipping.
|
|
19813
|
+
<details><summary><code>client.shipping.orderTemplates.<a href="/src/api/resources/shipping/resources/orderTemplates/client/Client.ts">referencesRemoveV1</a>(orderTemplateId, { ...params }) -> boolean</code></summary>
|
|
19230
19814
|
<dl>
|
|
19231
19815
|
<dd>
|
|
19232
19816
|
|
|
@@ -19238,7 +19822,7 @@ await client.shipping.orderSchedules.pauseV1("order_schedule_id");
|
|
|
19238
19822
|
<dl>
|
|
19239
19823
|
<dd>
|
|
19240
19824
|
|
|
19241
|
-
|
|
19825
|
+
Removes a (possibly dangling) reference id from a template column. | authz: min_org_role=operator | (OrderTemplateRemoveReferenceReq) -> (bool)
|
|
19242
19826
|
|
|
19243
19827
|
</dd>
|
|
19244
19828
|
</dl>
|
|
@@ -19254,7 +19838,9 @@ Archives an order schedule and prevents future runs. | authz: min_org_role=opera
|
|
|
19254
19838
|
<dd>
|
|
19255
19839
|
|
|
19256
19840
|
```typescript
|
|
19257
|
-
await client.shipping.
|
|
19841
|
+
await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
19842
|
+
column: "shipper_org_id",
|
|
19843
|
+
});
|
|
19258
19844
|
```
|
|
19259
19845
|
|
|
19260
19846
|
</dd>
|
|
@@ -19270,7 +19856,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19270
19856
|
<dl>
|
|
19271
19857
|
<dd>
|
|
19272
19858
|
|
|
19273
|
-
**
|
|
19859
|
+
**orderTemplateId:** `string`
|
|
19274
19860
|
|
|
19275
19861
|
</dd>
|
|
19276
19862
|
</dl>
|
|
@@ -19278,7 +19864,15 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19278
19864
|
<dl>
|
|
19279
19865
|
<dd>
|
|
19280
19866
|
|
|
19281
|
-
**
|
|
19867
|
+
**request:** `Chrt.shipping.OrderTemplateRemoveReferenceReq`
|
|
19868
|
+
|
|
19869
|
+
</dd>
|
|
19870
|
+
</dl>
|
|
19871
|
+
|
|
19872
|
+
<dl>
|
|
19873
|
+
<dd>
|
|
19874
|
+
|
|
19875
|
+
**requestOptions:** `OrderTemplates.RequestOptions`
|
|
19282
19876
|
|
|
19283
19877
|
</dd>
|
|
19284
19878
|
</dl>
|
|
@@ -19289,7 +19883,9 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19289
19883
|
</dl>
|
|
19290
19884
|
</details>
|
|
19291
19885
|
|
|
19292
|
-
|
|
19886
|
+
## Shipping TaskGroups
|
|
19887
|
+
|
|
19888
|
+
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TaskGroupTypeaheadResult[]</code></summary>
|
|
19293
19889
|
<dl>
|
|
19294
19890
|
<dd>
|
|
19295
19891
|
|
|
@@ -19301,7 +19897,7 @@ await client.shipping.orderSchedules.archiveV1("order_schedule_id");
|
|
|
19301
19897
|
<dl>
|
|
19302
19898
|
<dd>
|
|
19303
19899
|
|
|
19304
|
-
|
|
19900
|
+
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
|
|
19305
19901
|
|
|
19306
19902
|
</dd>
|
|
19307
19903
|
</dl>
|
|
@@ -19317,7 +19913,10 @@ Triggers an order schedule immediately. | authz: min_org_role=operator | () -> (
|
|
|
19317
19913
|
<dd>
|
|
19318
19914
|
|
|
19319
19915
|
```typescript
|
|
19320
|
-
await client.shipping.
|
|
19916
|
+
await client.shipping.taskGroups.typeaheadV1({
|
|
19917
|
+
query: "query",
|
|
19918
|
+
limit: 1,
|
|
19919
|
+
});
|
|
19321
19920
|
```
|
|
19322
19921
|
|
|
19323
19922
|
</dd>
|
|
@@ -19333,7 +19932,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19333
19932
|
<dl>
|
|
19334
19933
|
<dd>
|
|
19335
19934
|
|
|
19336
|
-
**
|
|
19935
|
+
**request:** `Chrt.shipping.TaskGroupsTypeaheadV1Request`
|
|
19337
19936
|
|
|
19338
19937
|
</dd>
|
|
19339
19938
|
</dl>
|
|
@@ -19341,7 +19940,7 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19341
19940
|
<dl>
|
|
19342
19941
|
<dd>
|
|
19343
19942
|
|
|
19344
|
-
**requestOptions:** `
|
|
19943
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
19345
19944
|
|
|
19346
19945
|
</dd>
|
|
19347
19946
|
</dl>
|
|
@@ -19352,8 +19951,6 @@ await client.shipping.orderSchedules.triggerV1("order_schedule_id");
|
|
|
19352
19951
|
</dl>
|
|
19353
19952
|
</details>
|
|
19354
19953
|
|
|
19355
|
-
## Shipping TaskGroups
|
|
19356
|
-
|
|
19357
19954
|
<details><summary><code>client.shipping.taskGroups.<a href="/src/api/resources/shipping/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
19358
19955
|
<dl>
|
|
19359
19956
|
<dd>
|
|
@@ -23910,7 +24507,9 @@ await client.shipping.orderDrafts.expanded.listV1({
|
|
|
23910
24507
|
</dl>
|
|
23911
24508
|
</details>
|
|
23912
24509
|
|
|
23913
|
-
|
|
24510
|
+
## Shipping OrderSchedules Draft
|
|
24511
|
+
|
|
24512
|
+
<details><summary><code>client.shipping.orderSchedules.draft.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.ts">newV1</a>({ ...params }) -> string</code></summary>
|
|
23914
24513
|
<dl>
|
|
23915
24514
|
<dd>
|
|
23916
24515
|
|
|
@@ -23922,7 +24521,7 @@ await client.shipping.orderDrafts.expanded.listV1({
|
|
|
23922
24521
|
<dl>
|
|
23923
24522
|
<dd>
|
|
23924
24523
|
|
|
23925
|
-
|
|
24524
|
+
Creates a new draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientCreate1) -> (PydanticObjectId)
|
|
23926
24525
|
|
|
23927
24526
|
</dd>
|
|
23928
24527
|
</dl>
|
|
@@ -23938,9 +24537,9 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
23938
24537
|
<dd>
|
|
23939
24538
|
|
|
23940
24539
|
```typescript
|
|
23941
|
-
await client.shipping.
|
|
23942
|
-
|
|
23943
|
-
|
|
24540
|
+
await client.shipping.orderSchedules.draft.newV1({
|
|
24541
|
+
schema_version: 1,
|
|
24542
|
+
name: "name",
|
|
23944
24543
|
});
|
|
23945
24544
|
```
|
|
23946
24545
|
|
|
@@ -23957,7 +24556,7 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
23957
24556
|
<dl>
|
|
23958
24557
|
<dd>
|
|
23959
24558
|
|
|
23960
|
-
**request:** `Chrt.shipping.
|
|
24559
|
+
**request:** `Chrt.shipping.orderSchedules.OrderScheduleClientCreate1`
|
|
23961
24560
|
|
|
23962
24561
|
</dd>
|
|
23963
24562
|
</dl>
|
|
@@ -23965,7 +24564,7 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
23965
24564
|
<dl>
|
|
23966
24565
|
<dd>
|
|
23967
24566
|
|
|
23968
|
-
**requestOptions:** `
|
|
24567
|
+
**requestOptions:** `Draft.RequestOptions`
|
|
23969
24568
|
|
|
23970
24569
|
</dd>
|
|
23971
24570
|
</dl>
|
|
@@ -23976,9 +24575,7 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
23976
24575
|
</dl>
|
|
23977
24576
|
</details>
|
|
23978
24577
|
|
|
23979
|
-
|
|
23980
|
-
|
|
23981
|
-
<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>
|
|
24578
|
+
<details><summary><code>client.shipping.orderSchedules.draft.<a href="/src/api/resources/shipping/resources/orderSchedules/resources/draft/client/Client.ts">updateV1</a>(orderScheduleId, { ...params }) -> boolean</code></summary>
|
|
23982
24579
|
<dl>
|
|
23983
24580
|
<dd>
|
|
23984
24581
|
|
|
@@ -23990,7 +24587,7 @@ await client.shipping.orderDrafts.expanded.typeaheadV1({
|
|
|
23990
24587
|
<dl>
|
|
23991
24588
|
<dd>
|
|
23992
24589
|
|
|
23993
|
-
|
|
24590
|
+
Updates a draft order schedule. | authz: min_org_role=operator | (OrderScheduleClientUpdate1) -> (bool)
|
|
23994
24591
|
|
|
23995
24592
|
</dd>
|
|
23996
24593
|
</dl>
|
|
@@ -24006,7 +24603,7 @@ Validates an order manifest for scheduled order creation. | authz: min_org_role=
|
|
|
24006
24603
|
<dd>
|
|
24007
24604
|
|
|
24008
24605
|
```typescript
|
|
24009
|
-
await client.shipping.orderSchedules.
|
|
24606
|
+
await client.shipping.orderSchedules.draft.updateV1("order_schedule_id");
|
|
24010
24607
|
```
|
|
24011
24608
|
|
|
24012
24609
|
</dd>
|
|
@@ -24022,7 +24619,7 @@ await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
|
24022
24619
|
<dl>
|
|
24023
24620
|
<dd>
|
|
24024
24621
|
|
|
24025
|
-
**
|
|
24622
|
+
**orderScheduleId:** `string`
|
|
24026
24623
|
|
|
24027
24624
|
</dd>
|
|
24028
24625
|
</dl>
|
|
@@ -24030,7 +24627,15 @@ await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
|
24030
24627
|
<dl>
|
|
24031
24628
|
<dd>
|
|
24032
24629
|
|
|
24033
|
-
**
|
|
24630
|
+
**request:** `Chrt.shipping.orderSchedules.OrderScheduleClientUpdate1`
|
|
24631
|
+
|
|
24632
|
+
</dd>
|
|
24633
|
+
</dl>
|
|
24634
|
+
|
|
24635
|
+
<dl>
|
|
24636
|
+
<dd>
|
|
24637
|
+
|
|
24638
|
+
**requestOptions:** `Draft.RequestOptions`
|
|
24034
24639
|
|
|
24035
24640
|
</dd>
|
|
24036
24641
|
</dl>
|
|
@@ -24041,9 +24646,9 @@ await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
|
24041
24646
|
</dl>
|
|
24042
24647
|
</details>
|
|
24043
24648
|
|
|
24044
|
-
## Shipping
|
|
24649
|
+
## Shipping OrderSchedules OrderManifest
|
|
24045
24650
|
|
|
24046
|
-
<details><summary><code>client.shipping.
|
|
24651
|
+
<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>
|
|
24047
24652
|
<dl>
|
|
24048
24653
|
<dd>
|
|
24049
24654
|
|
|
@@ -24055,7 +24660,7 @@ await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
|
24055
24660
|
<dl>
|
|
24056
24661
|
<dd>
|
|
24057
24662
|
|
|
24058
|
-
|
|
24663
|
+
Validates an order manifest for scheduled order creation. | authz: min_org_role=operator | (OrderManifest1) -> (OrderManifestValidationResult)
|
|
24059
24664
|
|
|
24060
24665
|
</dd>
|
|
24061
24666
|
</dl>
|
|
@@ -24071,7 +24676,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
|
|
|
24071
24676
|
<dd>
|
|
24072
24677
|
|
|
24073
24678
|
```typescript
|
|
24074
|
-
await client.shipping.
|
|
24679
|
+
await client.shipping.orderSchedules.orderManifest.validateV1({});
|
|
24075
24680
|
```
|
|
24076
24681
|
|
|
24077
24682
|
</dd>
|
|
@@ -24087,15 +24692,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
24087
24692
|
<dl>
|
|
24088
24693
|
<dd>
|
|
24089
24694
|
|
|
24090
|
-
**
|
|
24091
|
-
|
|
24092
|
-
</dd>
|
|
24093
|
-
</dl>
|
|
24094
|
-
|
|
24095
|
-
<dl>
|
|
24096
|
-
<dd>
|
|
24097
|
-
|
|
24098
|
-
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
24695
|
+
**request:** `Chrt.OrderManifest1`
|
|
24099
24696
|
|
|
24100
24697
|
</dd>
|
|
24101
24698
|
</dl>
|
|
@@ -24103,7 +24700,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
24103
24700
|
<dl>
|
|
24104
24701
|
<dd>
|
|
24105
24702
|
|
|
24106
|
-
**requestOptions:** `
|
|
24703
|
+
**requestOptions:** `OrderManifest.RequestOptions`
|
|
24107
24704
|
|
|
24108
24705
|
</dd>
|
|
24109
24706
|
</dl>
|
|
@@ -24114,7 +24711,9 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
24114
24711
|
</dl>
|
|
24115
24712
|
</details>
|
|
24116
24713
|
|
|
24117
|
-
|
|
24714
|
+
## Shipping Orders Expanded
|
|
24715
|
+
|
|
24716
|
+
<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>
|
|
24118
24717
|
<dl>
|
|
24119
24718
|
<dd>
|
|
24120
24719
|
|
|
@@ -24126,7 +24725,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
|
24126
24725
|
<dl>
|
|
24127
24726
|
<dd>
|
|
24128
24727
|
|
|
24129
|
-
Retrieves an expanded order with optional related data for
|
|
24728
|
+
Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
24130
24729
|
|
|
24131
24730
|
</dd>
|
|
24132
24731
|
</dl>
|
|
@@ -24142,7 +24741,7 @@ Retrieves an expanded order with optional related data for coordinator operators
|
|
|
24142
24741
|
<dd>
|
|
24143
24742
|
|
|
24144
24743
|
```typescript
|
|
24145
|
-
await client.shipping.orders.expanded.
|
|
24744
|
+
await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
|
|
24146
24745
|
```
|
|
24147
24746
|
|
|
24148
24747
|
</dd>
|
|
@@ -24185,7 +24784,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
24185
24784
|
</dl>
|
|
24186
24785
|
</details>
|
|
24187
24786
|
|
|
24188
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">
|
|
24787
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forCoordinatorOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpanded</code></summary>
|
|
24189
24788
|
<dl>
|
|
24190
24789
|
<dd>
|
|
24191
24790
|
|
|
@@ -24197,7 +24796,7 @@ await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {})
|
|
|
24197
24796
|
<dl>
|
|
24198
24797
|
<dd>
|
|
24199
24798
|
|
|
24200
|
-
|
|
24799
|
+
Retrieves an expanded order with optional related data for coordinator operators (the provider org coordinating the order). | authz_personas=[coordinator_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
24201
24800
|
|
|
24202
24801
|
</dd>
|
|
24203
24802
|
</dl>
|
|
@@ -24213,29 +24812,7 @@ Lists expanded orders where the caller's provider org is the coordinator. Filter
|
|
|
24213
24812
|
<dd>
|
|
24214
24813
|
|
|
24215
24814
|
```typescript
|
|
24216
|
-
await client.shipping.orders.expanded.
|
|
24217
|
-
sort_by: "draft_started_at_timestamp",
|
|
24218
|
-
sort_order: "asc",
|
|
24219
|
-
page: 1,
|
|
24220
|
-
page_size: 1,
|
|
24221
|
-
search: "search",
|
|
24222
|
-
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24223
|
-
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24224
|
-
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24225
|
-
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24226
|
-
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24227
|
-
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24228
|
-
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24229
|
-
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24230
|
-
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24231
|
-
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24232
|
-
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24233
|
-
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24234
|
-
filter_executor_org_id: "filter_executor_org_id",
|
|
24235
|
-
filter_shipper_org_id: "filter_shipper_org_id",
|
|
24236
|
-
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|
|
24237
|
-
body: {},
|
|
24238
|
-
});
|
|
24815
|
+
await client.shipping.orders.expanded.forCoordinatorOperatorsV1("order_ref", {});
|
|
24239
24816
|
```
|
|
24240
24817
|
|
|
24241
24818
|
</dd>
|
|
@@ -24251,7 +24828,15 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
24251
24828
|
<dl>
|
|
24252
24829
|
<dd>
|
|
24253
24830
|
|
|
24254
|
-
**
|
|
24831
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
24832
|
+
|
|
24833
|
+
</dd>
|
|
24834
|
+
</dl>
|
|
24835
|
+
|
|
24836
|
+
<dl>
|
|
24837
|
+
<dd>
|
|
24838
|
+
|
|
24839
|
+
**request:** `Chrt.OrderAndTaskGroupExpandedReq`
|
|
24255
24840
|
|
|
24256
24841
|
</dd>
|
|
24257
24842
|
</dl>
|
|
@@ -24270,7 +24855,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
24270
24855
|
</dl>
|
|
24271
24856
|
</details>
|
|
24272
24857
|
|
|
24273
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">
|
|
24858
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">listForCoordinatorOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
24274
24859
|
<dl>
|
|
24275
24860
|
<dd>
|
|
24276
24861
|
|
|
@@ -24282,7 +24867,7 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
24282
24867
|
<dl>
|
|
24283
24868
|
<dd>
|
|
24284
24869
|
|
|
24285
|
-
Lists expanded orders
|
|
24870
|
+
Lists expanded orders where the caller's provider org is the coordinator. Filtering, sorting, pagination, optional search. | authz: allowed_org_types=[provider], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
24286
24871
|
|
|
24287
24872
|
</dd>
|
|
24288
24873
|
</dl>
|
|
@@ -24298,7 +24883,7 @@ Lists expanded orders for shipper operators with filtering, sorting, pagination,
|
|
|
24298
24883
|
<dd>
|
|
24299
24884
|
|
|
24300
24885
|
```typescript
|
|
24301
|
-
await client.shipping.orders.expanded.
|
|
24886
|
+
await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
24302
24887
|
sort_by: "draft_started_at_timestamp",
|
|
24303
24888
|
sort_order: "asc",
|
|
24304
24889
|
page: 1,
|
|
@@ -24317,7 +24902,8 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
24317
24902
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24318
24903
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24319
24904
|
filter_executor_org_id: "filter_executor_org_id",
|
|
24320
|
-
|
|
24905
|
+
filter_shipper_org_id: "filter_shipper_org_id",
|
|
24906
|
+
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|
|
24321
24907
|
body: {},
|
|
24322
24908
|
});
|
|
24323
24909
|
```
|
|
@@ -24335,7 +24921,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
24335
24921
|
<dl>
|
|
24336
24922
|
<dd>
|
|
24337
24923
|
|
|
24338
|
-
**request:** `Chrt.shipping.orders.
|
|
24924
|
+
**request:** `Chrt.shipping.orders.ExpandedListForCoordinatorOperatorsV1Request`
|
|
24339
24925
|
|
|
24340
24926
|
</dd>
|
|
24341
24927
|
</dl>
|
|
@@ -24354,7 +24940,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
24354
24940
|
</dl>
|
|
24355
24941
|
</details>
|
|
24356
24942
|
|
|
24357
|
-
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">
|
|
24943
|
+
<details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">listForShipperOperatorsV1</a>({ ...params }) -> Chrt.OrdersExpandedListRes</code></summary>
|
|
24358
24944
|
<dl>
|
|
24359
24945
|
<dd>
|
|
24360
24946
|
|
|
@@ -24366,7 +24952,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
24366
24952
|
<dl>
|
|
24367
24953
|
<dd>
|
|
24368
24954
|
|
|
24369
|
-
|
|
24955
|
+
Lists expanded orders for shipper operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[shipper], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
|
|
24370
24956
|
|
|
24371
24957
|
</dd>
|
|
24372
24958
|
</dl>
|
|
@@ -24382,9 +24968,27 @@ Returns distinct short_id and off_chrt_reference_id values matching the query vi
|
|
|
24382
24968
|
<dd>
|
|
24383
24969
|
|
|
24384
24970
|
```typescript
|
|
24385
|
-
await client.shipping.orders.expanded.
|
|
24386
|
-
|
|
24387
|
-
|
|
24971
|
+
await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
24972
|
+
sort_by: "draft_started_at_timestamp",
|
|
24973
|
+
sort_order: "asc",
|
|
24974
|
+
page: 1,
|
|
24975
|
+
page_size: 1,
|
|
24976
|
+
search: "search",
|
|
24977
|
+
filter_draft_started_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24978
|
+
filter_draft_started_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24979
|
+
filter_staged_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24980
|
+
filter_staged_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24981
|
+
filter_in_progress_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24982
|
+
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24983
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24984
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24985
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24986
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24987
|
+
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24988
|
+
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24989
|
+
filter_executor_org_id: "filter_executor_org_id",
|
|
24990
|
+
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
24991
|
+
body: {},
|
|
24388
24992
|
});
|
|
24389
24993
|
```
|
|
24390
24994
|
|
|
@@ -24401,7 +25005,7 @@ await client.shipping.orders.expanded.typeaheadV1({
|
|
|
24401
25005
|
<dl>
|
|
24402
25006
|
<dd>
|
|
24403
25007
|
|
|
24404
|
-
**request:** `Chrt.shipping.orders.
|
|
25008
|
+
**request:** `Chrt.shipping.orders.ExpandedListForShipperOperatorsV1Request`
|
|
24405
25009
|
|
|
24406
25010
|
</dd>
|
|
24407
25011
|
</dl>
|
|
@@ -25770,72 +26374,6 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
25770
26374
|
</dl>
|
|
25771
26375
|
</details>
|
|
25772
26376
|
|
|
25773
|
-
<details><summary><code>client.shipping.taskGroups.expanded.<a href="/src/api/resources/shipping/resources/taskGroups/resources/expanded/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.TaskGroupTypeaheadResult[]</code></summary>
|
|
25774
|
-
<dl>
|
|
25775
|
-
<dd>
|
|
25776
|
-
|
|
25777
|
-
#### 📝 Description
|
|
25778
|
-
|
|
25779
|
-
<dl>
|
|
25780
|
-
<dd>
|
|
25781
|
-
|
|
25782
|
-
<dl>
|
|
25783
|
-
<dd>
|
|
25784
|
-
|
|
25785
|
-
Returns distinct order_short_id and order_off_chrt_reference_id values matching the query via case-insensitive regex. Searches non-draft task groups where the caller's provider org is the executor. | authz: allowed_org_types=[provider], min_org_role=driver | () -> (list[TaskGroupTypeaheadResult])
|
|
25786
|
-
|
|
25787
|
-
</dd>
|
|
25788
|
-
</dl>
|
|
25789
|
-
</dd>
|
|
25790
|
-
</dl>
|
|
25791
|
-
|
|
25792
|
-
#### 🔌 Usage
|
|
25793
|
-
|
|
25794
|
-
<dl>
|
|
25795
|
-
<dd>
|
|
25796
|
-
|
|
25797
|
-
<dl>
|
|
25798
|
-
<dd>
|
|
25799
|
-
|
|
25800
|
-
```typescript
|
|
25801
|
-
await client.shipping.taskGroups.expanded.typeaheadV1({
|
|
25802
|
-
query: "query",
|
|
25803
|
-
limit: 1,
|
|
25804
|
-
});
|
|
25805
|
-
```
|
|
25806
|
-
|
|
25807
|
-
</dd>
|
|
25808
|
-
</dl>
|
|
25809
|
-
</dd>
|
|
25810
|
-
</dl>
|
|
25811
|
-
|
|
25812
|
-
#### ⚙️ Parameters
|
|
25813
|
-
|
|
25814
|
-
<dl>
|
|
25815
|
-
<dd>
|
|
25816
|
-
|
|
25817
|
-
<dl>
|
|
25818
|
-
<dd>
|
|
25819
|
-
|
|
25820
|
-
**request:** `Chrt.shipping.taskGroups.ExpandedTypeaheadV1Request`
|
|
25821
|
-
|
|
25822
|
-
</dd>
|
|
25823
|
-
</dl>
|
|
25824
|
-
|
|
25825
|
-
<dl>
|
|
25826
|
-
<dd>
|
|
25827
|
-
|
|
25828
|
-
**requestOptions:** `Expanded.RequestOptions`
|
|
25829
|
-
|
|
25830
|
-
</dd>
|
|
25831
|
-
</dl>
|
|
25832
|
-
</dd>
|
|
25833
|
-
</dl>
|
|
25834
|
-
|
|
25835
|
-
</dd>
|
|
25836
|
-
</dl>
|
|
25837
|
-
</details>
|
|
25838
|
-
|
|
25839
26377
|
## Shipping Tasks ExecutorOrgNotes
|
|
25840
26378
|
|
|
25841
26379
|
<details><summary><code>client.shipping.tasks.executorOrgNotes.<a href="/src/api/resources/shipping/resources/tasks/resources/executorOrgNotes/client/Client.ts">addV1</a>(taskId, { ...params }) -> boolean</code></summary>
|