@rossum/api-client 0.1.25 → 0.1.30

package/types/src/hookTemplates/models/hookTemplate.schema.d.ts

@@ -2,7 +2,7 @@ import { z } from 'zod';
 export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
     url: z.ZodString;
-    events: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"annotation_content.confirm">, z.ZodLiteral<"annotation_content.export">, z.ZodLiteral<"annotation_content.initialize">, z.ZodLiteral<"annotation_content.started">, z.ZodLiteral<"annotation_content.updated">, z.ZodLiteral<"annotation_content.user_update">, z.ZodLiteral<"annotation_content">, z.ZodLiteral<"annotation_status.changed">, z.ZodLiteral<"annotation_status">, z.ZodLiteral<"upload.created">, z.ZodLiteral<"upload">, z.ZodLiteral<"email.received">, z.ZodLiteral<"email">, z.ZodLiteral<"invocation.manual">, z.ZodLiteral<"invocation.scheduled">, z.ZodLiteral<"invocation">]>, "many">;
+    events: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"annotation_content.confirm">, z.ZodLiteral<"annotation_content.export">, z.ZodLiteral<"annotation_content.initialize">, z.ZodLiteral<"annotation_content.started">, z.ZodLiteral<"annotation_content.updated">, z.ZodLiteral<"annotation_content.user_update">, z.ZodLiteral<"annotation_content">, z.ZodLiteral<"annotation_status.changed">, z.ZodLiteral<"annotation_status">, z.ZodLiteral<"upload.created">, z.ZodLiteral<"upload">, z.ZodLiteral<"email.received">, z.ZodLiteral<"email">, z.ZodLiteral<"invocation.manual">, z.ZodLiteral<"invocation.scheduled">, z.ZodLiteral<"invocation.integration">, z.ZodLiteral<"invocation.interface">, z.ZodLiteral<"invocation">]>, "many">;
     sideload: z.ZodArray<z.ZodString, "many">;
     metadata: z.ZodOptional<z.ZodUnknown>;
     test: z.ZodOptional<z.ZodUnknown>;
@@ -33,7 +33,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
     url: string;
     name: string;
     description: string;
-    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled")[];
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
     sideload: string[];
     extensionSource: "custom" | "rossum_store";
     guide: string;
@@ -55,7 +55,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
     url: string;
     name: string;
     description: string;
-    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled")[];
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
     sideload: string[];
     extensionSource: "custom" | "rossum_store";
     guide: string;
@@ -186,7 +186,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
 }>>, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
     url: z.ZodString;
-    events: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"annotation_content.confirm">, z.ZodLiteral<"annotation_content.export">, z.ZodLiteral<"annotation_content.initialize">, z.ZodLiteral<"annotation_content.started">, z.ZodLiteral<"annotation_content.updated">, z.ZodLiteral<"annotation_content.user_update">, z.ZodLiteral<"annotation_content">, z.ZodLiteral<"annotation_status.changed">, z.ZodLiteral<"annotation_status">, z.ZodLiteral<"upload.created">, z.ZodLiteral<"upload">, z.ZodLiteral<"email.received">, z.ZodLiteral<"email">, z.ZodLiteral<"invocation.manual">, z.ZodLiteral<"invocation.scheduled">, z.ZodLiteral<"invocation">]>, "many">;
+    events: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"annotation_content.confirm">, z.ZodLiteral<"annotation_content.export">, z.ZodLiteral<"annotation_content.initialize">, z.ZodLiteral<"annotation_content.started">, z.ZodLiteral<"annotation_content.updated">, z.ZodLiteral<"annotation_content.user_update">, z.ZodLiteral<"annotation_content">, z.ZodLiteral<"annotation_status.changed">, z.ZodLiteral<"annotation_status">, z.ZodLiteral<"upload.created">, z.ZodLiteral<"upload">, z.ZodLiteral<"email.received">, z.ZodLiteral<"email">, z.ZodLiteral<"invocation.manual">, z.ZodLiteral<"invocation.scheduled">, z.ZodLiteral<"invocation.integration">, z.ZodLiteral<"invocation.interface">, z.ZodLiteral<"invocation">]>, "many">;
     sideload: z.ZodArray<z.ZodString, "many">;
     metadata: z.ZodOptional<z.ZodUnknown>;
     test: z.ZodOptional<z.ZodUnknown>;
@@ -217,7 +217,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
     url: string;
     name: string;
     description: string;
-    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled")[];
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
     sideload: string[];
     extensionSource: "custom" | "rossum_store";
     guide: string;
@@ -239,7 +239,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
     url: string;
     name: string;
     description: string;
-    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled")[];
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
     sideload: string[];
     extensionSource: "custom" | "rossum_store";
     guide: string;
@@ -269,9 +269,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
 }>>, z.ZodObject<{
     type: z.ZodLiteral<"function">;
     config: z.ZodObject<{
-        private: z.ZodOptional<z.ZodBoolean>;
-        runtime: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"nodejs22.x">, z.ZodLiteral<"nodejs18.x">, z.ZodLiteral<"python3.12">, z.ZodLiteral<"python3.8">]>>;
-        code: z.ZodOptional<z.ZodString>;
+        private: z.ZodOptional<z.ZodUnknown>;
         schedule: z.ZodOptional<z.ZodObject<{
             cron: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
@@ -280,7 +278,7 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
             cron?: string | undefined;
         }>>;
         payloadLoggingEnabled: z.ZodOptional<z.ZodBoolean>;
-        app: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        app: z.ZodNullable<z.ZodOptional<z.ZodObject<{
             url: z.ZodString;
             settings: z.ZodOptional<z.ZodUnknown>;
             displayMode: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"fullscreen">, z.ZodLiteral<"drawer">]>>;
@@ -293,10 +291,11 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
             settings?: unknown;
             displayMode?: "fullscreen" | "drawer" | undefined;
         }>>>;
+        runtime: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"nodejs22.x">, z.ZodLiteral<"nodejs18.x">, z.ZodLiteral<"python3.12">, z.ZodLiteral<"python3.8">]>>;
+        code: z.ZodOptional<z.ZodString>;
+        thirdPartyLibraryPack: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        private?: boolean | undefined;
-        runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-        code?: string | undefined;
+        private?: unknown;
         schedule?: {
             cron?: string | undefined;
         } | undefined;
@@ -306,10 +305,11 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
             settings?: unknown;
             displayMode?: "fullscreen" | "drawer" | undefined;
         } | null | undefined;
-    }, {
-        private?: boolean | undefined;
         runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
         code?: string | undefined;
+        thirdPartyLibraryPack?: string | undefined;
+    }, {
+        private?: unknown;
         schedule?: {
             cron?: string | undefined;
         } | undefined;
@@ -319,13 +319,14 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
             settings?: unknown;
             displayMode?: "fullscreen" | "drawer" | undefined;
         } | null | undefined;
+        runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
+        code?: string | undefined;
+        thirdPartyLibraryPack?: string | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     type: "function";
     config: {
-        private?: boolean | undefined;
-        runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-        code?: string | undefined;
+        private?: unknown;
         schedule?: {
             cron?: string | undefined;
         } | undefined;
@@ -335,21 +336,189 @@ export declare const hookTemplateSchema: z.ZodUnion<[z.ZodIntersection<z.ZodInte
             settings?: unknown;
             displayMode?: "fullscreen" | "drawer" | undefined;
         } | null | undefined;
+        runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
+        code?: string | undefined;
+        thirdPartyLibraryPack?: string | undefined;
     };
 }, {
     type: "function";
     config: {
-        private?: boolean | undefined;
+        private?: unknown;
+        schedule?: {
+            cron?: string | undefined;
+        } | undefined;
+        payloadLoggingEnabled?: boolean | undefined;
+        app?: {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        } | null | undefined;
         runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
         code?: string | undefined;
+        thirdPartyLibraryPack?: string | undefined;
+    };
+}>>, z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+    events: z.ZodArray<z.ZodUnion<[z.ZodLiteral<"annotation_content.confirm">, z.ZodLiteral<"annotation_content.export">, z.ZodLiteral<"annotation_content.initialize">, z.ZodLiteral<"annotation_content.started">, z.ZodLiteral<"annotation_content.updated">, z.ZodLiteral<"annotation_content.user_update">, z.ZodLiteral<"annotation_content">, z.ZodLiteral<"annotation_status.changed">, z.ZodLiteral<"annotation_status">, z.ZodLiteral<"upload.created">, z.ZodLiteral<"upload">, z.ZodLiteral<"email.received">, z.ZodLiteral<"email">, z.ZodLiteral<"invocation.manual">, z.ZodLiteral<"invocation.scheduled">, z.ZodLiteral<"invocation.integration">, z.ZodLiteral<"invocation.interface">, z.ZodLiteral<"invocation">]>, "many">;
+    sideload: z.ZodArray<z.ZodString, "many">;
+    metadata: z.ZodOptional<z.ZodUnknown>;
+    test: z.ZodOptional<z.ZodUnknown>;
+    description: z.ZodString;
+    extensionSource: z.ZodUnion<[z.ZodLiteral<"rossum_store">, z.ZodLiteral<"custom">]>;
+    settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    guide: z.ZodString;
+    readMoreUrl: z.ZodNullable<z.ZodString>;
+    extensionImageUrl: z.ZodNullable<z.ZodString>;
+    settingsDescription: z.ZodArray<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        tooltip: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        description?: string | undefined;
+        tooltip?: string | undefined;
+    }, {
+        name?: string | undefined;
+        description?: string | undefined;
+        tooltip?: string | undefined;
+    }>, "many">;
+    storeDescription: z.ZodString;
+    externalUrl: z.ZodString;
+    useTokenOwner: z.ZodBoolean;
+    order: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    name: string;
+    description: string;
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
+    sideload: string[];
+    extensionSource: "custom" | "rossum_store";
+    guide: string;
+    readMoreUrl: string | null;
+    extensionImageUrl: string | null;
+    settingsDescription: {
+        name?: string | undefined;
+        description?: string | undefined;
+        tooltip?: string | undefined;
+    }[];
+    storeDescription: string;
+    externalUrl: string;
+    useTokenOwner: boolean;
+    order: number;
+    metadata?: unknown;
+    test?: unknown;
+    settings?: Record<string, unknown> | undefined;
+}, {
+    url: string;
+    name: string;
+    description: string;
+    events: ("email" | "annotation_content" | "annotation_status" | "upload" | "invocation" | "annotation_content.confirm" | "annotation_content.export" | "annotation_content.initialize" | "annotation_content.started" | "annotation_content.updated" | "annotation_content.user_update" | "annotation_status.changed" | "upload.created" | "email.received" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface")[];
+    sideload: string[];
+    extensionSource: "custom" | "rossum_store";
+    guide: string;
+    readMoreUrl: string | null;
+    extensionImageUrl: string | null;
+    settingsDescription: {
+        name?: string | undefined;
+        description?: string | undefined;
+        tooltip?: string | undefined;
+    }[];
+    storeDescription: string;
+    externalUrl: string;
+    useTokenOwner: boolean;
+    order: number;
+    metadata?: unknown;
+    test?: unknown;
+    settings?: Record<string, unknown> | undefined;
+}>, z.ZodObject<{
+    id: z.ZodOptional<z.ZodNumber>;
+    installAction: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id?: number | undefined;
+    installAction?: string | undefined;
+}, {
+    id?: number | undefined;
+    installAction?: string | undefined;
+}>>, z.ZodObject<{
+    type: z.ZodLiteral<"job">;
+    config: z.ZodObject<{
+        private: z.ZodOptional<z.ZodUnknown>;
+        actorName: z.ZodOptional<z.ZodString>;
+        app: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+            url: z.ZodString;
+            settings: z.ZodOptional<z.ZodUnknown>;
+            displayMode: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"fullscreen">, z.ZodLiteral<"drawer">]>>;
+        }, "strip", z.ZodTypeAny, {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        }, {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        }>>>;
+        schedule: z.ZodOptional<z.ZodObject<{
+            cron: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            cron?: string | undefined;
+        }, {
+            cron?: string | undefined;
+        }>>;
+        payloadLoggingEnabled: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        private?: unknown;
+        actorName?: string | undefined;
+        app?: {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        } | null | undefined;
         schedule?: {
             cron?: string | undefined;
         } | undefined;
         payloadLoggingEnabled?: boolean | undefined;
+    }, {
+        private?: unknown;
+        actorName?: string | undefined;
         app?: {
             url: string;
             settings?: unknown;
             displayMode?: "fullscreen" | "drawer" | undefined;
         } | null | undefined;
+        schedule?: {
+            cron?: string | undefined;
+        } | undefined;
+        payloadLoggingEnabled?: boolean | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "job";
+    config: {
+        private?: unknown;
+        actorName?: string | undefined;
+        app?: {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        } | null | undefined;
+        schedule?: {
+            cron?: string | undefined;
+        } | undefined;
+        payloadLoggingEnabled?: boolean | undefined;
+    };
+}, {
+    type: "job";
+    config: {
+        private?: unknown;
+        actorName?: string | undefined;
+        app?: {
+            url: string;
+            settings?: unknown;
+            displayMode?: "fullscreen" | "drawer" | undefined;
+        } | null | undefined;
+        schedule?: {
+            cron?: string | undefined;
+        } | undefined;
+        payloadLoggingEnabled?: boolean | undefined;
     };
 }>>]>;

package/types/src/hooks/endpoints/cancelRun.d.ts

@@ -0,0 +1,14 @@
+export type CancelRunResponse = {
+    cancelRequested: string;
+};
+export declare const cancelRun: (runUuid: string) => {
+    readonly endpoint: `/hooks/runs/${string}/cancel`;
+    readonly method: "POST";
+    readonly responseSchema: import("zod").ZodObject<{
+        cancelRequested: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        cancelRequested: string;
+    }, {
+        cancelRequested: string;
+    }>;
+};

package/types/src/hooks/endpoints/cancelRun.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const cancelRunResponseSchema: z.ZodObject<{
+    cancelRequested: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    cancelRequested: string;
+}, {
+    cancelRequested: string;
+}>;