@rossum/api-client 0.1.25 → 0.1.26

package/types/src/genericEngines/models/genericEngine.schema.d.ts

@@ -7,16 +7,16 @@ export declare const genericEngineSchema: z.ZodObject<{
     description: z.ZodString;
     documentationUrl: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    url: string;
     id: number;
     schema: string | null;
-    url: string;
     name: string;
     description: string;
     documentationUrl: string | null;
 }, {
+    url: string;
     id: number;
     schema: string | null;
-    url: string;
     name: string;
     description: string;
     documentationUrl: string | null;

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

@@ -24,18 +24,18 @@ export declare const groups: {
                 name: import("zod").ZodString;
                 url: import("zod").ZodString;
             }, "strip", import("zod").ZodTypeAny, {
-                id: number;
                 url: string;
+                id: number;
                 name: string;
             }, {
-                id: number;
                 url: string;
+                id: number;
                 name: string;
             }>, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             results: {
-                id: number;
                 url: string;
+                id: number;
                 name: string;
             }[];
             pagination: {
@@ -46,8 +46,8 @@ export declare const groups: {
             };
         }, {
             results: {
-                id: number;
                 url: string;
+                id: number;
                 name: string;
             }[];
             pagination: {

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

@@ -23,18 +23,18 @@ export declare const list: () => {
             name: import("zod").ZodString;
             url: import("zod").ZodString;
         }, "strip", import("zod").ZodTypeAny, {
-            id: number;
             url: string;
+            id: number;
             name: string;
         }, {
-            id: number;
             url: string;
+            id: number;
             name: string;
         }>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         results: {
-            id: number;
             url: string;
+            id: number;
             name: string;
         }[];
         pagination: {
@@ -45,8 +45,8 @@ export declare const list: () => {
         };
     }, {
         results: {
-            id: number;
             url: string;
+            id: number;
             name: string;
         }[];
         pagination: {

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

@@ -5,11 +5,11 @@ export declare const groupSchema: z.ZodObject<{
     name: z.ZodString;
     url: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    id: number;
     url: string;
+    id: number;
     name: string;
 }, {
-    id: number;
     url: string;
+    id: number;
     name: string;
 }>;

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

@@ -0,0 +1,67 @@
+import { Url } from '../../utils/codecUtils';
+export type CreateHookInterfacePayload = {
+    hook: Url;
+    name: string;
+    description: string;
+    payload: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+    type: string;
+};
+export declare const create: (payload: CreateHookInterfacePayload) => {
+    readonly endpoint: "/hook_interfaces";
+    readonly method: "POST";
+    readonly payload: CreateHookInterfacePayload;
+    readonly responseSchema: 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, {
+        type: string;
+        url: string;
+        id: number;
+        metadata: Record<string, unknown>;
+        organization: string;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }, {
+        type: string;
+        url: string;
+        id: number;
+        metadata: Record<string, unknown>;
+        organization: string;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }>;
+    readonly payloadSchema: import("zod").ZodObject<{
+        hook: import("zod").ZodString;
+        name: import("zod").ZodString;
+        description: import("zod").ZodString;
+        payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+        metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+        type: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: string;
+        metadata: Record<string, unknown>;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }, {
+        type: string;
+        metadata: Record<string, unknown>;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }>;
+};

package/types/src/hookInterfaces/endpoints/create.schema.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const createHookInterfacePayloadSchema: z.ZodObject<{
+    hook: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    metadata: Record<string, unknown>;
+    payload: Record<string, unknown>;
+    name: string;
+    description: string;
+    hook: string;
+}, {
+    type: string;
+    metadata: Record<string, unknown>;
+    payload: Record<string, unknown>;
+    name: string;
+    description: string;
+    hook: string;
+}>;

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

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+import { ID } from '../../utils/codecUtils';
+export declare const deleteEndpoint: (id: ID) => {
+    readonly endpoint: `/hook_interfaces/${number}`;
+    readonly method: "DELETE";
+    readonly responseSchema: z.ZodUnknown;
+};

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

@@ -0,0 +1,243 @@
+export type { HookInterfaceListQuery } from './list';
+export declare const hookInterfaces: {
+    list: (query: import("./list").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, {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            }, {
+                next: string | null;
+                previous: string | null;
+                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, {
+                type: string;
+                url: string;
+                id: number;
+                metadata: Record<string, unknown>;
+                organization: string;
+                payload: Record<string, unknown>;
+                name: string;
+                description: string;
+                hook: string;
+            }, {
+                type: string;
+                url: string;
+                id: number;
+                metadata: Record<string, unknown>;
+                organization: string;
+                payload: Record<string, unknown>;
+                name: string;
+                description: string;
+                hook: string;
+            }>, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            results: {
+                type: string;
+                url: string;
+                id: number;
+                metadata: Record<string, unknown>;
+                organization: string;
+                payload: Record<string, unknown>;
+                name: string;
+                description: string;
+                hook: string;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }, {
+            results: {
+                type: string;
+                url: string;
+                id: number;
+                metadata: Record<string, unknown>;
+                organization: string;
+                payload: Record<string, unknown>;
+                name: string;
+                description: string;
+                hook: string;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }>;
+        readonly query: import("./list").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, {
+            name?: string | undefined;
+            hook?: number | undefined;
+            type?: string | undefined;
+            canInvoke?: boolean | undefined;
+        }, {
+            name?: string | undefined;
+            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, {
+            pageSize?: number | undefined;
+            page?: number | undefined;
+        }, {
+            pageSize?: number | undefined;
+            page?: number | undefined;
+        }>>;
+    };
+    create: (payload: import("./create").CreateHookInterfacePayload) => {
+        readonly endpoint: "/hook_interfaces";
+        readonly method: "POST";
+        readonly payload: import("./create").CreateHookInterfacePayload;
+        readonly responseSchema: 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, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }>;
+        readonly payloadSchema: import("zod").ZodObject<{
+            hook: import("zod").ZodString;
+            name: import("zod").ZodString;
+            description: import("zod").ZodString;
+            payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            type: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            metadata: Record<string, unknown>;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }, {
+            type: string;
+            metadata: Record<string, unknown>;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }>;
+    };
+    delete: (id: import("../../..").ID) => {
+        readonly endpoint: `/hook_interfaces/${number}`;
+        readonly method: "DELETE";
+        readonly responseSchema: import("zod").ZodUnknown;
+    };
+    invoke: (id: import("../../..").ID, payload?: import("./invoke").InvokePayload) => {
+        readonly endpoint: `/hook_interfaces/${number}/invoke`;
+        readonly method: "POST";
+        readonly payload: import("./invoke").InvokePayload;
+        readonly responseSchema: import("zod").ZodUnknown;
+        readonly payloadSchema: import("zod").ZodUnion<[import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>, import("zod").ZodUndefined]>;
+    };
+    patch: (id: import("../../..").ID, payload: import("./patch").PatchHookInterfacePayload) => {
+        readonly endpoint: `/hook_interfaces/${number}`;
+        readonly method: "PATCH";
+        readonly payload: import("./patch").PatchHookInterfacePayload;
+        readonly responseSchema: 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, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }>;
+        readonly payloadSchema: import("zod").ZodObject<{
+            name: import("zod").ZodString;
+            description: import("zod").ZodString;
+            payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            type: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            metadata: Record<string, unknown>;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+        }, {
+            type: string;
+            metadata: Record<string, unknown>;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+        }>;
+    };
+};

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

@@ -0,0 +1,10 @@
+import { ID } from '../../utils/codecUtils';
+export type InvokeResponse = unknown;
+export type InvokePayload = Record<string, unknown> | undefined;
+export declare const invoke: (id: ID, payload?: InvokePayload) => {
+    readonly endpoint: `/hook_interfaces/${number}/invoke`;
+    readonly method: "POST";
+    readonly payload: InvokePayload;
+    readonly responseSchema: import("zod").ZodUnknown;
+    readonly payloadSchema: import("zod").ZodUnion<[import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>, import("zod").ZodUndefined]>;
+};

package/types/src/hookInterfaces/endpoints/invoke.schema.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const invokeResponseSchema: z.ZodUnknown;
+export declare const invokePayloadSchema: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodUndefined]>;

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

@@ -0,0 +1,123 @@
+import { ID } from '../../utils/codecUtils';
+import { PaginationQuery } from '../../utils/listQuery';
+export type HookInterfaceListQuery = Partial<{
+    name: string;
+    hook: ID;
+    type: string;
+    canInvoke: boolean;
+}> & PaginationQuery;
+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, {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        }, {
+            next: string | null;
+            previous: string | null;
+            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, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }, {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }>, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        results: {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }, {
+        results: {
+            type: string;
+            url: string;
+            id: number;
+            metadata: Record<string, unknown>;
+            organization: string;
+            payload: Record<string, unknown>;
+            name: string;
+            description: string;
+            hook: string;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            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, {
+        name?: string | undefined;
+        hook?: number | undefined;
+        type?: string | undefined;
+        canInvoke?: boolean | undefined;
+    }, {
+        name?: string | undefined;
+        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, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }>>;
+};

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

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+export declare const hookInterfaceListQuerySchema: 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;
+    canInvoke?: boolean | undefined;
+}, {
+    name?: string | undefined;
+    hook?: number | undefined;
+    type?: string | undefined;
+    canInvoke?: boolean | undefined;
+}>, 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;
+}>>;

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

@@ -0,0 +1,63 @@
+import { ID } from '../../utils/codecUtils';
+export type PatchHookInterfacePayload = {
+    name: string;
+    description: string;
+    payload: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+    type: string;
+};
+export declare const patch: (id: ID, payload: PatchHookInterfacePayload) => {
+    readonly endpoint: `/hook_interfaces/${number}`;
+    readonly method: "PATCH";
+    readonly payload: PatchHookInterfacePayload;
+    readonly responseSchema: 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, {
+        type: string;
+        url: string;
+        id: number;
+        metadata: Record<string, unknown>;
+        organization: string;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }, {
+        type: string;
+        url: string;
+        id: number;
+        metadata: Record<string, unknown>;
+        organization: string;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+        hook: string;
+    }>;
+    readonly payloadSchema: import("zod").ZodObject<{
+        name: import("zod").ZodString;
+        description: import("zod").ZodString;
+        payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+        metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+        type: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: string;
+        metadata: Record<string, unknown>;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+    }, {
+        type: string;
+        metadata: Record<string, unknown>;
+        payload: Record<string, unknown>;
+        name: string;
+        description: string;
+    }>;
+};