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

@rossum/api-client 0.1.25 → 0.1.30

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

Files changed (817) hide show

package/types/src/relations/endpoints/patch.d.ts CHANGED Viewed

@@ -12,13 +12,13 @@ export declare const patch: (relationId: ID, payload: PatchRelationPayload) => {
         annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }>, import("zod").ZodObject<{
         type: import("zod").ZodLiteral<"edit">;
@@ -36,13 +36,13 @@ export declare const patch: (relationId: ID, payload: PatchRelationPayload) => {
         annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }>, import("zod").ZodObject<{
         type: import("zod").ZodLiteral<"duplicate">;
@@ -60,13 +60,13 @@ export declare const patch: (relationId: ID, payload: PatchRelationPayload) => {
         annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }, {
         annotations: string[];
-        id: number;
         url: string;
+        id: number;
         key: string | null;
     }>, import("zod").ZodObject<{
         type: import("zod").ZodLiteral<"attachment">;

package/types/src/relations/models/relations.schema.d.ts CHANGED Viewed

@@ -7,13 +7,13 @@ export declare const relationBaseSchema: z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>;
 export declare const editRelationSchema: z.ZodIntersection<z.ZodObject<{
@@ -23,13 +23,13 @@ export declare const editRelationSchema: z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"edit">;
@@ -48,13 +48,13 @@ export declare const duplicateRelationSchema: z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"duplicate">;
@@ -73,13 +73,13 @@ export declare const attachmentRelationSchema: z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"attachment">;
@@ -98,13 +98,13 @@ export declare const relationSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"edit">;
@@ -122,13 +122,13 @@ export declare const relationSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"duplicate">;
@@ -146,13 +146,13 @@ export declare const relationSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }, {
     annotations: string[];
-    id: number;
     url: string;
+    id: number;
     key: string | null;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"attachment">;

package/types/src/rule-templates/endpoints/create.d.ts CHANGED Viewed

@@ -11,75 +11,69 @@ export declare const create: (payload: RuleTemplateCreatePayload) => {
         triggerCondition: import("zod").ZodString;
         triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
         enabled: import("zod").ZodBoolean;
-        ruleActions: import("zod").ZodArray<import("zod").ZodObject<{
+        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>;
-            action: import("zod").ZodOptional<import("zod").ZodObject<{
-                type: import("zod").ZodUnion<[import("zod").ZodLiteral<"add_automation_blocker">, import("zod").ZodLiteral<"show_message">, import("zod").ZodLiteral<"send_email">, import("zod").ZodLiteral<"hide_field">, import("zod").ZodLiteral<"change_queue">, import("zod").ZodLiteral<"show_field">, import("zod").ZodLiteral<"change_status">, import("zod").ZodLiteral<"add_label">, import("zod").ZodLiteral<"remove_label">, import("zod").ZodString]>;
-                payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            }, "strip", import("zod").ZodTypeAny, {
-                type: string;
-                payload?: unknown;
-            }, {
-                type: string;
-                payload?: unknown;
-            }>>;
         }, "strip", import("zod").ZodTypeAny, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
         }, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }>, "many">;
+        }>, 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">]>>;
+            payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }>>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
         url: string;
+        id: number;
         name: string;
         enabled: boolean;
-        description: string;
-        triggerCondition: string;
-        ruleActions: {
+        actions: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[];
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         triggerConditionSummary?: string | undefined;
     }, {
-        id: number;
         url: string;
+        id: number;
         name: string;
         enabled: boolean;
-        description: string;
-        triggerCondition: string;
-        ruleActions: {
+        actions: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[];
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         triggerConditionSummary?: string | undefined;
     }>;
     readonly payloadSchema: import("zod").ZodObject<{
@@ -90,40 +84,34 @@ export declare const create: (payload: RuleTemplateCreatePayload) => {
         triggerCondition: import("zod").ZodOptional<import("zod").ZodString>;
         triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
         enabled: import("zod").ZodOptional<import("zod").ZodBoolean>;
-        ruleActions: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+        actions: import("zod").ZodOptional<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>;
-            action: import("zod").ZodOptional<import("zod").ZodObject<{
-                type: import("zod").ZodUnion<[import("zod").ZodLiteral<"add_automation_blocker">, import("zod").ZodLiteral<"show_message">, import("zod").ZodLiteral<"send_email">, import("zod").ZodLiteral<"hide_field">, import("zod").ZodLiteral<"change_queue">, import("zod").ZodLiteral<"show_field">, import("zod").ZodLiteral<"change_status">, import("zod").ZodLiteral<"add_label">, import("zod").ZodLiteral<"remove_label">, import("zod").ZodString]>;
-                payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            }, "strip", import("zod").ZodTypeAny, {
-                type: string;
-                payload?: unknown;
-            }, {
-                type: string;
-                payload?: unknown;
-            }>>;
         }, "strip", import("zod").ZodTypeAny, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
         }, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }>, "many">>;
+        }>, 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">]>>;
+            payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }>>, "many">>;
     }, "strip", import("zod").ZodTypeAny, {
         id?: number | undefined;
         url?: string | undefined;
@@ -132,16 +120,16 @@ export declare const create: (payload: RuleTemplateCreatePayload) => {
         triggerCondition?: string | undefined;
         triggerConditionSummary?: string | undefined;
         enabled?: boolean | undefined;
-        ruleActions?: {
+        actions?: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[] | undefined;
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[] | undefined;
     }, {
         id?: number | undefined;
         url?: string | undefined;
@@ -150,16 +138,16 @@ export declare const create: (payload: RuleTemplateCreatePayload) => {
         triggerCondition?: string | undefined;
         triggerConditionSummary?: string | undefined;
         enabled?: boolean | undefined;
-        ruleActions?: {
+        actions?: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[] | undefined;
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[] | undefined;
     }>;
     readonly payload: Partial<RuleTemplate>;
 };

package/types/src/rule-templates/endpoints/create.schema.d.ts CHANGED Viewed

@@ -7,40 +7,34 @@ export declare const ruleTemplateCreatePayloadSchema: z.ZodObject<{
     triggerCondition: z.ZodOptional<z.ZodString>;
     triggerConditionSummary: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     enabled: z.ZodOptional<z.ZodBoolean>;
-    ruleActions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    actions: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
         id: z.ZodString;
         enabled: z.ZodBoolean;
         name: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
-        action: z.ZodOptional<z.ZodObject<{
-            type: z.ZodUnion<[z.ZodLiteral<"add_automation_blocker">, z.ZodLiteral<"show_message">, z.ZodLiteral<"send_email">, z.ZodLiteral<"hide_field">, z.ZodLiteral<"change_queue">, z.ZodLiteral<"show_field">, z.ZodLiteral<"change_status">, z.ZodLiteral<"add_label">, z.ZodLiteral<"remove_label">, z.ZodString]>;
-            payload: z.ZodOptional<z.ZodUnknown>;
-        }, "strip", z.ZodTypeAny, {
-            type: string;
-            payload?: unknown;
-        }, {
-            type: string;
-            payload?: unknown;
-        }>>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
     }, {
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
-    }>, "many">>;
+    }>, z.ZodObject<{
+        type: z.ZodString;
+        event: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"annotation_imported">, z.ZodLiteral<"annotation_confirmed">, z.ZodLiteral<"annotation_exported">, z.ZodLiteral<"validation">]>>;
+        payload: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    }, {
+        type: string;
+        event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    }>>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id?: number | undefined;
     url?: string | undefined;
@@ -49,16 +43,16 @@ export declare const ruleTemplateCreatePayloadSchema: z.ZodObject<{
     triggerCondition?: string | undefined;
     triggerConditionSummary?: string | undefined;
     enabled?: boolean | undefined;
-    ruleActions?: {
+    actions?: ({
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
-    }[] | undefined;
+    } & {
+        type: string;
+        event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    })[] | undefined;
 }, {
     id?: number | undefined;
     url?: string | undefined;
@@ -67,14 +61,14 @@ export declare const ruleTemplateCreatePayloadSchema: z.ZodObject<{
     triggerCondition?: string | undefined;
     triggerConditionSummary?: string | undefined;
     enabled?: boolean | undefined;
-    ruleActions?: {
+    actions?: ({
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
-    }[] | undefined;
+    } & {
+        type: string;
+        event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    })[] | undefined;
 }>;

package/types/src/rule-templates/endpoints/get.d.ts CHANGED Viewed

@@ -10,75 +10,69 @@ export declare const get: (ruleId: ID) => {
         triggerCondition: import("zod").ZodString;
         triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
         enabled: import("zod").ZodBoolean;
-        ruleActions: import("zod").ZodArray<import("zod").ZodObject<{
+        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>;
-            action: import("zod").ZodOptional<import("zod").ZodObject<{
-                type: import("zod").ZodUnion<[import("zod").ZodLiteral<"add_automation_blocker">, import("zod").ZodLiteral<"show_message">, import("zod").ZodLiteral<"send_email">, import("zod").ZodLiteral<"hide_field">, import("zod").ZodLiteral<"change_queue">, import("zod").ZodLiteral<"show_field">, import("zod").ZodLiteral<"change_status">, import("zod").ZodLiteral<"add_label">, import("zod").ZodLiteral<"remove_label">, import("zod").ZodString]>;
-                payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            }, "strip", import("zod").ZodTypeAny, {
-                type: string;
-                payload?: unknown;
-            }, {
-                type: string;
-                payload?: unknown;
-            }>>;
         }, "strip", import("zod").ZodTypeAny, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
         }, {
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }>, "many">;
+        }>, 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">]>>;
+            payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }, {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }>>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
         url: string;
+        id: number;
         name: string;
         enabled: boolean;
-        description: string;
-        triggerCondition: string;
-        ruleActions: {
+        actions: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[];
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         triggerConditionSummary?: string | undefined;
     }, {
-        id: number;
         url: string;
+        id: number;
         name: string;
         enabled: boolean;
-        description: string;
-        triggerCondition: string;
-        ruleActions: {
+        actions: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[];
+        } & {
+            type: string;
+            event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         triggerConditionSummary?: string | undefined;
     }>;
 };