@rossum/api-client 0.1.30 → 0.2.1

package/types/src/rules/models/{schemaRule.schema.d.ts → queueRule.schema.d.ts}

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const schemaActionSchema: z.ZodObject<{
+export declare const queueActionSchema: 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>;
@@ -12,21 +12,15 @@ export declare const schemaActionSchema: z.ZodObject<{
     event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
     payload?: unknown;
 }>;
-export declare const schemaRuleActionSchema: z.ZodIntersection<z.ZodObject<{
+export declare const queueRuleActionSchema: z.ZodIntersection<z.ZodObject<{
     id: z.ZodString;
     enabled: z.ZodBoolean;
-    name: z.ZodOptional<z.ZodString>;
-    description: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     enabled: boolean;
-    name?: string | undefined;
-    description?: string | undefined;
 }, {
     id: string;
     enabled: boolean;
-    name?: string | undefined;
-    description?: string | undefined;
 }>, 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">]>>;
@@ -40,32 +34,24 @@ export declare const schemaRuleActionSchema: z.ZodIntersection<z.ZodObject<{
     event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
     payload?: unknown;
 }>>;
-export declare const schemaRuleSchema: z.ZodObject<{
+export declare const queueRuleSchema: z.ZodObject<{
     id: z.ZodNumber;
     url: z.ZodString;
     enabled: z.ZodBoolean;
     name: z.ZodString;
     description: z.ZodString;
-    ruleTemplate: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    schema: z.ZodString;
+    queues: z.ZodArray<z.ZodString, "many">;
     triggerCondition: z.ZodString;
     triggerConditionSummary: z.ZodOptional<z.ZodString>;
-    synchronizedFromTemplate: z.ZodOptional<z.ZodBoolean>;
     actions: z.ZodArray<z.ZodIntersection<z.ZodObject<{
         id: z.ZodString;
         enabled: z.ZodBoolean;
-        name: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         enabled: boolean;
-        name?: string | undefined;
-        description?: string | undefined;
     }, {
         id: string;
         enabled: boolean;
-        name?: string | undefined;
-        description?: string | undefined;
     }>, 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">]>>;
@@ -79,17 +65,16 @@ export declare const schemaRuleSchema: z.ZodObject<{
         event?: "validation" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
         payload?: unknown;
     }>>, "many">;
+    schema: z.ZodNullable<z.ZodOptional<z.ZodString>>;
 }, "strip", z.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;
@@ -97,20 +82,17 @@ export declare const schemaRuleSchema: z.ZodObject<{
     })[];
     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;
@@ -118,7 +100,6 @@ export declare const schemaRuleSchema: z.ZodObject<{
     })[];
     description: string;
     triggerCondition: string;
-    ruleTemplate?: string | null | undefined;
     triggerConditionSummary?: string | undefined;
-    synchronizedFromTemplate?: boolean | undefined;
+    schema?: string | null | undefined;
 }>;

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

@@ -0,0 +1,77 @@
+export declare const get: (requestId: string) => {
+    readonly endpoint: `/rules_execution_logs/${string}`;
+    readonly method: "GET";
+    readonly responseSchema: import("zod").ZodObject<{
+        ruleId: import("zod").ZodNumber;
+        ruleName: import("zod").ZodString;
+        queueId: import("zod").ZodNumber;
+        annotationId: import("zod").ZodNumber;
+        requestId: import("zod").ZodString;
+        createdAt: import("zod").ZodString;
+        triggerEvent: import("zod").ZodString;
+        triggerCondition: import("zod").ZodString;
+        triggerConditionResults: import("zod").ZodArray<import("zod").ZodBoolean, "many">;
+        triggerConditionValues: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>, "many">>;
+        executionResult: import("zod").ZodUnion<[import("zod").ZodLiteral<"success">, import("zod").ZodLiteral<"failure">, import("zod").ZodLiteral<"partial_success">]>;
+        executionError: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+        actions: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
+            actionId: import("zod").ZodNullable<import("zod").ZodString>;
+            actionType: import("zod").ZodString;
+            success: import("zod").ZodBoolean;
+            payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+            error: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            payload: Record<string, unknown>;
+            success: boolean;
+            actionId: string | null;
+            actionType: string;
+            error?: string | undefined;
+        }, {
+            payload: Record<string, unknown>;
+            success: boolean;
+            actionId: string | null;
+            actionType: string;
+            error?: string | undefined;
+        }>, "many">>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        requestId: string;
+        ruleId: number;
+        ruleName: string;
+        createdAt: string;
+        actions: ({
+            payload: Record<string, unknown>;
+            success: boolean;
+            actionId: string | null;
+            actionType: string;
+            error?: string | undefined;
+        }[] | null)[] | null;
+        queueId: number;
+        annotationId: number;
+        triggerCondition: string;
+        triggerEvent: string;
+        triggerConditionResults: boolean[];
+        triggerConditionValues: Record<string, string>[] | null;
+        executionResult: "success" | "failure" | "partial_success";
+        executionError?: string | null | undefined;
+    }, {
+        requestId: string;
+        ruleId: number;
+        ruleName: string;
+        createdAt: string;
+        actions: ({
+            payload: Record<string, unknown>;
+            success: boolean;
+            actionId: string | null;
+            actionType: string;
+            error?: string | undefined;
+        }[] | null)[] | null;
+        queueId: number;
+        annotationId: number;
+        triggerCondition: string;
+        triggerEvent: string;
+        triggerConditionResults: boolean[];
+        triggerConditionValues: Record<string, string>[] | null;
+        executionResult: "success" | "failure" | "partial_success";
+        executionError?: string | null | undefined;
+    }>;
+};

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

@@ -0,0 +1,288 @@
+export type { RulesExecutionLogsQuery, RulesExecutionLogsResponse, } from './list';
+export declare const rulesExecutionLogs: {
+    get: (requestId: string) => {
+        readonly endpoint: `/rules_execution_logs/${string}`;
+        readonly method: "GET";
+        readonly responseSchema: import("zod").ZodObject<{
+            ruleId: import("zod").ZodNumber;
+            ruleName: import("zod").ZodString;
+            queueId: import("zod").ZodNumber;
+            annotationId: import("zod").ZodNumber;
+            requestId: import("zod").ZodString;
+            createdAt: import("zod").ZodString;
+            triggerEvent: import("zod").ZodString;
+            triggerCondition: import("zod").ZodString;
+            triggerConditionResults: import("zod").ZodArray<import("zod").ZodBoolean, "many">;
+            triggerConditionValues: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>, "many">>;
+            executionResult: import("zod").ZodUnion<[import("zod").ZodLiteral<"success">, import("zod").ZodLiteral<"failure">, import("zod").ZodLiteral<"partial_success">]>;
+            executionError: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+            actions: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
+                actionId: import("zod").ZodNullable<import("zod").ZodString>;
+                actionType: import("zod").ZodString;
+                success: import("zod").ZodBoolean;
+                payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+                error: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                payload: Record<string, unknown>;
+                success: boolean;
+                actionId: string | null;
+                actionType: string;
+                error?: string | undefined;
+            }, {
+                payload: Record<string, unknown>;
+                success: boolean;
+                actionId: string | null;
+                actionType: string;
+                error?: string | undefined;
+            }>, "many">>, "many">>;
+        }, "strip", import("zod").ZodTypeAny, {
+            requestId: string;
+            ruleId: number;
+            ruleName: string;
+            createdAt: string;
+            actions: ({
+                payload: Record<string, unknown>;
+                success: boolean;
+                actionId: string | null;
+                actionType: string;
+                error?: string | undefined;
+            }[] | null)[] | null;
+            queueId: number;
+            annotationId: number;
+            triggerCondition: string;
+            triggerEvent: string;
+            triggerConditionResults: boolean[];
+            triggerConditionValues: Record<string, string>[] | null;
+            executionResult: "success" | "failure" | "partial_success";
+            executionError?: string | null | undefined;
+        }, {
+            requestId: string;
+            ruleId: number;
+            ruleName: string;
+            createdAt: string;
+            actions: ({
+                payload: Record<string, unknown>;
+                success: boolean;
+                actionId: string | null;
+                actionType: string;
+                error?: string | undefined;
+            }[] | null)[] | null;
+            queueId: number;
+            annotationId: number;
+            triggerCondition: string;
+            triggerEvent: string;
+            triggerConditionResults: boolean[];
+            triggerConditionValues: Record<string, string>[] | null;
+            executionResult: "success" | "failure" | "partial_success";
+            executionError?: string | null | undefined;
+        }>;
+    };
+    list: (query?: import("./list").RulesExecutionLogsQuery) => {
+        readonly endpoint: "/rules_execution_logs";
+        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<{
+                ruleId: import("zod").ZodNumber;
+                ruleName: import("zod").ZodString;
+                queueId: import("zod").ZodNumber;
+                annotationId: import("zod").ZodNumber;
+                requestId: import("zod").ZodString;
+                createdAt: import("zod").ZodString;
+                triggerEvent: import("zod").ZodString;
+                triggerCondition: import("zod").ZodString;
+                triggerConditionResults: import("zod").ZodArray<import("zod").ZodBoolean, "many">;
+                triggerConditionValues: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>, "many">>;
+                executionResult: import("zod").ZodUnion<[import("zod").ZodLiteral<"success">, import("zod").ZodLiteral<"failure">, import("zod").ZodLiteral<"partial_success">]>;
+                executionError: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+                actions: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{
+                    actionId: import("zod").ZodNullable<import("zod").ZodString>;
+                    actionType: import("zod").ZodString;
+                    success: import("zod").ZodBoolean;
+                    payload: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
+                    error: import("zod").ZodOptional<import("zod").ZodString>;
+                }, "strip", import("zod").ZodTypeAny, {
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }, {
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }>, "many">>, "many">>;
+            }, "strip", import("zod").ZodTypeAny, {
+                requestId: string;
+                ruleId: number;
+                ruleName: string;
+                createdAt: string;
+                actions: ({
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }[] | null)[] | null;
+                queueId: number;
+                annotationId: number;
+                triggerCondition: string;
+                triggerEvent: string;
+                triggerConditionResults: boolean[];
+                triggerConditionValues: Record<string, string>[] | null;
+                executionResult: "success" | "failure" | "partial_success";
+                executionError?: string | null | undefined;
+            }, {
+                requestId: string;
+                ruleId: number;
+                ruleName: string;
+                createdAt: string;
+                actions: ({
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }[] | null)[] | null;
+                queueId: number;
+                annotationId: number;
+                triggerCondition: string;
+                triggerEvent: string;
+                triggerConditionResults: boolean[];
+                triggerConditionValues: Record<string, string>[] | null;
+                executionResult: "success" | "failure" | "partial_success";
+                executionError?: string | null | undefined;
+            }>, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            results: {
+                requestId: string;
+                ruleId: number;
+                ruleName: string;
+                createdAt: string;
+                actions: ({
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }[] | null)[] | null;
+                queueId: number;
+                annotationId: number;
+                triggerCondition: string;
+                triggerEvent: string;
+                triggerConditionResults: boolean[];
+                triggerConditionValues: Record<string, string>[] | null;
+                executionResult: "success" | "failure" | "partial_success";
+                executionError?: string | null | undefined;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }, {
+            results: {
+                requestId: string;
+                ruleId: number;
+                ruleName: string;
+                createdAt: string;
+                actions: ({
+                    payload: Record<string, unknown>;
+                    success: boolean;
+                    actionId: string | null;
+                    actionType: string;
+                    error?: string | undefined;
+                }[] | null)[] | null;
+                queueId: number;
+                annotationId: number;
+                triggerCondition: string;
+                triggerEvent: string;
+                triggerConditionResults: boolean[];
+                triggerConditionValues: Record<string, string>[] | null;
+                executionResult: "success" | "failure" | "partial_success";
+                executionError?: string | null | undefined;
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }>;
+        readonly query: {
+            readonly includeTotal: true;
+            readonly pageSize?: number;
+            readonly page?: number;
+            readonly createdAtAfter?: string;
+            readonly createdAtBefore?: string;
+            readonly rule?: Array<number>;
+            readonly annotation?: Array<number>;
+            readonly queue?: Array<number>;
+            readonly requestId?: string;
+            readonly executionResult?: Array<string>;
+            readonly triggerEvent?: Array<string>;
+            readonly search?: string;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+            page: import("zod").ZodOptional<import("zod").ZodNumber>;
+            pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
+            createdAtAfter: import("zod").ZodOptional<import("zod").ZodString>;
+            createdAtBefore: import("zod").ZodOptional<import("zod").ZodString>;
+            rule: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+            annotation: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+            queue: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+            requestId: import("zod").ZodOptional<import("zod").ZodString>;
+            executionResult: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            triggerEvent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            search: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            page?: number | undefined;
+            pageSize?: number | undefined;
+            createdAtAfter?: string | undefined;
+            createdAtBefore?: string | undefined;
+            rule?: number[] | undefined;
+            annotation?: number[] | undefined;
+            queue?: number[] | undefined;
+            requestId?: string | undefined;
+            executionResult?: string[] | undefined;
+            triggerEvent?: string[] | undefined;
+            search?: string | undefined;
+        }, {
+            page?: number | undefined;
+            pageSize?: number | undefined;
+            createdAtAfter?: string | undefined;
+            createdAtBefore?: string | undefined;
+            rule?: number[] | undefined;
+            annotation?: number[] | undefined;
+            queue?: number[] | undefined;
+            requestId?: string | undefined;
+            executionResult?: string[] | undefined;
+            triggerEvent?: string[] | undefined;
+            search?: string | undefined;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
+    };
+};