@chrt-inc/typescript-sdk 1.691.0 → 1.702.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/operations/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/operations/client/Client.js +12 -2
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +100 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +394 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.ts +15 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/Client.d.ts +150 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/Client.js +581 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksAdd1.d.ts +11 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksAdd1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.d.ts +11 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistClientCreate1.d.ts +17 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistClientCreate1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistsListV1Request.d.ts +24 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/ChecklistsListV1Request.js +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/operations/resources/checklists/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/operations/resources/checklists/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/checklists/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/operations/resources/index.js +5 -1
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.d.ts +170 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/Client.js +653 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskAddCommentReq1.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskAddCommentReq1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.d.ts +19 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.ts +33 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.js +5 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/operationsTasks/index.js +17 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.js +63 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.d.ts +11 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.js +63 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.d.ts +11 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.js +5 -0
- package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.js +75 -0
- package/dist/cjs/api/types/AiImageDescription.d.ts +30 -0
- package/dist/cjs/api/types/AiImageDescription.js +5 -0
- package/dist/cjs/api/types/Case1.d.ts +4 -0
- package/dist/cjs/api/types/CaseChecksDisableReq.d.ts +7 -0
- package/dist/cjs/api/types/CaseChecksDisableReq.js +5 -0
- package/dist/cjs/api/types/CaseChecksDismissReq.d.ts +8 -0
- package/dist/cjs/api/types/CaseChecksDismissReq.js +5 -0
- package/dist/cjs/api/types/CaseChecksSummary1.d.ts +27 -0
- package/dist/cjs/api/types/CaseChecksSummary1.js +5 -0
- package/dist/cjs/api/types/Check1.d.ts +33 -0
- package/dist/cjs/api/types/Check1.js +5 -0
- package/dist/cjs/api/types/CheckEnum.d.ts +46 -0
- package/dist/cjs/api/types/CheckEnum.js +23 -0
- package/dist/cjs/api/types/CheckStatusEnum.d.ts +32 -0
- package/dist/cjs/api/types/CheckStatusEnum.js +15 -0
- package/dist/cjs/api/types/Checklist1.d.ts +18 -0
- package/dist/cjs/api/types/Checklist1.js +5 -0
- package/dist/cjs/api/types/ChecklistCheck1.d.ts +15 -0
- package/dist/cjs/api/types/ChecklistCheck1.js +5 -0
- package/dist/cjs/api/types/ChecklistListRes.d.ts +8 -0
- package/dist/cjs/api/types/ChecklistListRes.js +5 -0
- package/dist/cjs/api/types/ChecklistSortByEnum.d.ts +9 -0
- package/dist/cjs/api/types/ChecklistSortByEnum.js +11 -0
- package/dist/cjs/api/types/DriverComplianceDocument1.d.ts +1 -0
- package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.d.ts +16 -1
- package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.js +15 -0
- package/dist/cjs/api/types/LlmModelEnum.d.ts +12 -0
- package/dist/cjs/api/types/LlmModelEnum.js +14 -0
- package/dist/cjs/api/types/OperationsTask1.d.ts +19 -0
- package/dist/cjs/api/types/OperationsTask1.js +5 -0
- package/dist/cjs/api/types/OperationsTaskComment1.d.ts +10 -0
- package/dist/cjs/api/types/OperationsTaskComment1.js +5 -0
- package/dist/cjs/api/types/OperationsTaskListRes.d.ts +8 -0
- package/dist/cjs/api/types/OperationsTaskListRes.js +5 -0
- package/dist/cjs/api/types/OperationsTaskSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/OperationsTaskSortByEnum.js +10 -0
- package/dist/cjs/api/types/OrgComplianceDocument1.d.ts +1 -0
- package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.d.ts +11 -1
- package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.js +10 -0
- package/dist/cjs/api/types/TaskArtifactS3ObjectMetadata1.d.ts +2 -0
- package/dist/cjs/api/types/index.d.ts +16 -0
- package/dist/cjs/api/types/index.js +16 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/operations/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/operations/client/Client.mjs +10 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +100 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +394 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksApplyChecklistReq.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.d.mts +15 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseChecksRecordImageAnalysisResultsReq.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/Client.d.mts +150 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/Client.mjs +544 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistChecksAdd1.d.mts +11 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistChecksAdd1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.d.mts +11 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistChecksRemove1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistClientCreate1.d.mts +17 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistsListV1Request.d.mts +24 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/ChecklistsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/operations/resources/checklists/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/checklists/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/checklists/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/operations/resources/index.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.d.mts +170 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/Client.mjs +616 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskAddCommentReq1.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskAddCommentReq1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.d.mts +19 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientCreate1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTaskClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.d.mts +33 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/OperationsTasksListV1Request.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/operationsTasks/index.mjs +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.mjs +63 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.d.mts +11 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.mjs +63 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.d.mts +11 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.mjs +4 -0
- package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs +75 -0
- package/dist/esm/api/types/AiImageDescription.d.mts +30 -0
- package/dist/esm/api/types/AiImageDescription.mjs +4 -0
- package/dist/esm/api/types/Case1.d.mts +4 -0
- package/dist/esm/api/types/CaseChecksDisableReq.d.mts +7 -0
- package/dist/esm/api/types/CaseChecksDisableReq.mjs +4 -0
- package/dist/esm/api/types/CaseChecksDismissReq.d.mts +8 -0
- package/dist/esm/api/types/CaseChecksDismissReq.mjs +4 -0
- package/dist/esm/api/types/CaseChecksSummary1.d.mts +27 -0
- package/dist/esm/api/types/CaseChecksSummary1.mjs +4 -0
- package/dist/esm/api/types/Check1.d.mts +33 -0
- package/dist/esm/api/types/Check1.mjs +4 -0
- package/dist/esm/api/types/CheckEnum.d.mts +46 -0
- package/dist/esm/api/types/CheckEnum.mjs +20 -0
- package/dist/esm/api/types/CheckStatusEnum.d.mts +32 -0
- package/dist/esm/api/types/CheckStatusEnum.mjs +12 -0
- package/dist/esm/api/types/Checklist1.d.mts +18 -0
- package/dist/esm/api/types/Checklist1.mjs +4 -0
- package/dist/esm/api/types/ChecklistCheck1.d.mts +15 -0
- package/dist/esm/api/types/ChecklistCheck1.mjs +4 -0
- package/dist/esm/api/types/ChecklistListRes.d.mts +8 -0
- package/dist/esm/api/types/ChecklistListRes.mjs +4 -0
- package/dist/esm/api/types/ChecklistSortByEnum.d.mts +9 -0
- package/dist/esm/api/types/ChecklistSortByEnum.mjs +8 -0
- package/dist/esm/api/types/DriverComplianceDocument1.d.mts +1 -0
- package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.d.mts +16 -1
- package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.mjs +15 -0
- package/dist/esm/api/types/LlmModelEnum.d.mts +12 -0
- package/dist/esm/api/types/LlmModelEnum.mjs +11 -0
- package/dist/esm/api/types/OperationsTask1.d.mts +19 -0
- package/dist/esm/api/types/OperationsTask1.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskComment1.d.mts +10 -0
- package/dist/esm/api/types/OperationsTaskComment1.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskListRes.d.mts +8 -0
- package/dist/esm/api/types/OperationsTaskListRes.mjs +4 -0
- package/dist/esm/api/types/OperationsTaskSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/OperationsTaskSortByEnum.mjs +7 -0
- package/dist/esm/api/types/OrgComplianceDocument1.d.mts +1 -0
- package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.d.mts +11 -1
- package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.mjs +10 -0
- package/dist/esm/api/types/TaskArtifactS3ObjectMetadata1.d.mts +2 -0
- package/dist/esm/api/types/index.d.mts +16 -0
- package/dist/esm/api/types/index.mjs +16 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +1957 -142
package/reference.md
CHANGED
|
@@ -10762,7 +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">
|
|
10765
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">recordImageAnalysisResultsV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
|
|
10766
10766
|
<dl>
|
|
10767
10767
|
<dd>
|
|
10768
10768
|
|
|
@@ -10774,7 +10774,7 @@ await client.notifications.webhookSetup.turnOffV1();
|
|
|
10774
10774
|
<dl>
|
|
10775
10775
|
<dd>
|
|
10776
10776
|
|
|
10777
|
-
|
|
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
10778
|
|
|
10779
10779
|
</dd>
|
|
10780
10780
|
</dl>
|
|
@@ -10790,14 +10790,10 @@ Lists cases for the caller's organization with filtering, sorting, and paginatio
|
|
|
10790
10790
|
<dd>
|
|
10791
10791
|
|
|
10792
10792
|
```typescript
|
|
10793
|
-
await client.operations.cases.
|
|
10794
|
-
|
|
10795
|
-
|
|
10796
|
-
|
|
10797
|
-
page_size: 1,
|
|
10798
|
-
filter_assigned_operator_user_id: "filter_assigned_operator_user_id",
|
|
10799
|
-
filter_needs_action: true,
|
|
10800
|
-
filter_unassigned: true,
|
|
10793
|
+
await client.operations.cases.recordImageAnalysisResultsV1("task_artifact_id", {
|
|
10794
|
+
results: {
|
|
10795
|
+
key: "not_started",
|
|
10796
|
+
},
|
|
10801
10797
|
});
|
|
10802
10798
|
```
|
|
10803
10799
|
|
|
@@ -10814,7 +10810,15 @@ await client.operations.cases.listV1({
|
|
|
10814
10810
|
<dl>
|
|
10815
10811
|
<dd>
|
|
10816
10812
|
|
|
10817
|
-
**
|
|
10813
|
+
**taskArtifactId:** `string`
|
|
10814
|
+
|
|
10815
|
+
</dd>
|
|
10816
|
+
</dl>
|
|
10817
|
+
|
|
10818
|
+
<dl>
|
|
10819
|
+
<dd>
|
|
10820
|
+
|
|
10821
|
+
**request:** `Chrt.operations.CaseChecksRecordImageAnalysisResultsReq`
|
|
10818
10822
|
|
|
10819
10823
|
</dd>
|
|
10820
10824
|
</dl>
|
|
@@ -10833,7 +10837,7 @@ await client.operations.cases.listV1({
|
|
|
10833
10837
|
</dl>
|
|
10834
10838
|
</details>
|
|
10835
10839
|
|
|
10836
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
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>
|
|
10837
10841
|
<dl>
|
|
10838
10842
|
<dd>
|
|
10839
10843
|
|
|
@@ -10845,7 +10849,7 @@ await client.operations.cases.listV1({
|
|
|
10845
10849
|
<dl>
|
|
10846
10850
|
<dd>
|
|
10847
10851
|
|
|
10848
|
-
|
|
10852
|
+
Adds the Checklist's checks to the Case's enabled_check_keys (deduped) and records the Checklist id. Does not touch existing check runs. Idempotent. | authz: min_org_role=operator | (CaseChecksApplyChecklistReq) -> (bool)
|
|
10849
10853
|
|
|
10850
10854
|
</dd>
|
|
10851
10855
|
</dl>
|
|
@@ -10861,7 +10865,9 @@ Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
|
|
|
10861
10865
|
<dd>
|
|
10862
10866
|
|
|
10863
10867
|
```typescript
|
|
10864
|
-
await client.operations.cases.
|
|
10868
|
+
await client.operations.cases.applyChecklistV1("case_id", {
|
|
10869
|
+
checklist_id: "checklist_id",
|
|
10870
|
+
});
|
|
10865
10871
|
```
|
|
10866
10872
|
|
|
10867
10873
|
</dd>
|
|
@@ -10885,6 +10891,14 @@ await client.operations.cases.getV1("case_id");
|
|
|
10885
10891
|
<dl>
|
|
10886
10892
|
<dd>
|
|
10887
10893
|
|
|
10894
|
+
**request:** `Chrt.operations.CaseChecksApplyChecklistReq`
|
|
10895
|
+
|
|
10896
|
+
</dd>
|
|
10897
|
+
</dl>
|
|
10898
|
+
|
|
10899
|
+
<dl>
|
|
10900
|
+
<dd>
|
|
10901
|
+
|
|
10888
10902
|
**requestOptions:** `Cases.RequestOptions`
|
|
10889
10903
|
|
|
10890
10904
|
</dd>
|
|
@@ -10896,7 +10910,7 @@ await client.operations.cases.getV1("case_id");
|
|
|
10896
10910
|
</dl>
|
|
10897
10911
|
</details>
|
|
10898
10912
|
|
|
10899
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10913
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">disableCheckV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
10900
10914
|
<dl>
|
|
10901
10915
|
<dd>
|
|
10902
10916
|
|
|
@@ -10908,7 +10922,7 @@ await client.operations.cases.getV1("case_id");
|
|
|
10908
10922
|
<dl>
|
|
10909
10923
|
<dd>
|
|
10910
10924
|
|
|
10911
|
-
|
|
10925
|
+
Adds a CheckEnum to the Case's disabled_check_keys (operator override). The Checklist that enabled the check stays applied; the workflow's effective set becomes enabled - disabled. Requires the CheckEnum to currently be in enabled_check_keys; otherwise 400. Existing check runs are untouched — operators dismiss them individually if they also want them out of summary counts. | authz: min_org_role=operator | (CaseChecksDisableReq) -> (bool)
|
|
10912
10926
|
|
|
10913
10927
|
</dd>
|
|
10914
10928
|
</dl>
|
|
@@ -10924,7 +10938,9 @@ Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpda
|
|
|
10924
10938
|
<dd>
|
|
10925
10939
|
|
|
10926
10940
|
```typescript
|
|
10927
|
-
await client.operations.cases.
|
|
10941
|
+
await client.operations.cases.disableCheckV1("case_id", {
|
|
10942
|
+
check: "shipping.order.placed.order_details_reviewed",
|
|
10943
|
+
});
|
|
10928
10944
|
```
|
|
10929
10945
|
|
|
10930
10946
|
</dd>
|
|
@@ -10948,7 +10964,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
10948
10964
|
<dl>
|
|
10949
10965
|
<dd>
|
|
10950
10966
|
|
|
10951
|
-
**request:** `Chrt.
|
|
10967
|
+
**request:** `Chrt.CaseChecksDisableReq`
|
|
10952
10968
|
|
|
10953
10969
|
</dd>
|
|
10954
10970
|
</dl>
|
|
@@ -10967,7 +10983,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
10967
10983
|
</dl>
|
|
10968
10984
|
</details>
|
|
10969
10985
|
|
|
10970
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
10986
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">enableCheckV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
10971
10987
|
<dl>
|
|
10972
10988
|
<dd>
|
|
10973
10989
|
|
|
@@ -10979,7 +10995,7 @@ await client.operations.cases.updateV1("case_id");
|
|
|
10979
10995
|
<dl>
|
|
10980
10996
|
<dd>
|
|
10981
10997
|
|
|
10982
|
-
|
|
10998
|
+
Removes a CheckEnum from the Case's disabled_check_keys, restoring it to the workflow's effective set. Inverse of disable. No-op if the CheckEnum isn't currently disabled. | authz: min_org_role=operator | (CaseChecksDisableReq) -> (bool)
|
|
10983
10999
|
|
|
10984
11000
|
</dd>
|
|
10985
11001
|
</dl>
|
|
@@ -10995,7 +11011,9 @@ Retrieves the case for a given shipping order. | authz: min_org_role=operator |
|
|
|
10995
11011
|
<dd>
|
|
10996
11012
|
|
|
10997
11013
|
```typescript
|
|
10998
|
-
await client.operations.cases.
|
|
11014
|
+
await client.operations.cases.enableCheckV1("case_id", {
|
|
11015
|
+
check: "shipping.order.placed.order_details_reviewed",
|
|
11016
|
+
});
|
|
10999
11017
|
```
|
|
11000
11018
|
|
|
11001
11019
|
</dd>
|
|
@@ -11011,7 +11029,15 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11011
11029
|
<dl>
|
|
11012
11030
|
<dd>
|
|
11013
11031
|
|
|
11014
|
-
**
|
|
11032
|
+
**caseId:** `string`
|
|
11033
|
+
|
|
11034
|
+
</dd>
|
|
11035
|
+
</dl>
|
|
11036
|
+
|
|
11037
|
+
<dl>
|
|
11038
|
+
<dd>
|
|
11039
|
+
|
|
11040
|
+
**request:** `Chrt.CaseChecksDisableReq`
|
|
11015
11041
|
|
|
11016
11042
|
</dd>
|
|
11017
11043
|
</dl>
|
|
@@ -11030,7 +11056,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11030
11056
|
</dl>
|
|
11031
11057
|
</details>
|
|
11032
11058
|
|
|
11033
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11059
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">dismissCheckV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11034
11060
|
<dl>
|
|
11035
11061
|
<dd>
|
|
11036
11062
|
|
|
@@ -11042,7 +11068,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11042
11068
|
<dl>
|
|
11043
11069
|
<dd>
|
|
11044
11070
|
|
|
11045
|
-
|
|
11071
|
+
Transitions one (check, entity_id) Check1 to status=DISMISSED. Does not affect other runs of the same check on different entity_ids. | authz: min_org_role=operator | (CaseChecksDismissReq) -> (bool)
|
|
11046
11072
|
|
|
11047
11073
|
</dd>
|
|
11048
11074
|
</dl>
|
|
@@ -11058,7 +11084,10 @@ Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | a
|
|
|
11058
11084
|
<dd>
|
|
11059
11085
|
|
|
11060
11086
|
```typescript
|
|
11061
|
-
await client.operations.cases.
|
|
11087
|
+
await client.operations.cases.dismissCheckV1("case_id", {
|
|
11088
|
+
check: "shipping.order.placed.order_details_reviewed",
|
|
11089
|
+
entity_id: "entity_id",
|
|
11090
|
+
});
|
|
11062
11091
|
```
|
|
11063
11092
|
|
|
11064
11093
|
</dd>
|
|
@@ -11074,7 +11103,15 @@ await client.operations.cases.getByOrderRefV1("order_ref");
|
|
|
11074
11103
|
<dl>
|
|
11075
11104
|
<dd>
|
|
11076
11105
|
|
|
11077
|
-
**
|
|
11106
|
+
**caseId:** `string`
|
|
11107
|
+
|
|
11108
|
+
</dd>
|
|
11109
|
+
</dl>
|
|
11110
|
+
|
|
11111
|
+
<dl>
|
|
11112
|
+
<dd>
|
|
11113
|
+
|
|
11114
|
+
**request:** `Chrt.CaseChecksDismissReq`
|
|
11078
11115
|
|
|
11079
11116
|
</dd>
|
|
11080
11117
|
</dl>
|
|
@@ -11093,7 +11130,7 @@ await client.operations.cases.getByOrderRefV1("order_ref");
|
|
|
11093
11130
|
</dl>
|
|
11094
11131
|
</details>
|
|
11095
11132
|
|
|
11096
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11133
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">undismissCheckV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11097
11134
|
<dl>
|
|
11098
11135
|
<dd>
|
|
11099
11136
|
|
|
@@ -11105,7 +11142,7 @@ await client.operations.cases.getByOrderRefV1("order_ref");
|
|
|
11105
11142
|
<dl>
|
|
11106
11143
|
<dd>
|
|
11107
11144
|
|
|
11108
|
-
|
|
11145
|
+
Transitions a DISMISSED (check, entity_id) Check1 back to NOT_STARTED so the next matching event re-evaluates it. No-op if not currently DISMISSED. | authz: min_org_role=operator | (CaseChecksDismissReq) -> (bool)
|
|
11109
11146
|
|
|
11110
11147
|
</dd>
|
|
11111
11148
|
</dl>
|
|
@@ -11121,7 +11158,10 @@ Retrieves the case for a given order short ID. | authz: min_org_role=operator |
|
|
|
11121
11158
|
<dd>
|
|
11122
11159
|
|
|
11123
11160
|
```typescript
|
|
11124
|
-
await client.operations.cases.
|
|
11161
|
+
await client.operations.cases.undismissCheckV1("case_id", {
|
|
11162
|
+
check: "shipping.order.placed.order_details_reviewed",
|
|
11163
|
+
entity_id: "entity_id",
|
|
11164
|
+
});
|
|
11125
11165
|
```
|
|
11126
11166
|
|
|
11127
11167
|
</dd>
|
|
@@ -11137,7 +11177,15 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11137
11177
|
<dl>
|
|
11138
11178
|
<dd>
|
|
11139
11179
|
|
|
11140
|
-
**
|
|
11180
|
+
**caseId:** `string`
|
|
11181
|
+
|
|
11182
|
+
</dd>
|
|
11183
|
+
</dl>
|
|
11184
|
+
|
|
11185
|
+
<dl>
|
|
11186
|
+
<dd>
|
|
11187
|
+
|
|
11188
|
+
**request:** `Chrt.CaseChecksDismissReq`
|
|
11141
11189
|
|
|
11142
11190
|
</dd>
|
|
11143
11191
|
</dl>
|
|
@@ -11156,7 +11204,7 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11156
11204
|
</dl>
|
|
11157
11205
|
</details>
|
|
11158
11206
|
|
|
11159
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11207
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">listV1</a>({ ...params }) -> Chrt.CaseListRes</code></summary>
|
|
11160
11208
|
<dl>
|
|
11161
11209
|
<dd>
|
|
11162
11210
|
|
|
@@ -11168,7 +11216,7 @@ await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
|
11168
11216
|
<dl>
|
|
11169
11217
|
<dd>
|
|
11170
11218
|
|
|
11171
|
-
|
|
11219
|
+
Lists cases for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (CaseListRes)
|
|
11172
11220
|
|
|
11173
11221
|
</dd>
|
|
11174
11222
|
</dl>
|
|
@@ -11184,8 +11232,14 @@ Updates whether a case needs action. | authz: min_org_role=operator | (CaseNeeds
|
|
|
11184
11232
|
<dd>
|
|
11185
11233
|
|
|
11186
11234
|
```typescript
|
|
11187
|
-
await client.operations.cases.
|
|
11188
|
-
|
|
11235
|
+
await client.operations.cases.listV1({
|
|
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,
|
|
11189
11243
|
});
|
|
11190
11244
|
```
|
|
11191
11245
|
|
|
@@ -11202,15 +11256,7 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11202
11256
|
<dl>
|
|
11203
11257
|
<dd>
|
|
11204
11258
|
|
|
11205
|
-
**
|
|
11206
|
-
|
|
11207
|
-
</dd>
|
|
11208
|
-
</dl>
|
|
11209
|
-
|
|
11210
|
-
<dl>
|
|
11211
|
-
<dd>
|
|
11212
|
-
|
|
11213
|
-
**request:** `Chrt.operations.CaseNeedsActionReq`
|
|
11259
|
+
**request:** `Chrt.operations.CasesListV1Request`
|
|
11214
11260
|
|
|
11215
11261
|
</dd>
|
|
11216
11262
|
</dl>
|
|
@@ -11229,7 +11275,7 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11229
11275
|
</dl>
|
|
11230
11276
|
</details>
|
|
11231
11277
|
|
|
11232
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11278
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getV1</a>(caseId) -> Chrt.Case1</code></summary>
|
|
11233
11279
|
<dl>
|
|
11234
11280
|
<dd>
|
|
11235
11281
|
|
|
@@ -11241,7 +11287,7 @@ await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
|
11241
11287
|
<dl>
|
|
11242
11288
|
<dd>
|
|
11243
11289
|
|
|
11244
|
-
|
|
11290
|
+
Retrieves a single case. | authz: min_org_role=operator | () -> (Case1)
|
|
11245
11291
|
|
|
11246
11292
|
</dd>
|
|
11247
11293
|
</dl>
|
|
@@ -11257,9 +11303,7 @@ Updates a case's status. Closing a case also clears needs_action. | authz: min_o
|
|
|
11257
11303
|
<dd>
|
|
11258
11304
|
|
|
11259
11305
|
```typescript
|
|
11260
|
-
await client.operations.cases.
|
|
11261
|
-
status: "open",
|
|
11262
|
-
});
|
|
11306
|
+
await client.operations.cases.getV1("case_id");
|
|
11263
11307
|
```
|
|
11264
11308
|
|
|
11265
11309
|
</dd>
|
|
@@ -11283,14 +11327,6 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11283
11327
|
<dl>
|
|
11284
11328
|
<dd>
|
|
11285
11329
|
|
|
11286
|
-
**request:** `Chrt.operations.CaseStatusReq`
|
|
11287
|
-
|
|
11288
|
-
</dd>
|
|
11289
|
-
</dl>
|
|
11290
|
-
|
|
11291
|
-
<dl>
|
|
11292
|
-
<dd>
|
|
11293
|
-
|
|
11294
11330
|
**requestOptions:** `Cases.RequestOptions`
|
|
11295
11331
|
|
|
11296
11332
|
</dd>
|
|
@@ -11302,7 +11338,7 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11302
11338
|
</dl>
|
|
11303
11339
|
</details>
|
|
11304
11340
|
|
|
11305
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11341
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11306
11342
|
<dl>
|
|
11307
11343
|
<dd>
|
|
11308
11344
|
|
|
@@ -11314,7 +11350,7 @@ await client.operations.cases.updateStatusV1("case_id", {
|
|
|
11314
11350
|
<dl>
|
|
11315
11351
|
<dd>
|
|
11316
11352
|
|
|
11317
|
-
|
|
11353
|
+
Updates a case's department_id. | authz: min_org_role=operator | (CaseClientUpdate1) -> (bool)
|
|
11318
11354
|
|
|
11319
11355
|
</dd>
|
|
11320
11356
|
</dl>
|
|
@@ -11330,9 +11366,7 @@ Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) ->
|
|
|
11330
11366
|
<dd>
|
|
11331
11367
|
|
|
11332
11368
|
```typescript
|
|
11333
|
-
await client.operations.cases.
|
|
11334
|
-
operator_user_ids: ["operator_user_ids"],
|
|
11335
|
-
});
|
|
11369
|
+
await client.operations.cases.updateV1("case_id");
|
|
11336
11370
|
```
|
|
11337
11371
|
|
|
11338
11372
|
</dd>
|
|
@@ -11356,7 +11390,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11356
11390
|
<dl>
|
|
11357
11391
|
<dd>
|
|
11358
11392
|
|
|
11359
|
-
**request:** `Chrt.operations.
|
|
11393
|
+
**request:** `Chrt.operations.CaseClientUpdate1`
|
|
11360
11394
|
|
|
11361
11395
|
</dd>
|
|
11362
11396
|
</dl>
|
|
@@ -11375,7 +11409,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11375
11409
|
</dl>
|
|
11376
11410
|
</details>
|
|
11377
11411
|
|
|
11378
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11412
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderV1</a>(orderId) -> Chrt.Case1</code></summary>
|
|
11379
11413
|
<dl>
|
|
11380
11414
|
<dd>
|
|
11381
11415
|
|
|
@@ -11387,7 +11421,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11387
11421
|
<dl>
|
|
11388
11422
|
<dd>
|
|
11389
11423
|
|
|
11390
|
-
|
|
11424
|
+
Retrieves the case for a given shipping order. | authz: min_org_role=operator | () -> (Case1)
|
|
11391
11425
|
|
|
11392
11426
|
</dd>
|
|
11393
11427
|
</dl>
|
|
@@ -11403,9 +11437,7 @@ Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignR
|
|
|
11403
11437
|
<dd>
|
|
11404
11438
|
|
|
11405
11439
|
```typescript
|
|
11406
|
-
await client.operations.cases.
|
|
11407
|
-
operator_user_ids: ["operator_user_ids"],
|
|
11408
|
-
});
|
|
11440
|
+
await client.operations.cases.getByOrderV1("order_id");
|
|
11409
11441
|
```
|
|
11410
11442
|
|
|
11411
11443
|
</dd>
|
|
@@ -11421,15 +11453,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11421
11453
|
<dl>
|
|
11422
11454
|
<dd>
|
|
11423
11455
|
|
|
11424
|
-
**
|
|
11425
|
-
|
|
11426
|
-
</dd>
|
|
11427
|
-
</dl>
|
|
11428
|
-
|
|
11429
|
-
<dl>
|
|
11430
|
-
<dd>
|
|
11431
|
-
|
|
11432
|
-
**request:** `Chrt.operations.CaseUnassignReq`
|
|
11456
|
+
**orderId:** `string`
|
|
11433
11457
|
|
|
11434
11458
|
</dd>
|
|
11435
11459
|
</dl>
|
|
@@ -11448,7 +11472,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11448
11472
|
</dl>
|
|
11449
11473
|
</details>
|
|
11450
11474
|
|
|
11451
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
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>
|
|
11452
11476
|
<dl>
|
|
11453
11477
|
<dd>
|
|
11454
11478
|
|
|
@@ -11460,7 +11484,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11460
11484
|
<dl>
|
|
11461
11485
|
<dd>
|
|
11462
11486
|
|
|
11463
|
-
|
|
11487
|
+
Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11464
11488
|
|
|
11465
11489
|
</dd>
|
|
11466
11490
|
</dl>
|
|
@@ -11476,9 +11500,7 @@ Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq
|
|
|
11476
11500
|
<dd>
|
|
11477
11501
|
|
|
11478
11502
|
```typescript
|
|
11479
|
-
await client.operations.cases.
|
|
11480
|
-
message: "message",
|
|
11481
|
-
});
|
|
11503
|
+
await client.operations.cases.getByOrderRefV1("order_ref");
|
|
11482
11504
|
```
|
|
11483
11505
|
|
|
11484
11506
|
</dd>
|
|
@@ -11494,7 +11516,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11494
11516
|
<dl>
|
|
11495
11517
|
<dd>
|
|
11496
11518
|
|
|
11497
|
-
**
|
|
11519
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
11498
11520
|
|
|
11499
11521
|
</dd>
|
|
11500
11522
|
</dl>
|
|
@@ -11502,7 +11524,62 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11502
11524
|
<dl>
|
|
11503
11525
|
<dd>
|
|
11504
11526
|
|
|
11505
|
-
**
|
|
11527
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11528
|
+
|
|
11529
|
+
</dd>
|
|
11530
|
+
</dl>
|
|
11531
|
+
</dd>
|
|
11532
|
+
</dl>
|
|
11533
|
+
|
|
11534
|
+
</dd>
|
|
11535
|
+
</dl>
|
|
11536
|
+
</details>
|
|
11537
|
+
|
|
11538
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderShortIdV1</a>(orderShortId) -> Chrt.Case1</code></summary>
|
|
11539
|
+
<dl>
|
|
11540
|
+
<dd>
|
|
11541
|
+
|
|
11542
|
+
#### 📝 Description
|
|
11543
|
+
|
|
11544
|
+
<dl>
|
|
11545
|
+
<dd>
|
|
11546
|
+
|
|
11547
|
+
<dl>
|
|
11548
|
+
<dd>
|
|
11549
|
+
|
|
11550
|
+
Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11551
|
+
|
|
11552
|
+
</dd>
|
|
11553
|
+
</dl>
|
|
11554
|
+
</dd>
|
|
11555
|
+
</dl>
|
|
11556
|
+
|
|
11557
|
+
#### 🔌 Usage
|
|
11558
|
+
|
|
11559
|
+
<dl>
|
|
11560
|
+
<dd>
|
|
11561
|
+
|
|
11562
|
+
<dl>
|
|
11563
|
+
<dd>
|
|
11564
|
+
|
|
11565
|
+
```typescript
|
|
11566
|
+
await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
11567
|
+
```
|
|
11568
|
+
|
|
11569
|
+
</dd>
|
|
11570
|
+
</dl>
|
|
11571
|
+
</dd>
|
|
11572
|
+
</dl>
|
|
11573
|
+
|
|
11574
|
+
#### ⚙️ Parameters
|
|
11575
|
+
|
|
11576
|
+
<dl>
|
|
11577
|
+
<dd>
|
|
11578
|
+
|
|
11579
|
+
<dl>
|
|
11580
|
+
<dd>
|
|
11581
|
+
|
|
11582
|
+
**orderShortId:** `string`
|
|
11506
11583
|
|
|
11507
11584
|
</dd>
|
|
11508
11585
|
</dl>
|
|
@@ -11521,7 +11598,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11521
11598
|
</dl>
|
|
11522
11599
|
</details>
|
|
11523
11600
|
|
|
11524
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11601
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateNeedsActionV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11525
11602
|
<dl>
|
|
11526
11603
|
<dd>
|
|
11527
11604
|
|
|
@@ -11533,7 +11610,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11533
11610
|
<dl>
|
|
11534
11611
|
<dd>
|
|
11535
11612
|
|
|
11536
|
-
|
|
11613
|
+
Updates whether a case needs action. | authz: min_org_role=operator | (CaseNeedsActionReq) -> (bool)
|
|
11537
11614
|
|
|
11538
11615
|
</dd>
|
|
11539
11616
|
</dl>
|
|
@@ -11549,7 +11626,9 @@ Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
|
11549
11626
|
<dd>
|
|
11550
11627
|
|
|
11551
11628
|
```typescript
|
|
11552
|
-
await client.operations.cases.
|
|
11629
|
+
await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
11630
|
+
needs_action: true,
|
|
11631
|
+
});
|
|
11553
11632
|
```
|
|
11554
11633
|
|
|
11555
11634
|
</dd>
|
|
@@ -11573,7 +11652,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
11573
11652
|
<dl>
|
|
11574
11653
|
<dd>
|
|
11575
11654
|
|
|
11576
|
-
**
|
|
11655
|
+
**request:** `Chrt.operations.CaseNeedsActionReq`
|
|
11577
11656
|
|
|
11578
11657
|
</dd>
|
|
11579
11658
|
</dl>
|
|
@@ -11592,9 +11671,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
11592
11671
|
</dl>
|
|
11593
11672
|
</details>
|
|
11594
11673
|
|
|
11595
|
-
|
|
11596
|
-
|
|
11597
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11674
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateStatusV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11598
11675
|
<dl>
|
|
11599
11676
|
<dd>
|
|
11600
11677
|
|
|
@@ -11606,7 +11683,7 @@ await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
|
11606
11683
|
<dl>
|
|
11607
11684
|
<dd>
|
|
11608
11685
|
|
|
11609
|
-
|
|
11686
|
+
Updates a case's status. Closing a case also clears needs_action. | authz: min_org_role=operator | (CaseStatusReq) -> (bool)
|
|
11610
11687
|
|
|
11611
11688
|
</dd>
|
|
11612
11689
|
</dl>
|
|
@@ -11622,11 +11699,8 @@ Lists department configurations for the caller's organization. | authz: min_org_
|
|
|
11622
11699
|
<dd>
|
|
11623
11700
|
|
|
11624
11701
|
```typescript
|
|
11625
|
-
await client.operations.
|
|
11626
|
-
|
|
11627
|
-
sort_order: "asc",
|
|
11628
|
-
page: 1,
|
|
11629
|
-
page_size: 1,
|
|
11702
|
+
await client.operations.cases.updateStatusV1("case_id", {
|
|
11703
|
+
status: "open",
|
|
11630
11704
|
});
|
|
11631
11705
|
```
|
|
11632
11706
|
|
|
@@ -11643,7 +11717,7 @@ await client.operations.departments.listV1({
|
|
|
11643
11717
|
<dl>
|
|
11644
11718
|
<dd>
|
|
11645
11719
|
|
|
11646
|
-
**
|
|
11720
|
+
**caseId:** `string`
|
|
11647
11721
|
|
|
11648
11722
|
</dd>
|
|
11649
11723
|
</dl>
|
|
@@ -11651,7 +11725,15 @@ await client.operations.departments.listV1({
|
|
|
11651
11725
|
<dl>
|
|
11652
11726
|
<dd>
|
|
11653
11727
|
|
|
11654
|
-
**
|
|
11728
|
+
**request:** `Chrt.operations.CaseStatusReq`
|
|
11729
|
+
|
|
11730
|
+
</dd>
|
|
11731
|
+
</dl>
|
|
11732
|
+
|
|
11733
|
+
<dl>
|
|
11734
|
+
<dd>
|
|
11735
|
+
|
|
11736
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11655
11737
|
|
|
11656
11738
|
</dd>
|
|
11657
11739
|
</dl>
|
|
@@ -11662,7 +11744,7 @@ await client.operations.departments.listV1({
|
|
|
11662
11744
|
</dl>
|
|
11663
11745
|
</details>
|
|
11664
11746
|
|
|
11665
|
-
<details><summary><code>client.operations.
|
|
11747
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">assignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11666
11748
|
<dl>
|
|
11667
11749
|
<dd>
|
|
11668
11750
|
|
|
@@ -11674,7 +11756,7 @@ await client.operations.departments.listV1({
|
|
|
11674
11756
|
<dl>
|
|
11675
11757
|
<dd>
|
|
11676
11758
|
|
|
11677
|
-
|
|
11759
|
+
Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
|
|
11678
11760
|
|
|
11679
11761
|
</dd>
|
|
11680
11762
|
</dl>
|
|
@@ -11690,7 +11772,9 @@ Retrieves a single department configuration. | authz: min_org_role=operator | ()
|
|
|
11690
11772
|
<dd>
|
|
11691
11773
|
|
|
11692
11774
|
```typescript
|
|
11693
|
-
await client.operations.
|
|
11775
|
+
await client.operations.cases.assignV1("case_id", {
|
|
11776
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11777
|
+
});
|
|
11694
11778
|
```
|
|
11695
11779
|
|
|
11696
11780
|
</dd>
|
|
@@ -11706,7 +11790,1518 @@ await client.operations.departments.getV1("department_id");
|
|
|
11706
11790
|
<dl>
|
|
11707
11791
|
<dd>
|
|
11708
11792
|
|
|
11709
|
-
**
|
|
11793
|
+
**caseId:** `string`
|
|
11794
|
+
|
|
11795
|
+
</dd>
|
|
11796
|
+
</dl>
|
|
11797
|
+
|
|
11798
|
+
<dl>
|
|
11799
|
+
<dd>
|
|
11800
|
+
|
|
11801
|
+
**request:** `Chrt.operations.CaseAssignReq`
|
|
11802
|
+
|
|
11803
|
+
</dd>
|
|
11804
|
+
</dl>
|
|
11805
|
+
|
|
11806
|
+
<dl>
|
|
11807
|
+
<dd>
|
|
11808
|
+
|
|
11809
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11810
|
+
|
|
11811
|
+
</dd>
|
|
11812
|
+
</dl>
|
|
11813
|
+
</dd>
|
|
11814
|
+
</dl>
|
|
11815
|
+
|
|
11816
|
+
</dd>
|
|
11817
|
+
</dl>
|
|
11818
|
+
</details>
|
|
11819
|
+
|
|
11820
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">unassignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11821
|
+
<dl>
|
|
11822
|
+
<dd>
|
|
11823
|
+
|
|
11824
|
+
#### 📝 Description
|
|
11825
|
+
|
|
11826
|
+
<dl>
|
|
11827
|
+
<dd>
|
|
11828
|
+
|
|
11829
|
+
<dl>
|
|
11830
|
+
<dd>
|
|
11831
|
+
|
|
11832
|
+
Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
|
|
11833
|
+
|
|
11834
|
+
</dd>
|
|
11835
|
+
</dl>
|
|
11836
|
+
</dd>
|
|
11837
|
+
</dl>
|
|
11838
|
+
|
|
11839
|
+
#### 🔌 Usage
|
|
11840
|
+
|
|
11841
|
+
<dl>
|
|
11842
|
+
<dd>
|
|
11843
|
+
|
|
11844
|
+
<dl>
|
|
11845
|
+
<dd>
|
|
11846
|
+
|
|
11847
|
+
```typescript
|
|
11848
|
+
await client.operations.cases.unassignV1("case_id", {
|
|
11849
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11850
|
+
});
|
|
11851
|
+
```
|
|
11852
|
+
|
|
11853
|
+
</dd>
|
|
11854
|
+
</dl>
|
|
11855
|
+
</dd>
|
|
11856
|
+
</dl>
|
|
11857
|
+
|
|
11858
|
+
#### ⚙️ Parameters
|
|
11859
|
+
|
|
11860
|
+
<dl>
|
|
11861
|
+
<dd>
|
|
11862
|
+
|
|
11863
|
+
<dl>
|
|
11864
|
+
<dd>
|
|
11865
|
+
|
|
11866
|
+
**caseId:** `string`
|
|
11867
|
+
|
|
11868
|
+
</dd>
|
|
11869
|
+
</dl>
|
|
11870
|
+
|
|
11871
|
+
<dl>
|
|
11872
|
+
<dd>
|
|
11873
|
+
|
|
11874
|
+
**request:** `Chrt.operations.CaseUnassignReq`
|
|
11875
|
+
|
|
11876
|
+
</dd>
|
|
11877
|
+
</dl>
|
|
11878
|
+
|
|
11879
|
+
<dl>
|
|
11880
|
+
<dd>
|
|
11881
|
+
|
|
11882
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11883
|
+
|
|
11884
|
+
</dd>
|
|
11885
|
+
</dl>
|
|
11886
|
+
</dd>
|
|
11887
|
+
</dl>
|
|
11888
|
+
|
|
11889
|
+
</dd>
|
|
11890
|
+
</dl>
|
|
11891
|
+
</details>
|
|
11892
|
+
|
|
11893
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">addMessageV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11894
|
+
<dl>
|
|
11895
|
+
<dd>
|
|
11896
|
+
|
|
11897
|
+
#### 📝 Description
|
|
11898
|
+
|
|
11899
|
+
<dl>
|
|
11900
|
+
<dd>
|
|
11901
|
+
|
|
11902
|
+
<dl>
|
|
11903
|
+
<dd>
|
|
11904
|
+
|
|
11905
|
+
Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
|
|
11906
|
+
|
|
11907
|
+
</dd>
|
|
11908
|
+
</dl>
|
|
11909
|
+
</dd>
|
|
11910
|
+
</dl>
|
|
11911
|
+
|
|
11912
|
+
#### 🔌 Usage
|
|
11913
|
+
|
|
11914
|
+
<dl>
|
|
11915
|
+
<dd>
|
|
11916
|
+
|
|
11917
|
+
<dl>
|
|
11918
|
+
<dd>
|
|
11919
|
+
|
|
11920
|
+
```typescript
|
|
11921
|
+
await client.operations.cases.addMessageV1("case_id", {
|
|
11922
|
+
message: "message",
|
|
11923
|
+
});
|
|
11924
|
+
```
|
|
11925
|
+
|
|
11926
|
+
</dd>
|
|
11927
|
+
</dl>
|
|
11928
|
+
</dd>
|
|
11929
|
+
</dl>
|
|
11930
|
+
|
|
11931
|
+
#### ⚙️ Parameters
|
|
11932
|
+
|
|
11933
|
+
<dl>
|
|
11934
|
+
<dd>
|
|
11935
|
+
|
|
11936
|
+
<dl>
|
|
11937
|
+
<dd>
|
|
11938
|
+
|
|
11939
|
+
**caseId:** `string`
|
|
11940
|
+
|
|
11941
|
+
</dd>
|
|
11942
|
+
</dl>
|
|
11943
|
+
|
|
11944
|
+
<dl>
|
|
11945
|
+
<dd>
|
|
11946
|
+
|
|
11947
|
+
**request:** `Chrt.operations.CaseAddMessageReq`
|
|
11948
|
+
|
|
11949
|
+
</dd>
|
|
11950
|
+
</dl>
|
|
11951
|
+
|
|
11952
|
+
<dl>
|
|
11953
|
+
<dd>
|
|
11954
|
+
|
|
11955
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11956
|
+
|
|
11957
|
+
</dd>
|
|
11958
|
+
</dl>
|
|
11959
|
+
</dd>
|
|
11960
|
+
</dl>
|
|
11961
|
+
|
|
11962
|
+
</dd>
|
|
11963
|
+
</dl>
|
|
11964
|
+
</details>
|
|
11965
|
+
|
|
11966
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">deleteMessageV1</a>(caseId, messageId) -> boolean</code></summary>
|
|
11967
|
+
<dl>
|
|
11968
|
+
<dd>
|
|
11969
|
+
|
|
11970
|
+
#### 📝 Description
|
|
11971
|
+
|
|
11972
|
+
<dl>
|
|
11973
|
+
<dd>
|
|
11974
|
+
|
|
11975
|
+
<dl>
|
|
11976
|
+
<dd>
|
|
11977
|
+
|
|
11978
|
+
Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
11979
|
+
|
|
11980
|
+
</dd>
|
|
11981
|
+
</dl>
|
|
11982
|
+
</dd>
|
|
11983
|
+
</dl>
|
|
11984
|
+
|
|
11985
|
+
#### 🔌 Usage
|
|
11986
|
+
|
|
11987
|
+
<dl>
|
|
11988
|
+
<dd>
|
|
11989
|
+
|
|
11990
|
+
<dl>
|
|
11991
|
+
<dd>
|
|
11992
|
+
|
|
11993
|
+
```typescript
|
|
11994
|
+
await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
11995
|
+
```
|
|
11996
|
+
|
|
11997
|
+
</dd>
|
|
11998
|
+
</dl>
|
|
11999
|
+
</dd>
|
|
12000
|
+
</dl>
|
|
12001
|
+
|
|
12002
|
+
#### ⚙️ Parameters
|
|
12003
|
+
|
|
12004
|
+
<dl>
|
|
12005
|
+
<dd>
|
|
12006
|
+
|
|
12007
|
+
<dl>
|
|
12008
|
+
<dd>
|
|
12009
|
+
|
|
12010
|
+
**caseId:** `string`
|
|
12011
|
+
|
|
12012
|
+
</dd>
|
|
12013
|
+
</dl>
|
|
12014
|
+
|
|
12015
|
+
<dl>
|
|
12016
|
+
<dd>
|
|
12017
|
+
|
|
12018
|
+
**messageId:** `string`
|
|
12019
|
+
|
|
12020
|
+
</dd>
|
|
12021
|
+
</dl>
|
|
12022
|
+
|
|
12023
|
+
<dl>
|
|
12024
|
+
<dd>
|
|
12025
|
+
|
|
12026
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
12027
|
+
|
|
12028
|
+
</dd>
|
|
12029
|
+
</dl>
|
|
12030
|
+
</dd>
|
|
12031
|
+
</dl>
|
|
12032
|
+
|
|
12033
|
+
</dd>
|
|
12034
|
+
</dl>
|
|
12035
|
+
</details>
|
|
12036
|
+
|
|
12037
|
+
## Operations Checklists
|
|
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>
|
|
12040
|
+
<dl>
|
|
12041
|
+
<dd>
|
|
12042
|
+
|
|
12043
|
+
#### 📝 Description
|
|
12044
|
+
|
|
12045
|
+
<dl>
|
|
12046
|
+
<dd>
|
|
12047
|
+
|
|
12048
|
+
<dl>
|
|
12049
|
+
<dd>
|
|
12050
|
+
|
|
12051
|
+
Lists Checklists for the caller's organization with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (ChecklistListRes)
|
|
12052
|
+
|
|
12053
|
+
</dd>
|
|
12054
|
+
</dl>
|
|
12055
|
+
</dd>
|
|
12056
|
+
</dl>
|
|
12057
|
+
|
|
12058
|
+
#### 🔌 Usage
|
|
12059
|
+
|
|
12060
|
+
<dl>
|
|
12061
|
+
<dd>
|
|
12062
|
+
|
|
12063
|
+
<dl>
|
|
12064
|
+
<dd>
|
|
12065
|
+
|
|
12066
|
+
```typescript
|
|
12067
|
+
await client.operations.checklists.listV1({
|
|
12068
|
+
sort_by: "created_at_timestamp",
|
|
12069
|
+
sort_order: "asc",
|
|
12070
|
+
page: 1,
|
|
12071
|
+
page_size: 1,
|
|
12072
|
+
filter_archived: true,
|
|
12073
|
+
});
|
|
12074
|
+
```
|
|
12075
|
+
|
|
12076
|
+
</dd>
|
|
12077
|
+
</dl>
|
|
12078
|
+
</dd>
|
|
12079
|
+
</dl>
|
|
12080
|
+
|
|
12081
|
+
#### ⚙️ Parameters
|
|
12082
|
+
|
|
12083
|
+
<dl>
|
|
12084
|
+
<dd>
|
|
12085
|
+
|
|
12086
|
+
<dl>
|
|
12087
|
+
<dd>
|
|
12088
|
+
|
|
12089
|
+
**request:** `Chrt.operations.ChecklistsListV1Request`
|
|
12090
|
+
|
|
12091
|
+
</dd>
|
|
12092
|
+
</dl>
|
|
12093
|
+
|
|
12094
|
+
<dl>
|
|
12095
|
+
<dd>
|
|
12096
|
+
|
|
12097
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12098
|
+
|
|
12099
|
+
</dd>
|
|
12100
|
+
</dl>
|
|
12101
|
+
</dd>
|
|
12102
|
+
</dl>
|
|
12103
|
+
|
|
12104
|
+
</dd>
|
|
12105
|
+
</dl>
|
|
12106
|
+
</details>
|
|
12107
|
+
|
|
12108
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">getV1</a>(checklistId) -> Chrt.Checklist1</code></summary>
|
|
12109
|
+
<dl>
|
|
12110
|
+
<dd>
|
|
12111
|
+
|
|
12112
|
+
#### 📝 Description
|
|
12113
|
+
|
|
12114
|
+
<dl>
|
|
12115
|
+
<dd>
|
|
12116
|
+
|
|
12117
|
+
<dl>
|
|
12118
|
+
<dd>
|
|
12119
|
+
|
|
12120
|
+
Retrieves a single Checklist by id. | authz: min_org_role=operator | () -> (Checklist1)
|
|
12121
|
+
|
|
12122
|
+
</dd>
|
|
12123
|
+
</dl>
|
|
12124
|
+
</dd>
|
|
12125
|
+
</dl>
|
|
12126
|
+
|
|
12127
|
+
#### 🔌 Usage
|
|
12128
|
+
|
|
12129
|
+
<dl>
|
|
12130
|
+
<dd>
|
|
12131
|
+
|
|
12132
|
+
<dl>
|
|
12133
|
+
<dd>
|
|
12134
|
+
|
|
12135
|
+
```typescript
|
|
12136
|
+
await client.operations.checklists.getV1("checklist_id");
|
|
12137
|
+
```
|
|
12138
|
+
|
|
12139
|
+
</dd>
|
|
12140
|
+
</dl>
|
|
12141
|
+
</dd>
|
|
12142
|
+
</dl>
|
|
12143
|
+
|
|
12144
|
+
#### ⚙️ Parameters
|
|
12145
|
+
|
|
12146
|
+
<dl>
|
|
12147
|
+
<dd>
|
|
12148
|
+
|
|
12149
|
+
<dl>
|
|
12150
|
+
<dd>
|
|
12151
|
+
|
|
12152
|
+
**checklistId:** `string`
|
|
12153
|
+
|
|
12154
|
+
</dd>
|
|
12155
|
+
</dl>
|
|
12156
|
+
|
|
12157
|
+
<dl>
|
|
12158
|
+
<dd>
|
|
12159
|
+
|
|
12160
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12161
|
+
|
|
12162
|
+
</dd>
|
|
12163
|
+
</dl>
|
|
12164
|
+
</dd>
|
|
12165
|
+
</dl>
|
|
12166
|
+
|
|
12167
|
+
</dd>
|
|
12168
|
+
</dl>
|
|
12169
|
+
</details>
|
|
12170
|
+
|
|
12171
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">updateV1</a>(checklistId, { ...params }) -> boolean</code></summary>
|
|
12172
|
+
<dl>
|
|
12173
|
+
<dd>
|
|
12174
|
+
|
|
12175
|
+
#### 📝 Description
|
|
12176
|
+
|
|
12177
|
+
<dl>
|
|
12178
|
+
<dd>
|
|
12179
|
+
|
|
12180
|
+
<dl>
|
|
12181
|
+
<dd>
|
|
12182
|
+
|
|
12183
|
+
Updates scalar fields (name, description) on a Checklist. | authz: min_org_role=operator | (ChecklistClientUpdate1) -> (bool)
|
|
12184
|
+
|
|
12185
|
+
</dd>
|
|
12186
|
+
</dl>
|
|
12187
|
+
</dd>
|
|
12188
|
+
</dl>
|
|
12189
|
+
|
|
12190
|
+
#### 🔌 Usage
|
|
12191
|
+
|
|
12192
|
+
<dl>
|
|
12193
|
+
<dd>
|
|
12194
|
+
|
|
12195
|
+
<dl>
|
|
12196
|
+
<dd>
|
|
12197
|
+
|
|
12198
|
+
```typescript
|
|
12199
|
+
await client.operations.checklists.updateV1("checklist_id");
|
|
12200
|
+
```
|
|
12201
|
+
|
|
12202
|
+
</dd>
|
|
12203
|
+
</dl>
|
|
12204
|
+
</dd>
|
|
12205
|
+
</dl>
|
|
12206
|
+
|
|
12207
|
+
#### ⚙️ Parameters
|
|
12208
|
+
|
|
12209
|
+
<dl>
|
|
12210
|
+
<dd>
|
|
12211
|
+
|
|
12212
|
+
<dl>
|
|
12213
|
+
<dd>
|
|
12214
|
+
|
|
12215
|
+
**checklistId:** `string`
|
|
12216
|
+
|
|
12217
|
+
</dd>
|
|
12218
|
+
</dl>
|
|
12219
|
+
|
|
12220
|
+
<dl>
|
|
12221
|
+
<dd>
|
|
12222
|
+
|
|
12223
|
+
**request:** `Chrt.operations.ChecklistClientUpdate1`
|
|
12224
|
+
|
|
12225
|
+
</dd>
|
|
12226
|
+
</dl>
|
|
12227
|
+
|
|
12228
|
+
<dl>
|
|
12229
|
+
<dd>
|
|
12230
|
+
|
|
12231
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12232
|
+
|
|
12233
|
+
</dd>
|
|
12234
|
+
</dl>
|
|
12235
|
+
</dd>
|
|
12236
|
+
</dl>
|
|
12237
|
+
|
|
12238
|
+
</dd>
|
|
12239
|
+
</dl>
|
|
12240
|
+
</details>
|
|
12241
|
+
|
|
12242
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
12243
|
+
<dl>
|
|
12244
|
+
<dd>
|
|
12245
|
+
|
|
12246
|
+
#### 📝 Description
|
|
12247
|
+
|
|
12248
|
+
<dl>
|
|
12249
|
+
<dd>
|
|
12250
|
+
|
|
12251
|
+
<dl>
|
|
12252
|
+
<dd>
|
|
12253
|
+
|
|
12254
|
+
Creates a new Checklist for the caller's organization. | authz: min_org_role=operator | (ChecklistClientCreate1) -> (PydanticObjectId)
|
|
12255
|
+
|
|
12256
|
+
</dd>
|
|
12257
|
+
</dl>
|
|
12258
|
+
</dd>
|
|
12259
|
+
</dl>
|
|
12260
|
+
|
|
12261
|
+
#### 🔌 Usage
|
|
12262
|
+
|
|
12263
|
+
<dl>
|
|
12264
|
+
<dd>
|
|
12265
|
+
|
|
12266
|
+
<dl>
|
|
12267
|
+
<dd>
|
|
12268
|
+
|
|
12269
|
+
```typescript
|
|
12270
|
+
await client.operations.checklists.createV1({
|
|
12271
|
+
schema_version: 1,
|
|
12272
|
+
name: "name",
|
|
12273
|
+
});
|
|
12274
|
+
```
|
|
12275
|
+
|
|
12276
|
+
</dd>
|
|
12277
|
+
</dl>
|
|
12278
|
+
</dd>
|
|
12279
|
+
</dl>
|
|
12280
|
+
|
|
12281
|
+
#### ⚙️ Parameters
|
|
12282
|
+
|
|
12283
|
+
<dl>
|
|
12284
|
+
<dd>
|
|
12285
|
+
|
|
12286
|
+
<dl>
|
|
12287
|
+
<dd>
|
|
12288
|
+
|
|
12289
|
+
**request:** `Chrt.operations.ChecklistClientCreate1`
|
|
12290
|
+
|
|
12291
|
+
</dd>
|
|
12292
|
+
</dl>
|
|
12293
|
+
|
|
12294
|
+
<dl>
|
|
12295
|
+
<dd>
|
|
12296
|
+
|
|
12297
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12298
|
+
|
|
12299
|
+
</dd>
|
|
12300
|
+
</dl>
|
|
12301
|
+
</dd>
|
|
12302
|
+
</dl>
|
|
12303
|
+
|
|
12304
|
+
</dd>
|
|
12305
|
+
</dl>
|
|
12306
|
+
</details>
|
|
12307
|
+
|
|
12308
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">addChecksV1</a>(checklistId, { ...params }) -> boolean</code></summary>
|
|
12309
|
+
<dl>
|
|
12310
|
+
<dd>
|
|
12311
|
+
|
|
12312
|
+
#### 📝 Description
|
|
12313
|
+
|
|
12314
|
+
<dl>
|
|
12315
|
+
<dd>
|
|
12316
|
+
|
|
12317
|
+
<dl>
|
|
12318
|
+
<dd>
|
|
12319
|
+
|
|
12320
|
+
Adds checks to a Checklist. Idempotent for identical checks. | authz: min_org_role=operator | (ChecklistChecksAdd1) -> (bool)
|
|
12321
|
+
|
|
12322
|
+
</dd>
|
|
12323
|
+
</dl>
|
|
12324
|
+
</dd>
|
|
12325
|
+
</dl>
|
|
12326
|
+
|
|
12327
|
+
#### 🔌 Usage
|
|
12328
|
+
|
|
12329
|
+
<dl>
|
|
12330
|
+
<dd>
|
|
12331
|
+
|
|
12332
|
+
<dl>
|
|
12333
|
+
<dd>
|
|
12334
|
+
|
|
12335
|
+
```typescript
|
|
12336
|
+
await client.operations.checklists.addChecksV1("checklist_id");
|
|
12337
|
+
```
|
|
12338
|
+
|
|
12339
|
+
</dd>
|
|
12340
|
+
</dl>
|
|
12341
|
+
</dd>
|
|
12342
|
+
</dl>
|
|
12343
|
+
|
|
12344
|
+
#### ⚙️ Parameters
|
|
12345
|
+
|
|
12346
|
+
<dl>
|
|
12347
|
+
<dd>
|
|
12348
|
+
|
|
12349
|
+
<dl>
|
|
12350
|
+
<dd>
|
|
12351
|
+
|
|
12352
|
+
**checklistId:** `string`
|
|
12353
|
+
|
|
12354
|
+
</dd>
|
|
12355
|
+
</dl>
|
|
12356
|
+
|
|
12357
|
+
<dl>
|
|
12358
|
+
<dd>
|
|
12359
|
+
|
|
12360
|
+
**request:** `Chrt.operations.ChecklistChecksAdd1`
|
|
12361
|
+
|
|
12362
|
+
</dd>
|
|
12363
|
+
</dl>
|
|
12364
|
+
|
|
12365
|
+
<dl>
|
|
12366
|
+
<dd>
|
|
12367
|
+
|
|
12368
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12369
|
+
|
|
12370
|
+
</dd>
|
|
12371
|
+
</dl>
|
|
12372
|
+
</dd>
|
|
12373
|
+
</dl>
|
|
12374
|
+
|
|
12375
|
+
</dd>
|
|
12376
|
+
</dl>
|
|
12377
|
+
</details>
|
|
12378
|
+
|
|
12379
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">removeChecksV1</a>(checklistId, { ...params }) -> boolean</code></summary>
|
|
12380
|
+
<dl>
|
|
12381
|
+
<dd>
|
|
12382
|
+
|
|
12383
|
+
#### 📝 Description
|
|
12384
|
+
|
|
12385
|
+
<dl>
|
|
12386
|
+
<dd>
|
|
12387
|
+
|
|
12388
|
+
<dl>
|
|
12389
|
+
<dd>
|
|
12390
|
+
|
|
12391
|
+
Removes entries from a Checklist's `checks` list by CheckEnum. | authz: min_org_role=operator | (ChecklistChecksRemove1) -> (bool)
|
|
12392
|
+
|
|
12393
|
+
</dd>
|
|
12394
|
+
</dl>
|
|
12395
|
+
</dd>
|
|
12396
|
+
</dl>
|
|
12397
|
+
|
|
12398
|
+
#### 🔌 Usage
|
|
12399
|
+
|
|
12400
|
+
<dl>
|
|
12401
|
+
<dd>
|
|
12402
|
+
|
|
12403
|
+
<dl>
|
|
12404
|
+
<dd>
|
|
12405
|
+
|
|
12406
|
+
```typescript
|
|
12407
|
+
await client.operations.checklists.removeChecksV1("checklist_id");
|
|
12408
|
+
```
|
|
12409
|
+
|
|
12410
|
+
</dd>
|
|
12411
|
+
</dl>
|
|
12412
|
+
</dd>
|
|
12413
|
+
</dl>
|
|
12414
|
+
|
|
12415
|
+
#### ⚙️ Parameters
|
|
12416
|
+
|
|
12417
|
+
<dl>
|
|
12418
|
+
<dd>
|
|
12419
|
+
|
|
12420
|
+
<dl>
|
|
12421
|
+
<dd>
|
|
12422
|
+
|
|
12423
|
+
**checklistId:** `string`
|
|
12424
|
+
|
|
12425
|
+
</dd>
|
|
12426
|
+
</dl>
|
|
12427
|
+
|
|
12428
|
+
<dl>
|
|
12429
|
+
<dd>
|
|
12430
|
+
|
|
12431
|
+
**request:** `Chrt.operations.ChecklistChecksRemove1`
|
|
12432
|
+
|
|
12433
|
+
</dd>
|
|
12434
|
+
</dl>
|
|
12435
|
+
|
|
12436
|
+
<dl>
|
|
12437
|
+
<dd>
|
|
12438
|
+
|
|
12439
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12440
|
+
|
|
12441
|
+
</dd>
|
|
12442
|
+
</dl>
|
|
12443
|
+
</dd>
|
|
12444
|
+
</dl>
|
|
12445
|
+
|
|
12446
|
+
</dd>
|
|
12447
|
+
</dl>
|
|
12448
|
+
</details>
|
|
12449
|
+
|
|
12450
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">archiveV1</a>(checklistId) -> boolean</code></summary>
|
|
12451
|
+
<dl>
|
|
12452
|
+
<dd>
|
|
12453
|
+
|
|
12454
|
+
#### 📝 Description
|
|
12455
|
+
|
|
12456
|
+
<dl>
|
|
12457
|
+
<dd>
|
|
12458
|
+
|
|
12459
|
+
<dl>
|
|
12460
|
+
<dd>
|
|
12461
|
+
|
|
12462
|
+
Soft-deletes a Checklist by setting `archived=True`. Existing Cases that applied this Checklist are unaffected (copy-on-write). | authz: min_org_role=operator | () -> (bool)
|
|
12463
|
+
|
|
12464
|
+
</dd>
|
|
12465
|
+
</dl>
|
|
12466
|
+
</dd>
|
|
12467
|
+
</dl>
|
|
12468
|
+
|
|
12469
|
+
#### 🔌 Usage
|
|
12470
|
+
|
|
12471
|
+
<dl>
|
|
12472
|
+
<dd>
|
|
12473
|
+
|
|
12474
|
+
<dl>
|
|
12475
|
+
<dd>
|
|
12476
|
+
|
|
12477
|
+
```typescript
|
|
12478
|
+
await client.operations.checklists.archiveV1("checklist_id");
|
|
12479
|
+
```
|
|
12480
|
+
|
|
12481
|
+
</dd>
|
|
12482
|
+
</dl>
|
|
12483
|
+
</dd>
|
|
12484
|
+
</dl>
|
|
12485
|
+
|
|
12486
|
+
#### ⚙️ Parameters
|
|
12487
|
+
|
|
12488
|
+
<dl>
|
|
12489
|
+
<dd>
|
|
12490
|
+
|
|
12491
|
+
<dl>
|
|
12492
|
+
<dd>
|
|
12493
|
+
|
|
12494
|
+
**checklistId:** `string`
|
|
12495
|
+
|
|
12496
|
+
</dd>
|
|
12497
|
+
</dl>
|
|
12498
|
+
|
|
12499
|
+
<dl>
|
|
12500
|
+
<dd>
|
|
12501
|
+
|
|
12502
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12503
|
+
|
|
12504
|
+
</dd>
|
|
12505
|
+
</dl>
|
|
12506
|
+
</dd>
|
|
12507
|
+
</dl>
|
|
12508
|
+
|
|
12509
|
+
</dd>
|
|
12510
|
+
</dl>
|
|
12511
|
+
</details>
|
|
12512
|
+
|
|
12513
|
+
<details><summary><code>client.operations.checklists.<a href="/src/api/resources/operations/resources/checklists/client/Client.ts">unarchiveV1</a>(checklistId) -> boolean</code></summary>
|
|
12514
|
+
<dl>
|
|
12515
|
+
<dd>
|
|
12516
|
+
|
|
12517
|
+
#### 📝 Description
|
|
12518
|
+
|
|
12519
|
+
<dl>
|
|
12520
|
+
<dd>
|
|
12521
|
+
|
|
12522
|
+
<dl>
|
|
12523
|
+
<dd>
|
|
12524
|
+
|
|
12525
|
+
Restores an archived Checklist by setting `archived=False`. | authz: min_org_role=operator | () -> (bool)
|
|
12526
|
+
|
|
12527
|
+
</dd>
|
|
12528
|
+
</dl>
|
|
12529
|
+
</dd>
|
|
12530
|
+
</dl>
|
|
12531
|
+
|
|
12532
|
+
#### 🔌 Usage
|
|
12533
|
+
|
|
12534
|
+
<dl>
|
|
12535
|
+
<dd>
|
|
12536
|
+
|
|
12537
|
+
<dl>
|
|
12538
|
+
<dd>
|
|
12539
|
+
|
|
12540
|
+
```typescript
|
|
12541
|
+
await client.operations.checklists.unarchiveV1("checklist_id");
|
|
12542
|
+
```
|
|
12543
|
+
|
|
12544
|
+
</dd>
|
|
12545
|
+
</dl>
|
|
12546
|
+
</dd>
|
|
12547
|
+
</dl>
|
|
12548
|
+
|
|
12549
|
+
#### ⚙️ Parameters
|
|
12550
|
+
|
|
12551
|
+
<dl>
|
|
12552
|
+
<dd>
|
|
12553
|
+
|
|
12554
|
+
<dl>
|
|
12555
|
+
<dd>
|
|
12556
|
+
|
|
12557
|
+
**checklistId:** `string`
|
|
12558
|
+
|
|
12559
|
+
</dd>
|
|
12560
|
+
</dl>
|
|
12561
|
+
|
|
12562
|
+
<dl>
|
|
12563
|
+
<dd>
|
|
12564
|
+
|
|
12565
|
+
**requestOptions:** `Checklists.RequestOptions`
|
|
12566
|
+
|
|
12567
|
+
</dd>
|
|
12568
|
+
</dl>
|
|
12569
|
+
</dd>
|
|
12570
|
+
</dl>
|
|
12571
|
+
|
|
12572
|
+
</dd>
|
|
12573
|
+
</dl>
|
|
12574
|
+
</details>
|
|
12575
|
+
|
|
12576
|
+
## Operations Departments
|
|
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>
|
|
12579
|
+
<dl>
|
|
12580
|
+
<dd>
|
|
12581
|
+
|
|
12582
|
+
#### 📝 Description
|
|
12583
|
+
|
|
12584
|
+
<dl>
|
|
12585
|
+
<dd>
|
|
12586
|
+
|
|
12587
|
+
<dl>
|
|
12588
|
+
<dd>
|
|
12589
|
+
|
|
12590
|
+
Lists department configurations for the caller's organization. | authz: min_org_role=operator | () -> (DepartmentListRes)
|
|
12591
|
+
|
|
12592
|
+
</dd>
|
|
12593
|
+
</dl>
|
|
12594
|
+
</dd>
|
|
12595
|
+
</dl>
|
|
12596
|
+
|
|
12597
|
+
#### 🔌 Usage
|
|
12598
|
+
|
|
12599
|
+
<dl>
|
|
12600
|
+
<dd>
|
|
12601
|
+
|
|
12602
|
+
<dl>
|
|
12603
|
+
<dd>
|
|
12604
|
+
|
|
12605
|
+
```typescript
|
|
12606
|
+
await client.operations.departments.listV1({
|
|
12607
|
+
sort_by: "created_at",
|
|
12608
|
+
sort_order: "asc",
|
|
12609
|
+
page: 1,
|
|
12610
|
+
page_size: 1,
|
|
12611
|
+
});
|
|
12612
|
+
```
|
|
12613
|
+
|
|
12614
|
+
</dd>
|
|
12615
|
+
</dl>
|
|
12616
|
+
</dd>
|
|
12617
|
+
</dl>
|
|
12618
|
+
|
|
12619
|
+
#### ⚙️ Parameters
|
|
12620
|
+
|
|
12621
|
+
<dl>
|
|
12622
|
+
<dd>
|
|
12623
|
+
|
|
12624
|
+
<dl>
|
|
12625
|
+
<dd>
|
|
12626
|
+
|
|
12627
|
+
**request:** `Chrt.operations.DepartmentsListV1Request`
|
|
12628
|
+
|
|
12629
|
+
</dd>
|
|
12630
|
+
</dl>
|
|
12631
|
+
|
|
12632
|
+
<dl>
|
|
12633
|
+
<dd>
|
|
12634
|
+
|
|
12635
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12636
|
+
|
|
12637
|
+
</dd>
|
|
12638
|
+
</dl>
|
|
12639
|
+
</dd>
|
|
12640
|
+
</dl>
|
|
12641
|
+
|
|
12642
|
+
</dd>
|
|
12643
|
+
</dl>
|
|
12644
|
+
</details>
|
|
12645
|
+
|
|
12646
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">getV1</a>(departmentId) -> Chrt.Department1</code></summary>
|
|
12647
|
+
<dl>
|
|
12648
|
+
<dd>
|
|
12649
|
+
|
|
12650
|
+
#### 📝 Description
|
|
12651
|
+
|
|
12652
|
+
<dl>
|
|
12653
|
+
<dd>
|
|
12654
|
+
|
|
12655
|
+
<dl>
|
|
12656
|
+
<dd>
|
|
12657
|
+
|
|
12658
|
+
Retrieves a single department configuration. | authz: min_org_role=operator | () -> (Department1)
|
|
12659
|
+
|
|
12660
|
+
</dd>
|
|
12661
|
+
</dl>
|
|
12662
|
+
</dd>
|
|
12663
|
+
</dl>
|
|
12664
|
+
|
|
12665
|
+
#### 🔌 Usage
|
|
12666
|
+
|
|
12667
|
+
<dl>
|
|
12668
|
+
<dd>
|
|
12669
|
+
|
|
12670
|
+
<dl>
|
|
12671
|
+
<dd>
|
|
12672
|
+
|
|
12673
|
+
```typescript
|
|
12674
|
+
await client.operations.departments.getV1("department_id");
|
|
12675
|
+
```
|
|
12676
|
+
|
|
12677
|
+
</dd>
|
|
12678
|
+
</dl>
|
|
12679
|
+
</dd>
|
|
12680
|
+
</dl>
|
|
12681
|
+
|
|
12682
|
+
#### ⚙️ Parameters
|
|
12683
|
+
|
|
12684
|
+
<dl>
|
|
12685
|
+
<dd>
|
|
12686
|
+
|
|
12687
|
+
<dl>
|
|
12688
|
+
<dd>
|
|
12689
|
+
|
|
12690
|
+
**departmentId:** `string`
|
|
12691
|
+
|
|
12692
|
+
</dd>
|
|
12693
|
+
</dl>
|
|
12694
|
+
|
|
12695
|
+
<dl>
|
|
12696
|
+
<dd>
|
|
12697
|
+
|
|
12698
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12699
|
+
|
|
12700
|
+
</dd>
|
|
12701
|
+
</dl>
|
|
12702
|
+
</dd>
|
|
12703
|
+
</dl>
|
|
12704
|
+
|
|
12705
|
+
</dd>
|
|
12706
|
+
</dl>
|
|
12707
|
+
</details>
|
|
12708
|
+
|
|
12709
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">deleteV1</a>(departmentId) -> boolean</code></summary>
|
|
12710
|
+
<dl>
|
|
12711
|
+
<dd>
|
|
12712
|
+
|
|
12713
|
+
#### 📝 Description
|
|
12714
|
+
|
|
12715
|
+
<dl>
|
|
12716
|
+
<dd>
|
|
12717
|
+
|
|
12718
|
+
<dl>
|
|
12719
|
+
<dd>
|
|
12720
|
+
|
|
12721
|
+
Deletes a department configuration. | authz: min_org_role=administrator | () -> (bool)
|
|
12722
|
+
|
|
12723
|
+
</dd>
|
|
12724
|
+
</dl>
|
|
12725
|
+
</dd>
|
|
12726
|
+
</dl>
|
|
12727
|
+
|
|
12728
|
+
#### 🔌 Usage
|
|
12729
|
+
|
|
12730
|
+
<dl>
|
|
12731
|
+
<dd>
|
|
12732
|
+
|
|
12733
|
+
<dl>
|
|
12734
|
+
<dd>
|
|
12735
|
+
|
|
12736
|
+
```typescript
|
|
12737
|
+
await client.operations.departments.deleteV1("department_id");
|
|
12738
|
+
```
|
|
12739
|
+
|
|
12740
|
+
</dd>
|
|
12741
|
+
</dl>
|
|
12742
|
+
</dd>
|
|
12743
|
+
</dl>
|
|
12744
|
+
|
|
12745
|
+
#### ⚙️ Parameters
|
|
12746
|
+
|
|
12747
|
+
<dl>
|
|
12748
|
+
<dd>
|
|
12749
|
+
|
|
12750
|
+
<dl>
|
|
12751
|
+
<dd>
|
|
12752
|
+
|
|
12753
|
+
**departmentId:** `string`
|
|
12754
|
+
|
|
12755
|
+
</dd>
|
|
12756
|
+
</dl>
|
|
12757
|
+
|
|
12758
|
+
<dl>
|
|
12759
|
+
<dd>
|
|
12760
|
+
|
|
12761
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12762
|
+
|
|
12763
|
+
</dd>
|
|
12764
|
+
</dl>
|
|
12765
|
+
</dd>
|
|
12766
|
+
</dl>
|
|
12767
|
+
|
|
12768
|
+
</dd>
|
|
12769
|
+
</dl>
|
|
12770
|
+
</details>
|
|
12771
|
+
|
|
12772
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">updateV1</a>(departmentId, { ...params }) -> boolean</code></summary>
|
|
12773
|
+
<dl>
|
|
12774
|
+
<dd>
|
|
12775
|
+
|
|
12776
|
+
#### 📝 Description
|
|
12777
|
+
|
|
12778
|
+
<dl>
|
|
12779
|
+
<dd>
|
|
12780
|
+
|
|
12781
|
+
<dl>
|
|
12782
|
+
<dd>
|
|
12783
|
+
|
|
12784
|
+
Updates a department configuration. | authz: min_org_role=administrator | (DepartmentClientUpdate1) -> (bool)
|
|
12785
|
+
|
|
12786
|
+
</dd>
|
|
12787
|
+
</dl>
|
|
12788
|
+
</dd>
|
|
12789
|
+
</dl>
|
|
12790
|
+
|
|
12791
|
+
#### 🔌 Usage
|
|
12792
|
+
|
|
12793
|
+
<dl>
|
|
12794
|
+
<dd>
|
|
12795
|
+
|
|
12796
|
+
<dl>
|
|
12797
|
+
<dd>
|
|
12798
|
+
|
|
12799
|
+
```typescript
|
|
12800
|
+
await client.operations.departments.updateV1("department_id");
|
|
12801
|
+
```
|
|
12802
|
+
|
|
12803
|
+
</dd>
|
|
12804
|
+
</dl>
|
|
12805
|
+
</dd>
|
|
12806
|
+
</dl>
|
|
12807
|
+
|
|
12808
|
+
#### ⚙️ Parameters
|
|
12809
|
+
|
|
12810
|
+
<dl>
|
|
12811
|
+
<dd>
|
|
12812
|
+
|
|
12813
|
+
<dl>
|
|
12814
|
+
<dd>
|
|
12815
|
+
|
|
12816
|
+
**departmentId:** `string`
|
|
12817
|
+
|
|
12818
|
+
</dd>
|
|
12819
|
+
</dl>
|
|
12820
|
+
|
|
12821
|
+
<dl>
|
|
12822
|
+
<dd>
|
|
12823
|
+
|
|
12824
|
+
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
12825
|
+
|
|
12826
|
+
</dd>
|
|
12827
|
+
</dl>
|
|
12828
|
+
|
|
12829
|
+
<dl>
|
|
12830
|
+
<dd>
|
|
12831
|
+
|
|
12832
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12833
|
+
|
|
12834
|
+
</dd>
|
|
12835
|
+
</dl>
|
|
12836
|
+
</dd>
|
|
12837
|
+
</dl>
|
|
12838
|
+
|
|
12839
|
+
</dd>
|
|
12840
|
+
</dl>
|
|
12841
|
+
</details>
|
|
12842
|
+
|
|
12843
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
12844
|
+
<dl>
|
|
12845
|
+
<dd>
|
|
12846
|
+
|
|
12847
|
+
#### 📝 Description
|
|
12848
|
+
|
|
12849
|
+
<dl>
|
|
12850
|
+
<dd>
|
|
12851
|
+
|
|
12852
|
+
<dl>
|
|
12853
|
+
<dd>
|
|
12854
|
+
|
|
12855
|
+
Creates a new department configuration for the caller's organization. | authz: min_org_role=administrator | (DepartmentClientCreate1) -> (PydanticObjectId)
|
|
12856
|
+
|
|
12857
|
+
</dd>
|
|
12858
|
+
</dl>
|
|
12859
|
+
</dd>
|
|
12860
|
+
</dl>
|
|
12861
|
+
|
|
12862
|
+
#### 🔌 Usage
|
|
12863
|
+
|
|
12864
|
+
<dl>
|
|
12865
|
+
<dd>
|
|
12866
|
+
|
|
12867
|
+
<dl>
|
|
12868
|
+
<dd>
|
|
12869
|
+
|
|
12870
|
+
```typescript
|
|
12871
|
+
await client.operations.departments.createV1({
|
|
12872
|
+
schema_version: 1,
|
|
12873
|
+
name: "name",
|
|
12874
|
+
department: "automotive",
|
|
12875
|
+
});
|
|
12876
|
+
```
|
|
12877
|
+
|
|
12878
|
+
</dd>
|
|
12879
|
+
</dl>
|
|
12880
|
+
</dd>
|
|
12881
|
+
</dl>
|
|
12882
|
+
|
|
12883
|
+
#### ⚙️ Parameters
|
|
12884
|
+
|
|
12885
|
+
<dl>
|
|
12886
|
+
<dd>
|
|
12887
|
+
|
|
12888
|
+
<dl>
|
|
12889
|
+
<dd>
|
|
12890
|
+
|
|
12891
|
+
**request:** `Chrt.operations.DepartmentClientCreate1`
|
|
12892
|
+
|
|
12893
|
+
</dd>
|
|
12894
|
+
</dl>
|
|
12895
|
+
|
|
12896
|
+
<dl>
|
|
12897
|
+
<dd>
|
|
12898
|
+
|
|
12899
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12900
|
+
|
|
12901
|
+
</dd>
|
|
12902
|
+
</dl>
|
|
12903
|
+
</dd>
|
|
12904
|
+
</dl>
|
|
12905
|
+
|
|
12906
|
+
</dd>
|
|
12907
|
+
</dl>
|
|
12908
|
+
</details>
|
|
12909
|
+
|
|
12910
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">addOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12911
|
+
<dl>
|
|
12912
|
+
<dd>
|
|
12913
|
+
|
|
12914
|
+
#### 📝 Description
|
|
12915
|
+
|
|
12916
|
+
<dl>
|
|
12917
|
+
<dd>
|
|
12918
|
+
|
|
12919
|
+
<dl>
|
|
12920
|
+
<dd>
|
|
12921
|
+
|
|
12922
|
+
Adds an operator to a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12923
|
+
|
|
12924
|
+
</dd>
|
|
12925
|
+
</dl>
|
|
12926
|
+
</dd>
|
|
12927
|
+
</dl>
|
|
12928
|
+
|
|
12929
|
+
#### 🔌 Usage
|
|
12930
|
+
|
|
12931
|
+
<dl>
|
|
12932
|
+
<dd>
|
|
12933
|
+
|
|
12934
|
+
<dl>
|
|
12935
|
+
<dd>
|
|
12936
|
+
|
|
12937
|
+
```typescript
|
|
12938
|
+
await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
12939
|
+
```
|
|
12940
|
+
|
|
12941
|
+
</dd>
|
|
12942
|
+
</dl>
|
|
12943
|
+
</dd>
|
|
12944
|
+
</dl>
|
|
12945
|
+
|
|
12946
|
+
#### ⚙️ Parameters
|
|
12947
|
+
|
|
12948
|
+
<dl>
|
|
12949
|
+
<dd>
|
|
12950
|
+
|
|
12951
|
+
<dl>
|
|
12952
|
+
<dd>
|
|
12953
|
+
|
|
12954
|
+
**departmentId:** `string`
|
|
12955
|
+
|
|
12956
|
+
</dd>
|
|
12957
|
+
</dl>
|
|
12958
|
+
|
|
12959
|
+
<dl>
|
|
12960
|
+
<dd>
|
|
12961
|
+
|
|
12962
|
+
**userId:** `string`
|
|
12963
|
+
|
|
12964
|
+
</dd>
|
|
12965
|
+
</dl>
|
|
12966
|
+
|
|
12967
|
+
<dl>
|
|
12968
|
+
<dd>
|
|
12969
|
+
|
|
12970
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12971
|
+
|
|
12972
|
+
</dd>
|
|
12973
|
+
</dl>
|
|
12974
|
+
</dd>
|
|
12975
|
+
</dl>
|
|
12976
|
+
|
|
12977
|
+
</dd>
|
|
12978
|
+
</dl>
|
|
12979
|
+
</details>
|
|
12980
|
+
|
|
12981
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">removeOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12982
|
+
<dl>
|
|
12983
|
+
<dd>
|
|
12984
|
+
|
|
12985
|
+
#### 📝 Description
|
|
12986
|
+
|
|
12987
|
+
<dl>
|
|
12988
|
+
<dd>
|
|
12989
|
+
|
|
12990
|
+
<dl>
|
|
12991
|
+
<dd>
|
|
12992
|
+
|
|
12993
|
+
Removes an operator from a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12994
|
+
|
|
12995
|
+
</dd>
|
|
12996
|
+
</dl>
|
|
12997
|
+
</dd>
|
|
12998
|
+
</dl>
|
|
12999
|
+
|
|
13000
|
+
#### 🔌 Usage
|
|
13001
|
+
|
|
13002
|
+
<dl>
|
|
13003
|
+
<dd>
|
|
13004
|
+
|
|
13005
|
+
<dl>
|
|
13006
|
+
<dd>
|
|
13007
|
+
|
|
13008
|
+
```typescript
|
|
13009
|
+
await client.operations.departments.removeOperatorV1("department_id", "user_id");
|
|
13010
|
+
```
|
|
13011
|
+
|
|
13012
|
+
</dd>
|
|
13013
|
+
</dl>
|
|
13014
|
+
</dd>
|
|
13015
|
+
</dl>
|
|
13016
|
+
|
|
13017
|
+
#### ⚙️ Parameters
|
|
13018
|
+
|
|
13019
|
+
<dl>
|
|
13020
|
+
<dd>
|
|
13021
|
+
|
|
13022
|
+
<dl>
|
|
13023
|
+
<dd>
|
|
13024
|
+
|
|
13025
|
+
**departmentId:** `string`
|
|
13026
|
+
|
|
13027
|
+
</dd>
|
|
13028
|
+
</dl>
|
|
13029
|
+
|
|
13030
|
+
<dl>
|
|
13031
|
+
<dd>
|
|
13032
|
+
|
|
13033
|
+
**userId:** `string`
|
|
13034
|
+
|
|
13035
|
+
</dd>
|
|
13036
|
+
</dl>
|
|
13037
|
+
|
|
13038
|
+
<dl>
|
|
13039
|
+
<dd>
|
|
13040
|
+
|
|
13041
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
13042
|
+
|
|
13043
|
+
</dd>
|
|
13044
|
+
</dl>
|
|
13045
|
+
</dd>
|
|
13046
|
+
</dl>
|
|
13047
|
+
|
|
13048
|
+
</dd>
|
|
13049
|
+
</dl>
|
|
13050
|
+
</details>
|
|
13051
|
+
|
|
13052
|
+
## Operations OperationsTasks
|
|
13053
|
+
|
|
13054
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OperationsTaskListRes</code></summary>
|
|
13055
|
+
<dl>
|
|
13056
|
+
<dd>
|
|
13057
|
+
|
|
13058
|
+
#### 📝 Description
|
|
13059
|
+
|
|
13060
|
+
<dl>
|
|
13061
|
+
<dd>
|
|
13062
|
+
|
|
13063
|
+
<dl>
|
|
13064
|
+
<dd>
|
|
13065
|
+
|
|
13066
|
+
Lists incomplete OperationsTasks for the caller's organization by default, with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (OperationsTaskListRes)
|
|
13067
|
+
|
|
13068
|
+
</dd>
|
|
13069
|
+
</dl>
|
|
13070
|
+
</dd>
|
|
13071
|
+
</dl>
|
|
13072
|
+
|
|
13073
|
+
#### 🔌 Usage
|
|
13074
|
+
|
|
13075
|
+
<dl>
|
|
13076
|
+
<dd>
|
|
13077
|
+
|
|
13078
|
+
<dl>
|
|
13079
|
+
<dd>
|
|
13080
|
+
|
|
13081
|
+
```typescript
|
|
13082
|
+
await client.operations.operationsTasks.listV1({
|
|
13083
|
+
sort_by: "deadline_timestamp",
|
|
13084
|
+
sort_order: "asc",
|
|
13085
|
+
page: 1,
|
|
13086
|
+
page_size: 1,
|
|
13087
|
+
filter_case_id: "filter_case_id",
|
|
13088
|
+
filter_completed: true,
|
|
13089
|
+
filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
13090
|
+
filter_deadline_lte: "2024-01-15T09:30:00Z",
|
|
13091
|
+
});
|
|
13092
|
+
```
|
|
13093
|
+
|
|
13094
|
+
</dd>
|
|
13095
|
+
</dl>
|
|
13096
|
+
</dd>
|
|
13097
|
+
</dl>
|
|
13098
|
+
|
|
13099
|
+
#### ⚙️ Parameters
|
|
13100
|
+
|
|
13101
|
+
<dl>
|
|
13102
|
+
<dd>
|
|
13103
|
+
|
|
13104
|
+
<dl>
|
|
13105
|
+
<dd>
|
|
13106
|
+
|
|
13107
|
+
**request:** `Chrt.operations.OperationsTasksListV1Request`
|
|
13108
|
+
|
|
13109
|
+
</dd>
|
|
13110
|
+
</dl>
|
|
13111
|
+
|
|
13112
|
+
<dl>
|
|
13113
|
+
<dd>
|
|
13114
|
+
|
|
13115
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13116
|
+
|
|
13117
|
+
</dd>
|
|
13118
|
+
</dl>
|
|
13119
|
+
</dd>
|
|
13120
|
+
</dl>
|
|
13121
|
+
|
|
13122
|
+
</dd>
|
|
13123
|
+
</dl>
|
|
13124
|
+
</details>
|
|
13125
|
+
|
|
13126
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">getV1</a>(taskId) -> Chrt.OperationsTask1</code></summary>
|
|
13127
|
+
<dl>
|
|
13128
|
+
<dd>
|
|
13129
|
+
|
|
13130
|
+
#### 📝 Description
|
|
13131
|
+
|
|
13132
|
+
<dl>
|
|
13133
|
+
<dd>
|
|
13134
|
+
|
|
13135
|
+
<dl>
|
|
13136
|
+
<dd>
|
|
13137
|
+
|
|
13138
|
+
Retrieves a single OperationsTask by id. | authz: min_org_role=operator | () -> (OperationsTask1)
|
|
13139
|
+
|
|
13140
|
+
</dd>
|
|
13141
|
+
</dl>
|
|
13142
|
+
</dd>
|
|
13143
|
+
</dl>
|
|
13144
|
+
|
|
13145
|
+
#### 🔌 Usage
|
|
13146
|
+
|
|
13147
|
+
<dl>
|
|
13148
|
+
<dd>
|
|
13149
|
+
|
|
13150
|
+
<dl>
|
|
13151
|
+
<dd>
|
|
13152
|
+
|
|
13153
|
+
```typescript
|
|
13154
|
+
await client.operations.operationsTasks.getV1("task_id");
|
|
13155
|
+
```
|
|
13156
|
+
|
|
13157
|
+
</dd>
|
|
13158
|
+
</dl>
|
|
13159
|
+
</dd>
|
|
13160
|
+
</dl>
|
|
13161
|
+
|
|
13162
|
+
#### ⚙️ Parameters
|
|
13163
|
+
|
|
13164
|
+
<dl>
|
|
13165
|
+
<dd>
|
|
13166
|
+
|
|
13167
|
+
<dl>
|
|
13168
|
+
<dd>
|
|
13169
|
+
|
|
13170
|
+
**taskId:** `string`
|
|
13171
|
+
|
|
13172
|
+
</dd>
|
|
13173
|
+
</dl>
|
|
13174
|
+
|
|
13175
|
+
<dl>
|
|
13176
|
+
<dd>
|
|
13177
|
+
|
|
13178
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13179
|
+
|
|
13180
|
+
</dd>
|
|
13181
|
+
</dl>
|
|
13182
|
+
</dd>
|
|
13183
|
+
</dl>
|
|
13184
|
+
|
|
13185
|
+
</dd>
|
|
13186
|
+
</dl>
|
|
13187
|
+
</details>
|
|
13188
|
+
|
|
13189
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">deleteV1</a>(taskId) -> boolean</code></summary>
|
|
13190
|
+
<dl>
|
|
13191
|
+
<dd>
|
|
13192
|
+
|
|
13193
|
+
#### 📝 Description
|
|
13194
|
+
|
|
13195
|
+
<dl>
|
|
13196
|
+
<dd>
|
|
13197
|
+
|
|
13198
|
+
<dl>
|
|
13199
|
+
<dd>
|
|
13200
|
+
|
|
13201
|
+
Hard-deletes an OperationsTask. | authz: min_org_role=operator | () -> (bool)
|
|
13202
|
+
|
|
13203
|
+
</dd>
|
|
13204
|
+
</dl>
|
|
13205
|
+
</dd>
|
|
13206
|
+
</dl>
|
|
13207
|
+
|
|
13208
|
+
#### 🔌 Usage
|
|
13209
|
+
|
|
13210
|
+
<dl>
|
|
13211
|
+
<dd>
|
|
13212
|
+
|
|
13213
|
+
<dl>
|
|
13214
|
+
<dd>
|
|
13215
|
+
|
|
13216
|
+
```typescript
|
|
13217
|
+
await client.operations.operationsTasks.deleteV1("task_id");
|
|
13218
|
+
```
|
|
13219
|
+
|
|
13220
|
+
</dd>
|
|
13221
|
+
</dl>
|
|
13222
|
+
</dd>
|
|
13223
|
+
</dl>
|
|
13224
|
+
|
|
13225
|
+
#### ⚙️ Parameters
|
|
13226
|
+
|
|
13227
|
+
<dl>
|
|
13228
|
+
<dd>
|
|
13229
|
+
|
|
13230
|
+
<dl>
|
|
13231
|
+
<dd>
|
|
13232
|
+
|
|
13233
|
+
**taskId:** `string`
|
|
13234
|
+
|
|
13235
|
+
</dd>
|
|
13236
|
+
</dl>
|
|
13237
|
+
|
|
13238
|
+
<dl>
|
|
13239
|
+
<dd>
|
|
13240
|
+
|
|
13241
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
13242
|
+
|
|
13243
|
+
</dd>
|
|
13244
|
+
</dl>
|
|
13245
|
+
</dd>
|
|
13246
|
+
</dl>
|
|
13247
|
+
|
|
13248
|
+
</dd>
|
|
13249
|
+
</dl>
|
|
13250
|
+
</details>
|
|
13251
|
+
|
|
13252
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">updateV1</a>(taskId, { ...params }) -> boolean</code></summary>
|
|
13253
|
+
<dl>
|
|
13254
|
+
<dd>
|
|
13255
|
+
|
|
13256
|
+
#### 📝 Description
|
|
13257
|
+
|
|
13258
|
+
<dl>
|
|
13259
|
+
<dd>
|
|
13260
|
+
|
|
13261
|
+
<dl>
|
|
13262
|
+
<dd>
|
|
13263
|
+
|
|
13264
|
+
Updates scalar fields (title, description, deadline_timestamp) on an OperationsTask. | authz: min_org_role=operator | (OperationsTaskClientUpdate1) -> (bool)
|
|
13265
|
+
|
|
13266
|
+
</dd>
|
|
13267
|
+
</dl>
|
|
13268
|
+
</dd>
|
|
13269
|
+
</dl>
|
|
13270
|
+
|
|
13271
|
+
#### 🔌 Usage
|
|
13272
|
+
|
|
13273
|
+
<dl>
|
|
13274
|
+
<dd>
|
|
13275
|
+
|
|
13276
|
+
<dl>
|
|
13277
|
+
<dd>
|
|
13278
|
+
|
|
13279
|
+
```typescript
|
|
13280
|
+
await client.operations.operationsTasks.updateV1("task_id");
|
|
13281
|
+
```
|
|
13282
|
+
|
|
13283
|
+
</dd>
|
|
13284
|
+
</dl>
|
|
13285
|
+
</dd>
|
|
13286
|
+
</dl>
|
|
13287
|
+
|
|
13288
|
+
#### ⚙️ Parameters
|
|
13289
|
+
|
|
13290
|
+
<dl>
|
|
13291
|
+
<dd>
|
|
13292
|
+
|
|
13293
|
+
<dl>
|
|
13294
|
+
<dd>
|
|
13295
|
+
|
|
13296
|
+
**taskId:** `string`
|
|
13297
|
+
|
|
13298
|
+
</dd>
|
|
13299
|
+
</dl>
|
|
13300
|
+
|
|
13301
|
+
<dl>
|
|
13302
|
+
<dd>
|
|
13303
|
+
|
|
13304
|
+
**request:** `Chrt.operations.OperationsTaskClientUpdate1`
|
|
11710
13305
|
|
|
11711
13306
|
</dd>
|
|
11712
13307
|
</dl>
|
|
@@ -11714,7 +13309,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11714
13309
|
<dl>
|
|
11715
13310
|
<dd>
|
|
11716
13311
|
|
|
11717
|
-
**requestOptions:** `
|
|
13312
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
11718
13313
|
|
|
11719
13314
|
</dd>
|
|
11720
13315
|
</dl>
|
|
@@ -11725,7 +13320,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11725
13320
|
</dl>
|
|
11726
13321
|
</details>
|
|
11727
13322
|
|
|
11728
|
-
<details><summary><code>client.operations.
|
|
13323
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
11729
13324
|
<dl>
|
|
11730
13325
|
<dd>
|
|
11731
13326
|
|
|
@@ -11737,7 +13332,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11737
13332
|
<dl>
|
|
11738
13333
|
<dd>
|
|
11739
13334
|
|
|
11740
|
-
|
|
13335
|
+
Creates a new OperationsTask on a Case owned by the caller's organization. | authz: min_org_role=operator | (OperationsTaskClientCreate1) -> (PydanticObjectId)
|
|
11741
13336
|
|
|
11742
13337
|
</dd>
|
|
11743
13338
|
</dl>
|
|
@@ -11753,7 +13348,12 @@ Deletes a department configuration. | authz: min_org_role=administrator | () ->
|
|
|
11753
13348
|
<dd>
|
|
11754
13349
|
|
|
11755
13350
|
```typescript
|
|
11756
|
-
await client.operations.
|
|
13351
|
+
await client.operations.operationsTasks.createV1({
|
|
13352
|
+
schema_version: 1,
|
|
13353
|
+
case_id: "case_id",
|
|
13354
|
+
title: "title",
|
|
13355
|
+
description: "description",
|
|
13356
|
+
});
|
|
11757
13357
|
```
|
|
11758
13358
|
|
|
11759
13359
|
</dd>
|
|
@@ -11769,7 +13369,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11769
13369
|
<dl>
|
|
11770
13370
|
<dd>
|
|
11771
13371
|
|
|
11772
|
-
**
|
|
13372
|
+
**request:** `Chrt.operations.OperationsTaskClientCreate1`
|
|
11773
13373
|
|
|
11774
13374
|
</dd>
|
|
11775
13375
|
</dl>
|
|
@@ -11777,7 +13377,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11777
13377
|
<dl>
|
|
11778
13378
|
<dd>
|
|
11779
13379
|
|
|
11780
|
-
**requestOptions:** `
|
|
13380
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
11781
13381
|
|
|
11782
13382
|
</dd>
|
|
11783
13383
|
</dl>
|
|
@@ -11788,7 +13388,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11788
13388
|
</dl>
|
|
11789
13389
|
</details>
|
|
11790
13390
|
|
|
11791
|
-
<details><summary><code>client.operations.
|
|
13391
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">completeV1</a>(taskId) -> boolean</code></summary>
|
|
11792
13392
|
<dl>
|
|
11793
13393
|
<dd>
|
|
11794
13394
|
|
|
@@ -11800,7 +13400,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11800
13400
|
<dl>
|
|
11801
13401
|
<dd>
|
|
11802
13402
|
|
|
11803
|
-
|
|
13403
|
+
Marks an OperationsTask as completed. Idempotent — calling on an already-completed task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
11804
13404
|
|
|
11805
13405
|
</dd>
|
|
11806
13406
|
</dl>
|
|
@@ -11816,7 +13416,7 @@ Updates a department configuration. | authz: min_org_role=administrator | (Depar
|
|
|
11816
13416
|
<dd>
|
|
11817
13417
|
|
|
11818
13418
|
```typescript
|
|
11819
|
-
await client.operations.
|
|
13419
|
+
await client.operations.operationsTasks.completeV1("task_id");
|
|
11820
13420
|
```
|
|
11821
13421
|
|
|
11822
13422
|
</dd>
|
|
@@ -11832,15 +13432,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11832
13432
|
<dl>
|
|
11833
13433
|
<dd>
|
|
11834
13434
|
|
|
11835
|
-
**
|
|
11836
|
-
|
|
11837
|
-
</dd>
|
|
11838
|
-
</dl>
|
|
11839
|
-
|
|
11840
|
-
<dl>
|
|
11841
|
-
<dd>
|
|
11842
|
-
|
|
11843
|
-
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
13435
|
+
**taskId:** `string`
|
|
11844
13436
|
|
|
11845
13437
|
</dd>
|
|
11846
13438
|
</dl>
|
|
@@ -11848,7 +13440,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11848
13440
|
<dl>
|
|
11849
13441
|
<dd>
|
|
11850
13442
|
|
|
11851
|
-
**requestOptions:** `
|
|
13443
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
11852
13444
|
|
|
11853
13445
|
</dd>
|
|
11854
13446
|
</dl>
|
|
@@ -11859,7 +13451,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11859
13451
|
</dl>
|
|
11860
13452
|
</details>
|
|
11861
13453
|
|
|
11862
|
-
<details><summary><code>client.operations.
|
|
13454
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">uncompleteV1</a>(taskId) -> boolean</code></summary>
|
|
11863
13455
|
<dl>
|
|
11864
13456
|
<dd>
|
|
11865
13457
|
|
|
@@ -11871,7 +13463,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11871
13463
|
<dl>
|
|
11872
13464
|
<dd>
|
|
11873
13465
|
|
|
11874
|
-
|
|
13466
|
+
Marks a previously-completed OperationsTask as incomplete and clears its completion timestamps. Idempotent — calling on an already-incomplete task is a no-op that returns False. | authz: min_org_role=operator | () -> (bool)
|
|
11875
13467
|
|
|
11876
13468
|
</dd>
|
|
11877
13469
|
</dl>
|
|
@@ -11887,11 +13479,7 @@ Creates a new department configuration for the caller's organization. | authz: m
|
|
|
11887
13479
|
<dd>
|
|
11888
13480
|
|
|
11889
13481
|
```typescript
|
|
11890
|
-
await client.operations.
|
|
11891
|
-
schema_version: 1,
|
|
11892
|
-
name: "name",
|
|
11893
|
-
department: "automotive",
|
|
11894
|
-
});
|
|
13482
|
+
await client.operations.operationsTasks.uncompleteV1("task_id");
|
|
11895
13483
|
```
|
|
11896
13484
|
|
|
11897
13485
|
</dd>
|
|
@@ -11907,7 +13495,7 @@ await client.operations.departments.createV1({
|
|
|
11907
13495
|
<dl>
|
|
11908
13496
|
<dd>
|
|
11909
13497
|
|
|
11910
|
-
**
|
|
13498
|
+
**taskId:** `string`
|
|
11911
13499
|
|
|
11912
13500
|
</dd>
|
|
11913
13501
|
</dl>
|
|
@@ -11915,7 +13503,7 @@ await client.operations.departments.createV1({
|
|
|
11915
13503
|
<dl>
|
|
11916
13504
|
<dd>
|
|
11917
13505
|
|
|
11918
|
-
**requestOptions:** `
|
|
13506
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
11919
13507
|
|
|
11920
13508
|
</dd>
|
|
11921
13509
|
</dl>
|
|
@@ -11926,7 +13514,7 @@ await client.operations.departments.createV1({
|
|
|
11926
13514
|
</dl>
|
|
11927
13515
|
</details>
|
|
11928
13516
|
|
|
11929
|
-
<details><summary><code>client.operations.
|
|
13517
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">addCommentV1</a>(taskId, { ...params }) -> string</code></summary>
|
|
11930
13518
|
<dl>
|
|
11931
13519
|
<dd>
|
|
11932
13520
|
|
|
@@ -11938,7 +13526,7 @@ await client.operations.departments.createV1({
|
|
|
11938
13526
|
<dl>
|
|
11939
13527
|
<dd>
|
|
11940
13528
|
|
|
11941
|
-
|
|
13529
|
+
Appends a comment to an OperationsTask's comment thread. Returns the new comment id. | authz: min_org_role=operator | (OperationsTaskAddCommentReq1) -> (str)
|
|
11942
13530
|
|
|
11943
13531
|
</dd>
|
|
11944
13532
|
</dl>
|
|
@@ -11954,7 +13542,9 @@ Adds an operator to a department. | authz: min_org_role=administrator | () -> (b
|
|
|
11954
13542
|
<dd>
|
|
11955
13543
|
|
|
11956
13544
|
```typescript
|
|
11957
|
-
await client.operations.
|
|
13545
|
+
await client.operations.operationsTasks.addCommentV1("task_id", {
|
|
13546
|
+
comment: "comment",
|
|
13547
|
+
});
|
|
11958
13548
|
```
|
|
11959
13549
|
|
|
11960
13550
|
</dd>
|
|
@@ -11970,7 +13560,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11970
13560
|
<dl>
|
|
11971
13561
|
<dd>
|
|
11972
13562
|
|
|
11973
|
-
**
|
|
13563
|
+
**taskId:** `string`
|
|
11974
13564
|
|
|
11975
13565
|
</dd>
|
|
11976
13566
|
</dl>
|
|
@@ -11978,7 +13568,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11978
13568
|
<dl>
|
|
11979
13569
|
<dd>
|
|
11980
13570
|
|
|
11981
|
-
**
|
|
13571
|
+
**request:** `Chrt.operations.OperationsTaskAddCommentReq1`
|
|
11982
13572
|
|
|
11983
13573
|
</dd>
|
|
11984
13574
|
</dl>
|
|
@@ -11986,7 +13576,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11986
13576
|
<dl>
|
|
11987
13577
|
<dd>
|
|
11988
13578
|
|
|
11989
|
-
**requestOptions:** `
|
|
13579
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
11990
13580
|
|
|
11991
13581
|
</dd>
|
|
11992
13582
|
</dl>
|
|
@@ -11997,7 +13587,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11997
13587
|
</dl>
|
|
11998
13588
|
</details>
|
|
11999
13589
|
|
|
12000
|
-
<details><summary><code>client.operations.
|
|
13590
|
+
<details><summary><code>client.operations.operationsTasks.<a href="/src/api/resources/operations/resources/operationsTasks/client/Client.ts">deleteCommentV1</a>(taskId, commentId) -> boolean</code></summary>
|
|
12001
13591
|
<dl>
|
|
12002
13592
|
<dd>
|
|
12003
13593
|
|
|
@@ -12009,7 +13599,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
12009
13599
|
<dl>
|
|
12010
13600
|
<dd>
|
|
12011
13601
|
|
|
12012
|
-
|
|
13602
|
+
Deletes a comment from an OperationsTask's comment thread. 404 if the comment isn't found. | authz: min_org_role=operator | () -> (bool)
|
|
12013
13603
|
|
|
12014
13604
|
</dd>
|
|
12015
13605
|
</dl>
|
|
@@ -12025,7 +13615,7 @@ Removes an operator from a department. | authz: min_org_role=administrator | ()
|
|
|
12025
13615
|
<dd>
|
|
12026
13616
|
|
|
12027
13617
|
```typescript
|
|
12028
|
-
await client.operations.
|
|
13618
|
+
await client.operations.operationsTasks.deleteCommentV1("task_id", "comment_id");
|
|
12029
13619
|
```
|
|
12030
13620
|
|
|
12031
13621
|
</dd>
|
|
@@ -12041,7 +13631,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
12041
13631
|
<dl>
|
|
12042
13632
|
<dd>
|
|
12043
13633
|
|
|
12044
|
-
**
|
|
13634
|
+
**taskId:** `string`
|
|
12045
13635
|
|
|
12046
13636
|
</dd>
|
|
12047
13637
|
</dl>
|
|
@@ -12049,7 +13639,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
12049
13639
|
<dl>
|
|
12050
13640
|
<dd>
|
|
12051
13641
|
|
|
12052
|
-
**
|
|
13642
|
+
**commentId:** `string`
|
|
12053
13643
|
|
|
12054
13644
|
</dd>
|
|
12055
13645
|
</dl>
|
|
@@ -12057,7 +13647,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
12057
13647
|
<dl>
|
|
12058
13648
|
<dd>
|
|
12059
13649
|
|
|
12060
|
-
**requestOptions:** `
|
|
13650
|
+
**requestOptions:** `OperationsTasks.RequestOptions`
|
|
12061
13651
|
|
|
12062
13652
|
</dd>
|
|
12063
13653
|
</dl>
|
|
@@ -13654,6 +15244,77 @@ await client.orgs.complianceDocuments.createV1({
|
|
|
13654
15244
|
</dl>
|
|
13655
15245
|
</details>
|
|
13656
15246
|
|
|
15247
|
+
<details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">updateV1</a>(orgComplianceDocumentId, { ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
|
|
15248
|
+
<dl>
|
|
15249
|
+
<dd>
|
|
15250
|
+
|
|
15251
|
+
#### 📝 Description
|
|
15252
|
+
|
|
15253
|
+
<dl>
|
|
15254
|
+
<dd>
|
|
15255
|
+
|
|
15256
|
+
<dl>
|
|
15257
|
+
<dd>
|
|
15258
|
+
|
|
15259
|
+
Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
|
|
15260
|
+
|
|
15261
|
+
</dd>
|
|
15262
|
+
</dl>
|
|
15263
|
+
</dd>
|
|
15264
|
+
</dl>
|
|
15265
|
+
|
|
15266
|
+
#### 🔌 Usage
|
|
15267
|
+
|
|
15268
|
+
<dl>
|
|
15269
|
+
<dd>
|
|
15270
|
+
|
|
15271
|
+
<dl>
|
|
15272
|
+
<dd>
|
|
15273
|
+
|
|
15274
|
+
```typescript
|
|
15275
|
+
await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
|
|
15276
|
+
```
|
|
15277
|
+
|
|
15278
|
+
</dd>
|
|
15279
|
+
</dl>
|
|
15280
|
+
</dd>
|
|
15281
|
+
</dl>
|
|
15282
|
+
|
|
15283
|
+
#### ⚙️ Parameters
|
|
15284
|
+
|
|
15285
|
+
<dl>
|
|
15286
|
+
<dd>
|
|
15287
|
+
|
|
15288
|
+
<dl>
|
|
15289
|
+
<dd>
|
|
15290
|
+
|
|
15291
|
+
**orgComplianceDocumentId:** `string`
|
|
15292
|
+
|
|
15293
|
+
</dd>
|
|
15294
|
+
</dl>
|
|
15295
|
+
|
|
15296
|
+
<dl>
|
|
15297
|
+
<dd>
|
|
15298
|
+
|
|
15299
|
+
**request:** `Chrt.orgs.OrgComplianceDocumentClientUpdate1`
|
|
15300
|
+
|
|
15301
|
+
</dd>
|
|
15302
|
+
</dl>
|
|
15303
|
+
|
|
15304
|
+
<dl>
|
|
15305
|
+
<dd>
|
|
15306
|
+
|
|
15307
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
15308
|
+
|
|
15309
|
+
</dd>
|
|
15310
|
+
</dl>
|
|
15311
|
+
</dd>
|
|
15312
|
+
</dl>
|
|
15313
|
+
|
|
15314
|
+
</dd>
|
|
15315
|
+
</dl>
|
|
15316
|
+
</details>
|
|
15317
|
+
|
|
13657
15318
|
## Orgs PrivateData
|
|
13658
15319
|
|
|
13659
15320
|
<details><summary><code>client.orgs.privateData.<a href="/src/api/resources/orgs/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.OrgPrivateData1</code></summary>
|
|
@@ -19729,6 +21390,77 @@ await client.shipping.drivers.complianceDocuments.createV1("driver_id", {
|
|
|
19729
21390
|
</dl>
|
|
19730
21391
|
</details>
|
|
19731
21392
|
|
|
21393
|
+
<details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">updateV1</a>(driverComplianceDocumentId, { ...params }) -> Chrt.DriverComplianceDocument1</code></summary>
|
|
21394
|
+
<dl>
|
|
21395
|
+
<dd>
|
|
21396
|
+
|
|
21397
|
+
#### 📝 Description
|
|
21398
|
+
|
|
21399
|
+
<dl>
|
|
21400
|
+
<dd>
|
|
21401
|
+
|
|
21402
|
+
<dl>
|
|
21403
|
+
<dd>
|
|
21404
|
+
|
|
21405
|
+
Updates a driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientUpdate1) -> (DriverComplianceDocument1)
|
|
21406
|
+
|
|
21407
|
+
</dd>
|
|
21408
|
+
</dl>
|
|
21409
|
+
</dd>
|
|
21410
|
+
</dl>
|
|
21411
|
+
|
|
21412
|
+
#### 🔌 Usage
|
|
21413
|
+
|
|
21414
|
+
<dl>
|
|
21415
|
+
<dd>
|
|
21416
|
+
|
|
21417
|
+
<dl>
|
|
21418
|
+
<dd>
|
|
21419
|
+
|
|
21420
|
+
```typescript
|
|
21421
|
+
await client.shipping.drivers.complianceDocuments.updateV1("driver_compliance_document_id");
|
|
21422
|
+
```
|
|
21423
|
+
|
|
21424
|
+
</dd>
|
|
21425
|
+
</dl>
|
|
21426
|
+
</dd>
|
|
21427
|
+
</dl>
|
|
21428
|
+
|
|
21429
|
+
#### ⚙️ Parameters
|
|
21430
|
+
|
|
21431
|
+
<dl>
|
|
21432
|
+
<dd>
|
|
21433
|
+
|
|
21434
|
+
<dl>
|
|
21435
|
+
<dd>
|
|
21436
|
+
|
|
21437
|
+
**driverComplianceDocumentId:** `string`
|
|
21438
|
+
|
|
21439
|
+
</dd>
|
|
21440
|
+
</dl>
|
|
21441
|
+
|
|
21442
|
+
<dl>
|
|
21443
|
+
<dd>
|
|
21444
|
+
|
|
21445
|
+
**request:** `Chrt.shipping.drivers.DriverComplianceDocumentClientUpdate1`
|
|
21446
|
+
|
|
21447
|
+
</dd>
|
|
21448
|
+
</dl>
|
|
21449
|
+
|
|
21450
|
+
<dl>
|
|
21451
|
+
<dd>
|
|
21452
|
+
|
|
21453
|
+
**requestOptions:** `ComplianceDocuments.RequestOptions`
|
|
21454
|
+
|
|
21455
|
+
</dd>
|
|
21456
|
+
</dl>
|
|
21457
|
+
</dd>
|
|
21458
|
+
</dl>
|
|
21459
|
+
|
|
21460
|
+
</dd>
|
|
21461
|
+
</dl>
|
|
21462
|
+
</details>
|
|
21463
|
+
|
|
19732
21464
|
## Shipping Drivers ComplianceDocuments S3Object
|
|
19733
21465
|
|
|
19734
21466
|
<details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> Chrt.DriverComplianceDocumentS3ObjectMetadata1</code></summary>
|
|
@@ -22071,6 +23803,89 @@ await client.shipping.taskArtifacts.s3Object.deleteV1("task_artifact_s3_object_m
|
|
|
22071
23803
|
</dl>
|
|
22072
23804
|
</details>
|
|
22073
23805
|
|
|
23806
|
+
<details><summary><code>client.shipping.taskArtifacts.s3Object.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.ts">writeAiImageDescriptionV1</a>(taskArtifactS3ObjectMetadataId, { ...params }) -> boolean</code></summary>
|
|
23807
|
+
<dl>
|
|
23808
|
+
<dd>
|
|
23809
|
+
|
|
23810
|
+
#### 📝 Description
|
|
23811
|
+
|
|
23812
|
+
<dl>
|
|
23813
|
+
<dd>
|
|
23814
|
+
|
|
23815
|
+
<dl>
|
|
23816
|
+
<dd>
|
|
23817
|
+
|
|
23818
|
+
Writes the AI-generated image description onto an existing TaskArtifactS3ObjectMetadata. Called by the shipping_task_image_analysis Temporal workflow via a delegation JWT. | authz_personas=[driver_for_executor, executor_org_operators, shipper_org_operators, coordinator_org_operators] | (AIImageDescription) -> (bool)
|
|
23819
|
+
|
|
23820
|
+
</dd>
|
|
23821
|
+
</dl>
|
|
23822
|
+
</dd>
|
|
23823
|
+
</dl>
|
|
23824
|
+
|
|
23825
|
+
#### 🔌 Usage
|
|
23826
|
+
|
|
23827
|
+
<dl>
|
|
23828
|
+
<dd>
|
|
23829
|
+
|
|
23830
|
+
<dl>
|
|
23831
|
+
<dd>
|
|
23832
|
+
|
|
23833
|
+
```typescript
|
|
23834
|
+
await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_artifact_s3_object_metadata_id", {
|
|
23835
|
+
model: "gpt-5.5",
|
|
23836
|
+
summary: "summary",
|
|
23837
|
+
package_types: ["package_types"],
|
|
23838
|
+
package_appearance: "package_appearance",
|
|
23839
|
+
readable_package_text: ["readable_package_text"],
|
|
23840
|
+
cargo_identity_assessment: "cargo_identity_assessment",
|
|
23841
|
+
location_description: "location_description",
|
|
23842
|
+
location_identifiers: ["location_identifiers"],
|
|
23843
|
+
completion_evidence: "completion_evidence",
|
|
23844
|
+
proof_notes: ["proof_notes"],
|
|
23845
|
+
dispute_defensibility: "dispute_defensibility",
|
|
23846
|
+
});
|
|
23847
|
+
```
|
|
23848
|
+
|
|
23849
|
+
</dd>
|
|
23850
|
+
</dl>
|
|
23851
|
+
</dd>
|
|
23852
|
+
</dl>
|
|
23853
|
+
|
|
23854
|
+
#### ⚙️ Parameters
|
|
23855
|
+
|
|
23856
|
+
<dl>
|
|
23857
|
+
<dd>
|
|
23858
|
+
|
|
23859
|
+
<dl>
|
|
23860
|
+
<dd>
|
|
23861
|
+
|
|
23862
|
+
**taskArtifactS3ObjectMetadataId:** `string`
|
|
23863
|
+
|
|
23864
|
+
</dd>
|
|
23865
|
+
</dl>
|
|
23866
|
+
|
|
23867
|
+
<dl>
|
|
23868
|
+
<dd>
|
|
23869
|
+
|
|
23870
|
+
**request:** `Chrt.AiImageDescription`
|
|
23871
|
+
|
|
23872
|
+
</dd>
|
|
23873
|
+
</dl>
|
|
23874
|
+
|
|
23875
|
+
<dl>
|
|
23876
|
+
<dd>
|
|
23877
|
+
|
|
23878
|
+
**requestOptions:** `S3Object.RequestOptions`
|
|
23879
|
+
|
|
23880
|
+
</dd>
|
|
23881
|
+
</dl>
|
|
23882
|
+
</dd>
|
|
23883
|
+
</dl>
|
|
23884
|
+
|
|
23885
|
+
</dd>
|
|
23886
|
+
</dl>
|
|
23887
|
+
</details>
|
|
23888
|
+
|
|
22074
23889
|
## Shipping TaskGroups TaskGroupId
|
|
22075
23890
|
|
|
22076
23891
|
<details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forExecutorOperatorsV1</a>(orderRef) -> string[]</code></summary>
|