npm - @rossum/api-client - Versions diffs - 0.1.25 → 0.1.26 - Mend

@rossum/api-client 0.1.25 → 0.1.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (802) hide show

package/types/src/hooks/endpoints/createFromTemplate.d.ts ADDED Viewed

@@ -0,0 +1,508 @@
+import { Url } from '../../utils/codecUtils';
+import { ExtensionEvent } from '../models/hookUtils';
+export type CreateHookFromTemplatePayload = {
+    name: string;
+    hookTemplate: Url;
+    events: ExtensionEvent[];
+    queues: Url[];
+    tokenOwner: Url | null;
+};
+export declare const createFromTemplate: (payload: CreateHookFromTemplatePayload) => {
+    readonly endpoint: "/hooks/create";
+    readonly method: "POST";
+    readonly responseSchema: import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        name: import("zod").ZodString;
+        url: import("zod").ZodString;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+        runAfter: import("zod").ZodArray<import("zod").ZodString, "many">;
+        active: import("zod").ZodBoolean;
+        events: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_content.confirm">, import("zod").ZodLiteral<"annotation_content.export">, import("zod").ZodLiteral<"annotation_content.initialize">, import("zod").ZodLiteral<"annotation_content.started">, import("zod").ZodLiteral<"annotation_content.updated">, import("zod").ZodLiteral<"annotation_content.user_update">, import("zod").ZodLiteral<"annotation_content">, import("zod").ZodLiteral<"annotation_status.changed">, import("zod").ZodLiteral<"annotation_status">, import("zod").ZodLiteral<"upload.created">, import("zod").ZodLiteral<"upload">, import("zod").ZodLiteral<"email.received">, import("zod").ZodLiteral<"email">, import("zod").ZodLiteral<"invocation.manual">, import("zod").ZodLiteral<"invocation.scheduled">, import("zod").ZodLiteral<"invocation.integration">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
+        metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        tokenOwner: import("zod").ZodNullable<import("zod").ZodString>;
+        test: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        description: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionSource: import("zod").ZodUnion<[import("zod").ZodLiteral<"rossum_store">, import("zod").ZodLiteral<"custom">]>;
+        settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        guide: import("zod").ZodNullable<import("zod").ZodString>;
+        readMoreUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionImageUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        settingsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secretsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secrets: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
+        hookTemplate: import("zod").ZodNullable<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"webhook">;
+        config: import("zod").ZodObject<{
+            private: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            url: import("zod").ZodOptional<import("zod").ZodString>;
+            insecureSsl: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            clientSslCertificate: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+            clientSslKey: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+            secret: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+            app: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodObject<{
+                url: import("zod").ZodString;
+                settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                displayMode: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"fullscreen">, import("zod").ZodLiteral<"drawer">]>>;
+            }, "strip", import("zod").ZodTypeAny, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }>>>;
+            schedule: import("zod").ZodOptional<import("zod").ZodObject<{
+                cron: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                cron?: string | undefined;
+            }, {
+                cron?: string | undefined;
+            }>>;
+            payloadLoggingEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            private?: boolean | undefined;
+            url?: string | undefined;
+            insecureSsl?: boolean | undefined;
+            clientSslCertificate?: string | null | undefined;
+            clientSslKey?: string | null | undefined;
+            secret?: string | null | undefined;
+            app?: {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            } | null | undefined;
+            schedule?: {
+                cron?: string | undefined;
+            } | undefined;
+            payloadLoggingEnabled?: boolean | undefined;
+        }, {
+            private?: boolean | undefined;
+            url?: string | undefined;
+            insecureSsl?: boolean | undefined;
+            clientSslCertificate?: string | null | undefined;
+            clientSslKey?: string | null | undefined;
+            secret?: string | null | undefined;
+            app?: {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            } | null | undefined;
+            schedule?: {
+                cron?: string | undefined;
+            } | undefined;
+            payloadLoggingEnabled?: boolean | undefined;
+        }>;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: "webhook";
+        config: {
+            private?: boolean | undefined;
+            url?: string | undefined;
+            insecureSsl?: boolean | undefined;
+            clientSslCertificate?: string | null | undefined;
+            clientSslKey?: string | null | undefined;
+            secret?: string | null | undefined;
+            app?: {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            } | null | undefined;
+            schedule?: {
+                cron?: string | undefined;
+            } | undefined;
+            payloadLoggingEnabled?: boolean | undefined;
+        };
+    }, {
+        type: "webhook";
+        config: {
+            private?: boolean | undefined;
+            url?: string | undefined;
+            insecureSsl?: boolean | undefined;
+            clientSslCertificate?: string | null | undefined;
+            clientSslKey?: string | null | undefined;
+            secret?: string | null | undefined;
+            app?: {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            } | null | undefined;
+            schedule?: {
+                cron?: string | undefined;
+            } | undefined;
+            payloadLoggingEnabled?: boolean | undefined;
+        };
+    }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        name: import("zod").ZodString;
+        url: import("zod").ZodString;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+        runAfter: import("zod").ZodArray<import("zod").ZodString, "many">;
+        active: import("zod").ZodBoolean;
+        events: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_content.confirm">, import("zod").ZodLiteral<"annotation_content.export">, import("zod").ZodLiteral<"annotation_content.initialize">, import("zod").ZodLiteral<"annotation_content.started">, import("zod").ZodLiteral<"annotation_content.updated">, import("zod").ZodLiteral<"annotation_content.user_update">, import("zod").ZodLiteral<"annotation_content">, import("zod").ZodLiteral<"annotation_status.changed">, import("zod").ZodLiteral<"annotation_status">, import("zod").ZodLiteral<"upload.created">, import("zod").ZodLiteral<"upload">, import("zod").ZodLiteral<"email.received">, import("zod").ZodLiteral<"email">, import("zod").ZodLiteral<"invocation.manual">, import("zod").ZodLiteral<"invocation.scheduled">, import("zod").ZodLiteral<"invocation.integration">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
+        metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        tokenOwner: import("zod").ZodNullable<import("zod").ZodString>;
+        test: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        description: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionSource: import("zod").ZodUnion<[import("zod").ZodLiteral<"rossum_store">, import("zod").ZodLiteral<"custom">]>;
+        settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        guide: import("zod").ZodNullable<import("zod").ZodString>;
+        readMoreUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionImageUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        settingsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secretsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secrets: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
+        hookTemplate: import("zod").ZodNullable<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"function">;
+        config: import("zod").ZodObject<{
+            private: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            schedule: import("zod").ZodOptional<import("zod").ZodObject<{
+                cron: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                cron?: string | undefined;
+            }, {
+                cron?: string | undefined;
+            }>>;
+            payloadLoggingEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            app: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodObject<{
+                url: import("zod").ZodString;
+                settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                displayMode: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"fullscreen">, import("zod").ZodLiteral<"drawer">]>>;
+            }, "strip", import("zod").ZodTypeAny, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }>>>;
+            runtime: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"nodejs22.x">, import("zod").ZodLiteral<"nodejs18.x">, import("zod").ZodLiteral<"python3.12">, import("zod").ZodLiteral<"python3.8">]>>;
+            code: import("zod").ZodOptional<import("zod").ZodString>;
+            thirdPartyLibraryPack: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            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;
+        }, {
+            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;
+        }>;
+        status: import("zod").ZodUnion<[import("zod").ZodLiteral<"pending">, import("zod").ZodLiteral<"ready">, import("zod").ZodLiteral<"failed">]>;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: "function";
+        status: "pending" | "ready" | "failed";
+        config: {
+            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;
+        };
+    }, {
+        type: "function";
+        status: "pending" | "ready" | "failed";
+        config: {
+            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;
+        };
+    }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        name: import("zod").ZodString;
+        url: import("zod").ZodString;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+        runAfter: import("zod").ZodArray<import("zod").ZodString, "many">;
+        active: import("zod").ZodBoolean;
+        events: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_content.confirm">, import("zod").ZodLiteral<"annotation_content.export">, import("zod").ZodLiteral<"annotation_content.initialize">, import("zod").ZodLiteral<"annotation_content.started">, import("zod").ZodLiteral<"annotation_content.updated">, import("zod").ZodLiteral<"annotation_content.user_update">, import("zod").ZodLiteral<"annotation_content">, import("zod").ZodLiteral<"annotation_status.changed">, import("zod").ZodLiteral<"annotation_status">, import("zod").ZodLiteral<"upload.created">, import("zod").ZodLiteral<"upload">, import("zod").ZodLiteral<"email.received">, import("zod").ZodLiteral<"email">, import("zod").ZodLiteral<"invocation.manual">, import("zod").ZodLiteral<"invocation.scheduled">, import("zod").ZodLiteral<"invocation.integration">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
+        metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        tokenOwner: import("zod").ZodNullable<import("zod").ZodString>;
+        test: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        description: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionSource: import("zod").ZodUnion<[import("zod").ZodLiteral<"rossum_store">, import("zod").ZodLiteral<"custom">]>;
+        settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        guide: import("zod").ZodNullable<import("zod").ZodString>;
+        readMoreUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        extensionImageUrl: import("zod").ZodNullable<import("zod").ZodString>;
+        settingsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secretsSchema: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+        secrets: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>>;
+        hookTemplate: import("zod").ZodNullable<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }, {
+        url: string;
+        id: number;
+        name: string;
+        queues: string[];
+        description: string | null;
+        runAfter: string[];
+        active: boolean;
+        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")[];
+        sideload: string[];
+        tokenOwner: string | null;
+        extensionSource: "custom" | "rossum_store";
+        guide: string | null;
+        readMoreUrl: string | null;
+        extensionImageUrl: string | null;
+        settingsSchema: Record<string, unknown> | null;
+        secretsSchema: Record<string, unknown> | null;
+        hookTemplate: string | null;
+        metadata?: unknown;
+        test?: unknown;
+        settings?: unknown;
+        secrets?: Record<string, unknown> | null | undefined;
+    }>, import("zod").ZodObject<{
+        type: import("zod").ZodLiteral<"job">;
+        config: import("zod").ZodObject<{
+            private: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            actorName: import("zod").ZodOptional<import("zod").ZodString>;
+            app: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodObject<{
+                url: import("zod").ZodString;
+                settings: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                displayMode: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"fullscreen">, import("zod").ZodLiteral<"drawer">]>>;
+            }, "strip", import("zod").ZodTypeAny, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }, {
+                url: string;
+                settings?: unknown;
+                displayMode?: "fullscreen" | "drawer" | undefined;
+            }>>>;
+            schedule: import("zod").ZodOptional<import("zod").ZodObject<{
+                cron: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                cron?: string | undefined;
+            }, {
+                cron?: string | undefined;
+            }>>;
+            payloadLoggingEnabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").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", import("zod").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;
+        };
+    }>>]>;
+    readonly payload: CreateHookFromTemplatePayload;
+    readonly payloadSchema: import("zod").ZodObject<{
+        name: import("zod").ZodString;
+        hookTemplate: import("zod").ZodString;
+        events: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_content.confirm">, import("zod").ZodLiteral<"annotation_content.export">, import("zod").ZodLiteral<"annotation_content.initialize">, import("zod").ZodLiteral<"annotation_content.started">, import("zod").ZodLiteral<"annotation_content.updated">, import("zod").ZodLiteral<"annotation_content.user_update">, import("zod").ZodLiteral<"annotation_content">, import("zod").ZodLiteral<"annotation_status.changed">, import("zod").ZodLiteral<"annotation_status">, import("zod").ZodLiteral<"upload.created">, import("zod").ZodLiteral<"upload">, import("zod").ZodLiteral<"email.received">, import("zod").ZodLiteral<"email">, import("zod").ZodLiteral<"invocation.manual">, import("zod").ZodLiteral<"invocation.scheduled">, import("zod").ZodLiteral<"invocation.integration">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+        tokenOwner: import("zod").ZodNullable<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        name: string;
+        queues: 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")[];
+        tokenOwner: string | null;
+        hookTemplate: string;
+    }, {
+        name: string;
+        queues: 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")[];
+        tokenOwner: string | null;
+        hookTemplate: string;
+    }>;
+};

package/types/src/hooks/endpoints/createFromTemplate.schema.d.ts ADDED Viewed

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const createHookFromTemplatePayloadSchema: z.ZodObject<{
+    name: z.ZodString;
+    hookTemplate: 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">]>, "many">;
+    queues: z.ZodArray<z.ZodString, "many">;
+    tokenOwner: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    queues: 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")[];
+    tokenOwner: string | null;
+    hookTemplate: string;
+}, {
+    name: string;
+    queues: 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")[];
+    tokenOwner: string | null;
+    hookTemplate: string;
+}>;