@rossum/api-client 0.1.30 → 0.2.1

package/types/src/queues/models/vendorEmailNotificationsSettings.schema.d.ts

@@ -0,0 +1,211 @@
+import { z } from 'zod';
+export declare const vendorEmailNotificationsSettingsSchema: z.ZodObject<{
+    emailWithoutProcessableAttachment: z.ZodObject<{
+        enabled: z.ZodBoolean;
+        templateValues: z.ZodObject<{
+            subject: z.ZodString;
+            message: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            subject: string;
+        }, {
+            message: string;
+            subject: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        templateValues: {
+            message: string;
+            subject: string;
+        };
+    }, {
+        enabled: boolean;
+        templateValues: {
+            message: string;
+            subject: string;
+        };
+    }>;
+    annotationStatusChange: z.ZodObject<{
+        received: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            templateValues: z.ZodObject<{
+                subject: z.ZodString;
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                subject: string;
+            }, {
+                message: string;
+                subject: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }>>;
+        confirmed: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            templateValues: z.ZodObject<{
+                subject: z.ZodString;
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                subject: string;
+            }, {
+                message: string;
+                subject: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }>>;
+        exported: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            templateValues: z.ZodObject<{
+                subject: z.ZodString;
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                subject: string;
+            }, {
+                message: string;
+                subject: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }, {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        received?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        confirmed?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        exported?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+    }, {
+        received?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        confirmed?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        exported?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    emailWithoutProcessableAttachment: {
+        enabled: boolean;
+        templateValues: {
+            message: string;
+            subject: string;
+        };
+    };
+    annotationStatusChange: {
+        received?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        confirmed?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        exported?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+    };
+}, {
+    emailWithoutProcessableAttachment: {
+        enabled: boolean;
+        templateValues: {
+            message: string;
+            subject: string;
+        };
+    };
+    annotationStatusChange: {
+        received?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        confirmed?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+        exported?: {
+            enabled: boolean;
+            templateValues: {
+                message: string;
+                subject: string;
+            };
+        } | undefined;
+    };
+}>;

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

@@ -159,8 +159,15 @@ export declare const relations: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").RelationListQuery;
-        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly parent?: number[] | undefined;
+            readonly annotation?: number[] | undefined;
+            readonly type?: import("..").RelationType | undefined;
+            readonly pageSize?: number;
+            readonly page?: number;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodIntersection<import("zod").ZodObject<{
             parent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
             annotation: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
             type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"edit">, import("zod").ZodLiteral<"duplicate">, import("zod").ZodLiteral<"attachment">]>>;
@@ -181,6 +188,12 @@ export declare const relations: {
         }, {
             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").CreateRelationPayload) => {
@@ -354,7 +367,7 @@ export declare const relations: {
     patch: (relationId: import("../../..").ID, payload: import("./patch").PatchRelationPayload) => {
         readonly endpoint: `/relations/${number}`;
         readonly method: "PATCH";
-        readonly payload: Partial<import("../models/relations").RelationBase>;
+        readonly payload: Partial<import("..").RelationBase>;
         readonly responseSchema: import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
             url: import("zod").ZodString;
             id: import("zod").ZodNumber;

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

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { ID } from '../../utils/codecUtils';
 import { PaginationQuery } from '../../utils/listQuery';
 import { RelationType } from '../models/relations';
@@ -9,13 +10,13 @@ export type RelationListQuery = Partial<{
 export declare const list: (query?: RelationListQuery) => {
     readonly endpoint: "/relations";
     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,12 +27,12 @@ export declare const list: (query?: RelationListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
-            url: import("zod").ZodString;
-            id: import("zod").ZodNumber;
-            key: import("zod").ZodNullable<import("zod").ZodString>;
-            annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
-        }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+            url: z.ZodString;
+            id: z.ZodNumber;
+            key: z.ZodNullable<z.ZodString>;
+            annotations: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
             annotations: string[];
             url: string;
             id: number;
@@ -41,21 +42,21 @@ export declare const list: (query?: RelationListQuery) => {
             url: string;
             id: number;
             key: string | null;
-        }>, import("zod").ZodObject<{
-            type: import("zod").ZodLiteral<"edit">;
-            parent: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"edit">;
+            parent: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
             type: "edit";
             parent: string;
         }, {
             type: "edit";
             parent: string;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            url: import("zod").ZodString;
-            id: import("zod").ZodNumber;
-            key: import("zod").ZodNullable<import("zod").ZodString>;
-            annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>>, z.ZodIntersection<z.ZodObject<{
+            url: z.ZodString;
+            id: z.ZodNumber;
+            key: z.ZodNullable<z.ZodString>;
+            annotations: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
             annotations: string[];
             url: string;
             id: number;
@@ -65,21 +66,21 @@ export declare const list: (query?: RelationListQuery) => {
             url: string;
             id: number;
             key: string | null;
-        }>, import("zod").ZodObject<{
-            type: import("zod").ZodLiteral<"duplicate">;
-            parent: import("zod").ZodNullable<import("zod").ZodString>;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"duplicate">;
+            parent: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
             type: "duplicate";
             parent: string | null;
         }, {
             type: "duplicate";
             parent: string | null;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            url: import("zod").ZodString;
-            id: import("zod").ZodNumber;
-            key: import("zod").ZodNullable<import("zod").ZodString>;
-            annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>>, z.ZodIntersection<z.ZodObject<{
+            url: z.ZodString;
+            id: z.ZodNumber;
+            key: z.ZodNullable<z.ZodString>;
+            annotations: z.ZodArray<z.ZodString, "many">;
+        }, "strip", z.ZodTypeAny, {
             annotations: string[];
             url: string;
             id: number;
@@ -89,17 +90,17 @@ export declare const list: (query?: RelationListQuery) => {
             url: string;
             id: number;
             key: string | null;
-        }>, import("zod").ZodObject<{
-            type: import("zod").ZodLiteral<"attachment">;
-            parent: import("zod").ZodNullable<import("zod").ZodString>;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"attachment">;
+            parent: z.ZodNullable<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
             type: "attachment";
             parent: string | null;
         }, {
             type: "attachment";
             parent: string | null;
         }>>]>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: (({
             annotations: string[];
             url: string;
@@ -164,12 +165,19 @@ export declare const list: (query?: RelationListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: RelationListQuery;
-    readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
-        parent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
-        annotation: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
-        type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"edit">, import("zod").ZodLiteral<"duplicate">, import("zod").ZodLiteral<"attachment">]>>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly parent?: number[] | undefined;
+        readonly annotation?: number[] | undefined;
+        readonly type?: RelationType | undefined;
+        readonly pageSize?: number;
+        readonly page?: number;
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+        parent: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        annotation: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        type: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"edit">, z.ZodLiteral<"duplicate">, z.ZodLiteral<"attachment">]>>;
+    }, "strip", z.ZodTypeAny, {
         parent?: number[] | undefined;
         annotation?: number[] | undefined;
         type?: "edit" | "duplicate" | "attachment" | undefined;
@@ -177,14 +185,20 @@ export declare const list: (query?: RelationListQuery) => {
         parent?: number[] | undefined;
         annotation?: number[] | undefined;
         type?: "edit" | "duplicate" | "attachment" | 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/relations/index.d.ts

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

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

@@ -0,0 +1,2 @@
+export * from './relations.schema';
+export * from './relations';

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

@@ -1,5 +1,5 @@
-import { SchemaRule } from '../models/schemaRule';
-export type RuleCreatePayload = Partial<SchemaRule>;
+import { QueueRule } from '../models/queueRule';
+export type RuleCreatePayload = Omit<QueueRule, 'id' | 'url'>;
 export declare const create: (payload: RuleCreatePayload) => {
     readonly endpoint: "/rules";
     readonly method: "POST";
@@ -9,26 +9,18 @@ export declare const create: (payload: RuleCreatePayload) => {
         enabled: import("zod").ZodBoolean;
         name: import("zod").ZodString;
         description: import("zod").ZodString;
-        ruleTemplate: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
-        schema: import("zod").ZodString;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
         triggerCondition: import("zod").ZodString;
         triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
-        synchronizedFromTemplate: import("zod").ZodOptional<import("zod").ZodBoolean>;
         actions: import("zod").ZodArray<import("zod").ZodIntersection<import("zod").ZodObject<{
             id: import("zod").ZodString;
             enabled: import("zod").ZodBoolean;
-            name: import("zod").ZodOptional<import("zod").ZodString>;
-            description: import("zod").ZodOptional<import("zod").ZodString>;
         }, "strip", import("zod").ZodTypeAny, {
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         }, {
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         }>, import("zod").ZodObject<{
             type: import("zod").ZodString;
             event: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_imported">, import("zod").ZodLiteral<"annotation_confirmed">, import("zod").ZodLiteral<"annotation_exported">, import("zod").ZodLiteral<"validation">]>>;
@@ -42,17 +34,16 @@ export declare const create: (payload: RuleCreatePayload) => {
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
             payload?: unknown;
         }>>, "many">;
+        schema: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
     }, "strip", import("zod").ZodTypeAny, {
         url: string;
         id: number;
-        schema: string;
         name: string;
+        queues: string[];
         enabled: boolean;
         actions: ({
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         } & {
             type: string;
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
@@ -60,20 +51,17 @@ export declare const create: (payload: RuleCreatePayload) => {
         })[];
         description: string;
         triggerCondition: string;
-        ruleTemplate?: string | null | undefined;
         triggerConditionSummary?: string | undefined;
-        synchronizedFromTemplate?: boolean | undefined;
+        schema?: string | null | undefined;
     }, {
         url: string;
         id: number;
-        schema: string;
         name: string;
+        queues: string[];
         enabled: boolean;
         actions: ({
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         } & {
             type: string;
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
@@ -81,36 +69,27 @@ export declare const create: (payload: RuleCreatePayload) => {
         })[];
         description: string;
         triggerCondition: string;
-        ruleTemplate?: string | null | undefined;
         triggerConditionSummary?: string | undefined;
-        synchronizedFromTemplate?: boolean | undefined;
+        schema?: string | null | undefined;
     }>;
-    readonly payloadSchema: import("zod").ZodObject<{
-        id: import("zod").ZodOptional<import("zod").ZodNumber>;
-        url: import("zod").ZodOptional<import("zod").ZodString>;
-        enabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
-        name: import("zod").ZodOptional<import("zod").ZodString>;
-        description: import("zod").ZodOptional<import("zod").ZodString>;
-        ruleTemplate: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>>;
-        schema: import("zod").ZodOptional<import("zod").ZodString>;
-        triggerCondition: import("zod").ZodOptional<import("zod").ZodString>;
-        triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-        synchronizedFromTemplate: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodBoolean>>;
-        actions: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodIntersection<import("zod").ZodObject<{
+    readonly payloadSchema: import("zod").ZodObject<Omit<{
+        id: import("zod").ZodNumber;
+        url: import("zod").ZodString;
+        enabled: import("zod").ZodBoolean;
+        name: import("zod").ZodString;
+        description: import("zod").ZodString;
+        queues: import("zod").ZodArray<import("zod").ZodString, "many">;
+        triggerCondition: import("zod").ZodString;
+        triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
+        actions: import("zod").ZodArray<import("zod").ZodIntersection<import("zod").ZodObject<{
             id: import("zod").ZodString;
             enabled: import("zod").ZodBoolean;
-            name: import("zod").ZodOptional<import("zod").ZodString>;
-            description: import("zod").ZodOptional<import("zod").ZodString>;
         }, "strip", import("zod").ZodTypeAny, {
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         }, {
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         }>, import("zod").ZodObject<{
             type: import("zod").ZodString;
             event: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"annotation_imported">, import("zod").ZodLiteral<"annotation_confirmed">, import("zod").ZodLiteral<"annotation_exported">, import("zod").ZodLiteral<"validation">]>>;
@@ -123,49 +102,40 @@ export declare const create: (payload: RuleCreatePayload) => {
             type: string;
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
             payload?: unknown;
-        }>>, "many">>;
-    }, "strip", import("zod").ZodTypeAny, {
-        id?: number | undefined;
-        url?: string | undefined;
-        enabled?: boolean | undefined;
-        name?: string | undefined;
-        description?: string | undefined;
-        ruleTemplate?: string | null | undefined;
-        schema?: string | undefined;
-        triggerCondition?: string | undefined;
-        triggerConditionSummary?: string | undefined;
-        synchronizedFromTemplate?: boolean | undefined;
-        actions?: ({
+        }>>, "many">;
+        schema: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+    }, "url" | "id">, "strip", import("zod").ZodTypeAny, {
+        name: string;
+        queues: string[];
+        enabled: boolean;
+        actions: ({
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         } & {
             type: string;
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
             payload?: unknown;
-        })[] | undefined;
-    }, {
-        id?: number | undefined;
-        url?: string | undefined;
-        enabled?: boolean | undefined;
-        name?: string | undefined;
-        description?: string | undefined;
-        ruleTemplate?: string | null | undefined;
-        schema?: string | undefined;
-        triggerCondition?: string | undefined;
+        })[];
+        description: string;
+        triggerCondition: string;
+        schema?: string | null | undefined;
         triggerConditionSummary?: string | undefined;
-        synchronizedFromTemplate?: boolean | undefined;
-        actions?: ({
+    }, {
+        name: string;
+        queues: string[];
+        enabled: boolean;
+        actions: ({
             id: string;
             enabled: boolean;
-            name?: string | undefined;
-            description?: string | undefined;
         } & {
             type: string;
             event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
             payload?: unknown;
-        })[] | undefined;
+        })[];
+        description: string;
+        triggerCondition: string;
+        schema?: string | null | undefined;
+        triggerConditionSummary?: string | undefined;
     }>;
-    readonly payload: Partial<SchemaRule>;
+    readonly payload: RuleCreatePayload;
 };