@rossum/api-client 0.1.25 → 0.1.30

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

@@ -20,11 +20,19 @@ export type WebhookConfig = Partial<{
     schedule: ScheduleConfig;
     payloadLoggingEnabled: boolean;
 }>;
-export type FunctionConfig = Partial<{
-    private: boolean;
-    runtime: FunctionRuntime;
-    code: string;
-    schedule: ScheduleConfig;
-    payloadLoggingEnabled: boolean;
-    app: AppConfig | null;
-}>;
+export type FunctionConfig = {
+    private?: unknown;
+    schedule?: ScheduleConfig;
+    payloadLoggingEnabled?: boolean;
+    app?: AppConfig | null;
+    runtime?: FunctionRuntime;
+    code?: string;
+    thirdPartyLibraryPack?: string;
+};
+export type JobConfig = {
+    private?: unknown;
+    actorName?: string;
+    app?: AppConfig | null;
+    schedule?: ScheduleConfig;
+    payloadLoggingEnabled?: boolean;
+};

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

@@ -82,9 +82,7 @@ export declare const webhookConfigSchema: z.ZodObject<{
     payloadLoggingEnabled?: boolean | undefined;
 }>;
 export declare const functionConfigSchema: 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, {
@@ -93,7 +91,7 @@ export declare const functionConfigSchema: z.ZodObject<{
         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">]>>;
@@ -106,10 +104,25 @@ export declare const functionConfigSchema: z.ZodObject<{
         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;
+    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;
@@ -119,17 +132,56 @@ export declare const functionConfigSchema: z.ZodObject<{
         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;
+}>;
+export declare const jobConfigSchema: 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;
 }>;

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

@@ -3,8 +3,9 @@ export type AnnotationContentAction = 'confirm' | 'export' | 'initialize' | 'sta
 export type UploadAction = 'created';
 export type AnnotationStatusAction = 'changed';
 export type EmailAction = 'received';
-export type InvocationAction = 'manual' | 'scheduled';
-export type ExtensionEvent = 'annotation_content.confirm' | 'annotation_content.export' | 'annotation_content.initialize' | 'annotation_content.started' | 'annotation_content.updated' | 'annotation_content.user_update' | 'annotation_content' | 'annotation_status.changed' | 'annotation_status' | 'upload.created' | 'upload' | 'email.received' | 'email' | 'invocation.manual' | 'invocation.scheduled' | 'invocation';
+export type InvocationAction = 'manual' | 'scheduled' | 'integration' | 'interface';
+export type HookAction = AnnotationContentAction | UploadAction | AnnotationStatusAction | EmailAction | InvocationAction;
+export type ExtensionEvent = 'annotation_content.confirm' | 'annotation_content.export' | 'annotation_content.initialize' | 'annotation_content.started' | 'annotation_content.updated' | 'annotation_content.user_update' | 'annotation_content' | 'annotation_status.changed' | 'annotation_status' | 'upload.created' | 'upload' | 'email.received' | 'email' | 'invocation.manual' | 'invocation.scheduled' | 'invocation.integration' | 'invocation.interface' | 'invocation';
 export type FunctionRuntime = 'nodejs22.x' | 'nodejs18.x' | 'python3.12' | 'python3.8';
 export type ExtensionSource = 'rossum_store' | 'custom';
-export type ExtensionStatus = 'pending' | 'ready';
+export type ExtensionStatus = 'pending' | 'ready' | 'failed';

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

@@ -4,8 +4,9 @@ export declare const annotationContentActionSchema: z.ZodUnion<[z.ZodLiteral<"co
 export declare const uploadActionSchema: z.ZodLiteral<"created">;
 export declare const annotationStatusActionSchema: z.ZodLiteral<"changed">;
 export declare const emailActionSchema: z.ZodLiteral<"received">;
-export declare const invocationActionSchema: z.ZodUnion<[z.ZodLiteral<"manual">, z.ZodLiteral<"scheduled">]>;
-export declare const extensionEventSchema: 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">]>;
+export declare const invocationActionSchema: z.ZodUnion<[z.ZodLiteral<"manual">, z.ZodLiteral<"scheduled">, z.ZodLiteral<"integration">, z.ZodLiteral<"interface">]>;
+export declare const hookActionSchema: z.ZodUnion<[z.ZodUnion<[z.ZodLiteral<"confirm">, z.ZodLiteral<"export">, z.ZodLiteral<"initialize">, z.ZodLiteral<"started">, z.ZodLiteral<"updated">, z.ZodLiteral<"user_update">]>, z.ZodLiteral<"created">, z.ZodLiteral<"changed">, z.ZodLiteral<"received">, z.ZodUnion<[z.ZodLiteral<"manual">, z.ZodLiteral<"scheduled">, z.ZodLiteral<"integration">, z.ZodLiteral<"interface">]>]>;
+export declare const extensionEventSchema: 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">]>;
 export declare const functionRuntimeSchema: z.ZodUnion<[z.ZodLiteral<"nodejs22.x">, z.ZodLiteral<"nodejs18.x">, z.ZodLiteral<"python3.12">, z.ZodLiteral<"python3.8">]>;
 export declare const extensionSourceSchema: z.ZodUnion<[z.ZodLiteral<"rossum_store">, z.ZodLiteral<"custom">]>;
-export declare const extensionStatusSchema: z.ZodUnion<[z.ZodLiteral<"pending">, z.ZodLiteral<"ready">]>;
+export declare const extensionStatusSchema: z.ZodUnion<[z.ZodLiteral<"pending">, z.ZodLiteral<"ready">, z.ZodLiteral<"failed">]>;

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

@@ -0,0 +1,53 @@
+import { HookType } from './hook';
+import { AnnotationContentAction, AnnotationStatusAction, EmailAction, InvocationAction, UploadAction } from './hookUtils';
+import { LogLevel } from './runLog';
+export declare const STATUS_CODE_2XX_OPTIONS: readonly ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
+export declare const STATUS_CODE_4XX_OPTIONS: readonly ["400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "421", "422", "423", "424", "425", "426", "428", "429", "431", "451"];
+export declare const STATUS_CODE_5XX_OPTIONS: readonly ["500", "501", "502", "503", "504", "505", "506", "507", "508", "510", "511"];
+export declare const STATUS_CODE_OPTIONS: readonly ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "421", "422", "423", "424", "425", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "510", "511"];
+export type StatusCode = '200' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '226' | '400' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '411' | '412' | '413' | '414' | '415' | '416' | '417' | '418' | '421' | '422' | '423' | '424' | '425' | '426' | '428' | '429' | '431' | '451' | '500' | '501' | '502' | '503' | '504' | '505' | '506' | '507' | '508' | '510' | '511';
+export type RunStatus = 'completed' | 'failed' | 'running' | 'cancelled' | 'waiting';
+export declare const RUN_STATUS_OPTIONS: ["completed", "failed", "running", "cancelled", "waiting"];
+type AnnotationContentRun = RunBase & {
+    annotationId?: number | null;
+    event: 'annotation_content';
+    action: AnnotationContentAction;
+};
+type AnnotationStatusRun = RunBase & {
+    annotationId?: number | null;
+    event: 'annotation_status';
+    action: AnnotationStatusAction;
+};
+type UploadRun = RunBase & {
+    emailId?: number | null;
+    event: 'upload';
+    action: UploadAction;
+};
+type EmailRun = RunBase & {
+    emailId?: number | null;
+    event: 'email';
+    action: EmailAction;
+};
+type InvocationRun = RunBase & {
+    event: 'invocation';
+    action: InvocationAction;
+};
+type RunBase = {
+    hookId: number;
+    hookType: HookType;
+    logLevel: LogLevel;
+    message: string;
+    queueId?: number | null;
+    request: string | null;
+    requestId: string;
+    response: string | null;
+    timestamp: string;
+    start?: string | null;
+    end?: string | null;
+    status?: RunStatus;
+    settings?: unknown;
+    uuid?: string;
+    cancelRequested?: string | null;
+};
+export type Run = AnnotationContentRun | AnnotationStatusRun | UploadRun | EmailRun | InvocationRun;
+export {};

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

@@ -0,0 +1,301 @@
+import { z } from 'zod';
+export declare const statusCodeSchema: z.ZodUnion<[z.ZodLiteral<"200">, z.ZodLiteral<"201">, z.ZodLiteral<"202">, z.ZodLiteral<"203">, z.ZodLiteral<"204">, z.ZodLiteral<"205">, z.ZodLiteral<"206">, z.ZodLiteral<"207">, z.ZodLiteral<"208">, z.ZodLiteral<"226">, z.ZodLiteral<"400">, z.ZodLiteral<"401">, z.ZodLiteral<"402">, z.ZodLiteral<"403">, z.ZodLiteral<"404">, z.ZodLiteral<"405">, z.ZodLiteral<"406">, z.ZodLiteral<"407">, z.ZodLiteral<"408">, z.ZodLiteral<"409">, z.ZodLiteral<"410">, z.ZodLiteral<"411">, z.ZodLiteral<"412">, z.ZodLiteral<"413">, z.ZodLiteral<"414">, z.ZodLiteral<"415">, z.ZodLiteral<"416">, z.ZodLiteral<"417">, z.ZodLiteral<"418">, z.ZodLiteral<"421">, z.ZodLiteral<"422">, z.ZodLiteral<"423">, z.ZodLiteral<"424">, z.ZodLiteral<"425">, z.ZodLiteral<"426">, z.ZodLiteral<"428">, z.ZodLiteral<"429">, z.ZodLiteral<"431">, z.ZodLiteral<"451">, z.ZodLiteral<"500">, z.ZodLiteral<"501">, z.ZodLiteral<"502">, z.ZodLiteral<"503">, z.ZodLiteral<"504">, z.ZodLiteral<"505">, z.ZodLiteral<"506">, z.ZodLiteral<"507">, z.ZodLiteral<"508">, z.ZodLiteral<"510">, z.ZodLiteral<"511">]>;
+export declare const runStatusSchema: z.ZodUnion<[z.ZodLiteral<"completed">, z.ZodLiteral<"failed">, z.ZodLiteral<"running">, z.ZodLiteral<"cancelled">, z.ZodLiteral<"waiting">]>;
+export declare const runSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+    hookId: z.ZodNumber;
+    hookType: z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"function">, z.ZodLiteral<"job">]>;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    message: z.ZodString;
+    queueId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    request: z.ZodNullable<z.ZodString>;
+    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">]>>;
+    settings: z.ZodOptional<z.ZodUnknown>;
+    uuid: z.ZodOptional<z.ZodString>;
+    cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}>, z.ZodObject<{
+    annotationId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    event: z.ZodLiteral<"annotation_content">;
+    action: z.ZodUnion<[z.ZodLiteral<"confirm">, z.ZodLiteral<"export">, z.ZodLiteral<"initialize">, z.ZodLiteral<"started">, z.ZodLiteral<"updated">, z.ZodLiteral<"user_update">]>;
+}, "strip", z.ZodTypeAny, {
+    event: "annotation_content";
+    action: "started" | "export" | "confirm" | "initialize" | "updated" | "user_update";
+    annotationId?: number | null | undefined;
+}, {
+    event: "annotation_content";
+    action: "started" | "export" | "confirm" | "initialize" | "updated" | "user_update";
+    annotationId?: number | null | undefined;
+}>>, z.ZodIntersection<z.ZodObject<{
+    hookId: z.ZodNumber;
+    hookType: z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"function">, z.ZodLiteral<"job">]>;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    message: z.ZodString;
+    queueId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    request: z.ZodNullable<z.ZodString>;
+    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">]>>;
+    settings: z.ZodOptional<z.ZodUnknown>;
+    uuid: z.ZodOptional<z.ZodString>;
+    cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}>, z.ZodObject<{
+    annotationId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    event: z.ZodLiteral<"annotation_status">;
+    action: z.ZodLiteral<"changed">;
+}, "strip", z.ZodTypeAny, {
+    event: "annotation_status";
+    action: "changed";
+    annotationId?: number | null | undefined;
+}, {
+    event: "annotation_status";
+    action: "changed";
+    annotationId?: number | null | undefined;
+}>>, z.ZodIntersection<z.ZodObject<{
+    hookId: z.ZodNumber;
+    hookType: z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"function">, z.ZodLiteral<"job">]>;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    message: z.ZodString;
+    queueId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    request: z.ZodNullable<z.ZodString>;
+    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">]>>;
+    settings: z.ZodOptional<z.ZodUnknown>;
+    uuid: z.ZodOptional<z.ZodString>;
+    cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}>, z.ZodObject<{
+    emailId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    event: z.ZodLiteral<"upload">;
+    action: z.ZodLiteral<"created">;
+}, "strip", z.ZodTypeAny, {
+    event: "upload";
+    action: "created";
+    emailId?: number | null | undefined;
+}, {
+    event: "upload";
+    action: "created";
+    emailId?: number | null | undefined;
+}>>, z.ZodIntersection<z.ZodObject<{
+    hookId: z.ZodNumber;
+    hookType: z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"function">, z.ZodLiteral<"job">]>;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    message: z.ZodString;
+    queueId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    request: z.ZodNullable<z.ZodString>;
+    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">]>>;
+    settings: z.ZodOptional<z.ZodUnknown>;
+    uuid: z.ZodOptional<z.ZodString>;
+    cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}>, z.ZodObject<{
+    emailId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    event: z.ZodLiteral<"email">;
+    action: z.ZodLiteral<"received">;
+}, "strip", z.ZodTypeAny, {
+    event: "email";
+    action: "received";
+    emailId?: number | null | undefined;
+}, {
+    event: "email";
+    action: "received";
+    emailId?: number | null | undefined;
+}>>, z.ZodIntersection<z.ZodObject<{
+    hookId: z.ZodNumber;
+    hookType: z.ZodUnion<[z.ZodLiteral<"webhook">, z.ZodLiteral<"function">, z.ZodLiteral<"job">]>;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    message: z.ZodString;
+    queueId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    request: z.ZodNullable<z.ZodString>;
+    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">]>>;
+    settings: z.ZodOptional<z.ZodUnknown>;
+    uuid: z.ZodOptional<z.ZodString>;
+    cancelRequested: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}, {
+    message: string;
+    hookId: number;
+    requestId: string;
+    timestamp: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+    hookType: "function" | "webhook" | "job";
+    request: string | null;
+    response: string | null;
+    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;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"invocation">;
+    action: z.ZodUnion<[z.ZodLiteral<"manual">, z.ZodLiteral<"scheduled">, z.ZodLiteral<"integration">, z.ZodLiteral<"interface">]>;
+}, "strip", z.ZodTypeAny, {
+    event: "invocation";
+    action: "manual" | "scheduled" | "integration" | "interface";
+}, {
+    event: "invocation";
+    action: "manual" | "scheduled" | "integration" | "interface";
+}>>]>;

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

@@ -0,0 +1,7 @@
+export declare const LOG_LEVEL_OPTIONS: readonly ["INFO", "ERROR", "WARNING"];
+export type LogLevel = 'INFO' | 'ERROR' | 'WARNING';
+export type RunLog = {
+    timestamp: string;
+    logLevel: LogLevel;
+    details: string;
+};

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

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const logLevelSchema: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+export declare const runLogSchema: z.ZodObject<{
+    timestamp: z.ZodString;
+    logLevel: z.ZodUnion<[z.ZodLiteral<"INFO">, z.ZodLiteral<"ERROR">, z.ZodLiteral<"WARNING">]>;
+    details: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    timestamp: string;
+    details: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+}, {
+    timestamp: string;
+    details: string;
+    logLevel: "INFO" | "ERROR" | "WARNING";
+}>;

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

@@ -68,8 +68,8 @@ export declare const create: (payload: CreateInboxPayload) => {
         }>;
         dmarcCheckAction: import("zod").ZodString;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
         url: string;
+        id: number;
         email: string;
         name: string;
         queues: string[];
@@ -93,8 +93,8 @@ export declare const create: (payload: CreateInboxPayload) => {
         bounceEmailTo?: string | null | undefined;
         metadata?: unknown;
     }, {
-        id: number;
         url: string;
+        id: number;
         email: string;
         name: string;
         queues: string[];

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

@@ -59,8 +59,8 @@ export declare const get: (inboxId: number) => {
         }>;
         dmarcCheckAction: import("zod").ZodString;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
         url: string;
+        id: number;
         email: string;
         name: string;
         queues: string[];
@@ -84,8 +84,8 @@ export declare const get: (inboxId: number) => {
         bounceEmailTo?: string | null | undefined;
         metadata?: unknown;
     }, {
-        id: number;
         url: string;
+        id: number;
         email: string;
         name: string;
         queues: string[];