@rossum/api-client 0.1.30 → 0.2.1

package/types/src/groups/endpoints/list.schema.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const workflowStepsListQuerySchema: z.ZodObject<{
+    workflow: z.ZodOptional<z.ZodNumber>;
+    id: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodArray<z.ZodNumber, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    workflow?: number | undefined;
+    id?: number | number[] | undefined;
+}, {
+    workflow?: number | undefined;
+    id?: number | number[] | undefined;
+}>;

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

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

package/types/src/groups/models/group.d.ts

@@ -0,0 +1,7 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type GroupUrl = Url;
+export type Group = {
+    id: ID;
+    name: string;
+    url: GroupUrl;
+};

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

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

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

@@ -88,8 +88,16 @@ export declare const hookInterfaces: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").HookInterfaceListQuery;
-        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly name?: string | undefined;
+            readonly hook?: number | undefined;
+            readonly type?: string | undefined;
+            readonly canInvoke?: boolean | undefined;
+            readonly pageSize?: number;
+            readonly page?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
             name: import("zod").ZodOptional<import("zod").ZodString>;
             hook: import("zod").ZodOptional<import("zod").ZodNumber>;
             type: import("zod").ZodOptional<import("zod").ZodString>;
@@ -113,6 +121,12 @@ export declare const hookInterfaces: {
         }, {
             pageSize?: number | undefined;
             page?: number | undefined;
+        }>>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
         }>>;
     };
     create: (payload: import("./create").CreateHookInterfacePayload) => {

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

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ID } from '../../utils/codecUtils';
 import { PaginationQuery } from '../../utils/listQuery';
 export type HookInterfaceListQuery = Partial<{
@@ -9,13 +10,13 @@ export type HookInterfaceListQuery = Partial<{
 export declare const list: (query: HookInterfaceListQuery) => {
     readonly endpoint: "/hook_interfaces";
     readonly method: "GET";
-    readonly responseSchema: import("zod").ZodObject<{
-        pagination: import("zod").ZodObject<{
-            next: import("zod").ZodNullable<import("zod").ZodString>;
-            previous: import("zod").ZodNullable<import("zod").ZodString>;
-            total: import("zod").ZodNumber;
-            totalPages: import("zod").ZodNumber;
-        }, "strip", import("zod").ZodTypeAny, {
+    readonly responseSchema: z.ZodObject<{
+        pagination: z.ZodObject<{
+            next: z.ZodNullable<z.ZodString>;
+            previous: z.ZodNullable<z.ZodString>;
+            total: z.ZodNumber;
+            totalPages: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
             next: string | null;
             previous: string | null;
             total: number;
@@ -26,17 +27,17 @@ export declare const list: (query: HookInterfaceListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            url: import("zod").ZodString;
-            organization: import("zod").ZodString;
-            hook: import("zod").ZodString;
-            name: import("zod").ZodString;
-            description: import("zod").ZodString;
-            payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
-            type: import("zod").ZodString;
-            metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            url: z.ZodString;
+            organization: z.ZodString;
+            hook: z.ZodString;
+            name: z.ZodString;
+            description: z.ZodString;
+            payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            type: z.ZodString;
+            metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
             type: string;
             url: string;
             id: number;
@@ -57,7 +58,7 @@ export declare const list: (query: HookInterfaceListQuery) => {
             description: string;
             hook: string;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             type: string;
             url: string;
@@ -94,13 +95,21 @@ export declare const list: (query: HookInterfaceListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: HookInterfaceListQuery;
-    readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
-        name: import("zod").ZodOptional<import("zod").ZodString>;
-        hook: import("zod").ZodOptional<import("zod").ZodNumber>;
-        type: import("zod").ZodOptional<import("zod").ZodString>;
-        canInvoke: import("zod").ZodOptional<import("zod").ZodBoolean>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly name?: string | undefined;
+        readonly hook?: number | undefined;
+        readonly type?: string | undefined;
+        readonly canInvoke?: boolean | undefined;
+        readonly pageSize?: number;
+        readonly page?: number;
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        hook: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodOptional<z.ZodString>;
+        canInvoke: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
         name?: string | undefined;
         hook?: number | undefined;
         type?: string | undefined;
@@ -110,14 +119,20 @@ export declare const list: (query: HookInterfaceListQuery) => {
         hook?: number | undefined;
         type?: string | undefined;
         canInvoke?: boolean | undefined;
-    }>, import("zod").ZodObject<{
-        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
-        page: import("zod").ZodOptional<import("zod").ZodNumber>;
-    }, "strip", import("zod").ZodTypeAny, {
+    }>, z.ZodObject<{
+        pageSize: z.ZodOptional<z.ZodNumber>;
+        page: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
         pageSize?: number | undefined;
         page?: number | undefined;
     }, {
         pageSize?: number | undefined;
         page?: number | undefined;
+    }>>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
     }>>;
 };

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

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

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

@@ -5,7 +5,7 @@ export declare const get: (hookTemplateUrl: Url) => {
     readonly responseSchema: import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
         name: import("zod").ZodString;
         url: 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.interface">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        events: import("zod").ZodArray<import("zod").ZodEnum<["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"]>, "many">;
         sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
         metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
         test: import("zod").ZodOptional<import("zod").ZodUnknown>;
@@ -36,7 +36,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;
@@ -58,7 +58,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;
@@ -189,7 +189,7 @@ export declare const get: (hookTemplateUrl: Url) => {
     }>>, import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
         name: import("zod").ZodString;
         url: 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.interface">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        events: import("zod").ZodArray<import("zod").ZodEnum<["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"]>, "many">;
         sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
         metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
         test: import("zod").ZodOptional<import("zod").ZodUnknown>;
@@ -220,7 +220,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;
@@ -242,7 +242,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;
@@ -295,7 +295,7 @@ export declare const get: (hookTemplateUrl: Url) => {
                 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>;
+            code: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
             thirdPartyLibraryPack: import("zod").ZodOptional<import("zod").ZodString>;
         }, "strip", import("zod").ZodTypeAny, {
             private?: unknown;
@@ -309,7 +309,7 @@ export declare const get: (hookTemplateUrl: Url) => {
                 displayMode?: "fullscreen" | "drawer" | undefined;
             } | null | undefined;
             runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-            code?: string | undefined;
+            code?: string | null | undefined;
             thirdPartyLibraryPack?: string | undefined;
         }, {
             private?: unknown;
@@ -323,7 +323,7 @@ export declare const get: (hookTemplateUrl: Url) => {
                 displayMode?: "fullscreen" | "drawer" | undefined;
             } | null | undefined;
             runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-            code?: string | undefined;
+            code?: string | null | undefined;
             thirdPartyLibraryPack?: string | undefined;
         }>;
     }, "strip", import("zod").ZodTypeAny, {
@@ -340,7 +340,7 @@ export declare const get: (hookTemplateUrl: Url) => {
                 displayMode?: "fullscreen" | "drawer" | undefined;
             } | null | undefined;
             runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-            code?: string | undefined;
+            code?: string | null | undefined;
             thirdPartyLibraryPack?: string | undefined;
         };
     }, {
@@ -357,13 +357,13 @@ export declare const get: (hookTemplateUrl: Url) => {
                 displayMode?: "fullscreen" | "drawer" | undefined;
             } | null | undefined;
             runtime?: "nodejs22.x" | "nodejs18.x" | "python3.12" | "python3.8" | undefined;
-            code?: string | undefined;
+            code?: string | null | undefined;
             thirdPartyLibraryPack?: string | undefined;
         };
     }>>, import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
         name: import("zod").ZodString;
         url: 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.interface">, import("zod").ZodLiteral<"invocation">]>, "many">;
+        events: import("zod").ZodArray<import("zod").ZodEnum<["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"]>, "many">;
         sideload: import("zod").ZodArray<import("zod").ZodString, "many">;
         metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
         test: import("zod").ZodOptional<import("zod").ZodUnknown>;
@@ -394,7 +394,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;
@@ -416,7 +416,7 @@ export declare const get: (hookTemplateUrl: Url) => {
         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")[];
+        events: ("email" | "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" | "invocation.manual" | "invocation.scheduled" | "invocation.integration" | "invocation.interface" | "invocation")[];
         sideload: string[];
         extensionSource: "custom" | "rossum_store";
         guide: string;