@rossum/api-client 0.1.30 → 0.2.1

package/types/src/engines/endpoints/queueStats.schema.d.ts

@@ -201,7 +201,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
             }>>;
             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;
@@ -209,12 +209,12 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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">]>;
@@ -249,7 +249,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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: ({
@@ -263,12 +263,69 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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;
@@ -334,12 +391,31 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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;
@@ -405,12 +481,31 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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>;
@@ -426,6 +521,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
         sessionTimeout: string;
         id: number;
         schema: string;
+        trainingEnabled: boolean;
         name: string;
         workflows: Record<string, string | number>[];
         workspace: string | null;
@@ -508,18 +604,36 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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;
     }, {
@@ -528,6 +642,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
         sessionTimeout: string;
         id: number;
         schema: string;
+        trainingEnabled: boolean;
         name: string;
         workflows: Record<string, string | number>[];
         workspace: string | null;
@@ -610,18 +725,36 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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">;
@@ -632,6 +765,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
         sessionTimeout: string;
         id: number;
         schema: string;
+        trainingEnabled: boolean;
         name: string;
         workflows: Record<string, string | number>[];
         workspace: string | null;
@@ -714,18 +848,36 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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;
     }[];
@@ -736,6 +888,7 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
         sessionTimeout: string;
         id: number;
         schema: string;
+        trainingEnabled: boolean;
         name: string;
         workflows: Record<string, string | number>[];
         workspace: string | null;
@@ -818,18 +971,36 @@ export declare const engineQueueStatsSideloadSchema: z.ZodObject<{
                     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;
     }[];

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

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

package/types/src/engines/models/engineQueueStatsItem.d.ts

@@ -0,0 +1,7 @@
+import { Url } from '../../types';
+export type EngineQueueStatsItem = {
+    url: Url;
+    numberOfUsedEngineFields: number;
+    predictionQueue: boolean;
+    trainingQueue: boolean;
+};

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

@@ -0,0 +1 @@
+export * from './engine';

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

@@ -110,8 +110,20 @@ export declare const genericEngines: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").GenericEngineListQuery;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly pageSize?: number;
+            readonly page?: number;
+            readonly fields?: ("id" | "name" | "url" | "schema" | "description" | "documentationUrl")[];
+            readonly ordering?: ("id" | "name" | "url" | "schema" | "description" | "documentationUrl" | "-id" | "-name" | "-url" | "-schema" | "-description" | "-documentationUrl")[];
+            readonly id?: number | number[];
+            readonly name?: number | number[];
+            readonly url?: number | number[];
+            readonly schema?: number | number[];
+            readonly description?: number | number[];
+            readonly documentationUrl?: number | number[];
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
             pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
             page: import("zod").ZodOptional<import("zod").ZodNumber>;
             fields: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"id">, import("zod").ZodLiteral<"name">, import("zod").ZodLiteral<"url">, import("zod").ZodLiteral<"schema">, import("zod").ZodLiteral<"description">, import("zod").ZodLiteral<"documentationUrl">]>, "many">>;
@@ -144,6 +156,12 @@ export declare const genericEngines: {
             schema?: number | number[] | undefined;
             description?: number | number[] | undefined;
             documentationUrl?: number | number[] | undefined;
-        }>;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
     };
 };

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

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 export type GenericEngineListQuery = {
     pageSize?: number;
     page?: number;
@@ -13,13 +14,13 @@ export type GenericEngineListQuery = {
 export declare const list: (query?: GenericEngineListQuery) => {
     readonly endpoint: "/generic_engines";
     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;
@@ -30,14 +31,14 @@ export declare const list: (query?: GenericEngineListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            name: import("zod").ZodString;
-            url: import("zod").ZodString;
-            schema: import("zod").ZodNullable<import("zod").ZodString>;
-            description: import("zod").ZodString;
-            documentationUrl: import("zod").ZodNullable<import("zod").ZodString>;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            name: z.ZodString;
+            url: z.ZodString;
+            schema: z.ZodNullable<z.ZodString>;
+            description: z.ZodString;
+            documentationUrl: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
             url: string;
             id: number;
             schema: string | null;
@@ -52,7 +53,7 @@ export declare const list: (query?: GenericEngineListQuery) => {
             description: string;
             documentationUrl: string | null;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             url: string;
             id: number;
@@ -83,19 +84,31 @@ export declare const list: (query?: GenericEngineListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: GenericEngineListQuery;
-    readonly querySchema: import("zod").ZodObject<{
-        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
-        page: import("zod").ZodOptional<import("zod").ZodNumber>;
-        fields: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"id">, import("zod").ZodLiteral<"name">, import("zod").ZodLiteral<"url">, import("zod").ZodLiteral<"schema">, import("zod").ZodLiteral<"description">, import("zod").ZodLiteral<"documentationUrl">]>, "many">>;
-        ordering: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"id">, import("zod").ZodLiteral<"name">, import("zod").ZodLiteral<"url">, import("zod").ZodLiteral<"schema">, import("zod").ZodLiteral<"description">, import("zod").ZodLiteral<"documentationUrl">, import("zod").ZodLiteral<"-id">, import("zod").ZodLiteral<"-name">, import("zod").ZodLiteral<"-url">, import("zod").ZodLiteral<"-schema">, import("zod").ZodLiteral<"-description">, import("zod").ZodLiteral<"-documentationUrl">]>, "many">>;
-        id: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        name: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        url: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        schema: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        description: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-        documentationUrl: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly pageSize?: number;
+        readonly page?: number;
+        readonly fields?: ("id" | "name" | "url" | "schema" | "description" | "documentationUrl")[];
+        readonly ordering?: ("id" | "name" | "url" | "schema" | "description" | "documentationUrl" | "-id" | "-name" | "-url" | "-schema" | "-description" | "-documentationUrl")[];
+        readonly id?: number | number[];
+        readonly name?: number | number[];
+        readonly url?: number | number[];
+        readonly schema?: number | number[];
+        readonly description?: number | number[];
+        readonly documentationUrl?: number | number[];
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodObject<{
+        pageSize: z.ZodOptional<z.ZodNumber>;
+        page: z.ZodOptional<z.ZodNumber>;
+        fields: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodLiteral<"id">, z.ZodLiteral<"name">, z.ZodLiteral<"url">, z.ZodLiteral<"schema">, z.ZodLiteral<"description">, z.ZodLiteral<"documentationUrl">]>, "many">>;
+        ordering: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodLiteral<"id">, z.ZodLiteral<"name">, z.ZodLiteral<"url">, z.ZodLiteral<"schema">, z.ZodLiteral<"description">, z.ZodLiteral<"documentationUrl">, z.ZodLiteral<"-id">, z.ZodLiteral<"-name">, z.ZodLiteral<"-url">, z.ZodLiteral<"-schema">, z.ZodLiteral<"-description">, z.ZodLiteral<"-documentationUrl">]>, "many">>;
+        id: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        name: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        url: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        schema: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        description: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+        documentationUrl: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+    }, "strip", z.ZodTypeAny, {
         pageSize?: number | undefined;
         page?: number | undefined;
         fields?: ("url" | "id" | "schema" | "name" | "description" | "documentationUrl")[] | undefined;
@@ -117,5 +130,11 @@ export declare const list: (query?: GenericEngineListQuery) => {
         schema?: number | number[] | undefined;
         description?: number | number[] | undefined;
         documentationUrl?: number | number[] | undefined;
-    }>;
+    }>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
+    }>>;
 };

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

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

package/types/src/genericEngines/models/genericEngine.d.ts

@@ -0,0 +1,9 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type GenericEngine = {
+    id: ID;
+    name: string;
+    url: Url;
+    schema: Url | null;
+    description: string;
+    documentationUrl: string | null;
+};

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

@@ -0,0 +1 @@
+export * from './genericEngine';

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

@@ -57,5 +57,15 @@ export declare const groups: {
                 totalPages: number;
             };
         }>;
+        readonly query: {
+            readonly includeTotal: true;
+        };
+        readonly querySchema: import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>;
     };
 };

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

@@ -1,13 +1,14 @@
+import { z } from 'zod';
 export declare const list: () => {
     readonly endpoint: "/groups";
     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;
@@ -18,11 +19,11 @@ export declare const list: () => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            name: import("zod").ZodString;
-            url: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            name: z.ZodString;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
             url: string;
             id: number;
             name: string;
@@ -31,7 +32,7 @@ export declare const list: () => {
             id: number;
             name: string;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             url: string;
             id: number;
@@ -56,4 +57,14 @@ export declare const list: () => {
             totalPages: number;
         };
     }>;
+    readonly query: {
+        readonly includeTotal: true;
+    };
+    readonly querySchema: z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
+    }>;
 };