@rossum/api-client 0.1.25 → 0.1.30

package/types/src/annotations/endpoints/split.d.ts

@@ -0,0 +1,88 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type SplitPayload = {
+    documents: [
+        {
+            pages: Array<{
+                page: Url;
+                rotationDeg?: number;
+            }>;
+            metadata?: unknown;
+        }
+    ];
+};
+export type SplitResponse = {
+    results: Array<{
+        document: Url;
+        annotation: Url;
+    }>;
+};
+export declare const split: (annotationId: ID, payload: SplitPayload) => {
+    readonly endpoint: `/annotations/${number}/split`;
+    readonly method: "POST";
+    readonly responseSchema: import("zod").ZodObject<{
+        results: import("zod").ZodArray<import("zod").ZodObject<{
+            document: import("zod").ZodString;
+            annotation: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            annotation: string;
+            document: string;
+        }, {
+            annotation: string;
+            document: string;
+        }>, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        results: {
+            annotation: string;
+            document: string;
+        }[];
+    }, {
+        results: {
+            annotation: string;
+            document: string;
+        }[];
+    }>;
+    readonly payload: SplitPayload;
+    readonly payloadSchema: import("zod").ZodObject<{
+        documents: import("zod").ZodTuple<[import("zod").ZodObject<{
+            pages: import("zod").ZodArray<import("zod").ZodObject<{
+                page: import("zod").ZodString;
+                rotationDeg: import("zod").ZodOptional<import("zod").ZodNumber>;
+            }, "strip", import("zod").ZodTypeAny, {
+                page: string;
+                rotationDeg?: number | undefined;
+            }, {
+                page: string;
+                rotationDeg?: number | undefined;
+            }>, "many">;
+            metadata: import("zod").ZodOptional<import("zod").ZodUnknown>;
+        }, "strip", import("zod").ZodTypeAny, {
+            pages: {
+                page: string;
+                rotationDeg?: number | undefined;
+            }[];
+            metadata?: unknown;
+        }, {
+            pages: {
+                page: string;
+                rotationDeg?: number | undefined;
+            }[];
+            metadata?: unknown;
+        }>], null>;
+    }, "strip", import("zod").ZodTypeAny, {
+        documents: [{
+            pages: {
+                page: string;
+                rotationDeg?: number | undefined;
+            }[];
+            metadata?: unknown;
+        }];
+    }, {
+        documents: [{
+            pages: {
+                page: string;
+                rotationDeg?: number | undefined;
+            }[];
+            metadata?: unknown;
+        }];
+    }>;
+};

package/types/src/annotations/endpoints/split.schema.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+export declare const splitPayloadSchema: z.ZodObject<{
+    documents: z.ZodTuple<[z.ZodObject<{
+        pages: z.ZodArray<z.ZodObject<{
+            page: z.ZodString;
+            rotationDeg: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            page: string;
+            rotationDeg?: number | undefined;
+        }, {
+            page: string;
+            rotationDeg?: number | undefined;
+        }>, "many">;
+        metadata: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        pages: {
+            page: string;
+            rotationDeg?: number | undefined;
+        }[];
+        metadata?: unknown;
+    }, {
+        pages: {
+            page: string;
+            rotationDeg?: number | undefined;
+        }[];
+        metadata?: unknown;
+    }>], null>;
+}, "strip", z.ZodTypeAny, {
+    documents: [{
+        pages: {
+            page: string;
+            rotationDeg?: number | undefined;
+        }[];
+        metadata?: unknown;
+    }];
+}, {
+    documents: [{
+        pages: {
+            page: string;
+            rotationDeg?: number | undefined;
+        }[];
+        metadata?: unknown;
+    }];
+}>;
+export declare const splitResponseSchema: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        document: z.ZodString;
+        annotation: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        annotation: string;
+        document: string;
+    }, {
+        annotation: string;
+        document: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    results: {
+        annotation: string;
+        document: string;
+    }[];
+}, {
+    results: {
+        annotation: string;
+        document: string;
+    }[];
+}>;

package/types/src/annotations/endpoints/start.d.ts

@@ -16,10 +16,10 @@ export declare const start: (annotationId: number, payload?: StartAnnotationPayl
         annotation: import("zod").ZodString;
         sessionTimeout: import("zod").ZodString;
     }, "strip", import("zod").ZodTypeAny, {
-        sessionTimeout: string;
         annotation: string;
-    }, {
         sessionTimeout: string;
+    }, {
         annotation: string;
+        sessionTimeout: string;
     }>;
 };

package/types/src/annotations/endpoints/startEditPages.d.ts

@@ -22,8 +22,8 @@ export declare const startEditPages: (annotationId: number) => {
             }>, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-            queue: string;
             url: string;
+            queue: string;
             started: boolean;
             originalFileName: string;
             parentPages: {
@@ -32,8 +32,8 @@ export declare const startEditPages: (annotationId: number) => {
             }[];
         }, {
             status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-            queue: string;
             url: string;
+            queue: string;
             started: boolean;
             originalFileName: string;
             parentPages: {
@@ -69,10 +69,12 @@ export declare const startEditPages: (annotationId: number) => {
             }[];
         }>]>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
+        parentAnnotation: string;
+        sessionTimeout: string;
         children: ({
             status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-            queue: string;
             url: string;
+            queue: string;
             started: boolean;
             originalFileName: string;
             parentPages: {
@@ -87,13 +89,13 @@ export declare const startEditPages: (annotationId: number) => {
                 rotationDeg: number;
             }[];
         })[];
+    }, {
         parentAnnotation: string;
         sessionTimeout: string;
-    }, {
         children: ({
             status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-            queue: string;
             url: string;
+            queue: string;
             started: boolean;
             originalFileName: string;
             parentPages: {
@@ -108,7 +110,5 @@ export declare const startEditPages: (annotationId: number) => {
                 rotationDeg: number;
             }[];
         })[];
-        parentAnnotation: string;
-        sessionTimeout: string;
     }>;
 };

package/types/src/annotations/endpoints/translate.d.ts

@@ -38,25 +38,25 @@ export declare const translate: (annotationId: number, payload: TranslateAnnotat
                 position: import("zod").ZodTuple<[import("zod").ZodNumber, import("zod").ZodNumber, import("zod").ZodNumber, import("zod").ZodNumber], null>;
                 text: import("zod").ZodString;
             }, "strip", import("zod").ZodTypeAny, {
-                text: string;
                 position: [number, number, number, number];
-            }, {
                 text: string;
+            }, {
                 position: [number, number, number, number];
+                text: string;
             }>, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             pageNumber: number;
             granularity: "lines";
             items: {
-                text: string;
                 position: [number, number, number, number];
+                text: string;
             }[];
         }, {
             pageNumber: number;
             granularity: "lines";
             items: {
-                text: string;
                 position: [number, number, number, number];
+                text: string;
             }[];
         }>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
@@ -64,8 +64,8 @@ export declare const translate: (annotationId: number, payload: TranslateAnnotat
             pageNumber: number;
             granularity: "lines";
             items: {
-                text: string;
                 position: [number, number, number, number];
+                text: string;
             }[];
         }[];
     }, {
@@ -73,8 +73,8 @@ export declare const translate: (annotationId: number, payload: TranslateAnnotat
             pageNumber: number;
             granularity: "lines";
             items: {
-                text: string;
                 position: [number, number, number, number];
+                text: string;
             }[];
         }[];
     }>;

package/types/src/annotations/endpoints/translate.schema.d.ts

@@ -20,25 +20,25 @@ export declare const translateAnnotationResponseSchema: z.ZodObject<{
             position: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
             text: z.ZodString;
         }, "strip", z.ZodTypeAny, {
-            text: string;
             position: [number, number, number, number];
-        }, {
             text: string;
+        }, {
             position: [number, number, number, number];
+            text: string;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         pageNumber: number;
         granularity: "lines";
         items: {
-            text: string;
             position: [number, number, number, number];
+            text: string;
         }[];
     }, {
         pageNumber: number;
         granularity: "lines";
         items: {
-            text: string;
             position: [number, number, number, number];
+            text: string;
         }[];
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
@@ -46,8 +46,8 @@ export declare const translateAnnotationResponseSchema: z.ZodObject<{
         pageNumber: number;
         granularity: "lines";
         items: {
-            text: string;
             position: [number, number, number, number];
+            text: string;
         }[];
     }[];
 }, {
@@ -55,8 +55,8 @@ export declare const translateAnnotationResponseSchema: z.ZodObject<{
         pageNumber: number;
         granularity: "lines";
         items: {
-            text: string;
             position: [number, number, number, number];
+            text: string;
         }[];
     }[];
 }>;

package/types/src/annotations/endpoints/updateContent.d.ts

@@ -62,9 +62,10 @@ export declare const updateContent: (annotationId: ID, datapointId: ID, payload:
         validationSources: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>>;
         timeSpent: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
         timeSpentOverall: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
+        noRecalculation: import("zod").ZodOptional<import("zod").ZodBoolean>;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -86,9 +87,10 @@ export declare const updateContent: (annotationId: ID, datapointId: ID, payload:
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     }, {
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -110,6 +112,7 @@ export declare const updateContent: (annotationId: ID, datapointId: ID, payload:
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     }>;
     readonly payload: UpdateAnnotationContentPayload;
     readonly payloadSchema: import("zod").ZodObject<{

package/types/src/annotations/endpoints/validate.d.ts

@@ -139,9 +139,10 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             validationSources: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>>;
             timeSpent: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
             timeSpentOverall: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
+            noRecalculation: import("zod").ZodOptional<import("zod").ZodBoolean>;
         }, "strip", import("zod").ZodTypeAny, {
-            id: number | null;
             url: string | null;
+            id: number | null;
             schemaId: string | null;
             category: "datapoint" | null;
             content?: {
@@ -163,9 +164,10 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             validationSources?: string[] | null | undefined;
             timeSpent?: number | null | undefined;
             timeSpentOverall?: number | null | undefined;
+            noRecalculation?: boolean | undefined;
         }, {
-            id: number | null;
             url: string | null;
+            id: number | null;
             schemaId: string | null;
             category: "datapoint" | null;
             content?: {
@@ -187,6 +189,7 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             validationSources?: string[] | null | undefined;
             timeSpent?: number | null | undefined;
             timeSpentOverall?: number | null | undefined;
+            noRecalculation?: boolean | undefined;
         }>, import("zod").ZodObject<{
             options: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                 value: import("zod").ZodString;
@@ -423,8 +426,8 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             aggregationType: "sum";
         })[];
         updatedDatapoints: ({
-            id: number | null;
             url: string | null;
+            id: number | null;
             schemaId: string | null;
             category: "datapoint" | null;
             content?: {
@@ -446,6 +449,7 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             validationSources?: string[] | null | undefined;
             timeSpent?: number | null | undefined;
             timeSpentOverall?: number | null | undefined;
+            noRecalculation?: boolean | undefined;
         } & {
             options?: {
                 value: string;
@@ -506,8 +510,8 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             aggregationType: "sum";
         })[];
         updatedDatapoints: ({
-            id: number | null;
             url: string | null;
+            id: number | null;
             schemaId: string | null;
             category: "datapoint" | null;
             content?: {
@@ -529,6 +533,7 @@ export declare const validate: (annotationId: number, payload?: ValidateAnnotati
             validationSources?: string[] | null | undefined;
             timeSpent?: number | null | undefined;
             timeSpentOverall?: number | null | undefined;
+            noRecalculation?: boolean | undefined;
         } & {
             options?: {
                 value: string;

package/types/src/annotations/endpoints/validate.schema.d.ts

@@ -95,9 +95,10 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         validationSources: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
         timeSpent: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         timeSpentOverall: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        noRecalculation: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -119,9 +120,10 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     }, {
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -143,6 +145,7 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     }>, z.ZodObject<{
         options: z.ZodOptional<z.ZodArray<z.ZodObject<{
             value: z.ZodString;
@@ -379,8 +382,8 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         aggregationType: "sum";
     })[];
     updatedDatapoints: ({
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -402,6 +405,7 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     } & {
         options?: {
             value: string;
@@ -462,8 +466,8 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         aggregationType: "sum";
     })[];
     updatedDatapoints: ({
-        id: number | null;
         url: string | null;
+        id: number | null;
         schemaId: string | null;
         category: "datapoint" | null;
         content?: {
@@ -485,6 +489,7 @@ export declare const validateAnnotationResponseSchema: z.ZodObject<{
         validationSources?: string[] | null | undefined;
         timeSpent?: number | null | undefined;
         timeSpentOverall?: number | null | undefined;
+        noRecalculation?: boolean | undefined;
     } & {
         options?: {
             value: string;

package/types/src/annotations/models/annotation.d.ts

@@ -13,6 +13,7 @@ export type Annotation = {
     createdAt: string;
     modifiedAt: string | null;
     confirmedAt: string | null;
+    exportFailedAt: string | null;
     exportedAt: string | null;
     deletedAt: string | null;
     rejectedAt: string | null;
@@ -24,6 +25,7 @@ export type Annotation = {
     status: AnnotationStatus;
     rirPollId: string | null;
     messages: Message[] | null;
+    einvoice: boolean;
     url: Url;
     content: Url;
     timeSpent: number | null;

package/types/src/annotations/models/annotation.schema.d.ts

@@ -11,6 +11,7 @@ export declare const annotationSchema: z.ZodObject<{
     createdAt: z.ZodString;
     modifiedAt: z.ZodNullable<z.ZodString>;
     confirmedAt: z.ZodNullable<z.ZodString>;
+    exportFailedAt: z.ZodNullable<z.ZodString>;
     exportedAt: z.ZodNullable<z.ZodString>;
     deletedAt: z.ZodNullable<z.ZodString>;
     rejectedAt: z.ZodNullable<z.ZodString>;
@@ -72,6 +73,7 @@ export declare const annotationSchema: z.ZodObject<{
             timestamp?: string | undefined;
         } | null | undefined;
     }>, "many">>;
+    einvoice: z.ZodBoolean;
     url: z.ZodString;
     content: z.ZodString;
     timeSpent: z.ZodNullable<z.ZodNumber>;
@@ -101,11 +103,12 @@ export declare const annotationSchema: z.ZodObject<{
     restrictedAccess: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-    document: string;
     assignees: string[];
+    url: string;
+    queue: string;
+    document: string;
     content: string;
     id: number;
-    queue: string;
     schema: string;
     relations: string[];
     pages: string[];
@@ -114,6 +117,7 @@ export declare const annotationSchema: z.ZodObject<{
     createdAt: string;
     modifiedAt: string | null;
     confirmedAt: string | null;
+    exportFailedAt: string | null;
     exportedAt: string | null;
     deletedAt: string | null;
     rejectedAt: string | null;
@@ -136,7 +140,7 @@ export declare const annotationSchema: z.ZodObject<{
             timestamp?: string | undefined;
         } | null | undefined;
     }[] | null;
-    url: string;
+    einvoice: boolean;
     timeSpent: number | null;
     metadata: Record<string, unknown>;
     automated: boolean;
@@ -157,11 +161,12 @@ export declare const annotationSchema: z.ZodObject<{
     hasEmailThreadWithNewReplies?: boolean | undefined;
 }, {
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
-    document: string;
     assignees: string[];
+    url: string;
+    queue: string;
+    document: string;
     content: string;
     id: number;
-    queue: string;
     schema: string;
     relations: string[];
     pages: string[];
@@ -170,6 +175,7 @@ export declare const annotationSchema: z.ZodObject<{
     createdAt: string;
     modifiedAt: string | null;
     confirmedAt: string | null;
+    exportFailedAt: string | null;
     exportedAt: string | null;
     deletedAt: string | null;
     rejectedAt: string | null;
@@ -192,7 +198,7 @@ export declare const annotationSchema: z.ZodObject<{
             timestamp?: string | undefined;
         } | null | undefined;
     }[] | null;
-    url: string;
+    einvoice: boolean;
     timeSpent: number | null;
     metadata: Record<string, unknown>;
     automated: boolean;

package/types/src/annotations/models/annotationData.d.ts

@@ -25,6 +25,7 @@ export type DatapointData = {
     validationSources?: Array<string> | null;
     timeSpent?: number | null;
     timeSpentOverall?: number | null;
+    noRecalculation?: boolean;
 };
 export type TupleData = {
     id: ID | null;