@rossum/api-client 0.1.30 → 0.2.1

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

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ID } from '../../utils/codecUtils';
 import { PaginationQuery } from '../../utils/listQuery';
 export type EngineFieldListQuery = {
@@ -9,13 +10,13 @@ export type EngineFieldListQuery = {
 export declare const list: (query?: EngineFieldListQuery) => {
     readonly endpoint: "/engine_fields";
     readonly method: "GET";
-    readonly responseSchema: import("zod").ZodObject<{
-        pagination: import("zod").ZodObject<{
-            next: import("zod").ZodNullable<import("zod").ZodString>;
-            previous: import("zod").ZodNullable<import("zod").ZodString>;
-            total: import("zod").ZodNumber;
-            totalPages: import("zod").ZodNumber;
-        }, "strip", import("zod").ZodTypeAny, {
+    readonly responseSchema: z.ZodObject<{
+        pagination: z.ZodObject<{
+            next: z.ZodNullable<z.ZodString>;
+            previous: z.ZodNullable<z.ZodString>;
+            total: z.ZodNumber;
+            totalPages: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
             next: string | null;
             previous: string | null;
             total: number;
@@ -26,18 +27,18 @@ export declare const list: (query?: EngineFieldListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            url: import("zod").ZodString;
-            engine: import("zod").ZodString;
-            name: import("zod").ZodString;
-            label: import("zod").ZodString;
-            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"date">, import("zod").ZodLiteral<"enum">]>;
-            subtype: import("zod").ZodNullable<import("zod").ZodUnion<[import("zod").ZodLiteral<"alphanumeric">, import("zod").ZodLiteral<"numeric">, import("zod").ZodLiteral<"country_code">, import("zod").ZodLiteral<"currency_code">, import("zod").ZodLiteral<"iban">, import("zod").ZodLiteral<"vat_number">, import("zod").ZodLiteral<"integer">, import("zod").ZodLiteral<"rate">, import("zod").ZodLiteral<"amount">, import("zod").ZodLiteral<"period_end">, import("zod").ZodLiteral<"period_begin">, import("zod").ZodLiteral<"">]>>;
-            preTrainedFieldId: import("zod").ZodNullable<import("zod").ZodString>;
-            tabular: import("zod").ZodBoolean;
-            multiline: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            url: z.ZodString;
+            engine: z.ZodString;
+            name: z.ZodString;
+            label: z.ZodString;
+            type: z.ZodUnion<[z.ZodLiteral<"string">, z.ZodLiteral<"number">, z.ZodLiteral<"date">, z.ZodLiteral<"enum">]>;
+            subtype: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"alphanumeric">, z.ZodLiteral<"numeric">, z.ZodLiteral<"country_code">, z.ZodLiteral<"currency_code">, z.ZodLiteral<"iban">, z.ZodLiteral<"vat_number">, z.ZodLiteral<"integer">, z.ZodLiteral<"rate">, z.ZodLiteral<"amount">, z.ZodLiteral<"period_end">, z.ZodLiteral<"period_begin">, z.ZodLiteral<"">]>>;
+            preTrainedFieldId: z.ZodNullable<z.ZodString>;
+            tabular: z.ZodBoolean;
+            multiline: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
             type: "string" | "number" | "date" | "enum";
             url: string;
             id: number;
@@ -60,7 +61,7 @@ export declare const list: (query?: EngineFieldListQuery) => {
             tabular: boolean;
             multiline: string;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             type: "string" | "number" | "date" | "enum";
             url: string;
@@ -99,13 +100,21 @@ export declare const list: (query?: EngineFieldListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: EngineFieldListQuery;
-    readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
-        id: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        engine: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        name: import("zod").ZodOptional<import("zod").ZodString>;
-        used: import("zod").ZodOptional<import("zod").ZodBoolean>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly id?: ID | ID[];
+        readonly engine?: ID | ID[];
+        readonly name?: string;
+        readonly used?: boolean;
+        readonly pageSize?: number;
+        readonly page?: number;
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+        id: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        engine: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        name: z.ZodOptional<z.ZodString>;
+        used: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
         id?: number | number[] | undefined;
         engine?: number | number[] | undefined;
         name?: string | undefined;
@@ -115,14 +124,20 @@ export declare const list: (query?: EngineFieldListQuery) => {
         engine?: number | number[] | undefined;
         name?: string | undefined;
         used?: boolean | undefined;
-    }>, import("zod").ZodObject<{
-        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
-        page: import("zod").ZodOptional<import("zod").ZodNumber>;
-    }, "strip", import("zod").ZodTypeAny, {
+    }>, z.ZodObject<{
+        pageSize: z.ZodOptional<z.ZodNumber>;
+        page: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
         pageSize?: number | undefined;
         page?: number | undefined;
     }, {
         pageSize?: number | undefined;
         page?: number | undefined;
+    }>>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
     }>>;
 };

package/types/src/engineFields/endpoints/listPreTrainedFields.d.ts

@@ -13,8 +13,8 @@ export declare const listPreTrainedFields: () => {
             multiline: import("zod").ZodString;
         }, "strip", import("zod").ZodTypeAny, {
             type: "string" | "number" | "date" | "enum";
-            section: string;
             label: string;
+            section: string;
             name: string;
             description: string;
             subtype: string;
@@ -22,8 +22,8 @@ export declare const listPreTrainedFields: () => {
             multiline: string;
         }, {
             type: "string" | "number" | "date" | "enum";
-            section: string;
             label: string;
+            section: string;
             name: string;
             description: string;
             subtype: string;
@@ -33,8 +33,8 @@ export declare const listPreTrainedFields: () => {
     }, "strip", import("zod").ZodTypeAny, {
         results: {
             type: "string" | "number" | "date" | "enum";
-            section: string;
             label: string;
+            section: string;
             name: string;
             description: string;
             subtype: string;
@@ -44,8 +44,8 @@ export declare const listPreTrainedFields: () => {
     }, {
         results: {
             type: "string" | "number" | "date" | "enum";
-            section: string;
             label: string;
+            section: string;
             name: string;
             description: string;
             subtype: string;

package/types/src/engineFields/index.d.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './endpoints';

package/types/src/engineFields/models/index.d.ts

@@ -0,0 +1,3 @@
+export * from './engineField';
+export * from './engineFieldType';
+export * from './preTrainedField';

package/types/src/engineFields/models/preTrainedField.d.ts

@@ -0,0 +1,11 @@
+import { EngineFieldType, Multiline } from './engineFieldType';
+export type PreTrainedField = {
+    name: string;
+    label: string;
+    section: string;
+    type: EngineFieldType;
+    subtype: string;
+    tabular: boolean;
+    description: string;
+    multiline: Multiline;
+};

package/types/src/engineFields/models/preTrainedField.schema.d.ts

@@ -10,8 +10,8 @@ export declare const preTrainedFieldSchema: z.ZodObject<{
     multiline: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: "string" | "number" | "date" | "enum";
-    section: string;
     label: string;
+    section: string;
     name: string;
     description: string;
     subtype: string;
@@ -19,8 +19,8 @@ export declare const preTrainedFieldSchema: z.ZodObject<{
     multiline: string;
 }, {
     type: "string" | "number" | "date" | "enum";
-    section: string;
     label: string;
+    section: string;
     name: string;
     description: string;
     subtype: string;

package/types/src/engines/endpoints/index.d.ts

@@ -170,8 +170,14 @@ export declare const engines: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").EngineListQuery;
-        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly type?: "extractor" | "splitter" | undefined;
+            readonly ordering?: ("type" | "id" | "-id" | "-type")[] | undefined;
+            readonly pageSize?: number;
+            readonly page?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
             type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"extractor">, import("zod").ZodLiteral<"splitter">]>>;
             ordering: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"id">, import("zod").ZodLiteral<"-id">, import("zod").ZodLiteral<"type">, import("zod").ZodLiteral<"-type">]>, "many">>;
         }, "strip", import("zod").ZodTypeAny, {
@@ -189,6 +195,12 @@ export declare const engines: {
         }, {
             pageSize?: number | undefined;
             page?: number | undefined;
+        }>>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
         }>>;
     };
     patch: (engineId: import("../../..").ID, payload: import("./patch").EnginePatchPayload) => {
@@ -347,8 +359,12 @@ export declare const engines: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("../../utils/listQuery").PaginationQuery;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly pageSize?: number;
+            readonly page?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
             pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
             page: import("zod").ZodOptional<import("zod").ZodNumber>;
         }, "strip", import("zod").ZodTypeAny, {
@@ -357,7 +373,13 @@ export declare const engines: {
         }, {
             pageSize?: number | undefined;
             page?: number | undefined;
-        }>;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
         readonly sideloadSchema: import("zod").ZodObject<{
             queues: import("zod").ZodArray<import("zod").ZodObject<{
                 id: import("zod").ZodNumber;
@@ -550,7 +572,7 @@ export declare const engines: {
                     }>>;
                     annotationListTable: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodObject<{
                         columns: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodObject<{
-                            metaName: import("zod").ZodUnion<[import("zod").ZodLiteral<"original_file_name">, import("zod").ZodLiteral<"queue">, import("zod").ZodLiteral<"status">, import("zod").ZodLiteral<"labels">, import("zod").ZodLiteral<"details">, import("zod").ZodUnion<[import("zod").ZodLiteral<"created_at">, import("zod").ZodLiteral<"modified_at">, import("zod").ZodLiteral<"exported_at">, import("zod").ZodLiteral<"confirmed_at">, import("zod").ZodLiteral<"rejected_at">, import("zod").ZodLiteral<"deleted_at">, import("zod").ZodLiteral<"assigned_at">, import("zod").ZodLiteral<"export_failed_at">]>, import("zod").ZodUnion<[import("zod").ZodLiteral<"exported_by">, import("zod").ZodLiteral<"confirmed_by">, import("zod").ZodLiteral<"rejected_by">, import("zod").ZodLiteral<"deleted_by">, import("zod").ZodLiteral<"modifier">, import("zod").ZodLiteral<"assignees">, import("zod").ZodLiteral<"creator">]>]>;
+                            metaName: import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation">, import("zod").ZodLiteral<"original_file_name">, import("zod").ZodLiteral<"queue">, import("zod").ZodLiteral<"status">, import("zod").ZodLiteral<"labels">, import("zod").ZodLiteral<"details">, import("zod").ZodUnion<[import("zod").ZodLiteral<"created_at">, import("zod").ZodLiteral<"modified_at">, import("zod").ZodLiteral<"exported_at">, import("zod").ZodLiteral<"confirmed_at">, import("zod").ZodLiteral<"rejected_at">, import("zod").ZodLiteral<"deleted_at">, import("zod").ZodLiteral<"assigned_at">, import("zod").ZodLiteral<"export_failed_at">]>, import("zod").ZodUnion<[import("zod").ZodLiteral<"exported_by">, import("zod").ZodLiteral<"confirmed_by">, import("zod").ZodLiteral<"rejected_by">, import("zod").ZodLiteral<"deleted_by">, import("zod").ZodLiteral<"modifier">, import("zod").ZodLiteral<"assignees">, import("zod").ZodLiteral<"creator">]>]>;
                             columnType: import("zod").ZodLiteral<"meta">;
                             visible: import("zod").ZodBoolean;
                             width: import("zod").ZodNumber;
@@ -558,12 +580,12 @@ export declare const engines: {
                             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";
                         }>, import("zod").ZodObject<{
                             schemaId: import("zod").ZodString;
                             dataType: import("zod").ZodUnion<[import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"date">, import("zod").ZodLiteral<"boolean">]>;
@@ -598,7 +620,7 @@ export declare const engines: {
                             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: ({
@@ -612,12 +634,69 @@ export declare const engines: {
                             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: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodUnknown>>;
                     complexTables: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodBoolean>>;
                     uiUploadEnabled: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodBoolean>>;
+                    uiOnEditConfirm: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_list">, import("zod").ZodLiteral<"edit_next">, import("zod").ZodLiteral<"validate_first">]>>>;
+                    uiValidationScreenEnabled: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodBoolean>>;
+                    uiEditValues: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
+                        id: import("zod").ZodString;
+                        label: import("zod").ZodString;
+                        required: import("zod").ZodBoolean;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        id: string;
+                        label: string;
+                        required: boolean;
+                    }, {
+                        id: string;
+                        label: string;
+                        required: boolean;
+                    }>, import("zod").ZodObject<{
+                        dataType: import("zod").ZodLiteral<"enum">;
+                        enumOptions: import("zod").ZodArray<import("zod").ZodObject<{
+                            label: import("zod").ZodString;
+                            value: import("zod").ZodString;
+                        }, "strip", import("zod").ZodTypeAny, {
+                            value: string;
+                            label: string;
+                        }, {
+                            value: string;
+                            label: string;
+                        }>, "many">;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        dataType: "enum";
+                        enumOptions: {
+                            value: string;
+                            label: string;
+                        }[];
+                    }, {
+                        dataType: "enum";
+                        enumOptions: {
+                            value: string;
+                            label: string;
+                        }[];
+                    }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
+                        id: import("zod").ZodString;
+                        label: import("zod").ZodString;
+                        required: import("zod").ZodBoolean;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        id: string;
+                        label: string;
+                        required: boolean;
+                    }, {
+                        id: string;
+                        label: string;
+                        required: boolean;
+                    }>, import("zod").ZodObject<{
+                        dataType: import("zod").ZodLiteral<"string">;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        dataType: "string";
+                    }, {
+                        dataType: "string";
+                    }>>]>, "many">>>;
                 }, "strip", import("zod").ZodTypeAny, {
                     columns?: {
                         schemaId: string;
@@ -683,12 +762,31 @@ export declare const engines: {
                             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;
@@ -754,12 +852,31 @@ export declare const engines: {
                             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: import("zod").ZodNullable<import("zod").ZodString>;
                 dedicatedEngine: import("zod").ZodNullable<import("zod").ZodString>;
@@ -775,6 +892,7 @@ export declare const engines: {
                 sessionTimeout: string;
                 id: number;
                 schema: string;
+                trainingEnabled: boolean;
                 name: string;
                 workflows: Record<string, string | number>[];
                 workspace: string | null;
@@ -857,18 +975,36 @@ export declare const engines: {
                             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,6 +1013,7 @@ export declare const engines: {
                 sessionTimeout: string;
                 id: number;
                 schema: string;
+                trainingEnabled: boolean;
                 name: string;
                 workflows: Record<string, string | number>[];
                 workspace: string | null;
@@ -959,18 +1096,36 @@ export declare const engines: {
                             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">;
@@ -981,6 +1136,7 @@ export declare const engines: {
                 sessionTimeout: string;
                 id: number;
                 schema: string;
+                trainingEnabled: boolean;
                 name: string;
                 workflows: Record<string, string | number>[];
                 workspace: string | null;
@@ -1063,18 +1219,36 @@ export declare const engines: {
                             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;
             }[];
@@ -1085,6 +1259,7 @@ export declare const engines: {
                 sessionTimeout: string;
                 id: number;
                 schema: string;
+                trainingEnabled: boolean;
                 name: string;
                 workflows: Record<string, string | number>[];
                 workspace: string | null;
@@ -1167,18 +1342,36 @@ export declare const engines: {
                             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;
             }[];