@rossum/api-client 0.1.30 → 0.2.1

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

@@ -5,7 +5,7 @@ export type StartEditPagesResponse = {
     sessionTimeout: string;
     children: ChildAnnotation[];
 };
-export type ChildAnnotation = AccessibleChildAnnotation | InaccessibleChildAnnotation;
+export type ChildAnnotation = AccessibleChildAnnotation | InaccessibleChildAnnotation | EmptyChildAnnotation;
 export type AccessibleChildAnnotation = {
     url: Url;
     queue: Url;
@@ -13,14 +13,22 @@ export type AccessibleChildAnnotation = {
     started: boolean;
     originalFileName: string;
     parentPages: ParentPage[];
+    values: Record<string, string>;
 };
 export type InaccessibleChildAnnotation = {
     started: false;
     originalFileName: string;
     parentPages: ParentPage[];
 };
+export type EmptyChildAnnotation = {
+    originalFileName: string;
+    parentPages: ParentPage[];
+    values?: Record<string, string>;
+    annotation?: null;
+};
 export type ParentPage = {
     page: Url;
     rotationDeg: number;
+    deleted?: boolean;
 };
 export type EditDataSource = 'automation' | 'suggest' | 'modified_suggest' | 'manual';

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

@@ -2,12 +2,15 @@ import { z } from 'zod';
 export declare const parentPageSchema: z.ZodObject<{
     page: z.ZodString;
     rotationDeg: z.ZodNumber;
+    deleted: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     page: string;
     rotationDeg: number;
+    deleted?: boolean | undefined;
 }, {
     page: string;
     rotationDeg: number;
+    deleted?: boolean | undefined;
 }>;
 export declare const editDataSourceSchema: z.ZodUnion<[z.ZodLiteral<"automation">, z.ZodLiteral<"suggest">, z.ZodLiteral<"modified_suggest">, z.ZodLiteral<"manual">]>;
 export declare const accessibleChildAnnotationSchema: z.ZodObject<{
@@ -19,14 +22,19 @@ export declare const accessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: z.ZodArray<z.ZodObject<{
         page: z.ZodString;
         rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }>, "many">;
+    values: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    values: Record<string, string>;
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
     url: string;
     queue: string;
@@ -35,8 +43,10 @@ export declare const accessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }, {
+    values: Record<string, string>;
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
     url: string;
     queue: string;
@@ -45,6 +55,7 @@ export declare const accessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }>;
 export declare const inaccessibleChildAnnotationSchema: z.ZodObject<{
@@ -53,12 +64,15 @@ export declare const inaccessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: z.ZodArray<z.ZodObject<{
         page: z.ZodString;
         rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     started: false;
@@ -66,6 +80,7 @@ export declare const inaccessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }, {
     started: false;
@@ -73,8 +88,45 @@ export declare const inaccessibleChildAnnotationSchema: z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }>;
+export declare const emptyChildAnnotationSchema: z.ZodObject<{
+    originalFileName: z.ZodString;
+    parentPages: z.ZodArray<z.ZodObject<{
+        page: z.ZodString;
+        rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }, {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }>, "many">;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    annotation: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    originalFileName: string;
+    parentPages: {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }[];
+    values?: Record<string, string> | undefined;
+    annotation?: null | undefined;
+}, {
+    originalFileName: string;
+    parentPages: {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }[];
+    values?: Record<string, string> | undefined;
+    annotation?: null | undefined;
+}>;
 export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     url: z.ZodString;
     queue: z.ZodString;
@@ -84,14 +136,19 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: z.ZodArray<z.ZodObject<{
         page: z.ZodString;
         rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }>, "many">;
+    values: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    values: Record<string, string>;
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
     url: string;
     queue: string;
@@ -100,8 +157,10 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }, {
+    values: Record<string, string>;
     status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
     url: string;
     queue: string;
@@ -110,6 +169,7 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }>, z.ZodObject<{
     started: z.ZodLiteral<false>;
@@ -117,12 +177,15 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: z.ZodArray<z.ZodObject<{
         page: z.ZodString;
         rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }, {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     started: false;
@@ -130,6 +193,7 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }, {
     started: false;
@@ -137,7 +201,43 @@ export declare const childAnnotationSchema: z.ZodUnion<[z.ZodObject<{
     parentPages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
+    }[];
+}>, z.ZodObject<{
+    originalFileName: z.ZodString;
+    parentPages: z.ZodArray<z.ZodObject<{
+        page: z.ZodString;
+        rotationDeg: z.ZodNumber;
+        deleted: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }, {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }>, "many">;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    annotation: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    originalFileName: string;
+    parentPages: {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
+    values?: Record<string, string> | undefined;
+    annotation?: null | undefined;
+}, {
+    originalFileName: string;
+    parentPages: {
+        page: string;
+        rotationDeg: number;
+        deleted?: boolean | undefined;
+    }[];
+    values?: Record<string, string> | undefined;
+    annotation?: null | undefined;
 }>]>;
 export declare const startEditPagesResponseSchema: z.ZodObject<{
     parentAnnotation: z.ZodString;
@@ -151,14 +251,19 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: z.ZodArray<z.ZodObject<{
             page: z.ZodString;
             rotationDeg: z.ZodNumber;
+            deleted: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }, {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }>, "many">;
+        values: z.ZodRecord<z.ZodString, z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        values: Record<string, string>;
         status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
         url: string;
         queue: string;
@@ -167,8 +272,10 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }, {
+        values: Record<string, string>;
         status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
         url: string;
         queue: string;
@@ -177,6 +284,7 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }>, z.ZodObject<{
         started: z.ZodLiteral<false>;
@@ -184,12 +292,15 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: z.ZodArray<z.ZodObject<{
             page: z.ZodString;
             rotationDeg: z.ZodNumber;
+            deleted: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }, {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         started: false;
@@ -197,6 +308,7 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }, {
         started: false;
@@ -204,12 +316,49 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
+        }[];
+    }>, z.ZodObject<{
+        originalFileName: z.ZodString;
+        parentPages: z.ZodArray<z.ZodObject<{
+            page: z.ZodString;
+            rotationDeg: z.ZodNumber;
+            deleted: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
+        }, {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
+        }>, "many">;
+        values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        annotation: z.ZodOptional<z.ZodNull>;
+    }, "strip", z.ZodTypeAny, {
+        originalFileName: string;
+        parentPages: {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
+        values?: Record<string, string> | undefined;
+        annotation?: null | undefined;
+    }, {
+        originalFileName: string;
+        parentPages: {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
+        }[];
+        values?: Record<string, string> | undefined;
+        annotation?: null | undefined;
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     parentAnnotation: string;
     sessionTimeout: string;
     children: ({
+        values: Record<string, string>;
         status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
         url: string;
         queue: string;
@@ -218,6 +367,7 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     } | {
         started: false;
@@ -225,12 +375,23 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
+    } | {
+        originalFileName: string;
+        parentPages: {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
+        }[];
+        values?: Record<string, string> | undefined;
+        annotation?: null | undefined;
     })[];
 }, {
     parentAnnotation: string;
     sessionTimeout: string;
     children: ({
+        values: Record<string, string>;
         status: "created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow";
         url: string;
         queue: string;
@@ -239,6 +400,7 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     } | {
         started: false;
@@ -246,6 +408,16 @@ export declare const startEditPagesResponseSchema: z.ZodObject<{
         parentPages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
+        }[];
+    } | {
+        originalFileName: string;
+        parentPages: {
+            page: string;
+            rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
+        values?: Record<string, string> | undefined;
+        annotation?: null | undefined;
     })[];
 }>;

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

@@ -253,7 +253,7 @@ export declare const authentication: {
             deleted?: boolean | undefined;
             phoneNumber?: string | null | undefined;
         }>;
-        readonly payload: Partial<import("../../users/models").User>;
+        readonly payload: Partial<import("../../users").User>;
     };
     getMembershipToken: (payload: import("./getMembershipToken").MembershipTokenPaylod) => {
         readonly endpoint: "/auth/membership_token";

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

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

package/types/src/authentication/models/authInfo.d.ts

@@ -0,0 +1,4 @@
+export type AuthInfo = {
+    key: string;
+    domain: string;
+};

package/types/src/authentication/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './authInfo';
+export * from './authInfo.schema';