@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
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../../../../../../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* sort_by: "deadline_timestamp",
|
|
9
|
+
* sort_order: "asc",
|
|
10
|
+
* page: 1,
|
|
11
|
+
* page_size: 1,
|
|
12
|
+
* filter_case_id: "filter_case_id",
|
|
13
|
+
* filter_completed: true,
|
|
14
|
+
* filter_deadline_gte: "2024-01-15T09:30:00Z",
|
|
15
|
+
* filter_deadline_lte: "2024-01-15T09:30:00Z"
|
|
16
|
+
* }
|
|
17
|
+
*/
|
|
18
|
+
export interface OperationsTasksListV1Request {
|
|
19
|
+
/** Field to sort by */
|
|
20
|
+
sort_by?: Chrt.OperationsTaskSortByEnum | null;
|
|
21
|
+
/** Sort order (asc or desc) */
|
|
22
|
+
sort_order?: Chrt.SortOrderEnum | null;
|
|
23
|
+
page?: number | null;
|
|
24
|
+
page_size?: number | null;
|
|
25
|
+
/** Filter by case id */
|
|
26
|
+
filter_case_id?: string | null;
|
|
27
|
+
/** Filter by completed flag. Defaults to False for incomplete tasks. */
|
|
28
|
+
filter_completed?: boolean | null;
|
|
29
|
+
/** Filter to tasks with deadline >= this timestamp */
|
|
30
|
+
filter_deadline_gte?: string | null;
|
|
31
|
+
/** Filter to tasks with deadline <= this timestamp */
|
|
32
|
+
filter_deadline_lte?: string | null;
|
|
33
|
+
}
|
package/dist/esm/api/resources/operations/resources/operationsTasks/client/requests/index.d.mts
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { type OperationsTasksListV1Request } from "./OperationsTasksListV1Request.mjs";
|
|
2
|
+
export { type OperationsTaskClientUpdate1 } from "./OperationsTaskClientUpdate1.mjs";
|
|
3
|
+
export { type OperationsTaskClientCreate1 } from "./OperationsTaskClientCreate1.mjs";
|
|
4
|
+
export { type OperationsTaskAddCommentReq1 } from "./OperationsTaskAddCommentReq1.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./client/index.mjs";
|
|
@@ -72,5 +72,19 @@ export declare class ComplianceDocuments {
|
|
|
72
72
|
*/
|
|
73
73
|
createV1(request: Chrt.orgs.OrgComplianceDocumentClientCreate1, requestOptions?: ComplianceDocuments.RequestOptions): core.HttpResponsePromise<Chrt.OrgComplianceDocument1>;
|
|
74
74
|
private __createV1;
|
|
75
|
+
/**
|
|
76
|
+
* Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
|
|
77
|
+
*
|
|
78
|
+
* @param {string} orgComplianceDocumentId
|
|
79
|
+
* @param {Chrt.orgs.OrgComplianceDocumentClientUpdate1} request
|
|
80
|
+
* @param {ComplianceDocuments.RequestOptions} requestOptions - Request-specific configuration.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* await client.orgs.complianceDocuments.updateV1("org_compliance_document_id")
|
|
86
|
+
*/
|
|
87
|
+
updateV1(orgComplianceDocumentId: string, request?: Chrt.orgs.OrgComplianceDocumentClientUpdate1, requestOptions?: ComplianceDocuments.RequestOptions): core.HttpResponsePromise<Chrt.OrgComplianceDocument1>;
|
|
88
|
+
private __updateV1;
|
|
75
89
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
76
90
|
}
|
|
@@ -199,6 +199,69 @@ export class ComplianceDocuments {
|
|
|
199
199
|
}
|
|
200
200
|
});
|
|
201
201
|
}
|
|
202
|
+
/**
|
|
203
|
+
* Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
|
|
204
|
+
*
|
|
205
|
+
* @param {string} orgComplianceDocumentId
|
|
206
|
+
* @param {Chrt.orgs.OrgComplianceDocumentClientUpdate1} request
|
|
207
|
+
* @param {ComplianceDocuments.RequestOptions} requestOptions - Request-specific configuration.
|
|
208
|
+
*
|
|
209
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* await client.orgs.complianceDocuments.updateV1("org_compliance_document_id")
|
|
213
|
+
*/
|
|
214
|
+
updateV1(orgComplianceDocumentId, request = {}, requestOptions) {
|
|
215
|
+
return core.HttpResponsePromise.fromPromise(this.__updateV1(orgComplianceDocumentId, request, requestOptions));
|
|
216
|
+
}
|
|
217
|
+
__updateV1(orgComplianceDocumentId_1) {
|
|
218
|
+
return __awaiter(this, arguments, void 0, function* (orgComplianceDocumentId, request = {}, requestOptions) {
|
|
219
|
+
var _a, _b, _c, _d;
|
|
220
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
221
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
222
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `orgs/compliance_documents/update/v1/${encodeURIComponent(orgComplianceDocumentId)}`),
|
|
223
|
+
method: "PATCH",
|
|
224
|
+
headers: _headers,
|
|
225
|
+
contentType: "application/json",
|
|
226
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
227
|
+
requestType: "json",
|
|
228
|
+
body: request,
|
|
229
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
230
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
231
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
232
|
+
});
|
|
233
|
+
if (_response.ok) {
|
|
234
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
235
|
+
}
|
|
236
|
+
if (_response.error.reason === "status-code") {
|
|
237
|
+
switch (_response.error.statusCode) {
|
|
238
|
+
case 422:
|
|
239
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
240
|
+
default:
|
|
241
|
+
throw new errors.ChrtError({
|
|
242
|
+
statusCode: _response.error.statusCode,
|
|
243
|
+
body: _response.error.body,
|
|
244
|
+
rawResponse: _response.rawResponse,
|
|
245
|
+
});
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
switch (_response.error.reason) {
|
|
249
|
+
case "non-json":
|
|
250
|
+
throw new errors.ChrtError({
|
|
251
|
+
statusCode: _response.error.statusCode,
|
|
252
|
+
body: _response.error.rawBody,
|
|
253
|
+
rawResponse: _response.rawResponse,
|
|
254
|
+
});
|
|
255
|
+
case "timeout":
|
|
256
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /orgs/compliance_documents/update/v1/{org_compliance_document_id}.");
|
|
257
|
+
case "unknown":
|
|
258
|
+
throw new errors.ChrtError({
|
|
259
|
+
message: _response.error.errorMessage,
|
|
260
|
+
rawResponse: _response.rawResponse,
|
|
261
|
+
});
|
|
262
|
+
}
|
|
263
|
+
});
|
|
264
|
+
}
|
|
202
265
|
_getAuthorizationHeader() {
|
|
203
266
|
return __awaiter(this, void 0, void 0, function* () {
|
|
204
267
|
const bearer = yield core.Supplier.get(this._options.token);
|
|
@@ -12,6 +12,7 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
12
12
|
export interface OrgComplianceDocumentClientCreate1 {
|
|
13
13
|
schema_version: number;
|
|
14
14
|
document_type: Chrt.OrgComplianceDocumentTypeEnum1;
|
|
15
|
+
description?: string | null;
|
|
15
16
|
valid_from?: string | null;
|
|
16
17
|
valid_until?: string | null;
|
|
17
18
|
}
|
|
@@ -76,5 +76,19 @@ export declare class ComplianceDocuments {
|
|
|
76
76
|
*/
|
|
77
77
|
createV1(driverId: string, request: Chrt.shipping.drivers.DriverComplianceDocumentClientCreate1, requestOptions?: ComplianceDocuments.RequestOptions): core.HttpResponsePromise<Chrt.DriverComplianceDocument1>;
|
|
78
78
|
private __createV1;
|
|
79
|
+
/**
|
|
80
|
+
* Updates a driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientUpdate1) -> (DriverComplianceDocument1)
|
|
81
|
+
*
|
|
82
|
+
* @param {string} driverComplianceDocumentId
|
|
83
|
+
* @param {Chrt.shipping.drivers.DriverComplianceDocumentClientUpdate1} request
|
|
84
|
+
* @param {ComplianceDocuments.RequestOptions} requestOptions - Request-specific configuration.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* await client.shipping.drivers.complianceDocuments.updateV1("driver_compliance_document_id")
|
|
90
|
+
*/
|
|
91
|
+
updateV1(driverComplianceDocumentId: string, request?: Chrt.shipping.drivers.DriverComplianceDocumentClientUpdate1, requestOptions?: ComplianceDocuments.RequestOptions): core.HttpResponsePromise<Chrt.DriverComplianceDocument1>;
|
|
92
|
+
private __updateV1;
|
|
79
93
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
80
94
|
}
|
|
@@ -208,6 +208,69 @@ export class ComplianceDocuments {
|
|
|
208
208
|
}
|
|
209
209
|
});
|
|
210
210
|
}
|
|
211
|
+
/**
|
|
212
|
+
* Updates a driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientUpdate1) -> (DriverComplianceDocument1)
|
|
213
|
+
*
|
|
214
|
+
* @param {string} driverComplianceDocumentId
|
|
215
|
+
* @param {Chrt.shipping.drivers.DriverComplianceDocumentClientUpdate1} request
|
|
216
|
+
* @param {ComplianceDocuments.RequestOptions} requestOptions - Request-specific configuration.
|
|
217
|
+
*
|
|
218
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
219
|
+
*
|
|
220
|
+
* @example
|
|
221
|
+
* await client.shipping.drivers.complianceDocuments.updateV1("driver_compliance_document_id")
|
|
222
|
+
*/
|
|
223
|
+
updateV1(driverComplianceDocumentId, request = {}, requestOptions) {
|
|
224
|
+
return core.HttpResponsePromise.fromPromise(this.__updateV1(driverComplianceDocumentId, request, requestOptions));
|
|
225
|
+
}
|
|
226
|
+
__updateV1(driverComplianceDocumentId_1) {
|
|
227
|
+
return __awaiter(this, arguments, void 0, function* (driverComplianceDocumentId, request = {}, requestOptions) {
|
|
228
|
+
var _a, _b, _c, _d;
|
|
229
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
230
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
231
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/drivers/compliance_documents/update/v1/${encodeURIComponent(driverComplianceDocumentId)}`),
|
|
232
|
+
method: "PATCH",
|
|
233
|
+
headers: _headers,
|
|
234
|
+
contentType: "application/json",
|
|
235
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
236
|
+
requestType: "json",
|
|
237
|
+
body: request,
|
|
238
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
239
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
240
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
241
|
+
});
|
|
242
|
+
if (_response.ok) {
|
|
243
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
244
|
+
}
|
|
245
|
+
if (_response.error.reason === "status-code") {
|
|
246
|
+
switch (_response.error.statusCode) {
|
|
247
|
+
case 422:
|
|
248
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
249
|
+
default:
|
|
250
|
+
throw new errors.ChrtError({
|
|
251
|
+
statusCode: _response.error.statusCode,
|
|
252
|
+
body: _response.error.body,
|
|
253
|
+
rawResponse: _response.rawResponse,
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
switch (_response.error.reason) {
|
|
258
|
+
case "non-json":
|
|
259
|
+
throw new errors.ChrtError({
|
|
260
|
+
statusCode: _response.error.statusCode,
|
|
261
|
+
body: _response.error.rawBody,
|
|
262
|
+
rawResponse: _response.rawResponse,
|
|
263
|
+
});
|
|
264
|
+
case "timeout":
|
|
265
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/drivers/compliance_documents/update/v1/{driver_compliance_document_id}.");
|
|
266
|
+
case "unknown":
|
|
267
|
+
throw new errors.ChrtError({
|
|
268
|
+
message: _response.error.errorMessage,
|
|
269
|
+
rawResponse: _response.rawResponse,
|
|
270
|
+
});
|
|
271
|
+
}
|
|
272
|
+
});
|
|
273
|
+
}
|
|
211
274
|
_getAuthorizationHeader() {
|
|
212
275
|
return __awaiter(this, void 0, void 0, function* () {
|
|
213
276
|
const bearer = yield core.Supplier.get(this._options.token);
|
|
@@ -12,6 +12,7 @@ import * as Chrt from "../../../../../../../../index.mjs";
|
|
|
12
12
|
export interface DriverComplianceDocumentClientCreate1 {
|
|
13
13
|
schema_version: number;
|
|
14
14
|
document_type: Chrt.DriverComplianceDocumentTypeEnum1;
|
|
15
|
+
description?: string | null;
|
|
15
16
|
valid_from?: string | null;
|
|
16
17
|
valid_until?: string | null;
|
|
17
18
|
}
|
|
@@ -79,5 +79,31 @@ export declare class S3Object {
|
|
|
79
79
|
*/
|
|
80
80
|
deleteV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
81
81
|
private __deleteV1;
|
|
82
|
+
/**
|
|
83
|
+
* 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)
|
|
84
|
+
*
|
|
85
|
+
* @param {string} taskArtifactS3ObjectMetadataId
|
|
86
|
+
* @param {Chrt.AiImageDescription} request
|
|
87
|
+
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_artifact_s3_object_metadata_id", {
|
|
93
|
+
* model: "gpt-5.5",
|
|
94
|
+
* summary: "summary",
|
|
95
|
+
* package_types: ["package_types"],
|
|
96
|
+
* package_appearance: "package_appearance",
|
|
97
|
+
* readable_package_text: ["readable_package_text"],
|
|
98
|
+
* cargo_identity_assessment: "cargo_identity_assessment",
|
|
99
|
+
* location_description: "location_description",
|
|
100
|
+
* location_identifiers: ["location_identifiers"],
|
|
101
|
+
* completion_evidence: "completion_evidence",
|
|
102
|
+
* proof_notes: ["proof_notes"],
|
|
103
|
+
* dispute_defensibility: "dispute_defensibility"
|
|
104
|
+
* })
|
|
105
|
+
*/
|
|
106
|
+
writeAiImageDescriptionV1(taskArtifactS3ObjectMetadataId: string, request: Chrt.AiImageDescription, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<boolean>;
|
|
107
|
+
private __writeAiImageDescriptionV1;
|
|
82
108
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
83
109
|
}
|
package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/s3Object/client/Client.mjs
CHANGED
|
@@ -259,6 +259,81 @@ export class S3Object {
|
|
|
259
259
|
}
|
|
260
260
|
});
|
|
261
261
|
}
|
|
262
|
+
/**
|
|
263
|
+
* 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)
|
|
264
|
+
*
|
|
265
|
+
* @param {string} taskArtifactS3ObjectMetadataId
|
|
266
|
+
* @param {Chrt.AiImageDescription} request
|
|
267
|
+
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
268
|
+
*
|
|
269
|
+
* @throws {@link Chrt.UnprocessableEntityError}
|
|
270
|
+
*
|
|
271
|
+
* @example
|
|
272
|
+
* await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_artifact_s3_object_metadata_id", {
|
|
273
|
+
* model: "gpt-5.5",
|
|
274
|
+
* summary: "summary",
|
|
275
|
+
* package_types: ["package_types"],
|
|
276
|
+
* package_appearance: "package_appearance",
|
|
277
|
+
* readable_package_text: ["readable_package_text"],
|
|
278
|
+
* cargo_identity_assessment: "cargo_identity_assessment",
|
|
279
|
+
* location_description: "location_description",
|
|
280
|
+
* location_identifiers: ["location_identifiers"],
|
|
281
|
+
* completion_evidence: "completion_evidence",
|
|
282
|
+
* proof_notes: ["proof_notes"],
|
|
283
|
+
* dispute_defensibility: "dispute_defensibility"
|
|
284
|
+
* })
|
|
285
|
+
*/
|
|
286
|
+
writeAiImageDescriptionV1(taskArtifactS3ObjectMetadataId, request, requestOptions) {
|
|
287
|
+
return core.HttpResponsePromise.fromPromise(this.__writeAiImageDescriptionV1(taskArtifactS3ObjectMetadataId, request, requestOptions));
|
|
288
|
+
}
|
|
289
|
+
__writeAiImageDescriptionV1(taskArtifactS3ObjectMetadataId, request, requestOptions) {
|
|
290
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
291
|
+
var _a, _b, _c, _d;
|
|
292
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
293
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
294
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/task_artifacts/s3_object/ai_image_description/v1/${encodeURIComponent(taskArtifactS3ObjectMetadataId)}`),
|
|
295
|
+
method: "PATCH",
|
|
296
|
+
headers: _headers,
|
|
297
|
+
contentType: "application/json",
|
|
298
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
299
|
+
requestType: "json",
|
|
300
|
+
body: request,
|
|
301
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
302
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
303
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
304
|
+
});
|
|
305
|
+
if (_response.ok) {
|
|
306
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
307
|
+
}
|
|
308
|
+
if (_response.error.reason === "status-code") {
|
|
309
|
+
switch (_response.error.statusCode) {
|
|
310
|
+
case 422:
|
|
311
|
+
throw new Chrt.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
312
|
+
default:
|
|
313
|
+
throw new errors.ChrtError({
|
|
314
|
+
statusCode: _response.error.statusCode,
|
|
315
|
+
body: _response.error.body,
|
|
316
|
+
rawResponse: _response.rawResponse,
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
switch (_response.error.reason) {
|
|
321
|
+
case "non-json":
|
|
322
|
+
throw new errors.ChrtError({
|
|
323
|
+
statusCode: _response.error.statusCode,
|
|
324
|
+
body: _response.error.rawBody,
|
|
325
|
+
rawResponse: _response.rawResponse,
|
|
326
|
+
});
|
|
327
|
+
case "timeout":
|
|
328
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /shipping/task_artifacts/s3_object/ai_image_description/v1/{task_artifact_s3_object_metadata_id}.");
|
|
329
|
+
case "unknown":
|
|
330
|
+
throw new errors.ChrtError({
|
|
331
|
+
message: _response.error.errorMessage,
|
|
332
|
+
rawResponse: _response.rawResponse,
|
|
333
|
+
});
|
|
334
|
+
}
|
|
335
|
+
});
|
|
336
|
+
}
|
|
262
337
|
_getAuthorizationHeader() {
|
|
263
338
|
return __awaiter(this, void 0, void 0, function* () {
|
|
264
339
|
const bearer = yield core.Supplier.get(this._options.token);
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Structured, factual description of a task-artifact image produced by an LLM.
|
|
7
|
+
*
|
|
8
|
+
* Stored on `TaskArtifactS3ObjectMetadata1.ai_image_description` so downstream
|
|
9
|
+
* consumers (Q&A, search, audit, case checks) can answer questions about the
|
|
10
|
+
* artifact without re-sending the image. `model` records which LLM produced
|
|
11
|
+
* the description; `provider` is derived from `model` so the two can never
|
|
12
|
+
* disagree.
|
|
13
|
+
*/
|
|
14
|
+
export interface AiImageDescription {
|
|
15
|
+
schema_version?: number;
|
|
16
|
+
model: Chrt.LlmModelEnum;
|
|
17
|
+
summary: string;
|
|
18
|
+
package_count?: number | null;
|
|
19
|
+
package_types: string[];
|
|
20
|
+
package_appearance: string;
|
|
21
|
+
readable_package_text: string[];
|
|
22
|
+
cargo_identity_assessment: string;
|
|
23
|
+
location_description: string;
|
|
24
|
+
location_identifiers: string[];
|
|
25
|
+
completion_evidence: string;
|
|
26
|
+
proof_notes: string[];
|
|
27
|
+
dispute_defensibility: string;
|
|
28
|
+
searchable_facts?: string[];
|
|
29
|
+
unresolved_questions?: string[];
|
|
30
|
+
}
|
|
@@ -17,6 +17,10 @@ export interface Case1 {
|
|
|
17
17
|
status?: Chrt.CaseStatusEnum;
|
|
18
18
|
needs_action?: boolean;
|
|
19
19
|
messages?: Chrt.CaseMessage1[];
|
|
20
|
+
enabled_check_keys?: Chrt.CheckEnum[];
|
|
21
|
+
disabled_check_keys?: Chrt.CheckEnum[];
|
|
22
|
+
checks?: Chrt.Check1[];
|
|
23
|
+
checks_summary?: Chrt.CaseChecksSummary1;
|
|
20
24
|
/** Must be a string starting with `user_` */
|
|
21
25
|
created_by_user_id: string;
|
|
22
26
|
created_at: string;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Denormalized summary cache for `Case.checks` plus applied-Checklist log.
|
|
7
|
+
*
|
|
8
|
+
* Embedded at `Case.checks_summary`. Rewritten on every mutation of
|
|
9
|
+
* `Case.checks` (or `applied_checklist_ids`) so the operator dashboard
|
|
10
|
+
* can filter / sort / count Cases without scanning the `checks` array.
|
|
11
|
+
* Dismissed checks are excluded from every cache field.
|
|
12
|
+
*
|
|
13
|
+
* `OperationsEventEnum` is exported alongside this model because the
|
|
14
|
+
* Case-level event log (forthcoming) will key off the same vocabulary;
|
|
15
|
+
* keeping the import here documents the shared dependency.
|
|
16
|
+
*/
|
|
17
|
+
export interface CaseChecksSummary1 {
|
|
18
|
+
schema_version: number;
|
|
19
|
+
applied_checklist_ids?: string[];
|
|
20
|
+
success_count?: number;
|
|
21
|
+
failure_count?: number;
|
|
22
|
+
unsure_count?: number;
|
|
23
|
+
error_count?: number;
|
|
24
|
+
failure_check_keys?: Chrt.CheckEnum[];
|
|
25
|
+
unsure_check_keys?: Chrt.CheckEnum[];
|
|
26
|
+
error_check_keys?: Chrt.CheckEnum[];
|
|
27
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* One evaluation of a check against a specific event-entity instance.
|
|
7
|
+
*
|
|
8
|
+
* Embedded as a list element on `Case.checks`. Uniqueness on the Case
|
|
9
|
+
* is `(check, entity_id)` — each Checklist'd check fans out into one
|
|
10
|
+
* `Check1` per event-entity it fires against. `entity_id` is whatever
|
|
11
|
+
* identifies the unique "instance of this event" — `order_id` for
|
|
12
|
+
* `order.*` events (1× per Case), `task_group_id` for
|
|
13
|
+
* `task_group.driver_assigned`, `task_artifact_id` for
|
|
14
|
+
* `task_artifact.*`, `task_id` for `task.completed`. See
|
|
15
|
+
* `CheckEnum`'s docstring for the per-event mapping.
|
|
16
|
+
*
|
|
17
|
+
* The workflow that runs the check writes `status` and
|
|
18
|
+
* `completed_at_timestamp` back when it finishes. Operators dismiss a
|
|
19
|
+
* specific run (one `(check, entity_id)`) by transitioning its
|
|
20
|
+
* `status` to `DISMISSED`; dismissing does *not* affect future runs
|
|
21
|
+
* of the same check on different `entity_id`s. `DISMISSED` is just
|
|
22
|
+
* another status, not a side-flag, so workflows can short-circuit
|
|
23
|
+
* with a single predicate and the dashboard cache counts naturally
|
|
24
|
+
* exclude it. The *who* / *when* of every status transition lives in
|
|
25
|
+
* the forthcoming Case event log, not on `Check1`.
|
|
26
|
+
*/
|
|
27
|
+
export interface Check1 {
|
|
28
|
+
schema_version: number;
|
|
29
|
+
check: Chrt.CheckEnum;
|
|
30
|
+
entity_id: string;
|
|
31
|
+
status?: Chrt.CheckStatusEnum;
|
|
32
|
+
completed_at_timestamp?: string | null;
|
|
33
|
+
}
|