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

@rossum/api-client 0.1.25 → 0.1.26

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 (802) hide show

package/types/src/rules/endpoints/list.d.ts CHANGED Viewed

@@ -35,102 +35,96 @@ export declare const list: (query: RuleListQuery) => {
             triggerCondition: import("zod").ZodString;
             triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
             synchronizedFromTemplate: import("zod").ZodOptional<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">]>>;
+                payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: string;
+                event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            }, {
+                type: string;
+                event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            }>>, "many">;
         }, "strip", import("zod").ZodTypeAny, {
+            url: string;
             id: number;
             schema: string;
-            url: string;
             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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            })[];
+            description: string;
+            triggerCondition: string;
             ruleTemplate?: string | null | undefined;
             triggerConditionSummary?: string | undefined;
             synchronizedFromTemplate?: boolean | undefined;
         }, {
+            url: string;
             id: number;
             schema: string;
-            url: string;
             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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            })[];
+            description: string;
+            triggerCondition: string;
             ruleTemplate?: string | null | undefined;
             triggerConditionSummary?: string | undefined;
             synchronizedFromTemplate?: boolean | undefined;
         }>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         results: {
+            url: string;
             id: number;
             schema: string;
-            url: string;
             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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            })[];
+            description: string;
+            triggerCondition: string;
             ruleTemplate?: string | null | undefined;
             triggerConditionSummary?: string | undefined;
             synchronizedFromTemplate?: boolean | undefined;
@@ -143,23 +137,23 @@ export declare const list: (query: RuleListQuery) => {
         };
     }, {
         results: {
+            url: string;
             id: number;
             schema: string;
-            url: string;
             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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+                payload?: unknown;
+            })[];
+            description: string;
+            triggerCondition: string;
             ruleTemplate?: string | null | undefined;
             triggerConditionSummary?: string | undefined;
             synchronizedFromTemplate?: boolean | undefined;

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

@@ -15,79 +15,73 @@ export declare const patch: (ruleId: ID, payload: RulePatchPayload) => {
         triggerCondition: import("zod").ZodString;
         triggerConditionSummary: import("zod").ZodOptional<import("zod").ZodString>;
         synchronizedFromTemplate: import("zod").ZodOptional<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">]>>;
+            payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }, {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }>>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
+        url: string;
         id: number;
         schema: string;
-        url: string;
         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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         ruleTemplate?: string | null | undefined;
         triggerConditionSummary?: string | undefined;
         synchronizedFromTemplate?: boolean | undefined;
     }, {
+        url: string;
         id: number;
         schema: string;
-        url: string;
         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?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[];
+        description: string;
+        triggerCondition: string;
         ruleTemplate?: string | null | undefined;
         triggerConditionSummary?: string | undefined;
         synchronizedFromTemplate?: boolean | undefined;
@@ -103,40 +97,34 @@ export declare const patch: (ruleId: ID, payload: RulePatchPayload) => {
         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>>;
-        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">]>>;
+            payload: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }, {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        }>>, "many">>;
     }, "strip", import("zod").ZodTypeAny, {
         id?: number | undefined;
         url?: string | undefined;
@@ -148,16 +136,16 @@ export declare const patch: (ruleId: ID, payload: RulePatchPayload) => {
         triggerCondition?: string | undefined;
         triggerConditionSummary?: string | undefined;
         synchronizedFromTemplate?: boolean | undefined;
-        ruleActions?: {
+        actions?: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[] | undefined;
+        } & {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[] | undefined;
     }, {
         id?: number | undefined;
         url?: string | undefined;
@@ -169,16 +157,16 @@ export declare const patch: (ruleId: ID, payload: RulePatchPayload) => {
         triggerCondition?: string | undefined;
         triggerConditionSummary?: string | undefined;
         synchronizedFromTemplate?: boolean | undefined;
-        ruleActions?: {
+        actions?: ({
             id: string;
             enabled: boolean;
             name?: string | undefined;
             description?: string | undefined;
-            action?: {
-                type: string;
-                payload?: unknown;
-            } | undefined;
-        }[] | undefined;
+        } & {
+            type: string;
+            event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+            payload?: unknown;
+        })[] | undefined;
     }>;
     readonly payload: Partial<SchemaRule>;
 };

package/types/src/rules/endpoints/patch.schema.d.ts CHANGED Viewed

@@ -10,40 +10,34 @@ export declare const rulePatchPayloadSchema: z.ZodObject<{
     triggerCondition: z.ZodOptional<z.ZodString>;
     triggerConditionSummary: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     synchronizedFromTemplate: z.ZodOptional<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">]>>;
+        payload: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    }, {
+        type: string;
+        event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    }>>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id?: number | undefined;
     url?: string | undefined;
@@ -55,16 +49,16 @@ export declare const rulePatchPayloadSchema: z.ZodObject<{
     triggerCondition?: string | undefined;
     triggerConditionSummary?: string | undefined;
     synchronizedFromTemplate?: boolean | undefined;
-    ruleActions?: {
+    actions?: ({
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
-    }[] | undefined;
+    } & {
+        type: string;
+        event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    })[] | undefined;
 }, {
     id?: number | undefined;
     url?: string | undefined;
@@ -76,14 +70,14 @@ export declare const rulePatchPayloadSchema: z.ZodObject<{
     triggerCondition?: string | undefined;
     triggerConditionSummary?: string | undefined;
     synchronizedFromTemplate?: boolean | undefined;
-    ruleActions?: {
+    actions?: ({
         id: string;
         enabled: boolean;
         name?: string | undefined;
         description?: string | undefined;
-        action?: {
-            type: string;
-            payload?: unknown;
-        } | undefined;
-    }[] | undefined;
+    } & {
+        type: string;
+        event?: "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        payload?: unknown;
+    })[] | undefined;
 }>;

package/types/src/rules/models/schemaRule.d.ts CHANGED Viewed

@@ -1,6 +1,7 @@
 import { ID, Url } from '../../utils/codecUtils';
 export type SchemaAction = {
-    type: 'add_automation_blocker' | 'show_message' | 'send_email' | 'hide_field' | 'change_queue' | 'show_field' | 'change_status' | 'add_label' | 'remove_label' | string;
+    type: string;
+    event?: 'annotation_imported' | 'annotation_confirmed' | 'annotation_exported';
     payload?: unknown;
 };
 export type SchemaRuleAction = {
@@ -8,8 +9,7 @@ export type SchemaRuleAction = {
     enabled: boolean;
     name?: string;
     description?: string;
-    action?: SchemaAction;
-};
+} & SchemaAction;
 export type SchemaRule = {
     id: ID;
     url: Url;
@@ -21,5 +21,5 @@ export type SchemaRule = {
     triggerCondition: string;
     triggerConditionSummary?: string;
     synchronizedFromTemplate?: boolean;
-    ruleActions: SchemaRuleAction[];
+    actions: SchemaRuleAction[];
 };