@rossum/api-client 0.1.30 → 0.2.1

package/types/src/hooks/models/run.schema.d.ts

@@ -11,14 +11,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     response: z.ZodNullable<z.ZodString>;
     timestamp: z.ZodString;
-    start: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    end: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>>;
+    start: z.ZodNullable<z.ZodString>;
+    end: z.ZodNullable<z.ZodString>;
+    status: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+    uuid: z.ZodString;
     settings: z.ZodOptional<z.ZodUnknown>;
-    uuid: z.ZodOptional<z.ZodString>;
     cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    output: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -26,15 +28,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -42,13 +45,13 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }>, z.ZodObject<{
     annotationId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     event: z.ZodLiteral<"annotation_content">;
@@ -71,14 +74,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     response: z.ZodNullable<z.ZodString>;
     timestamp: z.ZodString;
-    start: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    end: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>>;
+    start: z.ZodNullable<z.ZodString>;
+    end: z.ZodNullable<z.ZodString>;
+    status: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+    uuid: z.ZodString;
     settings: z.ZodOptional<z.ZodUnknown>;
-    uuid: z.ZodOptional<z.ZodString>;
     cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    output: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -86,15 +91,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -102,13 +108,13 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }>, z.ZodObject<{
     annotationId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     event: z.ZodLiteral<"annotation_status">;
@@ -131,14 +137,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     response: z.ZodNullable<z.ZodString>;
     timestamp: z.ZodString;
-    start: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    end: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>>;
+    start: z.ZodNullable<z.ZodString>;
+    end: z.ZodNullable<z.ZodString>;
+    status: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+    uuid: z.ZodString;
     settings: z.ZodOptional<z.ZodUnknown>;
-    uuid: z.ZodOptional<z.ZodString>;
     cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    output: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -146,15 +154,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -162,13 +171,13 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }>, z.ZodObject<{
     emailId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     event: z.ZodLiteral<"upload">;
@@ -191,14 +200,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     response: z.ZodNullable<z.ZodString>;
     timestamp: z.ZodString;
-    start: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    end: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>>;
+    start: z.ZodNullable<z.ZodString>;
+    end: z.ZodNullable<z.ZodString>;
+    status: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+    uuid: z.ZodString;
     settings: z.ZodOptional<z.ZodUnknown>;
-    uuid: z.ZodOptional<z.ZodString>;
     cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    output: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -206,15 +217,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -222,13 +234,13 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }>, z.ZodObject<{
     emailId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     event: z.ZodLiteral<"email">;
@@ -251,14 +263,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     requestId: z.ZodString;
     response: z.ZodNullable<z.ZodString>;
     timestamp: z.ZodString;
-    start: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    end: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    status: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>>;
+    start: z.ZodNullable<z.ZodString>;
+    end: z.ZodNullable<z.ZodString>;
+    status: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+    uuid: z.ZodString;
     settings: z.ZodOptional<z.ZodUnknown>;
-    uuid: z.ZodOptional<z.ZodString>;
     cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    output: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -266,15 +280,16 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }, {
     message: string;
+    status: "failed" | "completed" | "running" | "cancelled" | "waiting";
     hookId: number;
     requestId: string;
     timestamp: string;
@@ -282,13 +297,13 @@ export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     hookType: "function" | "webhook" | "job";
     request: string | null;
     response: string | null;
+    start: string | null;
+    end: string | null;
+    uuid: string;
     queueId?: number | null | undefined;
-    start?: string | null | undefined;
-    end?: string | null | undefined;
-    status?: "failed" | "completed" | "running" | "cancelled" | "waiting" | undefined;
     settings?: unknown;
-    uuid?: string | undefined;
     cancelRequested?: string | null | undefined;
+    output?: string | null | undefined;
 }>, z.ZodObject<{
     event: z.ZodLiteral<"invocation">;
     action: z.ZodUnion<[z.ZodLiteral<"manual">, z.ZodLiteral<"scheduled">, z.ZodLiteral<"integration">, z.ZodLiteral<"interface">]>;

package/types/src/hooks/models/values.d.ts

@@ -0,0 +1,6 @@
+export declare const extensionFunctionType = "function";
+export declare const extensionWebhookType = "webhook";
+export declare const extensionJobType = "job";
+export declare const rossumStore = "rossum_store";
+export declare const customExtension = "custom";
+export declare const runtimes: readonly ["nodejs22.x", "nodejs18.x", "python3.12", "python3.8"];

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

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

@@ -1,16 +1,17 @@
+import { z } from 'zod';
 export type ListInboxesQuery = {
     page?: number;
 };
 export declare const list: (query: ListInboxesQuery) => {
     readonly method: "GET";
     readonly endpoint: "/inboxes";
-    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,29 +22,29 @@ export declare const list: (query: ListInboxesQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            name: import("zod").ZodString;
-            url: import("zod").ZodString;
-            queues: import("zod").ZodArray<import("zod").ZodString, "many">;
-            email: import("zod").ZodString;
-            emailPrefix: import("zod").ZodString;
-            bounceEmailTo: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
-            bounceUnprocessableAttachments: import("zod").ZodNullable<import("zod").ZodBoolean>;
-            bouncePostponedAnnotations: import("zod").ZodNullable<import("zod").ZodBoolean>;
-            bounceDeletedAnnotations: import("zod").ZodNullable<import("zod").ZodBoolean>;
-            bounceEmailWithNoAttachments: import("zod").ZodNullable<import("zod").ZodBoolean>;
-            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            filters: import("zod").ZodObject<{
-                allowedSenders: import("zod").ZodArray<import("zod").ZodString, "many">;
-                deniedSenders: import("zod").ZodArray<import("zod").ZodString, "many">;
-                documentRejectionConditions: import("zod").ZodObject<{
-                    enabled: import("zod").ZodBoolean;
-                    resolutionLowerThanPx: import("zod").ZodTuple<[import("zod").ZodNumber, import("zod").ZodNumber], null>;
-                    fileSizeLessThanB: import("zod").ZodNullable<import("zod").ZodNumber>;
-                    mimeTypes: import("zod").ZodArray<import("zod").ZodString, "many">;
-                    fileNameRegexes: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            name: z.ZodString;
+            url: z.ZodString;
+            queues: z.ZodArray<z.ZodString, "many">;
+            email: z.ZodString;
+            emailPrefix: z.ZodString;
+            bounceEmailTo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            bounceUnprocessableAttachments: z.ZodNullable<z.ZodBoolean>;
+            bouncePostponedAnnotations: z.ZodNullable<z.ZodBoolean>;
+            bounceDeletedAnnotations: z.ZodNullable<z.ZodBoolean>;
+            bounceEmailWithNoAttachments: z.ZodNullable<z.ZodBoolean>;
+            metadata: z.ZodOptional<z.ZodUnknown>;
+            filters: z.ZodObject<{
+                allowedSenders: z.ZodArray<z.ZodString, "many">;
+                deniedSenders: z.ZodArray<z.ZodString, "many">;
+                documentRejectionConditions: z.ZodObject<{
+                    enabled: z.ZodBoolean;
+                    resolutionLowerThanPx: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
+                    fileSizeLessThanB: z.ZodNullable<z.ZodNumber>;
+                    mimeTypes: z.ZodArray<z.ZodString, "many">;
+                    fileNameRegexes: z.ZodNullable<z.ZodArray<z.ZodString, "many">>;
+                }, "strip", z.ZodTypeAny, {
                     enabled: boolean;
                     resolutionLowerThanPx: [number, number];
                     fileSizeLessThanB: number | null;
@@ -56,7 +57,7 @@ export declare const list: (query: ListInboxesQuery) => {
                     mimeTypes: string[];
                     fileNameRegexes: string[] | null;
                 }>;
-            }, "strip", import("zod").ZodTypeAny, {
+            }, "strip", z.ZodTypeAny, {
                 allowedSenders: string[];
                 deniedSenders: string[];
                 documentRejectionConditions: {
@@ -77,8 +78,8 @@ export declare const list: (query: ListInboxesQuery) => {
                     fileNameRegexes: string[] | null;
                 };
             }>;
-            dmarcCheckAction: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
+            dmarcCheckAction: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
             url: string;
             id: number;
             email: string;
@@ -129,7 +130,7 @@ export declare const list: (query: ListInboxesQuery) => {
             bounceEmailTo?: string | null | undefined;
             metadata?: unknown;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             url: string;
             id: number;
@@ -196,12 +197,21 @@ export declare const list: (query: ListInboxesQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: ListInboxesQuery;
-    readonly querySchema: import("zod").ZodObject<{
-        page: import("zod").ZodOptional<import("zod").ZodNumber>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly page?: number;
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodObject<{
+        page: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
         page?: number | undefined;
     }, {
         page?: number | undefined;
-    }>;
+    }>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
+    }>>;
 };

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

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

package/types/src/inboxes/mocks/inbox.d.ts

@@ -0,0 +1,4 @@
+import { Inbox } from '../models';
+export declare const mockInbox: (params?: {
+    overrides: Partial<Inbox>;
+}) => Inbox;

package/types/src/inboxes/mocks/index.d.ts

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

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

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