@rossum/api-client 0.1.30 → 0.2.1

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

@@ -2,149 +2,385 @@ export declare const automationBlockers: {
     get: (automationBlockerId: import("../../..").ID) => {
         readonly endpoint: `/automation_blockers/${number}`;
         readonly method: "GET";
-        readonly responseSchema: import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            url: import("zod").ZodString;
-            annotation: import("zod").ZodString;
-            content: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodObject<{
-                level: import("zod").ZodLiteral<"annotation">;
-                type: import("zod").ZodUnion<[import("zod").ZodLiteral<"automation_disabled">, import("zod").ZodLiteral<"is_duplicate">, import("zod").ZodLiteral<"suggested_edit_present">, import("zod").ZodLiteral<"error_message">, import("zod").ZodLiteral<"human_confirmation_required">, import("zod").ZodLiteral<"extension">]>;
+        readonly responseSchema: import("zod").ZodUnion<[import("zod").ZodObject<{
+            level: import("zod").ZodLiteral<"annotation">;
+            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"automation_disabled">, import("zod").ZodLiteral<"is_duplicate">, import("zod").ZodLiteral<"suggested_edit_present">, import("zod").ZodLiteral<"error_message">, import("zod").ZodLiteral<"human_confirmation_required">, import("zod").ZodLiteral<"extension">, import("zod").ZodLiteral<"delete_recommendation_filename">, import("zod").ZodLiteral<"delete_recommendation_page_count">, import("zod").ZodLiteral<"delete_recommendation_field">]>;
+            details: import("zod").ZodOptional<import("zod").ZodObject<{
+                content: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+                messageContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+                detail: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNullable<import("zod").ZodUnion<[import("zod").ZodObject<{
+                    ruleId: import("zod").ZodNumber;
+                    ruleName: import("zod").ZodOptional<import("zod").ZodString>;
+                }, "strip", import("zod").ZodTypeAny, {
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                }, {
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                }>, import("zod").ZodObject<{
+                    sourceSchemaId: import("zod").ZodString;
+                    hookName: import("zod").ZodOptional<import("zod").ZodLiteral<"computed_fields">>;
+                    hookId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
+                }, "strip", import("zod").ZodTypeAny, {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                }, {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                }>, import("zod").ZodObject<{
+                    hookId: import("zod").ZodNumber;
+                    hookName: import("zod").ZodString;
+                }, "strip", import("zod").ZodTypeAny, {
+                    hookId: number;
+                    hookName: string;
+                }, {
+                    hookId: number;
+                    hookName: string;
+                }>, import("zod").ZodObject<{
+                    ruleId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                    ruleName: import("zod").ZodOptional<import("zod").ZodString>;
+                    hookId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                    hookName: import("zod").ZodOptional<import("zod").ZodString>;
+                    sourceId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                    sourceSchemaId: import("zod").ZodOptional<import("zod").ZodString>;
+                }, "strip", import("zod").ZodTypeAny, {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                }, {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                }>]>>, "many">>;
+            }, "strip", import("zod").ZodTypeAny, {
+                content?: string[] | undefined;
+                messageContent?: string[] | undefined;
+                detail?: ({
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                } | {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                } | {
+                    hookId: number;
+                    hookName: string;
+                } | {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                } | null)[] | undefined;
+            }, {
+                content?: string[] | undefined;
+                messageContent?: string[] | undefined;
+                detail?: ({
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                } | {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                } | {
+                    hookId: number;
+                    hookName: string;
+                } | {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                } | null)[] | undefined;
+            }>>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension" | "delete_recommendation_filename" | "delete_recommendation_page_count" | "delete_recommendation_field";
+            level: "annotation";
+            details?: {
+                content?: string[] | undefined;
+                messageContent?: string[] | undefined;
+                detail?: ({
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                } | {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                } | {
+                    hookId: number;
+                    hookName: string;
+                } | {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                } | null)[] | undefined;
+            } | undefined;
+        }, {
+            type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension" | "delete_recommendation_filename" | "delete_recommendation_page_count" | "delete_recommendation_field";
+            level: "annotation";
+            details?: {
+                content?: string[] | undefined;
+                messageContent?: string[] | undefined;
+                detail?: ({
+                    ruleId: number;
+                    ruleName?: string | undefined;
+                } | {
+                    sourceSchemaId: string;
+                    hookName?: "computed_fields" | undefined;
+                    hookId?: number | null | undefined;
+                } | {
+                    hookId: number;
+                    hookName: string;
+                } | {
+                    ruleId?: number | undefined;
+                    ruleName?: string | undefined;
+                    hookId?: number | undefined;
+                    hookName?: string | undefined;
+                    sourceId?: number | undefined;
+                    sourceSchemaId?: string | undefined;
+                } | null)[] | undefined;
+            } | undefined;
+        }>, import("zod").ZodObject<{
+            level: import("zod").ZodLiteral<"datapoint">;
+            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"low_score">, import("zod").ZodLiteral<"failed_checks">, import("zod").ZodLiteral<"no_validation_sources">, import("zod").ZodLiteral<"error_message">, import("zod").ZodLiteral<"extension">]>;
+            schemaId: import("zod").ZodString;
+            samples: import("zod").ZodArray<import("zod").ZodObject<{
+                datapointId: import("zod").ZodNumber;
                 details: import("zod").ZodOptional<import("zod").ZodObject<{
                     content: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
                     messageContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+                    score: import("zod").ZodOptional<import("zod").ZodNumber>;
+                    threshold: import("zod").ZodOptional<import("zod").ZodNumber>;
+                    detail: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodObject<{
+                        ruleId: import("zod").ZodNumber;
+                        ruleName: import("zod").ZodOptional<import("zod").ZodString>;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    }, {
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    }>, import("zod").ZodObject<{
+                        sourceSchemaId: import("zod").ZodString;
+                        hookName: import("zod").ZodOptional<import("zod").ZodLiteral<"computed_fields">>;
+                        hookId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    }, {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    }>, import("zod").ZodObject<{
+                        hookId: import("zod").ZodNumber;
+                        hookName: import("zod").ZodString;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        hookId: number;
+                        hookName: string;
+                    }, {
+                        hookId: number;
+                        hookName: string;
+                    }>, import("zod").ZodObject<{
+                        ruleId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                        ruleName: import("zod").ZodOptional<import("zod").ZodString>;
+                        hookId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                        hookName: import("zod").ZodOptional<import("zod").ZodString>;
+                        sourceId: import("zod").ZodOptional<import("zod").ZodNumber>;
+                        sourceSchemaId: import("zod").ZodOptional<import("zod").ZodString>;
+                    }, "strip", import("zod").ZodTypeAny, {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    }, {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    }>]>, "many">>;
                 }, "strip", import("zod").ZodTypeAny, {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 }, {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 }>>;
             }, "strip", import("zod").ZodTypeAny, {
-                type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension";
-                level: "annotation";
+                datapointId: number;
                 details?: {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 } | undefined;
             }, {
-                type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension";
-                level: "annotation";
+                datapointId: number;
                 details?: {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 } | undefined;
-            }>, import("zod").ZodObject<{
-                level: import("zod").ZodLiteral<"datapoint">;
-                type: import("zod").ZodUnion<[import("zod").ZodLiteral<"low_score">, import("zod").ZodLiteral<"failed_checks">, import("zod").ZodLiteral<"no_validation_sources">, import("zod").ZodLiteral<"error_message">, import("zod").ZodLiteral<"extension">]>;
-                schemaId: import("zod").ZodString;
-                samples: import("zod").ZodArray<import("zod").ZodObject<{
-                    datapointId: import("zod").ZodNumber;
-                    details: import("zod").ZodOptional<import("zod").ZodObject<{
-                        content: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                        messageContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-                        score: import("zod").ZodOptional<import("zod").ZodNumber>;
-                    }, "strip", import("zod").ZodTypeAny, {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    }, {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    }>>;
-                }, "strip", import("zod").ZodTypeAny, {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }, {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }>, "many">;
-                samplesTruncated: import("zod").ZodBoolean;
-            }, "strip", import("zod").ZodTypeAny, {
-                type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
-                schemaId: string;
-                level: "datapoint";
-                samples: {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }[];
-                samplesTruncated: boolean;
-            }, {
-                type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
-                schemaId: string;
-                level: "datapoint";
-                samples: {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }[];
-                samplesTruncated: boolean;
-            }>]>, "many">;
+            }>, "many">;
+            samplesTruncated: import("zod").ZodBoolean;
         }, "strip", import("zod").ZodTypeAny, {
-            annotation: string;
-            url: string;
-            content: ({
-                type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension";
-                level: "annotation";
+            type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
+            schemaId: string;
+            level: "datapoint";
+            samples: {
+                datapointId: number;
                 details?: {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 } | undefined;
-            } | {
-                type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
-                schemaId: string;
-                level: "datapoint";
-                samples: {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }[];
-                samplesTruncated: boolean;
-            })[];
-            id: number;
+            }[];
+            samplesTruncated: boolean;
         }, {
-            annotation: string;
-            url: string;
-            content: ({
-                type: "automation_disabled" | "is_duplicate" | "suggested_edit_present" | "error_message" | "human_confirmation_required" | "extension";
-                level: "annotation";
+            type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
+            schemaId: string;
+            level: "datapoint";
+            samples: {
+                datapointId: number;
                 details?: {
                     content?: string[] | undefined;
                     messageContent?: string[] | undefined;
+                    score?: number | undefined;
+                    threshold?: number | undefined;
+                    detail?: ({
+                        ruleId: number;
+                        ruleName?: string | undefined;
+                    } | {
+                        sourceSchemaId: string;
+                        hookName?: "computed_fields" | undefined;
+                        hookId?: number | null | undefined;
+                    } | {
+                        hookId: number;
+                        hookName: string;
+                    } | {
+                        ruleId?: number | undefined;
+                        ruleName?: string | undefined;
+                        hookId?: number | undefined;
+                        hookName?: string | undefined;
+                        sourceId?: number | undefined;
+                        sourceSchemaId?: string | undefined;
+                    })[] | undefined;
                 } | undefined;
-            } | {
-                type: "error_message" | "extension" | "low_score" | "failed_checks" | "no_validation_sources";
-                schemaId: string;
-                level: "datapoint";
-                samples: {
-                    datapointId: number;
-                    details?: {
-                        content?: string[] | undefined;
-                        messageContent?: string[] | undefined;
-                        score?: number | undefined;
-                    } | undefined;
-                }[];
-                samplesTruncated: boolean;
-            })[];
-            id: number;
-        }>;
+            }[];
+            samplesTruncated: boolean;
+        }>]>;
     };
 };

package/types/src/automationBlockers/index.d.ts

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

package/types/src/automationBlockers/models/automationBlocker.d.ts

@@ -0,0 +1,55 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type RuleAutomationBlockerDetails = {
+    ruleId: number;
+    ruleName?: string;
+};
+export type FormulaAutomationBlockerDetails = {
+    sourceSchemaId: string;
+    hookName?: 'computed_fields';
+    hookId?: number | null;
+};
+export type ExtensionAutomationBlockerDetails = {
+    hookId: number;
+    hookName: string;
+};
+export type AutomationBlockerDetails = RuleAutomationBlockerDetails | FormulaAutomationBlockerDetails | ExtensionAutomationBlockerDetails | {
+    ruleId?: number;
+    ruleName?: string;
+    hookId?: number;
+    hookName?: string;
+    sourceId?: number;
+    sourceSchemaId?: string;
+};
+export type AutomationBlockerSample = {
+    datapointId: number;
+    details?: {
+        content?: string[];
+        messageContent?: string[];
+        score?: number;
+        threshold?: number;
+        detail?: AutomationBlockerDetails[];
+    };
+};
+export type AnnotationAutomationBlocker = {
+    level: 'annotation';
+    type: 'automation_disabled' | 'is_duplicate' | 'suggested_edit_present' | 'error_message' | 'human_confirmation_required' | 'extension' | 'delete_recommendation_filename' | 'delete_recommendation_page_count' | 'delete_recommendation_field';
+    details?: {
+        content?: string[];
+        messageContent?: string[];
+        detail?: (AutomationBlockerDetails | null)[];
+    };
+};
+export type DatapointAutomationBlocker = {
+    level: 'datapoint';
+    type: 'low_score' | 'failed_checks' | 'no_validation_sources' | 'error_message' | 'extension';
+    schemaId: string;
+    samples: Array<AutomationBlockerSample>;
+    samplesTruncated: boolean;
+};
+export type AutomationBlocker = AnnotationAutomationBlocker | DatapointAutomationBlocker;
+export type FailedAutomationResult = {
+    id: ID;
+    url: Url;
+    annotation: Url;
+    content: Array<AutomationBlocker>;
+};