@chrt-inc/typescript-sdk 1.719.0 → 1.726.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/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/operations/client/Client.js +10 -5
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +5 -125
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +17 -494
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.ts +3 -8
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/index.d.ts +0 -4
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/Client.d.ts +76 -0
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/Client.js +246 -0
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.d.ts +19 -0
- package/dist/cjs/api/resources/operations/resources/departmentRoutingRules/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +1 -1
- package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentClientCreate1.d.ts +1 -1
- package/dist/cjs/api/resources/operations/resources/index.d.ts +4 -2
- package/dist/cjs/api/resources/operations/resources/index.js +5 -3
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/Client.d.ts +181 -0
- package/dist/cjs/api/resources/operations/resources/{checklists → operationsTaskLists}/client/Client.js +206 -75
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistClientCreate1.d.ts → operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.ts} +3 -2
- package/dist/{esm/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.d.mts → cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientUpdate1.d.ts} +2 -1
- package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksAdd1.d.ts → operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.d.ts} +2 -2
- package/dist/cjs/api/resources/{orgs/resources/connections/client/requests/SetDepartmentReq.d.ts → operations/resources/operationsTaskLists/client/requests/OperationsTaskListEntriesRemove1.d.ts} +2 -2
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistsListV1Request.d.ts → operationsTaskLists/client/requests/OperationsTaskListsListV1Request.d.ts} +2 -2
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.ts +6 -0
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/operationsTaskLists/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +23 -5
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +108 -14
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.d.ts +7 -2
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.d.ts +4 -0
- package/dist/cjs/api/resources/operations/resources/{cases/client/requests/CaseStatusReq.d.ts → operationsTasks/client/requests/OperationsTaskStatusReq.d.ts} +3 -3
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +15 -6
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +0 -14
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +0 -63
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtProviderOrg/client/requests/OffChrtProviderOrgClientCreate1.d.ts +0 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtProviderOrg/client/requests/OffChrtProviderOrgClientUpdate1.d.ts +0 -2
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgClientCreate1.d.ts +0 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgClientUpdate1.d.ts +0 -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/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/Client.js +64 -0
- package/dist/cjs/api/resources/{operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.ts → shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.d.ts} +3 -3
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +1 -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/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/OrderDraftUpdateDriverReq.d.ts +13 -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/{operations/resources/cases/client/requests/CaseNeedsActionReq.d.ts → shipping/resources/orders/client/requests/OrdersCancelManyReq.d.ts} +3 -3
- 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/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/AiImageDescription.d.ts +1 -1
- package/dist/cjs/api/types/{AnalyticsTimeBucketResponse.d.ts → AnalyticsTimeBucketRes.d.ts} +1 -1
- 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/Case1.d.ts +1 -12
- package/dist/cjs/api/types/CaseSortByEnum.d.ts +1 -2
- package/dist/cjs/api/types/CaseSortByEnum.js +0 -1
- package/dist/cjs/api/types/Department1.d.ts +1 -0
- package/dist/cjs/api/types/DepartmentRoutingRule1.d.ts +16 -0
- package/dist/cjs/api/types/DepartmentTypeEnum.d.ts +10 -10
- package/dist/cjs/api/types/DepartmentTypeEnum.js +9 -9
- package/dist/cjs/api/types/DriverStatsRes.d.ts +11 -0
- package/dist/cjs/api/types/OffChrtProviderOrg1.d.ts +0 -1
- package/dist/cjs/api/types/OffChrtShipperOrg1.d.ts +0 -1
- package/dist/cjs/api/types/OperationsTask1.d.ts +7 -2
- package/dist/cjs/api/types/{Checklist1.d.ts → OperationsTaskList1.d.ts} +3 -2
- package/dist/cjs/api/types/OperationsTaskListEntry1.d.ts +23 -0
- package/dist/cjs/api/types/{ChecklistListRes.d.ts → OperationsTaskListListRes.d.ts} +2 -2
- package/dist/cjs/api/types/OperationsTaskListListRes.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListRemoveFromCaseRes1.d.ts +13 -0
- package/dist/cjs/api/types/OperationsTaskListRemoveFromCaseRes1.js +5 -0
- package/dist/{esm/api/types/ChecklistSortByEnum.d.mts → cjs/api/types/OperationsTaskListSortByEnum.d.ts} +2 -2
- package/dist/cjs/api/types/{ChecklistSortByEnum.js → OperationsTaskListSortByEnum.js} +2 -2
- package/dist/cjs/api/types/OperationsTaskStatusEnum.d.ts +17 -0
- package/dist/cjs/api/types/{CheckStatusEnum.js → OperationsTaskStatusEnum.js} +4 -7
- package/dist/cjs/api/types/OperationsTaskTypeEnum.d.ts +23 -0
- package/dist/cjs/api/types/OperationsTaskTypeEnum.js +20 -0
- 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/ProviderProviderConnection1.d.ts +0 -1
- package/dist/cjs/api/types/RoutingCounterpartyTypeEnum.d.ts +8 -0
- package/dist/cjs/api/types/RoutingCounterpartyTypeEnum.js +10 -0
- package/dist/cjs/api/types/ShipperProviderConnection1.d.ts +0 -1
- 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 +11 -12
- package/dist/cjs/api/types/index.js +11 -12
- 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/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/operations/client/Client.mjs +8 -3
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +5 -125
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +17 -494
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CasesListV1Request.d.mts +3 -8
- package/dist/esm/api/resources/operations/resources/cases/client/requests/index.d.mts +0 -4
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/Client.d.mts +76 -0
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/Client.mjs +209 -0
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.d.mts +19 -0
- package/dist/esm/api/resources/operations/resources/departmentRoutingRules/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +1 -1
- package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentClientCreate1.d.mts +1 -1
- package/dist/esm/api/resources/operations/resources/index.d.mts +4 -2
- package/dist/esm/api/resources/operations/resources/index.mjs +4 -2
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/Client.d.mts +181 -0
- package/dist/esm/api/resources/operations/resources/{checklists → operationsTaskLists}/client/Client.mjs +204 -73
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistClientCreate1.d.mts → operationsTaskLists/client/requests/OperationsTaskListClientCreate1.d.mts} +3 -2
- package/dist/{cjs/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.d.ts → esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListClientUpdate1.d.mts} +2 -1
- package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksAdd1.d.mts → operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.d.mts} +2 -2
- package/dist/esm/api/resources/{orgs/resources/connections/client/requests/SetDepartmentReq.d.mts → operations/resources/operationsTaskLists/client/requests/OperationsTaskListEntriesRemove1.d.mts} +2 -2
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistsListV1Request.d.mts → operationsTaskLists/client/requests/OperationsTaskListsListV1Request.d.mts} +2 -2
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/index.d.mts +6 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTaskLists/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +23 -5
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +108 -14
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.d.mts +7 -2
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.d.mts +4 -0
- package/dist/esm/api/resources/operations/resources/{cases/client/requests/CaseStatusReq.d.mts → operationsTasks/client/requests/OperationsTaskStatusReq.d.mts} +3 -3
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +15 -6
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +0 -14
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +0 -63
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/orgs/resources/offChrtProviderOrg/client/requests/OffChrtProviderOrgClientCreate1.d.mts +0 -1
- package/dist/esm/api/resources/orgs/resources/offChrtProviderOrg/client/requests/OffChrtProviderOrgClientUpdate1.d.mts +0 -2
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgClientCreate1.d.mts +0 -1
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgClientUpdate1.d.mts +0 -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/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/Client.mjs +64 -0
- package/dist/esm/api/resources/{operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.mts → shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.d.mts} +3 -3
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +1 -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/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/OrderDraftUpdateDriverReq.d.mts +13 -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/{operations/resources/cases/client/requests/CaseNeedsActionReq.d.mts → shipping/resources/orders/client/requests/OrdersCancelManyReq.d.mts} +3 -3
- 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/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/AiImageDescription.d.mts +1 -1
- package/dist/esm/api/types/{AnalyticsTimeBucketResponse.d.mts → AnalyticsTimeBucketRes.d.mts} +1 -1
- 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/Case1.d.mts +1 -12
- package/dist/esm/api/types/CaseSortByEnum.d.mts +1 -2
- package/dist/esm/api/types/CaseSortByEnum.mjs +0 -1
- package/dist/esm/api/types/Department1.d.mts +1 -0
- package/dist/esm/api/types/DepartmentRoutingRule1.d.mts +16 -0
- package/dist/esm/api/types/DepartmentTypeEnum.d.mts +10 -10
- package/dist/esm/api/types/DepartmentTypeEnum.mjs +9 -9
- package/dist/esm/api/types/DriverStatsRes.d.mts +11 -0
- package/dist/esm/api/types/OffChrtProviderOrg1.d.mts +0 -1
- package/dist/esm/api/types/OffChrtShipperOrg1.d.mts +0 -1
- package/dist/esm/api/types/OperationsTask1.d.mts +7 -2
- package/dist/esm/api/types/{Checklist1.d.mts → OperationsTaskList1.d.mts} +3 -2
- package/dist/esm/api/types/OperationsTaskListEntry1.d.mts +23 -0
- package/dist/esm/api/types/{ChecklistListRes.d.mts → OperationsTaskListListRes.d.mts} +2 -2
- package/dist/esm/api/types/OperationsTaskListListRes.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListRemoveFromCaseRes1.d.mts +13 -0
- package/dist/esm/api/types/OperationsTaskListRemoveFromCaseRes1.mjs +4 -0
- package/dist/{cjs/api/types/ChecklistSortByEnum.d.ts → esm/api/types/OperationsTaskListSortByEnum.d.mts} +2 -2
- package/dist/esm/api/types/{ChecklistSortByEnum.mjs → OperationsTaskListSortByEnum.mjs} +1 -1
- package/dist/esm/api/types/OperationsTaskStatusEnum.d.mts +17 -0
- package/dist/esm/api/types/OperationsTaskStatusEnum.mjs +9 -0
- package/dist/esm/api/types/OperationsTaskTypeEnum.d.mts +23 -0
- package/dist/esm/api/types/OperationsTaskTypeEnum.mjs +17 -0
- 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/ProviderProviderConnection1.d.mts +0 -1
- package/dist/esm/api/types/RoutingCounterpartyTypeEnum.d.mts +8 -0
- package/dist/esm/api/types/RoutingCounterpartyTypeEnum.mjs +7 -0
- package/dist/esm/api/types/ShipperProviderConnection1.d.mts +0 -1
- 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 +11 -12
- package/dist/esm/api/types/index.mjs +11 -12
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +816 -516
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.ts +0 -15
- package/dist/cjs/api/resources/operations/resources/checklists/client/Client.d.ts +0 -150
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.d.ts +0 -11
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/index.d.ts +0 -5
- package/dist/cjs/api/types/CaseChecksDisableReq.d.ts +0 -7
- package/dist/cjs/api/types/CaseChecksDismissReq.d.ts +0 -8
- package/dist/cjs/api/types/CaseChecksSummary1.d.ts +0 -27
- package/dist/cjs/api/types/CaseStatusEnum.d.ts +0 -9
- package/dist/cjs/api/types/CaseStatusEnum.js +0 -11
- package/dist/cjs/api/types/Check1.d.ts +0 -33
- package/dist/cjs/api/types/CheckEnum.d.ts +0 -46
- package/dist/cjs/api/types/CheckEnum.js +0 -23
- package/dist/cjs/api/types/CheckStatusEnum.d.ts +0 -32
- package/dist/cjs/api/types/ChecklistCheck1.d.ts +0 -15
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.mts +0 -15
- package/dist/esm/api/resources/operations/resources/checklists/client/Client.d.mts +0 -150
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.d.mts +0 -11
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/index.d.mts +0 -5
- package/dist/esm/api/types/CaseChecksDisableReq.d.mts +0 -7
- package/dist/esm/api/types/CaseChecksDismissReq.d.mts +0 -8
- package/dist/esm/api/types/CaseChecksSummary1.d.mts +0 -27
- package/dist/esm/api/types/CaseStatusEnum.d.mts +0 -9
- package/dist/esm/api/types/CaseStatusEnum.mjs +0 -8
- package/dist/esm/api/types/Check1.d.mts +0 -33
- package/dist/esm/api/types/CheckEnum.d.mts +0 -46
- package/dist/esm/api/types/CheckEnum.mjs +0 -20
- package/dist/esm/api/types/CheckStatusEnum.d.mts +0 -32
- package/dist/esm/api/types/CheckStatusEnum.mjs +0 -12
- package/dist/esm/api/types/ChecklistCheck1.d.mts +0 -15
- /package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/{AnalyticsTimePeriodRequest.js → AnalyticsTimePeriodReq.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists → departmentRoutingRules}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists → departmentRoutingRules}/client/index.js +0 -0
- /package/dist/cjs/api/resources/operations/resources/{cases/client/requests/CaseChecksApplyChecklistReq.js → departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists → departmentRoutingRules}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists → departmentRoutingRules}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists → departmentRoutingRules}/index.js +0 -0
- /package/dist/cjs/api/resources/operations/resources/{cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.js → operationsTaskLists/client/requests/OperationsTaskListClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{cases/client/requests/CaseNeedsActionReq.js → operationsTaskLists/client/requests/OperationsTaskListClientUpdate1.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{cases/client/requests/CaseStatusReq.js → operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksAdd1.js → operationsTaskLists/client/requests/OperationsTaskListEntriesRemove1.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksRemove1.js → operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistClientCreate1.js → operationsTaskLists/client/requests/OperationsTaskListsListV1Request.js} +0 -0
- /package/dist/cjs/api/resources/operations/resources/{checklists/client/requests/ChecklistClientUpdate1.js → operationsTasks/client/requests/OperationsTaskStatusReq.js} +0 -0
- /package/dist/cjs/api/resources/{operations/resources/checklists/client/requests/ChecklistsListV1Request.js → shipping/resources/drivers/client/requests/DriverStatsReq.js} +0 -0
- /package/dist/cjs/api/resources/{orgs/resources/connections/client/requests/SetDepartmentReq.js → shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.js} +0 -0
- /package/dist/cjs/api/{types/AnalyticsTimeBucketResponse.js → resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.js} +0 -0
- /package/dist/cjs/api/{types/CaseChecksDisableReq.js → resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.js} +0 -0
- /package/dist/cjs/api/{types/CaseChecksDismissReq.js → resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.js} +0 -0
- /package/dist/cjs/api/types/{CaseChecksSummary1.js → AnalyticsTimeBucketRes.js} +0 -0
- /package/dist/cjs/api/types/{Check1.js → DepartmentRoutingRule1.js} +0 -0
- /package/dist/cjs/api/types/{Checklist1.js → DriverStatsRes.js} +0 -0
- /package/dist/cjs/api/types/{ChecklistCheck1.js → OperationsTaskList1.js} +0 -0
- /package/dist/cjs/api/types/{ChecklistListRes.js → OperationsTaskListEntry1.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/{checklists → departmentRoutingRules}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists → departmentRoutingRules}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/operations/resources/{cases/client/requests/CaseChecksApplyChecklistReq.mjs → departmentRoutingRules/client/requests/DepartmentRoutingRuleClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists → departmentRoutingRules}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists → departmentRoutingRules}/index.d.mts +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists → departmentRoutingRules}/index.mjs +0 -0
- /package/dist/esm/api/resources/operations/resources/{cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.mjs → operationsTaskLists/client/requests/OperationsTaskListClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{cases/client/requests/CaseNeedsActionReq.mjs → operationsTaskLists/client/requests/OperationsTaskListClientUpdate1.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{cases/client/requests/CaseStatusReq.mjs → operationsTaskLists/client/requests/OperationsTaskListEntriesAdd1.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksAdd1.mjs → operationsTaskLists/client/requests/OperationsTaskListEntriesRemove1.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistChecksRemove1.mjs → operationsTaskLists/client/requests/OperationsTaskListsApplyToCaseV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistClientCreate1.mjs → operationsTaskLists/client/requests/OperationsTaskListsListV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/operations/resources/{checklists/client/requests/ChecklistClientUpdate1.mjs → operationsTasks/client/requests/OperationsTaskStatusReq.mjs} +0 -0
- /package/dist/esm/api/resources/{operations/resources/checklists/client/requests/ChecklistsListV1Request.mjs → shipping/resources/drivers/client/requests/DriverStatsReq.mjs} +0 -0
- /package/dist/esm/api/resources/{orgs/resources/connections/client/requests/SetDepartmentReq.mjs → shipping/resources/orderDrafts/client/requests/OrdersDraftDeleteManyReq.mjs} +0 -0
- /package/dist/esm/api/{types/AnalyticsTimeBucketResponse.mjs → resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftAddExecutorReq.mjs} +0 -0
- /package/dist/esm/api/{types/CaseChecksDisableReq.mjs → resources/shipping/resources/orderDrafts/resources/taskGroup/client/requests/OrderDraftUpdateDriverReq.mjs} +0 -0
- /package/dist/esm/api/{types/CaseChecksDismissReq.mjs → resources/shipping/resources/orders/client/requests/OrdersCancelManyReq.mjs} +0 -0
- /package/dist/esm/api/types/{CaseChecksSummary1.mjs → AnalyticsTimeBucketRes.mjs} +0 -0
- /package/dist/esm/api/types/{Check1.mjs → DepartmentRoutingRule1.mjs} +0 -0
- /package/dist/esm/api/types/{Checklist1.mjs → DriverStatsRes.mjs} +0 -0
- /package/dist/esm/api/types/{ChecklistCheck1.mjs → OperationsTaskList1.mjs} +0 -0
- /package/dist/esm/api/types/{ChecklistListRes.mjs → OperationsTaskListEntry1.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>
|
|
@@ -10762,82 +10762,7 @@ await client.notifications.webhookSetup.turnOffV1();
|
|
|
10762
10762
|
|
|
10763
10763
|
## Operations Cases
|
|
10764
10764
|
|
|
10765
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10766
|
-
<dl>
|
|
10767
|
-
<dd>
|
|
10768
|
-
|
|
10769
|
-
#### 📝 Description
|
|
10770
|
-
|
|
10771
|
-
<dl>
|
|
10772
|
-
<dd>
|
|
10773
|
-
|
|
10774
|
-
<dl>
|
|
10775
|
-
<dd>
|
|
10776
|
-
|
|
10777
|
-
Records image-analysis workflow results onto every participating org's Case for the order. Walks task_artifact -> task -> order, authorizes the caller against the shipping graph, then fans out to all Cases keyed on `order_id` — upserting one Check1 per surviving result keyed by (check, task_artifact_id) on each Case whose effective check set (`enabled - disabled`) includes it. Silently drops results for checks not in the image-uploaded event family, results for checks not in a given Case's effective set, and results whose existing row on that Case is DISMISSED. Returns True if any Case was updated. Intended to be called by the shipping_task_image_analysis Temporal workflow via an internal delegation JWT. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | (CaseChecksRecordImageAnalysisResultsReq) -> (bool)
|
|
10778
|
-
|
|
10779
|
-
</dd>
|
|
10780
|
-
</dl>
|
|
10781
|
-
</dd>
|
|
10782
|
-
</dl>
|
|
10783
|
-
|
|
10784
|
-
#### 🔌 Usage
|
|
10785
|
-
|
|
10786
|
-
<dl>
|
|
10787
|
-
<dd>
|
|
10788
|
-
|
|
10789
|
-
<dl>
|
|
10790
|
-
<dd>
|
|
10791
|
-
|
|
10792
|
-
```typescript
|
|
10793
|
-
await client.operations.cases.recordImageAnalysisResultsV1("task_artifact_id", {
|
|
10794
|
-
results: {
|
|
10795
|
-
key: "not_started",
|
|
10796
|
-
},
|
|
10797
|
-
});
|
|
10798
|
-
```
|
|
10799
|
-
|
|
10800
|
-
</dd>
|
|
10801
|
-
</dl>
|
|
10802
|
-
</dd>
|
|
10803
|
-
</dl>
|
|
10804
|
-
|
|
10805
|
-
#### ⚙️ Parameters
|
|
10806
|
-
|
|
10807
|
-
<dl>
|
|
10808
|
-
<dd>
|
|
10809
|
-
|
|
10810
|
-
<dl>
|
|
10811
|
-
<dd>
|
|
10812
|
-
|
|
10813
|
-
**taskArtifactId:** `string`
|
|
10814
|
-
|
|
10815
|
-
</dd>
|
|
10816
|
-
</dl>
|
|
10817
|
-
|
|
10818
|
-
<dl>
|
|
10819
|
-
<dd>
|
|
10820
|
-
|
|
10821
|
-
**request:** `Chrt.operations.CaseChecksRecordImageAnalysisResultsReq`
|
|
10822
|
-
|
|
10823
|
-
</dd>
|
|
10824
|
-
</dl>
|
|
10825
|
-
|
|
10826
|
-
<dl>
|
|
10827
|
-
<dd>
|
|
10828
|
-
|
|
10829
|
-
**requestOptions:** `Cases.RequestOptions`
|
|
10830
|
-
|
|
10831
|
-
</dd>
|
|
10832
|
-
</dl>
|
|
10833
|
-
</dd>
|
|
10834
|
-
</dl>
|
|
10835
|
-
|
|
10836
|
-
</dd>
|
|
10837
|
-
</dl>
|
|
10838
|
-
</details>
|
|
10839
|
-
|
|
10840
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">applyChecklistV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
10765
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CaseListRes</code></summary>
|
|
10841
10766
|
<dl>
|
|
10842
10767
|
<dd>
|
|
10843
10768
|
|
|
@@ -10849,7 +10774,7 @@ await client.operations.cases.recordImageAnalysisResultsV1("task_artifact_id", {
|
|
|
10849
10774
|
<dl>
|
|
10850
10775
|
<dd>
|
|
10851
10776
|
|
|
10852
|
-
|
|
10777
|
+
Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
|
|
10853
10778
|
|
|
10854
10779
|
</dd>
|
|
10855
10780
|
</dl>
|
|
@@ -10865,8 +10790,13 @@ Adds the Checklist's checks to the Case's enabled_check_keys (deduped) and recor
|
|
|
10865
10790
|
<dd>
|
|
10866
10791
|
|
|
10867
10792
|
```typescript
|
|
10868
|
-
await client.operations.cases.
|
|
10869
|
-
|
|
10793
|
+
await client.operations.cases.listV1({
|
|
10794
|
+
sort_by: "created_at",
|
|
10795
|
+
sort_order: "asc",
|
|
10796
|
+
page: 1,
|
|
10797
|
+
page_size: 1,
|
|
10798
|
+
filter_assigned_user_id: "filter_assigned_user_id",
|
|
10799
|
+
filter_unassigned: true,
|
|
10870
10800
|
});
|
|
10871
10801
|
```
|
|
10872
10802
|
|
|
@@ -10883,15 +10813,7 @@ await client.operations.cases.applyChecklistV1("case_id", {
|
|
|
10883
10813
|
<dl>
|
|
10884
10814
|
<dd>
|
|
10885
10815
|
|
|
10886
|
-
**
|
|
10887
|
-
|
|
10888
|
-
</dd>
|
|
10889
|
-
</dl>
|
|
10890
|
-
|
|
10891
|
-
<dl>
|
|
10892
|
-
<dd>
|
|
10893
|
-
|
|
10894
|
-
**request:** `Chrt.operations.CaseChecksApplyChecklistReq`
|
|
10816
|
+
**request:** `Chrt.operations.CasesListV1Request`
|
|
10895
10817
|
|
|
10896
10818
|
</dd>
|
|
10897
10819
|
</dl>
|
|
@@ -10910,7 +10832,7 @@ await client.operations.cases.applyChecklistV1("case_id", {
|
|
|
10910
10832
|
</dl>
|
|
10911
10833
|
</details>
|
|
10912
10834
|
|
|
10913
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10835
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getV1</a>(caseId) -> Chrt.Case1</code></summary>
|
|
10914
10836
|
<dl>
|
|
10915
10837
|
<dd>
|
|
10916
10838
|
|
|
@@ -10922,7 +10844,7 @@ await client.operations.cases.applyChecklistV1("case_id", {
|
|
|
10922
10844
|
<dl>
|
|
10923
10845
|
<dd>
|
|
10924
10846
|
|
|
10925
|
-
|
|
10847
|
+
Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
|
|
10926
10848
|
|
|
10927
10849
|
</dd>
|
|
10928
10850
|
</dl>
|
|
@@ -10938,9 +10860,7 @@ Adds a CheckEnum to the Case's disabled_check_keys (operator override). The Chec
|
|
|
10938
10860
|
<dd>
|
|
10939
10861
|
|
|
10940
10862
|
```typescript
|
|
10941
|
-
await client.operations.cases.
|
|
10942
|
-
check: "shipping.order.placed.order_details_reviewed",
|
|
10943
|
-
});
|
|
10863
|
+
await client.operations.cases.getV1("case_id");
|
|
10944
10864
|
```
|
|
10945
10865
|
|
|
10946
10866
|
</dd>
|
|
@@ -10964,14 +10884,6 @@ await client.operations.cases.disableCheckV1("case_id", {
|
|
|
10964
10884
|
<dl>
|
|
10965
10885
|
<dd>
|
|
10966
10886
|
|
|
10967
|
-
**request:** `Chrt.CaseChecksDisableReq`
|
|
10968
|
-
|
|
10969
|
-
</dd>
|
|
10970
|
-
</dl>
|
|
10971
|
-
|
|
10972
|
-
<dl>
|
|
10973
|
-
<dd>
|
|
10974
|
-
|
|
10975
10887
|
**requestOptions:** `Cases.RequestOptions`
|
|
10976
10888
|
|
|
10977
10889
|
</dd>
|
|
@@ -10983,7 +10895,7 @@ await client.operations.cases.disableCheckV1("case_id", {
|
|
|
10983
10895
|
</dl>
|
|
10984
10896
|
</details>
|
|
10985
10897
|
|
|
10986
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10898
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
10987
10899
|
<dl>
|
|
10988
10900
|
<dd>
|
|
10989
10901
|
|
|
@@ -10995,7 +10907,7 @@ await client.operations.cases.disableCheckV1("case_id", {
|
|
|
10995
10907
|
<dl>
|
|
10996
10908
|
<dd>
|
|
10997
10909
|
|
|
10998
|
-
|
|
10910
|
+
Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
|
|
10999
10911
|
|
|
11000
10912
|
</dd>
|
|
11001
10913
|
</dl>
|
|
@@ -11011,9 +10923,7 @@ Removes a CheckEnum from the Case's disabled_check_keys, restoring it to the wor
|
|
|
11011
10923
|
<dd>
|
|
11012
10924
|
|
|
11013
10925
|
```typescript
|
|
11014
|
-
await client.operations.cases.
|
|
11015
|
-
check: "shipping.order.placed.order_details_reviewed",
|
|
11016
|
-
});
|
|
10926
|
+
await client.operations.cases.updateV1("case_id");
|
|
11017
10927
|
```
|
|
11018
10928
|
|
|
11019
10929
|
</dd>
|
|
@@ -11037,7 +10947,7 @@ await client.operations.cases.enableCheckV1("case_id", {
|
|
|
11037
10947
|
<dl>
|
|
11038
10948
|
<dd>
|
|
11039
10949
|
|
|
11040
|
-
**request:** `Chrt.
|
|
10950
|
+
**request:** `Chrt.operations.CaseClientUpdate1`
|
|
11041
10951
|
|
|
11042
10952
|
</dd>
|
|
11043
10953
|
</dl>
|
|
@@ -11056,7 +10966,7 @@ await client.operations.cases.enableCheckV1("case_id", {
|
|
|
11056
10966
|
</dl>
|
|
11057
10967
|
</details>
|
|
11058
10968
|
|
|
11059
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10969
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderV1</a>(orderId) -> Chrt.Case1</code></summary>
|
|
11060
10970
|
<dl>
|
|
11061
10971
|
<dd>
|
|
11062
10972
|
|
|
@@ -11068,7 +10978,7 @@ await client.operations.cases.enableCheckV1("case_id", {
|
|
|
11068
10978
|
<dl>
|
|
11069
10979
|
<dd>
|
|
11070
10980
|
|
|
11071
|
-
|
|
10981
|
+
Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)
|
|
11072
10982
|
|
|
11073
10983
|
</dd>
|
|
11074
10984
|
</dl>
|
|
@@ -11084,10 +10994,7 @@ Transitions one (check, entity_id) Check1 to status=DISMISSED. Does not affect o
|
|
|
11084
10994
|
<dd>
|
|
11085
10995
|
|
|
11086
10996
|
```typescript
|
|
11087
|
-
await client.operations.cases.
|
|
11088
|
-
check: "shipping.order.placed.order_details_reviewed",
|
|
11089
|
-
entity_id: "entity_id",
|
|
11090
|
-
});
|
|
10997
|
+
await client.operations.cases.getByOrderV1("order_id");
|
|
11091
10998
|
```
|
|
11092
10999
|
|
|
11093
11000
|
</dd>
|
|
@@ -11103,15 +11010,7 @@ await client.operations.cases.dismissCheckV1("case_id", {
|
|
|
11103
11010
|
<dl>
|
|
11104
11011
|
<dd>
|
|
11105
11012
|
|
|
11106
|
-
**
|
|
11107
|
-
|
|
11108
|
-
</dd>
|
|
11109
|
-
</dl>
|
|
11110
|
-
|
|
11111
|
-
<dl>
|
|
11112
|
-
<dd>
|
|
11113
|
-
|
|
11114
|
-
**request:** `Chrt.CaseChecksDismissReq`
|
|
11013
|
+
**orderId:** `string`
|
|
11115
11014
|
|
|
11116
11015
|
</dd>
|
|
11117
11016
|
</dl>
|
|
@@ -11130,7 +11029,7 @@ await client.operations.cases.dismissCheckV1("case_id", {
|
|
|
11130
11029
|
</dl>
|
|
11131
11030
|
</details>
|
|
11132
11031
|
|
|
11133
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11032
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderRefV1</a>(orderRef) -> Chrt.Case1</code></summary>
|
|
11134
11033
|
<dl>
|
|
11135
11034
|
<dd>
|
|
11136
11035
|
|
|
@@ -11142,7 +11041,7 @@ await client.operations.cases.dismissCheckV1("case_id", {
|
|
|
11142
11041
|
<dl>
|
|
11143
11042
|
<dd>
|
|
11144
11043
|
|
|
11145
|
-
|
|
11044
|
+
Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11146
11045
|
|
|
11147
11046
|
</dd>
|
|
11148
11047
|
</dl>
|
|
@@ -11158,10 +11057,7 @@ Transitions a DISMISSED (check, entity_id) Check1 back to NOT_STARTED so the nex
|
|
|
11158
11057
|
<dd>
|
|
11159
11058
|
|
|
11160
11059
|
```typescript
|
|
11161
|
-
await client.operations.cases.
|
|
11162
|
-
check: "shipping.order.placed.order_details_reviewed",
|
|
11163
|
-
entity_id: "entity_id",
|
|
11164
|
-
});
|
|
11060
|
+
await client.operations.cases.getByOrderRefV1("order_ref");
|
|
11165
11061
|
```
|
|
11166
11062
|
|
|
11167
11063
|
</dd>
|
|
@@ -11177,15 +11073,7 @@ await client.operations.cases.undismissCheckV1("case_id", {
|
|
|
11177
11073
|
<dl>
|
|
11178
11074
|
<dd>
|
|
11179
11075
|
|
|
11180
|
-
**
|
|
11181
|
-
|
|
11182
|
-
</dd>
|
|
11183
|
-
</dl>
|
|
11184
|
-
|
|
11185
|
-
<dl>
|
|
11186
|
-
<dd>
|
|
11187
|
-
|
|
11188
|
-
**request:** `Chrt.CaseChecksDismissReq`
|
|
11076
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
11189
11077
|
|
|
11190
11078
|
</dd>
|
|
11191
11079
|
</dl>
|
|
@@ -11204,7 +11092,7 @@ await client.operations.cases.undismissCheckV1("case_id", {
|
|
|
11204
11092
|
</dl>
|
|
11205
11093
|
</details>
|
|
11206
11094
|
|
|
11207
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11095
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderShortIdV1</a>(orderShortId) -> Chrt.Case1</code></summary>
|
|
11208
11096
|
<dl>
|
|
11209
11097
|
<dd>
|
|
11210
11098
|
|
|
@@ -11216,7 +11104,7 @@ await client.operations.cases.undismissCheckV1("case_id", {
|
|
|
11216
11104
|
<dl>
|
|
11217
11105
|
<dd>
|
|
11218
11106
|
|
|
11219
|
-
|
|
11107
|
+
Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11220
11108
|
|
|
11221
11109
|
</dd>
|
|
11222
11110
|
</dl>
|
|
@@ -11232,15 +11120,7 @@ Lists cases for the caller's organization with filtering, sorting, and paginatio
|
|
|
11232
11120
|
<dd>
|
|
11233
11121
|
|
|
11234
11122
|
```typescript
|
|
11235
|
-
await client.operations.cases.
|
|
11236
|
-
sort_by: "created_at",
|
|
11237
|
-
sort_order: "asc",
|
|
11238
|
-
page: 1,
|
|
11239
|
-
page_size: 1,
|
|
11240
|
-
filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
|
|
11241
|
-
filter_needs_action: true,
|
|
11242
|
-
filter_unassigned: true,
|
|
11243
|
-
});
|
|
11123
|
+
await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
11244
11124
|
```
|
|
11245
11125
|
|
|
11246
11126
|
</dd>
|
|
@@ -11256,7 +11136,7 @@ await client.operations.cases.listV1({
|
|
|
11256
11136
|
<dl>
|
|
11257
11137
|
<dd>
|
|
11258
11138
|
|
|
11259
|
-
**
|
|
11139
|
+
**orderShortId:** `string`
|
|
11260
11140
|
|
|
11261
11141
|
</dd>
|
|
11262
11142
|
</dl>
|
|
@@ -11275,7 +11155,7 @@ await client.operations.cases.listV1({
|
|
|
11275
11155
|
</dl>
|
|
11276
11156
|
</details>
|
|
11277
11157
|
|
|
11278
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11158
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getSuggestedDepartmentV1</a>(caseId) -> (string | null) | undefined</code></summary>
|
|
11279
11159
|
<dl>
|
|
11280
11160
|
<dd>
|
|
11281
11161
|
|
|
@@ -11287,7 +11167,7 @@ await client.operations.cases.listV1({
|
|
|
11287
11167
|
<dl>
|
|
11288
11168
|
<dd>
|
|
11289
11169
|
|
|
11290
|
-
|
|
11170
|
+
Returns the department this case's order would map to from the shipper connection — a non-binding default for the UI. Department is never auto-applied; the frontend applies it explicitly via the update route. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
|
|
11291
11171
|
|
|
11292
11172
|
</dd>
|
|
11293
11173
|
</dl>
|
|
@@ -11303,7 +11183,7 @@ Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
|
|
|
11303
11183
|
<dd>
|
|
11304
11184
|
|
|
11305
11185
|
```typescript
|
|
11306
|
-
await client.operations.cases.
|
|
11186
|
+
await client.operations.cases.getSuggestedDepartmentV1("case_id");
|
|
11307
11187
|
```
|
|
11308
11188
|
|
|
11309
11189
|
</dd>
|
|
@@ -11338,7 +11218,7 @@ await client.operations.cases.getV1("case_id");
|
|
|
11338
11218
|
</dl>
|
|
11339
11219
|
</details>
|
|
11340
11220
|
|
|
11341
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11221
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">assignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11342
11222
|
<dl>
|
|
11343
11223
|
<dd>
|
|
11344
11224
|
|
|
@@ -11350,7 +11230,7 @@ await client.operations.cases.getV1("case_id");
|
|
|
11350
11230
|
<dl>
|
|
11351
11231
|
<dd>
|
|
11352
11232
|
|
|
11353
|
-
|
|
11233
|
+
Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
|
|
11354
11234
|
|
|
11355
11235
|
</dd>
|
|
11356
11236
|
</dl>
|
|
@@ -11366,7 +11246,9 @@ Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpda
|
|
|
11366
11246
|
<dd>
|
|
11367
11247
|
|
|
11368
11248
|
```typescript
|
|
11369
|
-
await client.operations.cases.
|
|
11249
|
+
await client.operations.cases.assignV1("case_id", {
|
|
11250
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11251
|
+
});
|
|
11370
11252
|
```
|
|
11371
11253
|
|
|
11372
11254
|
</dd>
|
|
@@ -11390,7 +11272,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
11390
11272
|
<dl>
|
|
11391
11273
|
<dd>
|
|
11392
11274
|
|
|
11393
|
-
**request:** `Chrt.operations.
|
|
11275
|
+
**request:** `Chrt.operations.CaseAssignReq`
|
|
11394
11276
|
|
|
11395
11277
|
</dd>
|
|
11396
11278
|
</dl>
|
|
@@ -11409,7 +11291,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
11409
11291
|
</dl>
|
|
11410
11292
|
</details>
|
|
11411
11293
|
|
|
11412
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11294
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">unassignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11413
11295
|
<dl>
|
|
11414
11296
|
<dd>
|
|
11415
11297
|
|
|
@@ -11421,7 +11303,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
11421
11303
|
<dl>
|
|
11422
11304
|
<dd>
|
|
11423
11305
|
|
|
11424
|
-
|
|
11306
|
+
Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
|
|
11425
11307
|
|
|
11426
11308
|
</dd>
|
|
11427
11309
|
</dl>
|
|
@@ -11437,7 +11319,9 @@ Retrieves the case for a given shipping order. | authz: min_org_role=operator |
|
|
|
11437
11319
|
<dd>
|
|
11438
11320
|
|
|
11439
11321
|
```typescript
|
|
11440
|
-
await client.operations.cases.
|
|
11322
|
+
await client.operations.cases.unassignV1("case_id", {
|
|
11323
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11324
|
+
});
|
|
11441
11325
|
```
|
|
11442
11326
|
|
|
11443
11327
|
</dd>
|
|
@@ -11453,70 +11337,15 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11453
11337
|
<dl>
|
|
11454
11338
|
<dd>
|
|
11455
11339
|
|
|
11456
|
-
**
|
|
11457
|
-
|
|
11458
|
-
</dd>
|
|
11459
|
-
</dl>
|
|
11460
|
-
|
|
11461
|
-
<dl>
|
|
11462
|
-
<dd>
|
|
11463
|
-
|
|
11464
|
-
**requestOptions:** `Cases.RequestOptions`
|
|
11465
|
-
|
|
11466
|
-
</dd>
|
|
11467
|
-
</dl>
|
|
11468
|
-
</dd>
|
|
11469
|
-
</dl>
|
|
11470
|
-
|
|
11471
|
-
</dd>
|
|
11472
|
-
</dl>
|
|
11473
|
-
</details>
|
|
11474
|
-
|
|
11475
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderRefV1</a>(orderRef) -> Chrt.Case1</code></summary>
|
|
11476
|
-
<dl>
|
|
11477
|
-
<dd>
|
|
11478
|
-
|
|
11479
|
-
#### 📝 Description
|
|
11480
|
-
|
|
11481
|
-
<dl>
|
|
11482
|
-
<dd>
|
|
11483
|
-
|
|
11484
|
-
<dl>
|
|
11485
|
-
<dd>
|
|
11486
|
-
|
|
11487
|
-
Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11488
|
-
|
|
11489
|
-
</dd>
|
|
11490
|
-
</dl>
|
|
11491
|
-
</dd>
|
|
11492
|
-
</dl>
|
|
11493
|
-
|
|
11494
|
-
#### 🔌 Usage
|
|
11495
|
-
|
|
11496
|
-
<dl>
|
|
11497
|
-
<dd>
|
|
11498
|
-
|
|
11499
|
-
<dl>
|
|
11500
|
-
<dd>
|
|
11501
|
-
|
|
11502
|
-
```typescript
|
|
11503
|
-
await client.operations.cases.getByOrderRefV1("order_ref");
|
|
11504
|
-
```
|
|
11340
|
+
**caseId:** `string`
|
|
11505
11341
|
|
|
11506
11342
|
</dd>
|
|
11507
11343
|
</dl>
|
|
11508
|
-
</dd>
|
|
11509
|
-
</dl>
|
|
11510
|
-
|
|
11511
|
-
#### ⚙️ Parameters
|
|
11512
11344
|
|
|
11513
11345
|
<dl>
|
|
11514
11346
|
<dd>
|
|
11515
11347
|
|
|
11516
|
-
|
|
11517
|
-
<dd>
|
|
11518
|
-
|
|
11519
|
-
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
11348
|
+
**request:** `Chrt.operations.CaseUnassignReq`
|
|
11520
11349
|
|
|
11521
11350
|
</dd>
|
|
11522
11351
|
</dl>
|
|
@@ -11535,7 +11364,7 @@ await client.operations.cases.getByOrderRefV1("order_ref");
|
|
|
11535
11364
|
</dl>
|
|
11536
11365
|
</details>
|
|
11537
11366
|
|
|
11538
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11367
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">addMessageV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11539
11368
|
<dl>
|
|
11540
11369
|
<dd>
|
|
11541
11370
|
|
|
@@ -11547,7 +11376,7 @@ await client.operations.cases.getByOrderRefV1("order_ref");
|
|
|
11547
11376
|
<dl>
|
|
11548
11377
|
<dd>
|
|
11549
11378
|
|
|
11550
|
-
|
|
11379
|
+
Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
|
|
11551
11380
|
|
|
11552
11381
|
</dd>
|
|
11553
11382
|
</dl>
|
|
@@ -11563,7 +11392,9 @@ Retrieves the case for a given order short ID. | authz: min_org_role=operator |
|
|
|
11563
11392
|
<dd>
|
|
11564
11393
|
|
|
11565
11394
|
```typescript
|
|
11566
|
-
await client.operations.cases.
|
|
11395
|
+
await client.operations.cases.addMessageV1("case_id", {
|
|
11396
|
+
message: "message",
|
|
11397
|
+
});
|
|
11567
11398
|
```
|
|
11568
11399
|
|
|
11569
11400
|
</dd>
|
|
@@ -11579,7 +11410,15 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11579
11410
|
<dl>
|
|
11580
11411
|
<dd>
|
|
11581
11412
|
|
|
11582
|
-
**
|
|
11413
|
+
**caseId:** `string`
|
|
11414
|
+
|
|
11415
|
+
</dd>
|
|
11416
|
+
</dl>
|
|
11417
|
+
|
|
11418
|
+
<dl>
|
|
11419
|
+
<dd>
|
|
11420
|
+
|
|
11421
|
+
**request:** `Chrt.operations.CaseAddMessageReq`
|
|
11583
11422
|
|
|
11584
11423
|
</dd>
|
|
11585
11424
|
</dl>
|
|
@@ -11598,7 +11437,7 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11598
11437
|
</dl>
|
|
11599
11438
|
</details>
|
|
11600
11439
|
|
|
11601
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11440
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">deleteMessageV1</a>(caseId, messageId) -> boolean</code></summary>
|
|
11602
11441
|
<dl>
|
|
11603
11442
|
<dd>
|
|
11604
11443
|
|
|
@@ -11610,7 +11449,7 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11610
11449
|
<dl>
|
|
11611
11450
|
<dd>
|
|
11612
11451
|
|
|
11613
|
-
|
|
11452
|
+
Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
11614
11453
|
|
|
11615
11454
|
</dd>
|
|
11616
11455
|
</dl>
|
|
@@ -11626,9 +11465,7 @@ Updates whether a case needs action. | authz: min_org_role=operator | (CaseNeeds
|
|
|
11626
11465
|
<dd>
|
|
11627
11466
|
|
|
11628
11467
|
```typescript
|
|
11629
|
-
await client.operations.cases.
|
|
11630
|
-
needs_action: true,
|
|
11631
|
-
});
|
|
11468
|
+
await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
11632
11469
|
```
|
|
11633
11470
|
|
|
11634
11471
|
</dd>
|
|
@@ -11652,7 +11489,7 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11652
11489
|
<dl>
|
|
11653
11490
|
<dd>
|
|
11654
11491
|
|
|
11655
|
-
**
|
|
11492
|
+
**messageId:** `string`
|
|
11656
11493
|
|
|
11657
11494
|
</dd>
|
|
11658
11495
|
</dl>
|
|
@@ -11671,7 +11508,9 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11671
11508
|
</dl>
|
|
11672
11509
|
</details>
|
|
11673
11510
|
|
|
11674
|
-
|
|
11511
|
+
## Operations DepartmentRoutingRules
|
|
11512
|
+
|
|
11513
|
+
<details><summary><code>client.operations.departmentRoutingRules.<a href="/src/api/resources/operations/resources/departmentRoutingRules/client/Client.ts">listV1</a>() -> Chrt.DepartmentRoutingRule1[]</code></summary>
|
|
11675
11514
|
<dl>
|
|
11676
11515
|
<dd>
|
|
11677
11516
|
|
|
@@ -11683,7 +11522,7 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11683
11522
|
<dl>
|
|
11684
11523
|
<dd>
|
|
11685
11524
|
|
|
11686
|
-
|
|
11525
|
+
Lists the caller org's department routing rules. | authz: min_org_role=operator | () -> (list[DepartmentRoutingRule1])
|
|
11687
11526
|
|
|
11688
11527
|
</dd>
|
|
11689
11528
|
</dl>
|
|
@@ -11699,9 +11538,7 @@ Updates a case's status. Closing a case also clears needs_action. | authz: min_o
|
|
|
11699
11538
|
<dd>
|
|
11700
11539
|
|
|
11701
11540
|
```typescript
|
|
11702
|
-
await client.operations.
|
|
11703
|
-
status: "open",
|
|
11704
|
-
});
|
|
11541
|
+
await client.operations.departmentRoutingRules.listV1();
|
|
11705
11542
|
```
|
|
11706
11543
|
|
|
11707
11544
|
</dd>
|
|
@@ -11717,23 +11554,7 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11717
11554
|
<dl>
|
|
11718
11555
|
<dd>
|
|
11719
11556
|
|
|
11720
|
-
**
|
|
11721
|
-
|
|
11722
|
-
</dd>
|
|
11723
|
-
</dl>
|
|
11724
|
-
|
|
11725
|
-
<dl>
|
|
11726
|
-
<dd>
|
|
11727
|
-
|
|
11728
|
-
**request:** `Chrt.operations.CaseStatusReq`
|
|
11729
|
-
|
|
11730
|
-
</dd>
|
|
11731
|
-
</dl>
|
|
11732
|
-
|
|
11733
|
-
<dl>
|
|
11734
|
-
<dd>
|
|
11735
|
-
|
|
11736
|
-
**requestOptions:** `Cases.RequestOptions`
|
|
11557
|
+
**requestOptions:** `DepartmentRoutingRules.RequestOptions`
|
|
11737
11558
|
|
|
11738
11559
|
</dd>
|
|
11739
11560
|
</dl>
|
|
@@ -11744,7 +11565,7 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11744
11565
|
</dl>
|
|
11745
11566
|
</details>
|
|
11746
11567
|
|
|
11747
|
-
<details><summary><code>client.operations.
|
|
11568
|
+
<details><summary><code>client.operations.departmentRoutingRules.<a href="/src/api/resources/operations/resources/departmentRoutingRules/client/Client.ts">upsertV1</a>({ ...params }) -> string</code></summary>
|
|
11748
11569
|
<dl>
|
|
11749
11570
|
<dd>
|
|
11750
11571
|
|
|
@@ -11756,7 +11577,7 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11756
11577
|
<dl>
|
|
11757
11578
|
<dd>
|
|
11758
11579
|
|
|
11759
|
-
|
|
11580
|
+
Sets the caller org's default operations desk for a counterparty (on-chrt shipper or off-chrt shipper shell). 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)
|
|
11760
11581
|
|
|
11761
11582
|
</dd>
|
|
11762
11583
|
</dl>
|
|
@@ -11772,8 +11593,11 @@ Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) ->
|
|
|
11772
11593
|
<dd>
|
|
11773
11594
|
|
|
11774
11595
|
```typescript
|
|
11775
|
-
await client.operations.
|
|
11776
|
-
|
|
11596
|
+
await client.operations.departmentRoutingRules.upsertV1({
|
|
11597
|
+
schema_version: 1,
|
|
11598
|
+
counterparty_type: "shipper_org",
|
|
11599
|
+
counterparty_id: "counterparty_id",
|
|
11600
|
+
department_id: "department_id",
|
|
11777
11601
|
});
|
|
11778
11602
|
```
|
|
11779
11603
|
|
|
@@ -11790,15 +11614,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11790
11614
|
<dl>
|
|
11791
11615
|
<dd>
|
|
11792
11616
|
|
|
11793
|
-
**
|
|
11794
|
-
|
|
11795
|
-
</dd>
|
|
11796
|
-
</dl>
|
|
11797
|
-
|
|
11798
|
-
<dl>
|
|
11799
|
-
<dd>
|
|
11800
|
-
|
|
11801
|
-
**request:** `Chrt.operations.CaseAssignReq`
|
|
11617
|
+
**request:** `Chrt.operations.DepartmentRoutingRuleClientCreate1`
|
|
11802
11618
|
|
|
11803
11619
|
</dd>
|
|
11804
11620
|
</dl>
|
|
@@ -11806,7 +11622,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11806
11622
|
<dl>
|
|
11807
11623
|
<dd>
|
|
11808
11624
|
|
|
11809
|
-
**requestOptions:** `
|
|
11625
|
+
**requestOptions:** `DepartmentRoutingRules.RequestOptions`
|
|
11810
11626
|
|
|
11811
11627
|
</dd>
|
|
11812
11628
|
</dl>
|
|
@@ -11817,7 +11633,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11817
11633
|
</dl>
|
|
11818
11634
|
</details>
|
|
11819
11635
|
|
|
11820
|
-
<details><summary><code>client.operations.
|
|
11636
|
+
<details><summary><code>client.operations.departmentRoutingRules.<a href="/src/api/resources/operations/resources/departmentRoutingRules/client/Client.ts">deleteV1</a>(counterpartyType, counterpartyId) -> boolean</code></summary>
|
|
11821
11637
|
<dl>
|
|
11822
11638
|
<dd>
|
|
11823
11639
|
|
|
@@ -11829,7 +11645,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11829
11645
|
<dl>
|
|
11830
11646
|
<dd>
|
|
11831
11647
|
|
|
11832
|
-
|
|
11648
|
+
Clears the caller org's default operations desk for a counterparty. | authz: min_org_role=administrator | () -> (bool)
|
|
11833
11649
|
|
|
11834
11650
|
</dd>
|
|
11835
11651
|
</dl>
|
|
@@ -11845,9 +11661,7 @@ Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignR
|
|
|
11845
11661
|
<dd>
|
|
11846
11662
|
|
|
11847
11663
|
```typescript
|
|
11848
|
-
await client.operations.
|
|
11849
|
-
operator_user_ids: ["operator_user_ids"],
|
|
11850
|
-
});
|
|
11664
|
+
await client.operations.departmentRoutingRules.deleteV1("shipper_org", "counterparty_id");
|
|
11851
11665
|
```
|
|
11852
11666
|
|
|
11853
11667
|
</dd>
|
|
@@ -11863,7 +11677,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11863
11677
|
<dl>
|
|
11864
11678
|
<dd>
|
|
11865
11679
|
|
|
11866
|
-
**
|
|
11680
|
+
**counterpartyType:** `Chrt.RoutingCounterpartyTypeEnum`
|
|
11867
11681
|
|
|
11868
11682
|
</dd>
|
|
11869
11683
|
</dl>
|
|
@@ -11871,7 +11685,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11871
11685
|
<dl>
|
|
11872
11686
|
<dd>
|
|
11873
11687
|
|
|
11874
|
-
**
|
|
11688
|
+
**counterpartyId:** `string`
|
|
11875
11689
|
|
|
11876
11690
|
</dd>
|
|
11877
11691
|
</dl>
|
|
@@ -11879,7 +11693,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11879
11693
|
<dl>
|
|
11880
11694
|
<dd>
|
|
11881
11695
|
|
|
11882
|
-
**requestOptions:** `
|
|
11696
|
+
**requestOptions:** `DepartmentRoutingRules.RequestOptions`
|
|
11883
11697
|
|
|
11884
11698
|
</dd>
|
|
11885
11699
|
</dl>
|
|
@@ -11890,7 +11704,9 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11890
11704
|
</dl>
|
|
11891
11705
|
</details>
|
|
11892
11706
|
|
|
11893
|
-
|
|
11707
|
+
## Operations Departments
|
|
11708
|
+
|
|
11709
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11894
11710
|
<dl>
|
|
11895
11711
|
<dd>
|
|
11896
11712
|
|
|
@@ -11902,7 +11718,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11902
11718
|
<dl>
|
|
11903
11719
|
<dd>
|
|
11904
11720
|
|
|
11905
|
-
|
|
11721
|
+
Lists department configurations for the caller's organization. | authz: min_org_role=operator | () -> (DepartmentListRes)
|
|
11906
11722
|
|
|
11907
11723
|
</dd>
|
|
11908
11724
|
</dl>
|
|
@@ -11918,8 +11734,11 @@ Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq
|
|
|
11918
11734
|
<dd>
|
|
11919
11735
|
|
|
11920
11736
|
```typescript
|
|
11921
|
-
await client.operations.
|
|
11922
|
-
|
|
11737
|
+
await client.operations.departments.listV1({
|
|
11738
|
+
sort_by: "created_at",
|
|
11739
|
+
sort_order: "asc",
|
|
11740
|
+
page: 1,
|
|
11741
|
+
page_size: 1,
|
|
11923
11742
|
});
|
|
11924
11743
|
```
|
|
11925
11744
|
|
|
@@ -11936,15 +11755,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11936
11755
|
<dl>
|
|
11937
11756
|
<dd>
|
|
11938
11757
|
|
|
11939
|
-
**
|
|
11940
|
-
|
|
11941
|
-
</dd>
|
|
11942
|
-
</dl>
|
|
11943
|
-
|
|
11944
|
-
<dl>
|
|
11945
|
-
<dd>
|
|
11946
|
-
|
|
11947
|
-
**request:** `Chrt.operations.CaseAddMessageReq`
|
|
11758
|
+
**request:** `Chrt.operations.DepartmentsListV1Request`
|
|
11948
11759
|
|
|
11949
11760
|
</dd>
|
|
11950
11761
|
</dl>
|
|
@@ -11952,7 +11763,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11952
11763
|
<dl>
|
|
11953
11764
|
<dd>
|
|
11954
11765
|
|
|
11955
|
-
**requestOptions:** `
|
|
11766
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11956
11767
|
|
|
11957
11768
|
</dd>
|
|
11958
11769
|
</dl>
|
|
@@ -11963,7 +11774,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11963
11774
|
</dl>
|
|
11964
11775
|
</details>
|
|
11965
11776
|
|
|
11966
|
-
<details><summary><code>client.operations.
|
|
11777
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">getV1</a>(departmentId) -> Chrt.Department1</code></summary>
|
|
11967
11778
|
<dl>
|
|
11968
11779
|
<dd>
|
|
11969
11780
|
|
|
@@ -11975,7 +11786,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11975
11786
|
<dl>
|
|
11976
11787
|
<dd>
|
|
11977
11788
|
|
|
11978
|
-
|
|
11789
|
+
Retrieves a single department configuration. | authz: min_org_role=operator | () -> (Department1)
|
|
11979
11790
|
|
|
11980
11791
|
</dd>
|
|
11981
11792
|
</dl>
|
|
@@ -11991,7 +11802,7 @@ Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
|
11991
11802
|
<dd>
|
|
11992
11803
|
|
|
11993
11804
|
```typescript
|
|
11994
|
-
await client.operations.
|
|
11805
|
+
await client.operations.departments.getV1("department_id");
|
|
11995
11806
|
```
|
|
11996
11807
|
|
|
11997
11808
|
</dd>
|
|
@@ -11999,23 +11810,15 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
11999
11810
|
</dd>
|
|
12000
11811
|
</dl>
|
|
12001
11812
|
|
|
12002
|
-
#### ⚙️ Parameters
|
|
12003
|
-
|
|
12004
|
-
<dl>
|
|
12005
|
-
<dd>
|
|
11813
|
+
#### ⚙️ Parameters
|
|
12006
11814
|
|
|
12007
11815
|
<dl>
|
|
12008
11816
|
<dd>
|
|
12009
11817
|
|
|
12010
|
-
**caseId:** `string`
|
|
12011
|
-
|
|
12012
|
-
</dd>
|
|
12013
|
-
</dl>
|
|
12014
|
-
|
|
12015
11818
|
<dl>
|
|
12016
11819
|
<dd>
|
|
12017
11820
|
|
|
12018
|
-
**
|
|
11821
|
+
**departmentId:** `string`
|
|
12019
11822
|
|
|
12020
11823
|
</dd>
|
|
12021
11824
|
</dl>
|
|
@@ -12023,7 +11826,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
12023
11826
|
<dl>
|
|
12024
11827
|
<dd>
|
|
12025
11828
|
|
|
12026
|
-
**requestOptions:** `
|
|
11829
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12027
11830
|
|
|
12028
11831
|
</dd>
|
|
12029
11832
|
</dl>
|
|
@@ -12034,9 +11837,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
12034
11837
|
</dl>
|
|
12035
11838
|
</details>
|
|
12036
11839
|
|
|
12037
|
-
|
|
12038
|
-
|
|
12039
|
-
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ChecklistListRes</code></summary>
|
|
11840
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">deleteV1</a>(departmentId) -> boolean</code></summary>
|
|
12040
11841
|
<dl>
|
|
12041
11842
|
<dd>
|
|
12042
11843
|
|
|
@@ -12048,7 +11849,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
12048
11849
|
<dl>
|
|
12049
11850
|
<dd>
|
|
12050
11851
|
|
|
12051
|
-
|
|
11852
|
+
Deletes a department configuration. | authz: min_org_role=administrator | () -> (bool)
|
|
12052
11853
|
|
|
12053
11854
|
</dd>
|
|
12054
11855
|
</dl>
|
|
@@ -12064,13 +11865,7 @@ Lists Checklists for the caller's organization with filtering, sorting, and pagi
|
|
|
12064
11865
|
<dd>
|
|
12065
11866
|
|
|
12066
11867
|
```typescript
|
|
12067
|
-
await client.operations.
|
|
12068
|
-
sort_by: "created_at_timestamp",
|
|
12069
|
-
sort_order: "asc",
|
|
12070
|
-
page: 1,
|
|
12071
|
-
page_size: 1,
|
|
12072
|
-
filter_archived: true,
|
|
12073
|
-
});
|
|
11868
|
+
await client.operations.departments.deleteV1("department_id");
|
|
12074
11869
|
```
|
|
12075
11870
|
|
|
12076
11871
|
</dd>
|
|
@@ -12086,7 +11881,7 @@ await client.operations.checklists.listV1({
|
|
|
12086
11881
|
<dl>
|
|
12087
11882
|
<dd>
|
|
12088
11883
|
|
|
12089
|
-
**
|
|
11884
|
+
**departmentId:** `string`
|
|
12090
11885
|
|
|
12091
11886
|
</dd>
|
|
12092
11887
|
</dl>
|
|
@@ -12094,7 +11889,7 @@ await client.operations.checklists.listV1({
|
|
|
12094
11889
|
<dl>
|
|
12095
11890
|
<dd>
|
|
12096
11891
|
|
|
12097
|
-
**requestOptions:** `
|
|
11892
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12098
11893
|
|
|
12099
11894
|
</dd>
|
|
12100
11895
|
</dl>
|
|
@@ -12105,7 +11900,7 @@ await client.operations.checklists.listV1({
|
|
|
12105
11900
|
</dl>
|
|
12106
11901
|
</details>
|
|
12107
11902
|
|
|
12108
|
-
<details><summary><code>client.operations.
|
|
11903
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">updateV1</a>(departmentId, { ...params }) -> boolean</code></summary>
|
|
12109
11904
|
<dl>
|
|
12110
11905
|
<dd>
|
|
12111
11906
|
|
|
@@ -12117,7 +11912,7 @@ await client.operations.checklists.listV1({
|
|
|
12117
11912
|
<dl>
|
|
12118
11913
|
<dd>
|
|
12119
11914
|
|
|
12120
|
-
|
|
11915
|
+
Updates a department configuration. | authz: min_org_role=administrator | (DepartmentClientUpdate1) -> (bool)
|
|
12121
11916
|
|
|
12122
11917
|
</dd>
|
|
12123
11918
|
</dl>
|
|
@@ -12133,7 +11928,7 @@ Retrieves a single Checklist by id. | authz: min_org_role=operator | () -> (Chec
|
|
|
12133
11928
|
<dd>
|
|
12134
11929
|
|
|
12135
11930
|
```typescript
|
|
12136
|
-
await client.operations.
|
|
11931
|
+
await client.operations.departments.updateV1("department_id");
|
|
12137
11932
|
```
|
|
12138
11933
|
|
|
12139
11934
|
</dd>
|
|
@@ -12149,7 +11944,15 @@ await client.operations.checklists.getV1("checklist_id");
|
|
|
12149
11944
|
<dl>
|
|
12150
11945
|
<dd>
|
|
12151
11946
|
|
|
12152
|
-
**
|
|
11947
|
+
**departmentId:** `string`
|
|
11948
|
+
|
|
11949
|
+
</dd>
|
|
11950
|
+
</dl>
|
|
11951
|
+
|
|
11952
|
+
<dl>
|
|
11953
|
+
<dd>
|
|
11954
|
+
|
|
11955
|
+
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
12153
11956
|
|
|
12154
11957
|
</dd>
|
|
12155
11958
|
</dl>
|
|
@@ -12157,7 +11960,7 @@ await client.operations.checklists.getV1("checklist_id");
|
|
|
12157
11960
|
<dl>
|
|
12158
11961
|
<dd>
|
|
12159
11962
|
|
|
12160
|
-
**requestOptions:** `
|
|
11963
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12161
11964
|
|
|
12162
11965
|
</dd>
|
|
12163
11966
|
</dl>
|
|
@@ -12168,7 +11971,7 @@ await client.operations.checklists.getV1("checklist_id");
|
|
|
12168
11971
|
</dl>
|
|
12169
11972
|
</details>
|
|
12170
11973
|
|
|
12171
|
-
<details><summary><code>client.operations.
|
|
11974
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
12172
11975
|
<dl>
|
|
12173
11976
|
<dd>
|
|
12174
11977
|
|
|
@@ -12180,7 +11983,7 @@ await client.operations.checklists.getV1("checklist_id");
|
|
|
12180
11983
|
<dl>
|
|
12181
11984
|
<dd>
|
|
12182
11985
|
|
|
12183
|
-
|
|
11986
|
+
Creates a new department configuration for the caller's organization. | authz: min_org_role=administrator | (DepartmentClientCreate1) -> (PydanticObjectId)
|
|
12184
11987
|
|
|
12185
11988
|
</dd>
|
|
12186
11989
|
</dl>
|
|
@@ -12196,7 +11999,11 @@ Updates scalar fields (name, description) on a Checklist. | authz: min_org_role=
|
|
|
12196
11999
|
<dd>
|
|
12197
12000
|
|
|
12198
12001
|
```typescript
|
|
12199
|
-
await client.operations.
|
|
12002
|
+
await client.operations.departments.createV1({
|
|
12003
|
+
schema_version: 1,
|
|
12004
|
+
name: "name",
|
|
12005
|
+
department_type: "aerospace",
|
|
12006
|
+
});
|
|
12200
12007
|
```
|
|
12201
12008
|
|
|
12202
12009
|
</dd>
|
|
@@ -12212,15 +12019,7 @@ await client.operations.checklists.updateV1("checklist_id");
|
|
|
12212
12019
|
<dl>
|
|
12213
12020
|
<dd>
|
|
12214
12021
|
|
|
12215
|
-
**
|
|
12216
|
-
|
|
12217
|
-
</dd>
|
|
12218
|
-
</dl>
|
|
12219
|
-
|
|
12220
|
-
<dl>
|
|
12221
|
-
<dd>
|
|
12222
|
-
|
|
12223
|
-
**request:** `Chrt.operations.ChecklistClientUpdate1`
|
|
12022
|
+
**request:** `Chrt.operations.DepartmentClientCreate1`
|
|
12224
12023
|
|
|
12225
12024
|
</dd>
|
|
12226
12025
|
</dl>
|
|
@@ -12228,7 +12027,7 @@ await client.operations.checklists.updateV1("checklist_id");
|
|
|
12228
12027
|
<dl>
|
|
12229
12028
|
<dd>
|
|
12230
12029
|
|
|
12231
|
-
**requestOptions:** `
|
|
12030
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12232
12031
|
|
|
12233
12032
|
</dd>
|
|
12234
12033
|
</dl>
|
|
@@ -12239,7 +12038,7 @@ await client.operations.checklists.updateV1("checklist_id");
|
|
|
12239
12038
|
</dl>
|
|
12240
12039
|
</details>
|
|
12241
12040
|
|
|
12242
|
-
<details><summary><code>client.operations.
|
|
12041
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">addOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12243
12042
|
<dl>
|
|
12244
12043
|
<dd>
|
|
12245
12044
|
|
|
@@ -12251,7 +12050,7 @@ await client.operations.checklists.updateV1("checklist_id");
|
|
|
12251
12050
|
<dl>
|
|
12252
12051
|
<dd>
|
|
12253
12052
|
|
|
12254
|
-
|
|
12053
|
+
Adds an operator to a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12255
12054
|
|
|
12256
12055
|
</dd>
|
|
12257
12056
|
</dl>
|
|
@@ -12267,10 +12066,7 @@ Creates a new Checklist for the caller's organization. | authz: min_org_role=ope
|
|
|
12267
12066
|
<dd>
|
|
12268
12067
|
|
|
12269
12068
|
```typescript
|
|
12270
|
-
await client.operations.
|
|
12271
|
-
schema_version: 1,
|
|
12272
|
-
name: "name",
|
|
12273
|
-
});
|
|
12069
|
+
await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
12274
12070
|
```
|
|
12275
12071
|
|
|
12276
12072
|
</dd>
|
|
@@ -12286,7 +12082,15 @@ await client.operations.checklists.createV1({
|
|
|
12286
12082
|
<dl>
|
|
12287
12083
|
<dd>
|
|
12288
12084
|
|
|
12289
|
-
**
|
|
12085
|
+
**departmentId:** `string`
|
|
12086
|
+
|
|
12087
|
+
</dd>
|
|
12088
|
+
</dl>
|
|
12089
|
+
|
|
12090
|
+
<dl>
|
|
12091
|
+
<dd>
|
|
12092
|
+
|
|
12093
|
+
**userId:** `string`
|
|
12290
12094
|
|
|
12291
12095
|
</dd>
|
|
12292
12096
|
</dl>
|
|
@@ -12294,7 +12098,7 @@ await client.operations.checklists.createV1({
|
|
|
12294
12098
|
<dl>
|
|
12295
12099
|
<dd>
|
|
12296
12100
|
|
|
12297
|
-
**requestOptions:** `
|
|
12101
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12298
12102
|
|
|
12299
12103
|
</dd>
|
|
12300
12104
|
</dl>
|
|
@@ -12305,7 +12109,7 @@ await client.operations.checklists.createV1({
|
|
|
12305
12109
|
</dl>
|
|
12306
12110
|
</details>
|
|
12307
12111
|
|
|
12308
|
-
<details><summary><code>client.operations.
|
|
12112
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">removeOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12309
12113
|
<dl>
|
|
12310
12114
|
<dd>
|
|
12311
12115
|
|
|
@@ -12317,7 +12121,7 @@ await client.operations.checklists.createV1({
|
|
|
12317
12121
|
<dl>
|
|
12318
12122
|
<dd>
|
|
12319
12123
|
|
|
12320
|
-
|
|
12124
|
+
Removes an operator from a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12321
12125
|
|
|
12322
12126
|
</dd>
|
|
12323
12127
|
</dl>
|
|
@@ -12333,7 +12137,7 @@ Adds checks to a Checklist. Idempotent for identical checks. | authz: min_org_ro
|
|
|
12333
12137
|
<dd>
|
|
12334
12138
|
|
|
12335
12139
|
```typescript
|
|
12336
|
-
await client.operations.
|
|
12140
|
+
await client.operations.departments.removeOperatorV1("department_id", "user_id");
|
|
12337
12141
|
```
|
|
12338
12142
|
|
|
12339
12143
|
</dd>
|
|
@@ -12349,7 +12153,7 @@ await client.operations.checklists.addChecksV1("checklist_id");
|
|
|
12349
12153
|
<dl>
|
|
12350
12154
|
<dd>
|
|
12351
12155
|
|
|
12352
|
-
**
|
|
12156
|
+
**departmentId:** `string`
|
|
12353
12157
|
|
|
12354
12158
|
</dd>
|
|
12355
12159
|
</dl>
|
|
@@ -12357,7 +12161,7 @@ await client.operations.checklists.addChecksV1("checklist_id");
|
|
|
12357
12161
|
<dl>
|
|
12358
12162
|
<dd>
|
|
12359
12163
|
|
|
12360
|
-
**
|
|
12164
|
+
**userId:** `string`
|
|
12361
12165
|
|
|
12362
12166
|
</dd>
|
|
12363
12167
|
</dl>
|
|
@@ -12365,7 +12169,7 @@ await client.operations.checklists.addChecksV1("checklist_id");
|
|
|
12365
12169
|
<dl>
|
|
12366
12170
|
<dd>
|
|
12367
12171
|
|
|
12368
|
-
**requestOptions:** `
|
|
12172
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12369
12173
|
|
|
12370
12174
|
</dd>
|
|
12371
12175
|
</dl>
|
|
@@ -12376,7 +12180,9 @@ await client.operations.checklists.addChecksV1("checklist_id");
|
|
|
12376
12180
|
</dl>
|
|
12377
12181
|
</details>
|
|
12378
12182
|
|
|
12379
|
-
|
|
12183
|
+
## Operations OperationsTaskLists
|
|
12184
|
+
|
|
12185
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OperationsTaskListListRes</code></summary>
|
|
12380
12186
|
<dl>
|
|
12381
12187
|
<dd>
|
|
12382
12188
|
|
|
@@ -12388,7 +12194,7 @@ await client.operations.checklists.addChecksV1("checklist_id");
|
|
|
12388
12194
|
<dl>
|
|
12389
12195
|
<dd>
|
|
12390
12196
|
|
|
12391
|
-
|
|
12197
|
+
Lists OperationsTaskLists for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListListRes)
|
|
12392
12198
|
|
|
12393
12199
|
</dd>
|
|
12394
12200
|
</dl>
|
|
@@ -12404,7 +12210,13 @@ Removes entries from a Checklist's `checks` list by CheckEnum. | authz: min_org_
|
|
|
12404
12210
|
<dd>
|
|
12405
12211
|
|
|
12406
12212
|
```typescript
|
|
12407
|
-
await client.operations.
|
|
12213
|
+
await client.operations.operationsTaskLists.listV1({
|
|
12214
|
+
sort_by: "created_at_timestamp",
|
|
12215
|
+
sort_order: "asc",
|
|
12216
|
+
page: 1,
|
|
12217
|
+
page_size: 1,
|
|
12218
|
+
filter_archived: true,
|
|
12219
|
+
});
|
|
12408
12220
|
```
|
|
12409
12221
|
|
|
12410
12222
|
</dd>
|
|
@@ -12420,15 +12232,7 @@ await client.operations.checklists.removeChecksV1("checklist_id");
|
|
|
12420
12232
|
<dl>
|
|
12421
12233
|
<dd>
|
|
12422
12234
|
|
|
12423
|
-
**
|
|
12424
|
-
|
|
12425
|
-
</dd>
|
|
12426
|
-
</dl>
|
|
12427
|
-
|
|
12428
|
-
<dl>
|
|
12429
|
-
<dd>
|
|
12430
|
-
|
|
12431
|
-
**request:** `Chrt.operations.ChecklistChecksRemove1`
|
|
12235
|
+
**request:** `Chrt.operations.OperationsTaskListsListV1Request`
|
|
12432
12236
|
|
|
12433
12237
|
</dd>
|
|
12434
12238
|
</dl>
|
|
@@ -12436,7 +12240,7 @@ await client.operations.checklists.removeChecksV1("checklist_id");
|
|
|
12436
12240
|
<dl>
|
|
12437
12241
|
<dd>
|
|
12438
12242
|
|
|
12439
|
-
**requestOptions:** `
|
|
12243
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12440
12244
|
|
|
12441
12245
|
</dd>
|
|
12442
12246
|
</dl>
|
|
@@ -12447,7 +12251,7 @@ await client.operations.checklists.removeChecksV1("checklist_id");
|
|
|
12447
12251
|
</dl>
|
|
12448
12252
|
</details>
|
|
12449
12253
|
|
|
12450
|
-
<details><summary><code>client.operations.
|
|
12254
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">getV1</a>(taskListId) -> Chrt.OperationsTaskList1</code></summary>
|
|
12451
12255
|
<dl>
|
|
12452
12256
|
<dd>
|
|
12453
12257
|
|
|
@@ -12459,7 +12263,7 @@ await client.operations.checklists.removeChecksV1("checklist_id");
|
|
|
12459
12263
|
<dl>
|
|
12460
12264
|
<dd>
|
|
12461
12265
|
|
|
12462
|
-
|
|
12266
|
+
Retrieves a single OperationsTaskList by id. | authz: min_org_role=operator | () -> (OperationsTaskList1)
|
|
12463
12267
|
|
|
12464
12268
|
</dd>
|
|
12465
12269
|
</dl>
|
|
@@ -12475,7 +12279,7 @@ Soft-deletes a Checklist by setting `archived=True`. Existing Cases that applied
|
|
|
12475
12279
|
<dd>
|
|
12476
12280
|
|
|
12477
12281
|
```typescript
|
|
12478
|
-
await client.operations.
|
|
12282
|
+
await client.operations.operationsTaskLists.getV1("task_list_id");
|
|
12479
12283
|
```
|
|
12480
12284
|
|
|
12481
12285
|
</dd>
|
|
@@ -12491,7 +12295,7 @@ await client.operations.checklists.archiveV1("checklist_id");
|
|
|
12491
12295
|
<dl>
|
|
12492
12296
|
<dd>
|
|
12493
12297
|
|
|
12494
|
-
**
|
|
12298
|
+
**taskListId:** `string`
|
|
12495
12299
|
|
|
12496
12300
|
</dd>
|
|
12497
12301
|
</dl>
|
|
@@ -12499,7 +12303,7 @@ await client.operations.checklists.archiveV1("checklist_id");
|
|
|
12499
12303
|
<dl>
|
|
12500
12304
|
<dd>
|
|
12501
12305
|
|
|
12502
|
-
**requestOptions:** `
|
|
12306
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12503
12307
|
|
|
12504
12308
|
</dd>
|
|
12505
12309
|
</dl>
|
|
@@ -12510,7 +12314,7 @@ await client.operations.checklists.archiveV1("checklist_id");
|
|
|
12510
12314
|
</dl>
|
|
12511
12315
|
</details>
|
|
12512
12316
|
|
|
12513
|
-
<details><summary><code>client.operations.
|
|
12317
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">updateV1</a>(taskListId, { ...params }) -> boolean</code></summary>
|
|
12514
12318
|
<dl>
|
|
12515
12319
|
<dd>
|
|
12516
12320
|
|
|
@@ -12522,7 +12326,7 @@ await client.operations.checklists.archiveV1("checklist_id");
|
|
|
12522
12326
|
<dl>
|
|
12523
12327
|
<dd>
|
|
12524
12328
|
|
|
12525
|
-
|
|
12329
|
+
Updates scalar fields (name, description, tags) on an OperationsTaskList. | authz: min_org_role=operator | (OperationsTaskListClientUpdate1) -> (bool)
|
|
12526
12330
|
|
|
12527
12331
|
</dd>
|
|
12528
12332
|
</dl>
|
|
@@ -12538,7 +12342,7 @@ Restores an archived Checklist by setting `archived=False`. | authz: min_org_rol
|
|
|
12538
12342
|
<dd>
|
|
12539
12343
|
|
|
12540
12344
|
```typescript
|
|
12541
|
-
await client.operations.
|
|
12345
|
+
await client.operations.operationsTaskLists.updateV1("task_list_id");
|
|
12542
12346
|
```
|
|
12543
12347
|
|
|
12544
12348
|
</dd>
|
|
@@ -12554,7 +12358,15 @@ await client.operations.checklists.unarchiveV1("checklist_id");
|
|
|
12554
12358
|
<dl>
|
|
12555
12359
|
<dd>
|
|
12556
12360
|
|
|
12557
|
-
**
|
|
12361
|
+
**taskListId:** `string`
|
|
12362
|
+
|
|
12363
|
+
</dd>
|
|
12364
|
+
</dl>
|
|
12365
|
+
|
|
12366
|
+
<dl>
|
|
12367
|
+
<dd>
|
|
12368
|
+
|
|
12369
|
+
**request:** `Chrt.operations.OperationsTaskListClientUpdate1`
|
|
12558
12370
|
|
|
12559
12371
|
</dd>
|
|
12560
12372
|
</dl>
|
|
@@ -12562,7 +12374,7 @@ await client.operations.checklists.unarchiveV1("checklist_id");
|
|
|
12562
12374
|
<dl>
|
|
12563
12375
|
<dd>
|
|
12564
12376
|
|
|
12565
|
-
**requestOptions:** `
|
|
12377
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12566
12378
|
|
|
12567
12379
|
</dd>
|
|
12568
12380
|
</dl>
|
|
@@ -12573,9 +12385,7 @@ await client.operations.checklists.unarchiveV1("checklist_id");
|
|
|
12573
12385
|
</dl>
|
|
12574
12386
|
</details>
|
|
12575
12387
|
|
|
12576
|
-
|
|
12577
|
-
|
|
12578
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
12388
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
12579
12389
|
<dl>
|
|
12580
12390
|
<dd>
|
|
12581
12391
|
|
|
@@ -12587,7 +12397,7 @@ await client.operations.checklists.unarchiveV1("checklist_id");
|
|
|
12587
12397
|
<dl>
|
|
12588
12398
|
<dd>
|
|
12589
12399
|
|
|
12590
|
-
|
|
12400
|
+
Creates a new OperationsTaskList for the caller's organization. | authz: min_org_role=operator | (OperationsTaskListClientCreate1) -> (PydanticObjectId)
|
|
12591
12401
|
|
|
12592
12402
|
</dd>
|
|
12593
12403
|
</dl>
|
|
@@ -12603,11 +12413,9 @@ Lists department configurations for the caller's organization. | authz: min_org_
|
|
|
12603
12413
|
<dd>
|
|
12604
12414
|
|
|
12605
12415
|
```typescript
|
|
12606
|
-
await client.operations.
|
|
12607
|
-
|
|
12608
|
-
|
|
12609
|
-
page: 1,
|
|
12610
|
-
page_size: 1,
|
|
12416
|
+
await client.operations.operationsTaskLists.createV1({
|
|
12417
|
+
schema_version: 1,
|
|
12418
|
+
name: "name",
|
|
12611
12419
|
});
|
|
12612
12420
|
```
|
|
12613
12421
|
|
|
@@ -12624,7 +12432,7 @@ await client.operations.departments.listV1({
|
|
|
12624
12432
|
<dl>
|
|
12625
12433
|
<dd>
|
|
12626
12434
|
|
|
12627
|
-
**request:** `Chrt.operations.
|
|
12435
|
+
**request:** `Chrt.operations.OperationsTaskListClientCreate1`
|
|
12628
12436
|
|
|
12629
12437
|
</dd>
|
|
12630
12438
|
</dl>
|
|
@@ -12632,7 +12440,7 @@ await client.operations.departments.listV1({
|
|
|
12632
12440
|
<dl>
|
|
12633
12441
|
<dd>
|
|
12634
12442
|
|
|
12635
|
-
**requestOptions:** `
|
|
12443
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12636
12444
|
|
|
12637
12445
|
</dd>
|
|
12638
12446
|
</dl>
|
|
@@ -12643,7 +12451,7 @@ await client.operations.departments.listV1({
|
|
|
12643
12451
|
</dl>
|
|
12644
12452
|
</details>
|
|
12645
12453
|
|
|
12646
|
-
<details><summary><code>client.operations.
|
|
12454
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">addEntriesV1</a>(taskListId, { ...params }) -> boolean</code></summary>
|
|
12647
12455
|
<dl>
|
|
12648
12456
|
<dd>
|
|
12649
12457
|
|
|
@@ -12655,7 +12463,7 @@ await client.operations.departments.listV1({
|
|
|
12655
12463
|
<dl>
|
|
12656
12464
|
<dd>
|
|
12657
12465
|
|
|
12658
|
-
|
|
12466
|
+
Appends entries to an OperationsTaskList's `entries` array. | authz: min_org_role=operator | (OperationsTaskListEntriesAdd1) -> (bool)
|
|
12659
12467
|
|
|
12660
12468
|
</dd>
|
|
12661
12469
|
</dl>
|
|
@@ -12671,7 +12479,7 @@ Retrieves a single department configuration. | authz: min_org_role=operator | ()
|
|
|
12671
12479
|
<dd>
|
|
12672
12480
|
|
|
12673
12481
|
```typescript
|
|
12674
|
-
await client.operations.
|
|
12482
|
+
await client.operations.operationsTaskLists.addEntriesV1("task_list_id");
|
|
12675
12483
|
```
|
|
12676
12484
|
|
|
12677
12485
|
</dd>
|
|
@@ -12687,7 +12495,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
12687
12495
|
<dl>
|
|
12688
12496
|
<dd>
|
|
12689
12497
|
|
|
12690
|
-
**
|
|
12498
|
+
**taskListId:** `string`
|
|
12691
12499
|
|
|
12692
12500
|
</dd>
|
|
12693
12501
|
</dl>
|
|
@@ -12695,7 +12503,15 @@ await client.operations.departments.getV1("department_id");
|
|
|
12695
12503
|
<dl>
|
|
12696
12504
|
<dd>
|
|
12697
12505
|
|
|
12698
|
-
**
|
|
12506
|
+
**request:** `Chrt.operations.OperationsTaskListEntriesAdd1`
|
|
12507
|
+
|
|
12508
|
+
</dd>
|
|
12509
|
+
</dl>
|
|
12510
|
+
|
|
12511
|
+
<dl>
|
|
12512
|
+
<dd>
|
|
12513
|
+
|
|
12514
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12699
12515
|
|
|
12700
12516
|
</dd>
|
|
12701
12517
|
</dl>
|
|
@@ -12706,7 +12522,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
12706
12522
|
</dl>
|
|
12707
12523
|
</details>
|
|
12708
12524
|
|
|
12709
|
-
<details><summary><code>client.operations.
|
|
12525
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeEntriesV1</a>(taskListId, { ...params }) -> boolean</code></summary>
|
|
12710
12526
|
<dl>
|
|
12711
12527
|
<dd>
|
|
12712
12528
|
|
|
@@ -12718,7 +12534,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
12718
12534
|
<dl>
|
|
12719
12535
|
<dd>
|
|
12720
12536
|
|
|
12721
|
-
|
|
12537
|
+
Removes entries from an OperationsTaskList by entry id. | authz: min_org_role=operator | (OperationsTaskListEntriesRemove1) -> (bool)
|
|
12722
12538
|
|
|
12723
12539
|
</dd>
|
|
12724
12540
|
</dl>
|
|
@@ -12734,7 +12550,7 @@ Deletes a department configuration. | authz: min_org_role=administrator | () ->
|
|
|
12734
12550
|
<dd>
|
|
12735
12551
|
|
|
12736
12552
|
```typescript
|
|
12737
|
-
await client.operations.
|
|
12553
|
+
await client.operations.operationsTaskLists.removeEntriesV1("task_list_id");
|
|
12738
12554
|
```
|
|
12739
12555
|
|
|
12740
12556
|
</dd>
|
|
@@ -12750,7 +12566,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
12750
12566
|
<dl>
|
|
12751
12567
|
<dd>
|
|
12752
12568
|
|
|
12753
|
-
**
|
|
12569
|
+
**taskListId:** `string`
|
|
12754
12570
|
|
|
12755
12571
|
</dd>
|
|
12756
12572
|
</dl>
|
|
@@ -12758,7 +12574,15 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
12758
12574
|
<dl>
|
|
12759
12575
|
<dd>
|
|
12760
12576
|
|
|
12761
|
-
**
|
|
12577
|
+
**request:** `Chrt.operations.OperationsTaskListEntriesRemove1`
|
|
12578
|
+
|
|
12579
|
+
</dd>
|
|
12580
|
+
</dl>
|
|
12581
|
+
|
|
12582
|
+
<dl>
|
|
12583
|
+
<dd>
|
|
12584
|
+
|
|
12585
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12762
12586
|
|
|
12763
12587
|
</dd>
|
|
12764
12588
|
</dl>
|
|
@@ -12769,7 +12593,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
12769
12593
|
</dl>
|
|
12770
12594
|
</details>
|
|
12771
12595
|
|
|
12772
|
-
<details><summary><code>client.operations.
|
|
12596
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">archiveV1</a>(taskListId) -> boolean</code></summary>
|
|
12773
12597
|
<dl>
|
|
12774
12598
|
<dd>
|
|
12775
12599
|
|
|
@@ -12781,7 +12605,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
12781
12605
|
<dl>
|
|
12782
12606
|
<dd>
|
|
12783
12607
|
|
|
12784
|
-
|
|
12608
|
+
Soft-deletes an OperationsTaskList by setting `archived=True`. Tasks already applied to Cases are unaffected. | authz: min_org_role=operator | () -> (bool)
|
|
12785
12609
|
|
|
12786
12610
|
</dd>
|
|
12787
12611
|
</dl>
|
|
@@ -12797,7 +12621,7 @@ Updates a department configuration. | authz: min_org_role=administrator | (Depar
|
|
|
12797
12621
|
<dd>
|
|
12798
12622
|
|
|
12799
12623
|
```typescript
|
|
12800
|
-
await client.operations.
|
|
12624
|
+
await client.operations.operationsTaskLists.archiveV1("task_list_id");
|
|
12801
12625
|
```
|
|
12802
12626
|
|
|
12803
12627
|
</dd>
|
|
@@ -12813,15 +12637,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
12813
12637
|
<dl>
|
|
12814
12638
|
<dd>
|
|
12815
12639
|
|
|
12816
|
-
**
|
|
12817
|
-
|
|
12818
|
-
</dd>
|
|
12819
|
-
</dl>
|
|
12820
|
-
|
|
12821
|
-
<dl>
|
|
12822
|
-
<dd>
|
|
12823
|
-
|
|
12824
|
-
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
12640
|
+
**taskListId:** `string`
|
|
12825
12641
|
|
|
12826
12642
|
</dd>
|
|
12827
12643
|
</dl>
|
|
@@ -12829,7 +12645,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
12829
12645
|
<dl>
|
|
12830
12646
|
<dd>
|
|
12831
12647
|
|
|
12832
|
-
**requestOptions:** `
|
|
12648
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12833
12649
|
|
|
12834
12650
|
</dd>
|
|
12835
12651
|
</dl>
|
|
@@ -12840,7 +12656,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
12840
12656
|
</dl>
|
|
12841
12657
|
</details>
|
|
12842
12658
|
|
|
12843
|
-
<details><summary><code>client.operations.
|
|
12659
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">unarchiveV1</a>(taskListId) -> boolean</code></summary>
|
|
12844
12660
|
<dl>
|
|
12845
12661
|
<dd>
|
|
12846
12662
|
|
|
@@ -12852,7 +12668,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
12852
12668
|
<dl>
|
|
12853
12669
|
<dd>
|
|
12854
12670
|
|
|
12855
|
-
|
|
12671
|
+
Restores an archived OperationsTaskList by setting `archived=False`. | authz: min_org_role=operator | () -> (bool)
|
|
12856
12672
|
|
|
12857
12673
|
</dd>
|
|
12858
12674
|
</dl>
|
|
@@ -12868,11 +12684,7 @@ Creates a new department configuration for the caller's organization. | authz: m
|
|
|
12868
12684
|
<dd>
|
|
12869
12685
|
|
|
12870
12686
|
```typescript
|
|
12871
|
-
await client.operations.
|
|
12872
|
-
schema_version: 1,
|
|
12873
|
-
name: "name",
|
|
12874
|
-
department_type: "automotive",
|
|
12875
|
-
});
|
|
12687
|
+
await client.operations.operationsTaskLists.unarchiveV1("task_list_id");
|
|
12876
12688
|
```
|
|
12877
12689
|
|
|
12878
12690
|
</dd>
|
|
@@ -12888,7 +12700,7 @@ await client.operations.departments.createV1({
|
|
|
12888
12700
|
<dl>
|
|
12889
12701
|
<dd>
|
|
12890
12702
|
|
|
12891
|
-
**
|
|
12703
|
+
**taskListId:** `string`
|
|
12892
12704
|
|
|
12893
12705
|
</dd>
|
|
12894
12706
|
</dl>
|
|
@@ -12896,7 +12708,7 @@ await client.operations.departments.createV1({
|
|
|
12896
12708
|
<dl>
|
|
12897
12709
|
<dd>
|
|
12898
12710
|
|
|
12899
|
-
**requestOptions:** `
|
|
12711
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12900
12712
|
|
|
12901
12713
|
</dd>
|
|
12902
12714
|
</dl>
|
|
@@ -12907,7 +12719,7 @@ await client.operations.departments.createV1({
|
|
|
12907
12719
|
</dl>
|
|
12908
12720
|
</details>
|
|
12909
12721
|
|
|
12910
|
-
<details><summary><code>client.operations.
|
|
12722
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">applyToCaseV1</a>(taskListId, caseId, { ...params }) -> string[]</code></summary>
|
|
12911
12723
|
<dl>
|
|
12912
12724
|
<dd>
|
|
12913
12725
|
|
|
@@ -12919,7 +12731,7 @@ await client.operations.departments.createV1({
|
|
|
12919
12731
|
<dl>
|
|
12920
12732
|
<dd>
|
|
12921
12733
|
|
|
12922
|
-
|
|
12734
|
+
Materializes each entry of an OperationsTaskList into an OperationsTask on the Case (status=not_started, source_task_list_id set). Deadlines: overall_deadline_timestamp wins, else the entry's deadline_offset_seconds, else a positional 20-min stagger. No dedup — applying twice creates duplicate tasks. | authz: min_org_role=operator | () -> (list[PydanticObjectId])
|
|
12923
12735
|
|
|
12924
12736
|
</dd>
|
|
12925
12737
|
</dl>
|
|
@@ -12935,7 +12747,9 @@ Adds an operator to a department. | authz: min_org_role=administrator | () -> (b
|
|
|
12935
12747
|
<dd>
|
|
12936
12748
|
|
|
12937
12749
|
```typescript
|
|
12938
|
-
await client.operations.
|
|
12750
|
+
await client.operations.operationsTaskLists.applyToCaseV1("task_list_id", "case_id", {
|
|
12751
|
+
overall_deadline_timestamp: "2024-01-15T09:30:00Z",
|
|
12752
|
+
});
|
|
12939
12753
|
```
|
|
12940
12754
|
|
|
12941
12755
|
</dd>
|
|
@@ -12951,7 +12765,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12951
12765
|
<dl>
|
|
12952
12766
|
<dd>
|
|
12953
12767
|
|
|
12954
|
-
**
|
|
12768
|
+
**taskListId:** `string`
|
|
12955
12769
|
|
|
12956
12770
|
</dd>
|
|
12957
12771
|
</dl>
|
|
@@ -12959,7 +12773,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12959
12773
|
<dl>
|
|
12960
12774
|
<dd>
|
|
12961
12775
|
|
|
12962
|
-
**
|
|
12776
|
+
**caseId:** `string`
|
|
12963
12777
|
|
|
12964
12778
|
</dd>
|
|
12965
12779
|
</dl>
|
|
@@ -12967,7 +12781,15 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12967
12781
|
<dl>
|
|
12968
12782
|
<dd>
|
|
12969
12783
|
|
|
12970
|
-
**
|
|
12784
|
+
**request:** `Chrt.operations.OperationsTaskListsApplyToCaseV1Request`
|
|
12785
|
+
|
|
12786
|
+
</dd>
|
|
12787
|
+
</dl>
|
|
12788
|
+
|
|
12789
|
+
<dl>
|
|
12790
|
+
<dd>
|
|
12791
|
+
|
|
12792
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
12971
12793
|
|
|
12972
12794
|
</dd>
|
|
12973
12795
|
</dl>
|
|
@@ -12978,7 +12800,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12978
12800
|
</dl>
|
|
12979
12801
|
</details>
|
|
12980
12802
|
|
|
12981
|
-
<details><summary><code>client.operations.
|
|
12803
|
+
<details><summary><code>client.operations.operationsTaskLists.<a href="/src/api/resources/operations/resources/operationsTaskLists/client/Client.ts">removeFromCaseV1</a>(taskListId, caseId) -> Chrt.OperationsTaskListRemoveFromCaseRes1</code></summary>
|
|
12982
12804
|
<dl>
|
|
12983
12805
|
<dd>
|
|
12984
12806
|
|
|
@@ -12990,7 +12812,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12990
12812
|
<dl>
|
|
12991
12813
|
<dd>
|
|
12992
12814
|
|
|
12993
|
-
Removes
|
|
12815
|
+
Removes the OperationsTasks this OperationsTaskList added to the Case (matched by source_task_list_id). Only untouched (not_started) tasks are deleted; started/completed/skipped tasks are kept. Returns deleted and kept counts. | authz: min_org_role=operator | () -> (OperationsTaskListRemoveFromCaseRes1)
|
|
12994
12816
|
|
|
12995
12817
|
</dd>
|
|
12996
12818
|
</dl>
|
|
@@ -13006,7 +12828,7 @@ Removes an operator from a department. | authz: min_org_role=administrator | ()
|
|
|
13006
12828
|
<dd>
|
|
13007
12829
|
|
|
13008
12830
|
```typescript
|
|
13009
|
-
await client.operations.
|
|
12831
|
+
await client.operations.operationsTaskLists.removeFromCaseV1("task_list_id", "case_id");
|
|
13010
12832
|
```
|
|
13011
12833
|
|
|
13012
12834
|
</dd>
|
|
@@ -13022,7 +12844,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
13022
12844
|
<dl>
|
|
13023
12845
|
<dd>
|
|
13024
12846
|
|
|
13025
|
-
**
|
|
12847
|
+
**taskListId:** `string`
|
|
13026
12848
|
|
|
13027
12849
|
</dd>
|
|
13028
12850
|
</dl>
|
|
@@ -13030,7 +12852,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
13030
12852
|
<dl>
|
|
13031
12853
|
<dd>
|
|
13032
12854
|
|
|
13033
|
-
**
|
|
12855
|
+
**caseId:** `string`
|
|
13034
12856
|
|
|
13035
12857
|
</dd>
|
|
13036
12858
|
</dl>
|
|
@@ -13038,7 +12860,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
13038
12860
|
<dl>
|
|
13039
12861
|
<dd>
|
|
13040
12862
|
|
|
13041
|
-
**requestOptions:** `
|
|
12863
|
+
**requestOptions:** `OperationsTaskLists.RequestOptions`
|
|
13042
12864
|
|
|
13043
12865
|
</dd>
|
|
13044
12866
|
</dl>
|
|
@@ -13063,7 +12885,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
13063
12885
|
<dl>
|
|
13064
12886
|
<dd>
|
|
13065
12887
|
|
|
13066
|
-
Lists
|
|
12888
|
+
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)
|
|
13067
12889
|
|
|
13068
12890
|
</dd>
|
|
13069
12891
|
</dl>
|
|
@@ -13084,8 +12906,9 @@ await client.operations.operationsTasks.listV1({
|
|
|
13084
12906
|
sort_order: "asc",
|
|
13085
12907
|
page: 1,
|
|
13086
12908
|
page_size: 1,
|
|
13087
|
-
|
|
13088
|
-
|
|
12909
|
+
filter_order_id: "filter_order_id",
|
|
12910
|
+
filter_department_id: "filter_department_id",
|
|
12911
|
+
filter_assigned_user_id: "filter_assigned_user_id",
|
|
13089
12912
|
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
13090
12913
|
filter_deadline_lte: "2024-01-15T09:30:00Z",
|
|
13091
12914
|
});
|
|
@@ -13332,7 +13155,7 @@ await client.operations.operationsTasks.updateV1("task_id");
|
|
|
13332
13155
|
<dl>
|
|
13333
13156
|
<dd>
|
|
13334
13157
|
|
|
13335
|
-
Creates a new OperationsTask on
|
|
13158
|
+
Creates a new OperationsTask on an Order the caller's organization has a Case for. | authz: min_org_role=operator | (OperationsTaskClientCreate1) -> (PydanticObjectId)
|
|
13336
13159
|
|
|
13337
13160
|
</dd>
|
|
13338
13161
|
</dl>
|
|
@@ -13350,7 +13173,8 @@ Creates a new OperationsTask on a Case owned by the caller's organization. | aut
|
|
|
13350
13173
|
```typescript
|
|
13351
13174
|
await client.operations.operationsTasks.createV1({
|
|
13352
13175
|
schema_version: 1,
|
|
13353
|
-
|
|
13176
|
+
order_id: "order_id",
|
|
13177
|
+
task_type: "review_order_details",
|
|
13354
13178
|
title: "title",
|
|
13355
13179
|
description: "description",
|
|
13356
13180
|
});
|
|
@@ -13514,7 +13338,7 @@ await client.operations.operationsTasks.uncompleteV1("task_id");
|
|
|
13514
13338
|
</dl>
|
|
13515
13339
|
</details>
|
|
13516
13340
|
|
|
13517
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">
|
|
13341
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateStatusV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13518
13342
|
<dl>
|
|
13519
13343
|
<dd>
|
|
13520
13344
|
|
|
@@ -13526,7 +13350,7 @@ await client.operations.operationsTasks.uncompleteV1("task_id");
|
|
|
13526
13350
|
<dl>
|
|
13527
13351
|
<dd>
|
|
13528
13352
|
|
|
13529
|
-
|
|
13353
|
+
Sets an OperationsTask's status (not_started / in_progress / completed / skipped). Setting COMPLETED stamps completed_at/by; any other status clears them. | authz: min_org_role=operator | (OperationsTaskStatusReq) -> (bool)
|
|
13530
13354
|
|
|
13531
13355
|
</dd>
|
|
13532
13356
|
</dl>
|
|
@@ -13542,8 +13366,8 @@ Appends a comment to an OperationsTask's comment thread. Returns the new comment
|
|
|
13542
13366
|
<dd>
|
|
13543
13367
|
|
|
13544
13368
|
```typescript
|
|
13545
|
-
await client.operations.operationsTasks.
|
|
13546
|
-
|
|
13369
|
+
await client.operations.operationsTasks.updateStatusV1("task_id", {
|
|
13370
|
+
status: "not_started",
|
|
13547
13371
|
});
|
|
13548
13372
|
```
|
|
13549
13373
|
|
|
@@ -13568,7 +13392,7 @@ await client.operations.operationsTasks.addCommentV1("task_id", {
|
|
|
13568
13392
|
<dl>
|
|
13569
13393
|
<dd>
|
|
13570
13394
|
|
|
13571
|
-
**request:** `Chrt.operations.
|
|
13395
|
+
**request:** `Chrt.operations.OperationsTaskStatusReq`
|
|
13572
13396
|
|
|
13573
13397
|
</dd>
|
|
13574
13398
|
</dl>
|
|
@@ -13587,7 +13411,7 @@ await client.operations.operationsTasks.addCommentV1("task_id", {
|
|
|
13587
13411
|
</dl>
|
|
13588
13412
|
</details>
|
|
13589
13413
|
|
|
13590
|
-
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">
|
|
13414
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">addCommentV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
13591
13415
|
<dl>
|
|
13592
13416
|
<dd>
|
|
13593
13417
|
|
|
@@ -13599,7 +13423,7 @@ await client.operations.operationsTasks.addCommentV1("task_id", {
|
|
|
13599
13423
|
<dl>
|
|
13600
13424
|
<dd>
|
|
13601
13425
|
|
|
13602
|
-
|
|
13426
|
+
Appends a comment to an OperationsTask's comment thread. Returns the new comment id. | authz: min_org_role=operator | (OperationsTaskAddCommentReq1) -> (str)
|
|
13603
13427
|
|
|
13604
13428
|
</dd>
|
|
13605
13429
|
</dl>
|
|
@@ -13615,7 +13439,9 @@ Deletes a comment from an OperationsTask's comment thread. 404 if the comment is
|
|
|
13615
13439
|
<dd>
|
|
13616
13440
|
|
|
13617
13441
|
```typescript
|
|
13618
|
-
await client.operations.operationsTasks.
|
|
13442
|
+
await client.operations.operationsTasks.addCommentV1("task_id", {
|
|
13443
|
+
comment: "comment",
|
|
13444
|
+
});
|
|
13619
13445
|
```
|
|
13620
13446
|
|
|
13621
13447
|
</dd>
|
|
@@ -13639,7 +13465,7 @@ await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id")
|
|
|
13639
13465
|
<dl>
|
|
13640
13466
|
<dd>
|
|
13641
13467
|
|
|
13642
|
-
**
|
|
13468
|
+
**request:** `Chrt.operations.OperationsTaskAddCommentReq1`
|
|
13643
13469
|
|
|
13644
13470
|
</dd>
|
|
13645
13471
|
</dl>
|
|
@@ -13658,9 +13484,7 @@ await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id")
|
|
|
13658
13484
|
</dl>
|
|
13659
13485
|
</details>
|
|
13660
13486
|
|
|
13661
|
-
|
|
13662
|
-
|
|
13663
|
-
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(caseS3ObjectMetadataId) -> Chrt.CaseS3ObjectMetadata1</code></summary>
|
|
13487
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">deleteCommentV1</a>(taskId, commentId) -> boolean</code></summary>
|
|
13664
13488
|
<dl>
|
|
13665
13489
|
<dd>
|
|
13666
13490
|
|
|
@@ -13672,7 +13496,7 @@ await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id")
|
|
|
13672
13496
|
<dl>
|
|
13673
13497
|
<dd>
|
|
13674
13498
|
|
|
13675
|
-
|
|
13499
|
+
Deletes a comment from an OperationsTask's comment thread. 404 if the comment isn't found. | authz: min_org_role=operator | () -> (bool)
|
|
13676
13500
|
|
|
13677
13501
|
</dd>
|
|
13678
13502
|
</dl>
|
|
@@ -13688,7 +13512,7 @@ Retrieves metadata for a case S3 object. | authz: min_org_role=operator | () ->
|
|
|
13688
13512
|
<dd>
|
|
13689
13513
|
|
|
13690
13514
|
```typescript
|
|
13691
|
-
await client.operations.
|
|
13515
|
+
await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id");
|
|
13692
13516
|
```
|
|
13693
13517
|
|
|
13694
13518
|
</dd>
|
|
@@ -13704,7 +13528,7 @@ await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_me
|
|
|
13704
13528
|
<dl>
|
|
13705
13529
|
<dd>
|
|
13706
13530
|
|
|
13707
|
-
**
|
|
13531
|
+
**taskId:** `string`
|
|
13708
13532
|
|
|
13709
13533
|
</dd>
|
|
13710
13534
|
</dl>
|
|
@@ -13712,7 +13536,15 @@ await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_me
|
|
|
13712
13536
|
<dl>
|
|
13713
13537
|
<dd>
|
|
13714
13538
|
|
|
13715
|
-
**
|
|
13539
|
+
**commentId:** `string`
|
|
13540
|
+
|
|
13541
|
+
</dd>
|
|
13542
|
+
</dl>
|
|
13543
|
+
|
|
13544
|
+
<dl>
|
|
13545
|
+
<dd>
|
|
13546
|
+
|
|
13547
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13716
13548
|
|
|
13717
13549
|
</dd>
|
|
13718
13550
|
</dl>
|
|
@@ -13723,7 +13555,9 @@ await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_me
|
|
|
13723
13555
|
</dl>
|
|
13724
13556
|
</details>
|
|
13725
13557
|
|
|
13726
|
-
|
|
13558
|
+
## Operations Cases S3Objects
|
|
13559
|
+
|
|
13560
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(caseS3ObjectMetadataId) -> Chrt.CaseS3ObjectMetadata1</code></summary>
|
|
13727
13561
|
<dl>
|
|
13728
13562
|
<dd>
|
|
13729
13563
|
|
|
@@ -13735,7 +13569,7 @@ await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_me
|
|
|
13735
13569
|
<dl>
|
|
13736
13570
|
<dd>
|
|
13737
13571
|
|
|
13738
|
-
|
|
13572
|
+
Retrieves metadata for a case S3 object. | authz: min_org_role=operator | () -> (CaseS3ObjectMetadata1)
|
|
13739
13573
|
|
|
13740
13574
|
</dd>
|
|
13741
13575
|
</dl>
|
|
@@ -13751,7 +13585,7 @@ Streams a case S3 object file from storage. | authz: min_org_role=operator | ()
|
|
|
13751
13585
|
<dd>
|
|
13752
13586
|
|
|
13753
13587
|
```typescript
|
|
13754
|
-
await client.operations.cases.s3Objects.
|
|
13588
|
+
await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_metadata_id");
|
|
13755
13589
|
```
|
|
13756
13590
|
|
|
13757
13591
|
</dd>
|
|
@@ -13786,7 +13620,7 @@ await client.operations.cases.s3Objects.getV1("case_s3_object_metadata_id");
|
|
|
13786
13620
|
</dl>
|
|
13787
13621
|
</details>
|
|
13788
13622
|
|
|
13789
|
-
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">
|
|
13623
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getV1</a>(caseS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
13790
13624
|
<dl>
|
|
13791
13625
|
<dd>
|
|
13792
13626
|
|
|
@@ -13798,7 +13632,7 @@ await client.operations.cases.s3Objects.getV1("case_s3_object_metadata_id");
|
|
|
13798
13632
|
<dl>
|
|
13799
13633
|
<dd>
|
|
13800
13634
|
|
|
13801
|
-
|
|
13635
|
+
Streams a case S3 object file from storage. | authz: min_org_role=operator | () -> (binary)
|
|
13802
13636
|
|
|
13803
13637
|
</dd>
|
|
13804
13638
|
</dl>
|
|
@@ -13814,9 +13648,7 @@ Uploads a file to a case. Automatic blurhash generation for images. | authz: min
|
|
|
13814
13648
|
<dd>
|
|
13815
13649
|
|
|
13816
13650
|
```typescript
|
|
13817
|
-
await client.operations.cases.s3Objects.
|
|
13818
|
-
file: fs.createReadStream("/path/to/your/file"),
|
|
13819
|
-
});
|
|
13651
|
+
await client.operations.cases.s3Objects.getV1("case_s3_object_metadata_id");
|
|
13820
13652
|
```
|
|
13821
13653
|
|
|
13822
13654
|
</dd>
|
|
@@ -13832,15 +13664,7 @@ await client.operations.cases.s3Objects.addV1("case_id", {
|
|
|
13832
13664
|
<dl>
|
|
13833
13665
|
<dd>
|
|
13834
13666
|
|
|
13835
|
-
**
|
|
13836
|
-
|
|
13837
|
-
</dd>
|
|
13838
|
-
</dl>
|
|
13839
|
-
|
|
13840
|
-
<dl>
|
|
13841
|
-
<dd>
|
|
13842
|
-
|
|
13843
|
-
**request:** `Chrt.operations.cases.BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost`
|
|
13667
|
+
**caseS3ObjectMetadataId:** `string`
|
|
13844
13668
|
|
|
13845
13669
|
</dd>
|
|
13846
13670
|
</dl>
|
|
@@ -13859,7 +13683,7 @@ await client.operations.cases.s3Objects.addV1("case_id", {
|
|
|
13859
13683
|
</dl>
|
|
13860
13684
|
</details>
|
|
13861
13685
|
|
|
13862
|
-
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">
|
|
13686
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">addV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
13863
13687
|
<dl>
|
|
13864
13688
|
<dd>
|
|
13865
13689
|
|
|
@@ -13871,7 +13695,7 @@ await client.operations.cases.s3Objects.addV1("case_id", {
|
|
|
13871
13695
|
<dl>
|
|
13872
13696
|
<dd>
|
|
13873
13697
|
|
|
13874
|
-
|
|
13698
|
+
Uploads a file to a case. Automatic blurhash generation for images. | authz: min_org_role=operator | (UploadFile) -> (bool)
|
|
13875
13699
|
|
|
13876
13700
|
</dd>
|
|
13877
13701
|
</dl>
|
|
@@ -13887,7 +13711,9 @@ Deletes an S3 object metadata and the associated S3 object from a case. Only the
|
|
|
13887
13711
|
<dd>
|
|
13888
13712
|
|
|
13889
13713
|
```typescript
|
|
13890
|
-
await client.operations.cases.s3Objects.
|
|
13714
|
+
await client.operations.cases.s3Objects.addV1("case_id", {
|
|
13715
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
13716
|
+
});
|
|
13891
13717
|
```
|
|
13892
13718
|
|
|
13893
13719
|
</dd>
|
|
@@ -13903,7 +13729,15 @@ await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
|
13903
13729
|
<dl>
|
|
13904
13730
|
<dd>
|
|
13905
13731
|
|
|
13906
|
-
**
|
|
13732
|
+
**caseId:** `string`
|
|
13733
|
+
|
|
13734
|
+
</dd>
|
|
13735
|
+
</dl>
|
|
13736
|
+
|
|
13737
|
+
<dl>
|
|
13738
|
+
<dd>
|
|
13739
|
+
|
|
13740
|
+
**request:** `Chrt.operations.cases.BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost`
|
|
13907
13741
|
|
|
13908
13742
|
</dd>
|
|
13909
13743
|
</dl>
|
|
@@ -13922,9 +13756,7 @@ await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
|
13922
13756
|
</dl>
|
|
13923
13757
|
</details>
|
|
13924
13758
|
|
|
13925
|
-
|
|
13926
|
-
|
|
13927
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>({ ...params }) -> Chrt.ShipperConnectionListRes</code></summary>
|
|
13759
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">deleteV1</a>(caseS3ObjectMetadataId) -> boolean</code></summary>
|
|
13928
13760
|
<dl>
|
|
13929
13761
|
<dd>
|
|
13930
13762
|
|
|
@@ -13936,7 +13768,7 @@ await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
|
13936
13768
|
<dl>
|
|
13937
13769
|
<dd>
|
|
13938
13770
|
|
|
13939
|
-
|
|
13771
|
+
Deletes an S3 object metadata and the associated S3 object from a case. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
13940
13772
|
|
|
13941
13773
|
</dd>
|
|
13942
13774
|
</dl>
|
|
@@ -13952,11 +13784,7 @@ Lists shipper organizations connected to the caller (caller must be a provider)
|
|
|
13952
13784
|
<dd>
|
|
13953
13785
|
|
|
13954
13786
|
```typescript
|
|
13955
|
-
await client.
|
|
13956
|
-
search: "search",
|
|
13957
|
-
page: 1,
|
|
13958
|
-
page_size: 1,
|
|
13959
|
-
});
|
|
13787
|
+
await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
13960
13788
|
```
|
|
13961
13789
|
|
|
13962
13790
|
</dd>
|
|
@@ -13972,7 +13800,7 @@ await client.orgs.connections.listShippersV1({
|
|
|
13972
13800
|
<dl>
|
|
13973
13801
|
<dd>
|
|
13974
13802
|
|
|
13975
|
-
**
|
|
13803
|
+
**caseS3ObjectMetadataId:** `string`
|
|
13976
13804
|
|
|
13977
13805
|
</dd>
|
|
13978
13806
|
</dl>
|
|
@@ -13980,7 +13808,7 @@ await client.orgs.connections.listShippersV1({
|
|
|
13980
13808
|
<dl>
|
|
13981
13809
|
<dd>
|
|
13982
13810
|
|
|
13983
|
-
**requestOptions:** `
|
|
13811
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
13984
13812
|
|
|
13985
13813
|
</dd>
|
|
13986
13814
|
</dl>
|
|
@@ -13991,7 +13819,9 @@ await client.orgs.connections.listShippersV1({
|
|
|
13991
13819
|
</dl>
|
|
13992
13820
|
</details>
|
|
13993
13821
|
|
|
13994
|
-
|
|
13822
|
+
## Orgs Connections
|
|
13823
|
+
|
|
13824
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>({ ...params }) -> Chrt.ShipperConnectionListRes</code></summary>
|
|
13995
13825
|
<dl>
|
|
13996
13826
|
<dd>
|
|
13997
13827
|
|
|
@@ -14003,7 +13833,7 @@ await client.orgs.connections.listShippersV1({
|
|
|
14003
13833
|
<dl>
|
|
14004
13834
|
<dd>
|
|
14005
13835
|
|
|
14006
|
-
Lists
|
|
13836
|
+
Lists shipper organizations connected to the caller (caller must be a provider) with optional search by company name or handle. | () -> (ShipperConnectionListRes)
|
|
14007
13837
|
|
|
14008
13838
|
</dd>
|
|
14009
13839
|
</dl>
|
|
@@ -14019,7 +13849,7 @@ Lists provider organizations connected to the caller. Shippers see providers fro
|
|
|
14019
13849
|
<dd>
|
|
14020
13850
|
|
|
14021
13851
|
```typescript
|
|
14022
|
-
await client.orgs.connections.
|
|
13852
|
+
await client.orgs.connections.listShippersV1({
|
|
14023
13853
|
search: "search",
|
|
14024
13854
|
page: 1,
|
|
14025
13855
|
page_size: 1,
|
|
@@ -14039,7 +13869,7 @@ await client.orgs.connections.listProvidersV1({
|
|
|
14039
13869
|
<dl>
|
|
14040
13870
|
<dd>
|
|
14041
13871
|
|
|
14042
|
-
**request:** `Chrt.orgs.
|
|
13872
|
+
**request:** `Chrt.orgs.ConnectionsListShippersV1Request`
|
|
14043
13873
|
|
|
14044
13874
|
</dd>
|
|
14045
13875
|
</dl>
|
|
@@ -14058,7 +13888,7 @@ await client.orgs.connections.listProvidersV1({
|
|
|
14058
13888
|
</dl>
|
|
14059
13889
|
</details>
|
|
14060
13890
|
|
|
14061
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
13891
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listProvidersV1</a>({ ...params }) -> Chrt.ProviderConnectionListRes</code></summary>
|
|
14062
13892
|
<dl>
|
|
14063
13893
|
<dd>
|
|
14064
13894
|
|
|
@@ -14070,7 +13900,7 @@ await client.orgs.connections.listProvidersV1({
|
|
|
14070
13900
|
<dl>
|
|
14071
13901
|
<dd>
|
|
14072
13902
|
|
|
14073
|
-
|
|
13903
|
+
Lists provider organizations connected to the caller. Shippers see providers from shipper_provider_connections; providers see other providers from provider_provider_connections (in either direction). | () -> (ProviderConnectionListRes)
|
|
14074
13904
|
|
|
14075
13905
|
</dd>
|
|
14076
13906
|
</dl>
|
|
@@ -14086,7 +13916,11 @@ Gets the connection between caller's org and the org with the specified handle.
|
|
|
14086
13916
|
<dd>
|
|
14087
13917
|
|
|
14088
13918
|
```typescript
|
|
14089
|
-
await client.orgs.connections.
|
|
13919
|
+
await client.orgs.connections.listProvidersV1({
|
|
13920
|
+
search: "search",
|
|
13921
|
+
page: 1,
|
|
13922
|
+
page_size: 1,
|
|
13923
|
+
});
|
|
14090
13924
|
```
|
|
14091
13925
|
|
|
14092
13926
|
</dd>
|
|
@@ -14102,7 +13936,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14102
13936
|
<dl>
|
|
14103
13937
|
<dd>
|
|
14104
13938
|
|
|
14105
|
-
**
|
|
13939
|
+
**request:** `Chrt.orgs.ConnectionsListProvidersV1Request`
|
|
14106
13940
|
|
|
14107
13941
|
</dd>
|
|
14108
13942
|
</dl>
|
|
@@ -14121,7 +13955,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14121
13955
|
</dl>
|
|
14122
13956
|
</details>
|
|
14123
13957
|
|
|
14124
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
13958
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">getByHandleV1</a>(handle) -> (Chrt.ConnectionsGetByHandleV1Response | null) | undefined</code></summary>
|
|
14125
13959
|
<dl>
|
|
14126
13960
|
<dd>
|
|
14127
13961
|
|
|
@@ -14133,7 +13967,7 @@ await client.orgs.connections.getByHandleV1("handle");
|
|
|
14133
13967
|
<dl>
|
|
14134
13968
|
<dd>
|
|
14135
13969
|
|
|
14136
|
-
|
|
13970
|
+
Gets the connection between caller's org and the org with the specified handle. | () -> (ShipperProviderConnection1 | ProviderProviderConnection1 | None)
|
|
14137
13971
|
|
|
14138
13972
|
</dd>
|
|
14139
13973
|
</dl>
|
|
@@ -14149,9 +13983,7 @@ Creates a new connection to a provider organization. Shippers create a shipper-p
|
|
|
14149
13983
|
<dd>
|
|
14150
13984
|
|
|
14151
13985
|
```typescript
|
|
14152
|
-
await client.orgs.connections.
|
|
14153
|
-
handle: "handle",
|
|
14154
|
-
});
|
|
13986
|
+
await client.orgs.connections.getByHandleV1("handle");
|
|
14155
13987
|
```
|
|
14156
13988
|
|
|
14157
13989
|
</dd>
|
|
@@ -14167,7 +13999,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14167
13999
|
<dl>
|
|
14168
14000
|
<dd>
|
|
14169
14001
|
|
|
14170
|
-
**
|
|
14002
|
+
**handle:** `string`
|
|
14171
14003
|
|
|
14172
14004
|
</dd>
|
|
14173
14005
|
</dl>
|
|
@@ -14186,7 +14018,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14186
14018
|
</dl>
|
|
14187
14019
|
</details>
|
|
14188
14020
|
|
|
14189
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14021
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToProviderV1</a>({ ...params }) -> string</code></summary>
|
|
14190
14022
|
<dl>
|
|
14191
14023
|
<dd>
|
|
14192
14024
|
|
|
@@ -14198,7 +14030,7 @@ await client.orgs.connections.createConnectionToProviderV1({
|
|
|
14198
14030
|
<dl>
|
|
14199
14031
|
<dd>
|
|
14200
14032
|
|
|
14201
|
-
Creates a new connection to a
|
|
14033
|
+
Creates a new connection to a provider organization. Shippers create a shipper-provider connection. Providers create a provider-provider connection where the initiator is the coordinator (payer) and the target is the executor (payee). | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14202
14034
|
|
|
14203
14035
|
</dd>
|
|
14204
14036
|
</dl>
|
|
@@ -14214,7 +14046,7 @@ Creates a new connection to a shipper organization. Only providers can initiate
|
|
|
14214
14046
|
<dd>
|
|
14215
14047
|
|
|
14216
14048
|
```typescript
|
|
14217
|
-
await client.orgs.connections.
|
|
14049
|
+
await client.orgs.connections.createConnectionToProviderV1({
|
|
14218
14050
|
handle: "handle",
|
|
14219
14051
|
});
|
|
14220
14052
|
```
|
|
@@ -14251,7 +14083,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14251
14083
|
</dl>
|
|
14252
14084
|
</details>
|
|
14253
14085
|
|
|
14254
|
-
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">
|
|
14086
|
+
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">createConnectionToShipperV1</a>({ ...params }) -> string</code></summary>
|
|
14255
14087
|
<dl>
|
|
14256
14088
|
<dd>
|
|
14257
14089
|
|
|
@@ -14263,7 +14095,7 @@ await client.orgs.connections.createConnectionToShipperV1({
|
|
|
14263
14095
|
<dl>
|
|
14264
14096
|
<dd>
|
|
14265
14097
|
|
|
14266
|
-
|
|
14098
|
+
Creates a new connection to a shipper organization. Only providers can initiate connections to shippers. | (CreateConnectionReq) -> (PydanticObjectId)
|
|
14267
14099
|
|
|
14268
14100
|
</dd>
|
|
14269
14101
|
</dl>
|
|
@@ -14279,7 +14111,9 @@ Sets or clears the department on a connection. Send null to clear. | authz: min_
|
|
|
14279
14111
|
<dd>
|
|
14280
14112
|
|
|
14281
14113
|
```typescript
|
|
14282
|
-
await client.orgs.connections.
|
|
14114
|
+
await client.orgs.connections.createConnectionToShipperV1({
|
|
14115
|
+
handle: "handle",
|
|
14116
|
+
});
|
|
14283
14117
|
```
|
|
14284
14118
|
|
|
14285
14119
|
</dd>
|
|
@@ -14295,15 +14129,7 @@ await client.orgs.connections.setDepartmentV1("connection_id");
|
|
|
14295
14129
|
<dl>
|
|
14296
14130
|
<dd>
|
|
14297
14131
|
|
|
14298
|
-
**
|
|
14299
|
-
|
|
14300
|
-
</dd>
|
|
14301
|
-
</dl>
|
|
14302
|
-
|
|
14303
|
-
<dl>
|
|
14304
|
-
<dd>
|
|
14305
|
-
|
|
14306
|
-
**request:** `Chrt.orgs.SetDepartmentReq`
|
|
14132
|
+
**request:** `Chrt.CreateConnectionReq`
|
|
14307
14133
|
|
|
14308
14134
|
</dd>
|
|
14309
14135
|
</dl>
|
|
@@ -16625,6 +16451,80 @@ await client.orgs.orgInfoForConnections.provider.updateV1();
|
|
|
16625
16451
|
|
|
16626
16452
|
## Shipping Drivers
|
|
16627
16453
|
|
|
16454
|
+
<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>
|
|
16455
|
+
<dl>
|
|
16456
|
+
<dd>
|
|
16457
|
+
|
|
16458
|
+
#### 📝 Description
|
|
16459
|
+
|
|
16460
|
+
<dl>
|
|
16461
|
+
<dd>
|
|
16462
|
+
|
|
16463
|
+
<dl>
|
|
16464
|
+
<dd>
|
|
16465
|
+
|
|
16466
|
+
Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)
|
|
16467
|
+
|
|
16468
|
+
</dd>
|
|
16469
|
+
</dl>
|
|
16470
|
+
</dd>
|
|
16471
|
+
</dl>
|
|
16472
|
+
|
|
16473
|
+
#### 🔌 Usage
|
|
16474
|
+
|
|
16475
|
+
<dl>
|
|
16476
|
+
<dd>
|
|
16477
|
+
|
|
16478
|
+
<dl>
|
|
16479
|
+
<dd>
|
|
16480
|
+
|
|
16481
|
+
```typescript
|
|
16482
|
+
await client.shipping.drivers.getStatsV1("driver_id", {
|
|
16483
|
+
start_timestamp: "2024-01-15T09:30:00Z",
|
|
16484
|
+
end_timestamp: "2024-01-15T09:30:00Z",
|
|
16485
|
+
});
|
|
16486
|
+
```
|
|
16487
|
+
|
|
16488
|
+
</dd>
|
|
16489
|
+
</dl>
|
|
16490
|
+
</dd>
|
|
16491
|
+
</dl>
|
|
16492
|
+
|
|
16493
|
+
#### ⚙️ Parameters
|
|
16494
|
+
|
|
16495
|
+
<dl>
|
|
16496
|
+
<dd>
|
|
16497
|
+
|
|
16498
|
+
<dl>
|
|
16499
|
+
<dd>
|
|
16500
|
+
|
|
16501
|
+
**driverId:** `string`
|
|
16502
|
+
|
|
16503
|
+
</dd>
|
|
16504
|
+
</dl>
|
|
16505
|
+
|
|
16506
|
+
<dl>
|
|
16507
|
+
<dd>
|
|
16508
|
+
|
|
16509
|
+
**request:** `Chrt.shipping.DriverStatsReq`
|
|
16510
|
+
|
|
16511
|
+
</dd>
|
|
16512
|
+
</dl>
|
|
16513
|
+
|
|
16514
|
+
<dl>
|
|
16515
|
+
<dd>
|
|
16516
|
+
|
|
16517
|
+
**requestOptions:** `Drivers.RequestOptions`
|
|
16518
|
+
|
|
16519
|
+
</dd>
|
|
16520
|
+
</dl>
|
|
16521
|
+
</dd>
|
|
16522
|
+
</dl>
|
|
16523
|
+
|
|
16524
|
+
</dd>
|
|
16525
|
+
</dl>
|
|
16526
|
+
</details>
|
|
16527
|
+
|
|
16628
16528
|
<details><summary><code>client.shipping.drivers.<a href="/src/api/resources/shipping/resources/drivers/client/Client.ts">getForCallerV1</a>() -> Chrt.Driver1</code></summary>
|
|
16629
16529
|
<dl>
|
|
16630
16530
|
<dd>
|
|
@@ -17841,7 +17741,7 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
17841
17741
|
<dl>
|
|
17842
17742
|
<dd>
|
|
17843
17743
|
|
|
17844
|
-
Cancels an order and
|
|
17744
|
+
Cancels an order and non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | () -> (bool)
|
|
17845
17745
|
|
|
17846
17746
|
</dd>
|
|
17847
17747
|
</dl>
|
|
@@ -17892,6 +17792,71 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17892
17792
|
</dl>
|
|
17893
17793
|
</details>
|
|
17894
17794
|
|
|
17795
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
17796
|
+
<dl>
|
|
17797
|
+
<dd>
|
|
17798
|
+
|
|
17799
|
+
#### 📝 Description
|
|
17800
|
+
|
|
17801
|
+
<dl>
|
|
17802
|
+
<dd>
|
|
17803
|
+
|
|
17804
|
+
<dl>
|
|
17805
|
+
<dd>
|
|
17806
|
+
|
|
17807
|
+
Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[lig_owner_operators] | (OrdersCancelManyReq) -> (bool)
|
|
17808
|
+
|
|
17809
|
+
</dd>
|
|
17810
|
+
</dl>
|
|
17811
|
+
</dd>
|
|
17812
|
+
</dl>
|
|
17813
|
+
|
|
17814
|
+
#### 🔌 Usage
|
|
17815
|
+
|
|
17816
|
+
<dl>
|
|
17817
|
+
<dd>
|
|
17818
|
+
|
|
17819
|
+
<dl>
|
|
17820
|
+
<dd>
|
|
17821
|
+
|
|
17822
|
+
```typescript
|
|
17823
|
+
await client.shipping.orders.cancelManyV1({
|
|
17824
|
+
order_ids: ["order_ids"],
|
|
17825
|
+
});
|
|
17826
|
+
```
|
|
17827
|
+
|
|
17828
|
+
</dd>
|
|
17829
|
+
</dl>
|
|
17830
|
+
</dd>
|
|
17831
|
+
</dl>
|
|
17832
|
+
|
|
17833
|
+
#### ⚙️ Parameters
|
|
17834
|
+
|
|
17835
|
+
<dl>
|
|
17836
|
+
<dd>
|
|
17837
|
+
|
|
17838
|
+
<dl>
|
|
17839
|
+
<dd>
|
|
17840
|
+
|
|
17841
|
+
**request:** `Chrt.shipping.OrdersCancelManyReq`
|
|
17842
|
+
|
|
17843
|
+
</dd>
|
|
17844
|
+
</dl>
|
|
17845
|
+
|
|
17846
|
+
<dl>
|
|
17847
|
+
<dd>
|
|
17848
|
+
|
|
17849
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17850
|
+
|
|
17851
|
+
</dd>
|
|
17852
|
+
</dl>
|
|
17853
|
+
</dd>
|
|
17854
|
+
</dl>
|
|
17855
|
+
|
|
17856
|
+
</dd>
|
|
17857
|
+
</dl>
|
|
17858
|
+
</details>
|
|
17859
|
+
|
|
17895
17860
|
## Shipping OrderDrafts
|
|
17896
17861
|
|
|
17897
17862
|
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">newV1</a>({ ...params }) -> Chrt.OrdersNewDraftRes</code></summary>
|
|
@@ -18091,6 +18056,71 @@ await client.shipping.orderDrafts.deleteV1("order_id");
|
|
|
18091
18056
|
</dl>
|
|
18092
18057
|
</details>
|
|
18093
18058
|
|
|
18059
|
+
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">deleteManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
18060
|
+
<dl>
|
|
18061
|
+
<dd>
|
|
18062
|
+
|
|
18063
|
+
#### 📝 Description
|
|
18064
|
+
|
|
18065
|
+
<dl>
|
|
18066
|
+
<dd>
|
|
18067
|
+
|
|
18068
|
+
<dl>
|
|
18069
|
+
<dd>
|
|
18070
|
+
|
|
18071
|
+
Deletes multiple draft orders and associated entities. | (OrdersDraftDeleteManyReq) -> (bool)
|
|
18072
|
+
|
|
18073
|
+
</dd>
|
|
18074
|
+
</dl>
|
|
18075
|
+
</dd>
|
|
18076
|
+
</dl>
|
|
18077
|
+
|
|
18078
|
+
#### 🔌 Usage
|
|
18079
|
+
|
|
18080
|
+
<dl>
|
|
18081
|
+
<dd>
|
|
18082
|
+
|
|
18083
|
+
<dl>
|
|
18084
|
+
<dd>
|
|
18085
|
+
|
|
18086
|
+
```typescript
|
|
18087
|
+
await client.shipping.orderDrafts.deleteManyV1({
|
|
18088
|
+
order_ids: ["order_ids"],
|
|
18089
|
+
});
|
|
18090
|
+
```
|
|
18091
|
+
|
|
18092
|
+
</dd>
|
|
18093
|
+
</dl>
|
|
18094
|
+
</dd>
|
|
18095
|
+
</dl>
|
|
18096
|
+
|
|
18097
|
+
#### ⚙️ Parameters
|
|
18098
|
+
|
|
18099
|
+
<dl>
|
|
18100
|
+
<dd>
|
|
18101
|
+
|
|
18102
|
+
<dl>
|
|
18103
|
+
<dd>
|
|
18104
|
+
|
|
18105
|
+
**request:** `Chrt.shipping.OrdersDraftDeleteManyReq`
|
|
18106
|
+
|
|
18107
|
+
</dd>
|
|
18108
|
+
</dl>
|
|
18109
|
+
|
|
18110
|
+
<dl>
|
|
18111
|
+
<dd>
|
|
18112
|
+
|
|
18113
|
+
**requestOptions:** `OrderDrafts.RequestOptions`
|
|
18114
|
+
|
|
18115
|
+
</dd>
|
|
18116
|
+
</dl>
|
|
18117
|
+
</dd>
|
|
18118
|
+
</dl>
|
|
18119
|
+
|
|
18120
|
+
</dd>
|
|
18121
|
+
</dl>
|
|
18122
|
+
</details>
|
|
18123
|
+
|
|
18094
18124
|
<details><summary><code>client.shipping.orderDrafts.<a href="/src/api/resources/shipping/resources/orderDrafts/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
18095
18125
|
<dl>
|
|
18096
18126
|
<dd>
|
|
@@ -22009,7 +22039,7 @@ for await (const item of response) {
|
|
|
22009
22039
|
<dl>
|
|
22010
22040
|
<dd>
|
|
22011
22041
|
|
|
22012
|
-
Adds a task group to an existing order draft.
|
|
22042
|
+
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)
|
|
22013
22043
|
|
|
22014
22044
|
</dd>
|
|
22015
22045
|
</dl>
|
|
@@ -22205,6 +22235,276 @@ await client.shipping.orderDrafts.taskGroup.setVehicleTypeV1("task_group_id");
|
|
|
22205
22235
|
</dl>
|
|
22206
22236
|
</details>
|
|
22207
22237
|
|
|
22238
|
+
<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>
|
|
22239
|
+
<dl>
|
|
22240
|
+
<dd>
|
|
22241
|
+
|
|
22242
|
+
#### 📝 Description
|
|
22243
|
+
|
|
22244
|
+
<dl>
|
|
22245
|
+
<dd>
|
|
22246
|
+
|
|
22247
|
+
<dl>
|
|
22248
|
+
<dd>
|
|
22249
|
+
|
|
22250
|
+
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)
|
|
22251
|
+
|
|
22252
|
+
</dd>
|
|
22253
|
+
</dl>
|
|
22254
|
+
</dd>
|
|
22255
|
+
</dl>
|
|
22256
|
+
|
|
22257
|
+
#### 🔌 Usage
|
|
22258
|
+
|
|
22259
|
+
<dl>
|
|
22260
|
+
<dd>
|
|
22261
|
+
|
|
22262
|
+
<dl>
|
|
22263
|
+
<dd>
|
|
22264
|
+
|
|
22265
|
+
```typescript
|
|
22266
|
+
await client.shipping.orderDrafts.taskGroup.addExecutorV1("task_group_id");
|
|
22267
|
+
```
|
|
22268
|
+
|
|
22269
|
+
</dd>
|
|
22270
|
+
</dl>
|
|
22271
|
+
</dd>
|
|
22272
|
+
</dl>
|
|
22273
|
+
|
|
22274
|
+
#### ⚙️ Parameters
|
|
22275
|
+
|
|
22276
|
+
<dl>
|
|
22277
|
+
<dd>
|
|
22278
|
+
|
|
22279
|
+
<dl>
|
|
22280
|
+
<dd>
|
|
22281
|
+
|
|
22282
|
+
**taskGroupId:** `string`
|
|
22283
|
+
|
|
22284
|
+
</dd>
|
|
22285
|
+
</dl>
|
|
22286
|
+
|
|
22287
|
+
<dl>
|
|
22288
|
+
<dd>
|
|
22289
|
+
|
|
22290
|
+
**request:** `Chrt.shipping.orderDrafts.OrderDraftAddExecutorReq`
|
|
22291
|
+
|
|
22292
|
+
</dd>
|
|
22293
|
+
</dl>
|
|
22294
|
+
|
|
22295
|
+
<dl>
|
|
22296
|
+
<dd>
|
|
22297
|
+
|
|
22298
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22299
|
+
|
|
22300
|
+
</dd>
|
|
22301
|
+
</dl>
|
|
22302
|
+
</dd>
|
|
22303
|
+
</dl>
|
|
22304
|
+
|
|
22305
|
+
</dd>
|
|
22306
|
+
</dl>
|
|
22307
|
+
</details>
|
|
22308
|
+
|
|
22309
|
+
<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>
|
|
22310
|
+
<dl>
|
|
22311
|
+
<dd>
|
|
22312
|
+
|
|
22313
|
+
#### 📝 Description
|
|
22314
|
+
|
|
22315
|
+
<dl>
|
|
22316
|
+
<dd>
|
|
22317
|
+
|
|
22318
|
+
<dl>
|
|
22319
|
+
<dd>
|
|
22320
|
+
|
|
22321
|
+
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)
|
|
22322
|
+
|
|
22323
|
+
</dd>
|
|
22324
|
+
</dl>
|
|
22325
|
+
</dd>
|
|
22326
|
+
</dl>
|
|
22327
|
+
|
|
22328
|
+
#### 🔌 Usage
|
|
22329
|
+
|
|
22330
|
+
<dl>
|
|
22331
|
+
<dd>
|
|
22332
|
+
|
|
22333
|
+
<dl>
|
|
22334
|
+
<dd>
|
|
22335
|
+
|
|
22336
|
+
```typescript
|
|
22337
|
+
await client.shipping.orderDrafts.taskGroup.removeExecutorV1("task_group_id");
|
|
22338
|
+
```
|
|
22339
|
+
|
|
22340
|
+
</dd>
|
|
22341
|
+
</dl>
|
|
22342
|
+
</dd>
|
|
22343
|
+
</dl>
|
|
22344
|
+
|
|
22345
|
+
#### ⚙️ Parameters
|
|
22346
|
+
|
|
22347
|
+
<dl>
|
|
22348
|
+
<dd>
|
|
22349
|
+
|
|
22350
|
+
<dl>
|
|
22351
|
+
<dd>
|
|
22352
|
+
|
|
22353
|
+
**taskGroupId:** `string`
|
|
22354
|
+
|
|
22355
|
+
</dd>
|
|
22356
|
+
</dl>
|
|
22357
|
+
|
|
22358
|
+
<dl>
|
|
22359
|
+
<dd>
|
|
22360
|
+
|
|
22361
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22362
|
+
|
|
22363
|
+
</dd>
|
|
22364
|
+
</dl>
|
|
22365
|
+
</dd>
|
|
22366
|
+
</dl>
|
|
22367
|
+
|
|
22368
|
+
</dd>
|
|
22369
|
+
</dl>
|
|
22370
|
+
</details>
|
|
22371
|
+
|
|
22372
|
+
<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>
|
|
22373
|
+
<dl>
|
|
22374
|
+
<dd>
|
|
22375
|
+
|
|
22376
|
+
#### 📝 Description
|
|
22377
|
+
|
|
22378
|
+
<dl>
|
|
22379
|
+
<dd>
|
|
22380
|
+
|
|
22381
|
+
<dl>
|
|
22382
|
+
<dd>
|
|
22383
|
+
|
|
22384
|
+
Assigns or swaps the driver on a draft task group. Only the executor org may assign drivers. | authz_personas=[executor_org_operators] | (OrderDraftUpdateDriverReq) -> (bool)
|
|
22385
|
+
|
|
22386
|
+
</dd>
|
|
22387
|
+
</dl>
|
|
22388
|
+
</dd>
|
|
22389
|
+
</dl>
|
|
22390
|
+
|
|
22391
|
+
#### 🔌 Usage
|
|
22392
|
+
|
|
22393
|
+
<dl>
|
|
22394
|
+
<dd>
|
|
22395
|
+
|
|
22396
|
+
<dl>
|
|
22397
|
+
<dd>
|
|
22398
|
+
|
|
22399
|
+
```typescript
|
|
22400
|
+
await client.shipping.orderDrafts.taskGroup.updateDriverV1("task_group_id", {
|
|
22401
|
+
driver_id: "driver_id",
|
|
22402
|
+
});
|
|
22403
|
+
```
|
|
22404
|
+
|
|
22405
|
+
</dd>
|
|
22406
|
+
</dl>
|
|
22407
|
+
</dd>
|
|
22408
|
+
</dl>
|
|
22409
|
+
|
|
22410
|
+
#### ⚙️ Parameters
|
|
22411
|
+
|
|
22412
|
+
<dl>
|
|
22413
|
+
<dd>
|
|
22414
|
+
|
|
22415
|
+
<dl>
|
|
22416
|
+
<dd>
|
|
22417
|
+
|
|
22418
|
+
**taskGroupId:** `string`
|
|
22419
|
+
|
|
22420
|
+
</dd>
|
|
22421
|
+
</dl>
|
|
22422
|
+
|
|
22423
|
+
<dl>
|
|
22424
|
+
<dd>
|
|
22425
|
+
|
|
22426
|
+
**request:** `Chrt.shipping.orderDrafts.OrderDraftUpdateDriverReq`
|
|
22427
|
+
|
|
22428
|
+
</dd>
|
|
22429
|
+
</dl>
|
|
22430
|
+
|
|
22431
|
+
<dl>
|
|
22432
|
+
<dd>
|
|
22433
|
+
|
|
22434
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22435
|
+
|
|
22436
|
+
</dd>
|
|
22437
|
+
</dl>
|
|
22438
|
+
</dd>
|
|
22439
|
+
</dl>
|
|
22440
|
+
|
|
22441
|
+
</dd>
|
|
22442
|
+
</dl>
|
|
22443
|
+
</details>
|
|
22444
|
+
|
|
22445
|
+
<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>
|
|
22446
|
+
<dl>
|
|
22447
|
+
<dd>
|
|
22448
|
+
|
|
22449
|
+
#### 📝 Description
|
|
22450
|
+
|
|
22451
|
+
<dl>
|
|
22452
|
+
<dd>
|
|
22453
|
+
|
|
22454
|
+
<dl>
|
|
22455
|
+
<dd>
|
|
22456
|
+
|
|
22457
|
+
Clears the driver on a draft task group. Only the executor org may remove drivers. | authz_personas=[executor_org_operators] | () -> (bool)
|
|
22458
|
+
|
|
22459
|
+
</dd>
|
|
22460
|
+
</dl>
|
|
22461
|
+
</dd>
|
|
22462
|
+
</dl>
|
|
22463
|
+
|
|
22464
|
+
#### 🔌 Usage
|
|
22465
|
+
|
|
22466
|
+
<dl>
|
|
22467
|
+
<dd>
|
|
22468
|
+
|
|
22469
|
+
<dl>
|
|
22470
|
+
<dd>
|
|
22471
|
+
|
|
22472
|
+
```typescript
|
|
22473
|
+
await client.shipping.orderDrafts.taskGroup.removeDriverV1("task_group_id");
|
|
22474
|
+
```
|
|
22475
|
+
|
|
22476
|
+
</dd>
|
|
22477
|
+
</dl>
|
|
22478
|
+
</dd>
|
|
22479
|
+
</dl>
|
|
22480
|
+
|
|
22481
|
+
#### ⚙️ Parameters
|
|
22482
|
+
|
|
22483
|
+
<dl>
|
|
22484
|
+
<dd>
|
|
22485
|
+
|
|
22486
|
+
<dl>
|
|
22487
|
+
<dd>
|
|
22488
|
+
|
|
22489
|
+
**taskGroupId:** `string`
|
|
22490
|
+
|
|
22491
|
+
</dd>
|
|
22492
|
+
</dl>
|
|
22493
|
+
|
|
22494
|
+
<dl>
|
|
22495
|
+
<dd>
|
|
22496
|
+
|
|
22497
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22498
|
+
|
|
22499
|
+
</dd>
|
|
22500
|
+
</dl>
|
|
22501
|
+
</dd>
|
|
22502
|
+
</dl>
|
|
22503
|
+
|
|
22504
|
+
</dd>
|
|
22505
|
+
</dl>
|
|
22506
|
+
</details>
|
|
22507
|
+
|
|
22208
22508
|
<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>
|
|
22209
22509
|
<dl>
|
|
22210
22510
|
<dd>
|
|
@@ -23475,11 +23775,10 @@ await client.shipping.orders.expanded.listForCoordinatorOperatorsV1({
|
|
|
23475
23775
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23476
23776
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23477
23777
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23778
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23779
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23478
23780
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23479
23781
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23480
|
-
filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23481
|
-
filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23482
|
-
filter_order_cancelled: true,
|
|
23483
23782
|
filter_executor_org_id: "filter_executor_org_id",
|
|
23484
23783
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
23485
23784
|
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|
|
@@ -23561,11 +23860,10 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
|
|
|
23561
23860
|
filter_in_progress_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23562
23861
|
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23563
23862
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23863
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23864
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23564
23865
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23565
23866
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23566
|
-
filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
23567
|
-
filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
23568
|
-
filter_order_cancelled: true,
|
|
23569
23867
|
filter_executor_org_id: "filter_executor_org_id",
|
|
23570
23868
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
23571
23869
|
body: {},
|
|
@@ -24889,9 +25187,10 @@ await client.shipping.taskGroups.expanded.listForExecutorOperatorsV1({
|
|
|
24889
25187
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24890
25188
|
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24891
25189
|
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25190
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25191
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24892
25192
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24893
25193
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24894
|
-
filter_order_cancelled: true,
|
|
24895
25194
|
filter_driver_id: "filter_driver_id",
|
|
24896
25195
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
24897
25196
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
@@ -24976,9 +25275,10 @@ await client.shipping.taskGroups.expanded.listForDriverForExecutorV1({
|
|
|
24976
25275
|
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24977
25276
|
filter_skipped_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24978
25277
|
filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
25278
|
+
filter_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
25279
|
+
filter_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24979
25280
|
filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24980
25281
|
filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24981
|
-
filter_order_cancelled: true,
|
|
24982
25282
|
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
24983
25283
|
filter_shipper_org_id: "filter_shipper_org_id",
|
|
24984
25284
|
filter_off_chrt_shipper_org_id: "filter_off_chrt_shipper_org_id",
|