@rossum/api-client 0.1.30 → 0.2.1

package/types/src/queues/endpoints/list.d.ts

@@ -6,11 +6,13 @@ export type QueueListQuery = {
     page?: number;
     ordering?: string[];
     id?: number[];
+    workspace?: number[];
     deleting?: boolean;
     name?: string;
-    dedicatedEngine?: number;
-    genericEngine?: number;
-    engine?: number;
+    dedicatedEngine?: number[];
+    genericEngine?: number[];
+    engine?: number[];
+    hooks?: number[];
 };
 type WithFields<T, F> = T & {
     fields?: F[];
@@ -230,7 +232,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                 }>>;
                 annotationListTable: z.ZodOptional<z.ZodOptional<z.ZodObject<{
                     columns: z.ZodArray<z.ZodUnion<[z.ZodObject<{
-                        metaName: z.ZodUnion<[z.ZodLiteral<"original_file_name">, z.ZodLiteral<"queue">, z.ZodLiteral<"status">, z.ZodLiteral<"labels">, z.ZodLiteral<"details">, z.ZodUnion<[z.ZodLiteral<"created_at">, z.ZodLiteral<"modified_at">, z.ZodLiteral<"exported_at">, z.ZodLiteral<"confirmed_at">, z.ZodLiteral<"rejected_at">, z.ZodLiteral<"deleted_at">, z.ZodLiteral<"assigned_at">, z.ZodLiteral<"export_failed_at">]>, z.ZodUnion<[z.ZodLiteral<"exported_by">, z.ZodLiteral<"confirmed_by">, z.ZodLiteral<"rejected_by">, z.ZodLiteral<"deleted_by">, z.ZodLiteral<"modifier">, z.ZodLiteral<"assignees">, z.ZodLiteral<"creator">]>]>;
+                        metaName: z.ZodUnion<[z.ZodLiteral<"annotation">, z.ZodLiteral<"original_file_name">, z.ZodLiteral<"queue">, z.ZodLiteral<"status">, z.ZodLiteral<"labels">, z.ZodLiteral<"details">, z.ZodUnion<[z.ZodLiteral<"created_at">, z.ZodLiteral<"modified_at">, z.ZodLiteral<"exported_at">, z.ZodLiteral<"confirmed_at">, z.ZodLiteral<"rejected_at">, z.ZodLiteral<"deleted_at">, z.ZodLiteral<"assigned_at">, z.ZodLiteral<"export_failed_at">]>, z.ZodUnion<[z.ZodLiteral<"exported_by">, z.ZodLiteral<"confirmed_by">, z.ZodLiteral<"rejected_by">, z.ZodLiteral<"deleted_by">, z.ZodLiteral<"modifier">, z.ZodLiteral<"assignees">, z.ZodLiteral<"creator">]>]>;
                         columnType: z.ZodLiteral<"meta">;
                         visible: z.ZodBoolean;
                         width: z.ZodNumber;
@@ -238,12 +240,12 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     }, {
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     }>, z.ZodObject<{
                         schemaId: z.ZodString;
                         dataType: z.ZodUnion<[z.ZodLiteral<"number">, z.ZodLiteral<"string">, z.ZodLiteral<"date">, z.ZodLiteral<"boolean">]>;
@@ -278,7 +280,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 }, {
                     columns: ({
@@ -292,12 +294,69 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 }>>>;
                 uploadValues: z.ZodOptional<z.ZodOptional<z.ZodUnknown>>;
                 complexTables: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
                 uiUploadEnabled: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+                uiOnEditConfirm: z.ZodOptional<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"annotation_list">, z.ZodLiteral<"edit_next">, z.ZodLiteral<"validate_first">]>>>;
+                uiValidationScreenEnabled: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
+                uiEditValues: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+                    id: z.ZodString;
+                    label: z.ZodString;
+                    required: z.ZodBoolean;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    label: string;
+                    required: boolean;
+                }, {
+                    id: string;
+                    label: string;
+                    required: boolean;
+                }>, z.ZodObject<{
+                    dataType: z.ZodLiteral<"enum">;
+                    enumOptions: z.ZodArray<z.ZodObject<{
+                        label: z.ZodString;
+                        value: z.ZodString;
+                    }, "strip", z.ZodTypeAny, {
+                        value: string;
+                        label: string;
+                    }, {
+                        value: string;
+                        label: string;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }, {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }>>, z.ZodIntersection<z.ZodObject<{
+                    id: z.ZodString;
+                    label: z.ZodString;
+                    required: z.ZodBoolean;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    label: string;
+                    required: boolean;
+                }, {
+                    id: string;
+                    label: string;
+                    required: boolean;
+                }>, z.ZodObject<{
+                    dataType: z.ZodLiteral<"string">;
+                }, "strip", z.ZodTypeAny, {
+                    dataType: "string";
+                }, {
+                    dataType: "string";
+                }>>]>, "many">>>;
             }, "strip", z.ZodTypeAny, {
                 columns?: {
                     schemaId: string;
@@ -363,12 +422,31 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             }, {
                 columns?: {
                     schemaId: string;
@@ -434,12 +512,31 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             }>;
             documentLifetime: z.ZodNullable<z.ZodString>;
             dedicatedEngine: z.ZodNullable<z.ZodString>;
@@ -455,6 +552,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
             sessionTimeout: string;
             id: number;
             schema: string;
+            trainingEnabled: boolean;
             name: string;
             workflows: Record<string, string | number>[];
             workspace: string | null;
@@ -537,18 +635,36 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             };
             documentLifetime: string | null;
             dedicatedEngine: string | null;
             genericEngine: string | null;
             engine: string | null;
-            trainingEnabled: boolean;
             deleteAfter: string | null;
             metadata?: unknown;
         }, {
@@ -557,6 +673,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
             sessionTimeout: string;
             id: number;
             schema: string;
+            trainingEnabled: boolean;
             name: string;
             workflows: Record<string, string | number>[];
             workspace: string | null;
@@ -639,18 +756,36 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             };
             documentLifetime: string | null;
             dedicatedEngine: string | null;
             genericEngine: string | null;
             engine: string | null;
-            trainingEnabled: boolean;
             deleteAfter: string | null;
             metadata?: unknown;
         }>, "many">;
@@ -661,6 +796,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
             sessionTimeout: string;
             id: number;
             schema: string;
+            trainingEnabled: boolean;
             name: string;
             workflows: Record<string, string | number>[];
             workspace: string | null;
@@ -743,18 +879,36 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             };
             documentLifetime: string | null;
             dedicatedEngine: string | null;
             genericEngine: string | null;
             engine: string | null;
-            trainingEnabled: boolean;
             deleteAfter: string | null;
             metadata?: unknown;
         }[];
@@ -771,6 +925,7 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
             sessionTimeout: string;
             id: number;
             schema: string;
+            trainingEnabled: boolean;
             name: string;
             workflows: Record<string, string | number>[];
             workspace: string | null;
@@ -853,18 +1008,36 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
                         width: number;
                         columnType: "meta";
                         visible: boolean;
-                        metaName: "status" | "assignees" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
+                        metaName: "status" | "assignees" | "annotation" | "queue" | "creator" | "modifier" | "labels" | "created_at" | "modified_at" | "exported_at" | "confirmed_at" | "rejected_at" | "deleted_at" | "assigned_at" | "export_failed_at" | "exported_by" | "confirmed_by" | "rejected_by" | "deleted_by" | "original_file_name" | "details";
                     })[];
                 } | undefined;
                 uploadValues?: unknown;
                 complexTables?: boolean | undefined;
                 uiUploadEnabled?: boolean | undefined;
+                uiOnEditConfirm?: "annotation_list" | "edit_next" | "validate_first" | undefined;
+                uiValidationScreenEnabled?: boolean | undefined;
+                uiEditValues?: (({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "enum";
+                    enumOptions: {
+                        value: string;
+                        label: string;
+                    }[];
+                }) | ({
+                    id: string;
+                    label: string;
+                    required: boolean;
+                } & {
+                    dataType: "string";
+                }))[] | undefined;
             };
             documentLifetime: string | null;
             dedicatedEngine: string | null;
             genericEngine: string | null;
             engine: string | null;
-            trainingEnabled: boolean;
             deleteAfter: string | null;
             metadata?: unknown;
         }[];
@@ -877,14 +1050,17 @@ export declare const list: <FieldsT extends keyof Queue = keyof Queue>(query?: W
     }>;
     readonly query: {
         readonly deleting: false;
+        readonly includeTotal: true;
         readonly pageSize?: number;
         readonly page?: number;
         readonly ordering?: string[];
         readonly id?: number[];
+        readonly workspace?: number[];
         readonly name?: string;
-        readonly dedicatedEngine?: number;
-        readonly genericEngine?: number;
-        readonly engine?: number;
+        readonly dedicatedEngine?: number[];
+        readonly genericEngine?: number[];
+        readonly engine?: number[];
+        readonly hooks?: number[];
         readonly fields?: FieldsT[] | undefined;
     };
     readonly querySchema: ZodType<WithFields<QueueListQuery, FieldsT>>;

package/types/src/queues/endpoints/list.schema.d.ts

@@ -4,31 +4,37 @@ export declare const queueListQuerySchema: z.ZodObject<{
     page: z.ZodOptional<z.ZodNumber>;
     ordering: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     id: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    workspace: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
     deleting: z.ZodOptional<z.ZodBoolean>;
     name: z.ZodOptional<z.ZodString>;
-    dedicatedEngine: z.ZodOptional<z.ZodNumber>;
-    genericEngine: z.ZodOptional<z.ZodNumber>;
-    engine: z.ZodOptional<z.ZodNumber>;
+    dedicatedEngine: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    genericEngine: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    engine: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    hooks: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
 }, "strip", z.ZodTypeAny, {
     pageSize?: number | undefined;
     page?: number | undefined;
     ordering?: string[] | undefined;
     id?: number[] | undefined;
+    workspace?: number[] | undefined;
     deleting?: boolean | undefined;
     name?: string | undefined;
-    dedicatedEngine?: number | undefined;
-    genericEngine?: number | undefined;
-    engine?: number | undefined;
+    dedicatedEngine?: number[] | undefined;
+    genericEngine?: number[] | undefined;
+    engine?: number[] | undefined;
+    hooks?: number[] | undefined;
 }, {
     pageSize?: number | undefined;
     page?: number | undefined;
     ordering?: string[] | undefined;
     id?: number[] | undefined;
+    workspace?: number[] | undefined;
     deleting?: boolean | undefined;
     name?: string | undefined;
-    dedicatedEngine?: number | undefined;
-    genericEngine?: number | undefined;
-    engine?: number | undefined;
+    dedicatedEngine?: number[] | undefined;
+    genericEngine?: number[] | undefined;
+    engine?: number[] | undefined;
+    hooks?: number[] | undefined;
 }>;
 export declare const queueListSideloadSchema: z.ZodObject<{
     inboxes: z.ZodArray<z.ZodObject<{