@rossum/api-client 0.1.30 → 0.2.1

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

@@ -0,0 +1,2 @@
+export * from './automationBlocker.schema';
+export * from './automationBlocker';

package/types/src/billing/endpoints/getHistory.schema.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+export declare const billingStatsPayloadSchema: z.ZodObject<{
+    filters: z.ZodOptional<z.ZodObject<{
+        beginDate: z.ZodString;
+        endDate: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        beginDate: string;
+        endDate: string;
+    }, {
+        beginDate: string;
+        endDate: string;
+    }>>;
+    groupBy: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    filters?: {
+        beginDate: string;
+        endDate: string;
+    } | undefined;
+    groupBy?: string[] | undefined;
+}, {
+    filters?: {
+        beginDate: string;
+        endDate: string;
+    } | undefined;
+    groupBy?: string[] | undefined;
+}>;

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

@@ -0,0 +1,5 @@
+export * from './getStats';
+export * from './getHistory';
+export * from './getStatsExport';
+export * from './getHistoryExport';
+export * from './getStats.schema';

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

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

package/types/src/billing/models/billingHistory.d.ts

@@ -0,0 +1,40 @@
+import { PaginationResponse } from '../../utils/pagination';
+export type BillingHistoryValues = {
+    purchasedPages: number;
+    billablePages: number;
+    purchasedDocuments: number;
+    billableDocuments: number;
+    extractedPagesWithLearning: number;
+    extractedPagesWithoutLearning: number;
+    splitPagesWithLearning: number;
+    splitPagesWithoutLearning: number;
+    extractedDocumentsWithLearning: number;
+    extractedDocumentsWithoutLearning: number;
+    splitDocumentsWithLearning: number;
+    splitDocumentsWithoutLearning: number;
+    ocrOnlyPages: number;
+    ocrOnlyDocuments: number;
+    purchasedExtractedPagesWithLearning: number;
+    purchasedExtractedPagesWithoutLearning: number;
+    purchasedSplitPagesWithLearning: number;
+    purchasedSplitPagesWithoutLearning: number;
+    purchasedExtractedDocumentsWithLearning: number;
+    purchasedExtractedDocumentsWithoutLearning: number;
+    purchasedSplitDocumentsWithLearning: number;
+    purchasedSplitDocumentsWithoutLearning: number;
+    purchasedOcrOnlyPages: number;
+    purchasedOcrOnlyDocuments: number;
+};
+export type BillingHistory = {
+    beginDate: string;
+    endDate: string;
+    values: BillingHistoryValues & {
+        isCurrent: boolean;
+    };
+};
+export type BillingHistoryListResponse = {
+    pagination: PaginationResponse;
+    results: BillingHistory[];
+    updatedAt: string;
+    totals: BillingHistoryValues;
+};

package/types/src/billing/models/billingStats.d.ts

@@ -0,0 +1,21 @@
+import { Url } from '../../utils/codecUtils';
+import { PaginationResponse } from '../../utils/pagination';
+export type BillingStatsValues = {
+    billablePages: number;
+    nonBillablePages: number;
+    billableDocuments: number;
+    nonBillableDocuments: number;
+};
+export type BillingStats = {
+    organization: Url | null;
+    queue: Url | null;
+    beginDate: string;
+    endDate: string;
+    values: BillingStatsValues;
+};
+export type BillingStatsListResponse = {
+    pagination: PaginationResponse;
+    results: BillingStats[];
+    updatedAt: string;
+    totals: BillingStatsValues;
+};

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

@@ -0,0 +1,4 @@
+export * from './billingHistory.schema';
+export * from './billingHistory';
+export * from './billingStats.schema';
+export * from './billingStats';

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

@@ -168,8 +168,15 @@ export declare const connectors: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").ConnectorListQuery;
-        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly id?: number | number[] | undefined;
+            readonly name?: string | undefined;
+            readonly serviceUrl?: string | undefined;
+            readonly pageSize?: number;
+            readonly page?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
             id: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodArray<import("zod").ZodNumber, "many">]>>;
             name: import("zod").ZodOptional<import("zod").ZodString>;
             serviceUrl: import("zod").ZodOptional<import("zod").ZodString>;
@@ -190,6 +197,12 @@ export declare const connectors: {
         }, {
             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;
         }>>;
     };
 };

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

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ID, Url } from '../../utils/codecUtils';
 import { PaginationQuery } from '../../utils/listQuery';
 export type ConnectorListQuery = Partial<{
@@ -8,13 +9,13 @@ export type ConnectorListQuery = Partial<{
 export declare const list: (query?: ConnectorListQuery) => {
     readonly endpoint: "/connectors";
     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;
@@ -25,20 +26,20 @@ export declare const list: (query?: ConnectorListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            name: import("zod").ZodString;
-            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
-            url: import("zod").ZodString;
-            serviceUrl: import("zod").ZodString;
-            params: import("zod").ZodNullable<import("zod").ZodString>;
-            authorizationToken: import("zod").ZodString;
-            authorizationType: import("zod").ZodString;
-            clientSslCertificate: import("zod").ZodNullable<import("zod").ZodString>;
-            clientSslKey: import("zod").ZodOptional<import("zod").ZodString>;
-            asynchronous: import("zod").ZodBoolean;
-            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            name: z.ZodString;
+            queues: z.ZodArray<z.ZodString, "many">;
+            url: z.ZodString;
+            serviceUrl: z.ZodString;
+            params: z.ZodNullable<z.ZodString>;
+            authorizationToken: z.ZodString;
+            authorizationType: z.ZodString;
+            clientSslCertificate: z.ZodNullable<z.ZodString>;
+            clientSslKey: z.ZodOptional<z.ZodString>;
+            asynchronous: z.ZodBoolean;
+            metadata: z.ZodOptional<z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
             params: string | null;
             url: string;
             id: number;
@@ -65,7 +66,7 @@ export declare const list: (query?: ConnectorListQuery) => {
             clientSslKey?: string | undefined;
             metadata?: unknown;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             params: string | null;
             url: string;
@@ -108,12 +109,19 @@ export declare const list: (query?: ConnectorListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: ConnectorListQuery;
-    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">]>>;
-        name: import("zod").ZodOptional<import("zod").ZodString>;
-        serviceUrl: import("zod").ZodOptional<import("zod").ZodString>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly id?: number | number[] | undefined;
+        readonly name?: string | undefined;
+        readonly serviceUrl?: string | undefined;
+        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">]>>;
+        name: z.ZodOptional<z.ZodString>;
+        serviceUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
         id?: number | number[] | undefined;
         name?: string | undefined;
         serviceUrl?: string | undefined;
@@ -121,14 +129,20 @@ export declare const list: (query?: ConnectorListQuery) => {
         id?: number | number[] | undefined;
         name?: string | undefined;
         serviceUrl?: string | 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/connectors/index.d.ts

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

package/types/src/connectors/models/connector.d.ts

@@ -0,0 +1,15 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type Connector = {
+    id: ID;
+    name: string;
+    queues: Array<Url>;
+    url: Url;
+    serviceUrl: Url;
+    params: string | null;
+    authorizationToken: string;
+    authorizationType: string;
+    clientSslCertificate: string | null;
+    clientSslKey?: string;
+    asynchronous: boolean;
+    metadata?: unknown;
+};

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

@@ -0,0 +1,2 @@
+export * from './connector.schema';
+export * from './connector';

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

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

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

@@ -0,0 +1,9 @@
+export * from './datapointField';
+export * from './datapointFieldSource';
+export * from './dedicatedEngineSchema';
+export * from './dedicatedEngineSchemaObject';
+export * from './integrityValidationResults';
+export * from './tableMultivalueField';
+export * from './simpleMultivalueField';
+export * from './transformedDatapointField';
+export { type SimpleMultivalueField, type TableMultivalueField, } from './transformedFields';

package/types/src/dedicatedEngineSchema/models/integrityValidationResults.d.ts

@@ -0,0 +1,31 @@
+type Errors = string[];
+type SourceValidateResult = Partial<{
+    schemaId: Errors;
+    queue: Errors;
+}>;
+type DatapointFieldValidateResult = Partial<{
+    engineOutputId: Errors;
+    type: Errors;
+    label: Errors;
+    description: Errors;
+    sources: Record<string, SourceValidateResult>;
+    nonFieldErrors: Errors;
+}>;
+type AllFieldsValidateResult = Partial<{
+    engineOutputId: Errors;
+    type: Errors;
+    label: Errors;
+    description: Errors;
+    sources: Record<string, SourceValidateResult>;
+    nonFieldErrors: Errors;
+    children: {
+        children: Record<string, DatapointFieldValidateResult>;
+    } | DatapointFieldValidateResult;
+}>;
+export type DedicatedEngineSchemaValidationResult = Partial<{
+    content: Partial<{
+        fields: Record<string, AllFieldsValidateResult>;
+        trainingQueues: Record<string, Errors>;
+    }>;
+}>;
+export {};

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

@@ -75,8 +75,20 @@ export declare const dedicatedEngines: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").DedicatedEngineListQuery;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly pageSize?: number;
+            readonly page?: number;
+            readonly fields?: ("id" | "name" | "url" | "status" | "schema" | "description")[];
+            readonly ordering?: ("id" | "name" | "url" | "status" | "schema" | "description" | "-id" | "-name" | "-url" | "-status" | "-schema" | "-description")[];
+            readonly id?: number | number[];
+            readonly name?: number | number[];
+            readonly url?: number | number[];
+            readonly status?: number | number[];
+            readonly schema?: number | number[];
+            readonly description?: 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<"status">, import("zod").ZodLiteral<"schema">, import("zod").ZodLiteral<"description">]>, "many">>;
@@ -109,7 +121,13 @@ export declare const dedicatedEngines: {
             status?: number | number[] | undefined;
             schema?: number | number[] | undefined;
             description?: number | number[] | undefined;
-        }>;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
     };
     create: (payload: import("./create").CreateDedicatedEnginePayload) => {
         readonly endpoint: "/dedicated_engines";

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

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

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

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

package/types/src/dedicatedEngines/models/dedicatedEngine.d.ts

@@ -0,0 +1,10 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type DedicatedEngineStatus = 'sample_review' | 'draft' | 'schema_review' | 'annotating_initial' | 'annotating_review' | 'annotating_training' | 'training_started' | 'training_finished' | 'retraining';
+export type DedicatedEngine = {
+    id: ID;
+    name: string;
+    url: Url;
+    status: DedicatedEngineStatus;
+    schema: Url | null;
+    description: string;
+};

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

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

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

@@ -182,13 +182,22 @@ export declare const deleteRecommendations: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").DeleteRecommendationListQueryEncoder;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly queue?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
             queue: import("zod").ZodOptional<import("zod").ZodNumber>;
         }, "strip", import("zod").ZodTypeAny, {
             queue?: number | undefined;
         }, {
             queue?: 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/deleteRecommendations/endpoints/list.d.ts

@@ -1,16 +1,17 @@
+import { z } from 'zod';
 export type DeleteRecommendationListQueryEncoder = {
     queue?: number;
 };
 export declare const list: (query?: DeleteRecommendationListQueryEncoder) => {
     readonly endpoint: "/delete_recommendations";
     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;
@@ -21,14 +22,14 @@ export declare const list: (query?: DeleteRecommendationListQueryEncoder) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            enabled: import("zod").ZodBoolean;
-            url: import("zod").ZodString;
-            organization: import("zod").ZodString;
-            queue: import("zod").ZodString;
-            triggers: import("zod").ZodArray<import("zod").ZodString, "many">;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            enabled: z.ZodBoolean;
+            url: z.ZodString;
+            organization: z.ZodString;
+            queue: z.ZodString;
+            triggers: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
             url: string;
             queue: string;
             id: number;
@@ -43,7 +44,7 @@ export declare const list: (query?: DeleteRecommendationListQueryEncoder) => {
             enabled: boolean;
             triggers: string[];
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             url: string;
             queue: string;
@@ -74,12 +75,21 @@ export declare const list: (query?: DeleteRecommendationListQueryEncoder) => {
             totalPages: number;
         };
     }>;
-    readonly query: DeleteRecommendationListQueryEncoder;
-    readonly querySchema: import("zod").ZodObject<{
-        queue: import("zod").ZodOptional<import("zod").ZodNumber>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly queue?: number;
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodObject<{
+        queue: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
         queue?: number | undefined;
     }, {
         queue?: number | undefined;
-    }>;
+    }>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
+    }>>;
 };

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

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