@rossum/api-client 0.1.30 → 0.2.1

package/types/src/suggestedEdit/models/suggestedDocument.schema.d.ts

@@ -3,21 +3,32 @@ export declare const suggestedDocumentSchema: z.ZodObject<{
     pages: 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">;
+    targetQueue: z.ZodString;
+    values: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
+    values: Record<string, string>;
+    targetQueue: string;
     pages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }, {
+    values: Record<string, string>;
+    targetQueue: string;
     pages: {
         page: string;
         rotationDeg: number;
+        deleted?: boolean | undefined;
     }[];
 }>;

package/types/src/suggestedEdit/models/suggestedEdit.d.ts

@@ -0,0 +1,8 @@
+import { ID, Url } from '../../utils/codecUtils';
+import { SuggestedDocument } from './suggestedDocument';
+export type SuggestedEdit = {
+    id: ID;
+    url: Url;
+    annotation: Url;
+    documents: Array<SuggestedDocument>;
+};

package/types/src/suggestedEdit/models/suggestedEdit.schema.d.ts

@@ -7,22 +7,33 @@ export declare const suggestedEditSchema: z.ZodObject<{
         pages: 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">;
+        targetQueue: z.ZodString;
+        values: z.ZodRecord<z.ZodString, z.ZodString>;
     }, "strip", z.ZodTypeAny, {
+        values: Record<string, string>;
+        targetQueue: string;
         pages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }, {
+        values: Record<string, string>;
+        targetQueue: string;
         pages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
@@ -30,9 +41,12 @@ export declare const suggestedEditSchema: z.ZodObject<{
     url: string;
     id: number;
     documents: {
+        values: Record<string, string>;
+        targetQueue: string;
         pages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }[];
 }, {
@@ -40,9 +54,12 @@ export declare const suggestedEditSchema: z.ZodObject<{
     url: string;
     id: number;
     documents: {
+        values: Record<string, string>;
+        targetQueue: string;
         pages: {
             page: string;
             rotationDeg: number;
+            deleted?: boolean | undefined;
         }[];
     }[];
 }>;

package/types/src/surveys/endpoints/get.schema.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const surveyGetQuerySchema: z.ZodObject<{
+    fields: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+}, "strip", z.ZodTypeAny, {
+    fields?: any[] | undefined;
+}, {
+    fields?: any[] | undefined;
+}>;

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

@@ -291,8 +291,13 @@ export declare const surveys: {
                 totalPages: number;
             };
         }>;
-        readonly query: import("./list").SurveysListQuery;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly pageSize?: number;
+            readonly templateUuid?: string;
+            readonly ordering?: string[];
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
             pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
             templateUuid: import("zod").ZodOptional<import("zod").ZodString>;
             ordering: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
@@ -304,6 +309,12 @@ export declare const surveys: {
             pageSize?: number | undefined;
             templateUuid?: string | undefined;
             ordering?: string[] | undefined;
-        }>;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
     };
 };

package/types/src/surveys/endpoints/list.d.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 export type SurveysListQuery = {
     pageSize?: number;
     templateUuid?: string;
@@ -6,13 +7,13 @@ export type SurveysListQuery = {
 export declare const list: (query: SurveysListQuery) => {
     readonly endpoint: "/surveys";
     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, {
+    readonly responseSchema: z.ZodObject<{
+        pagination: z.ZodObject<{
+            next: z.ZodNullable<z.ZodString>;
+            previous: z.ZodNullable<z.ZodString>;
+            total: z.ZodNumber;
+            totalPages: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
             next: string | null;
             previous: string | null;
             total: number;
@@ -23,26 +24,26 @@ export declare const list: (query: SurveysListQuery) => {
             total: number;
             totalPages: number;
         }>;
-        results: import("zod").ZodArray<import("zod").ZodObject<{
-            id: import("zod").ZodNumber;
-            url: import("zod").ZodString;
-            organization: import("zod").ZodString;
-            template: import("zod").ZodString;
-            createdAt: import("zod").ZodString;
-            modifiedAt: import("zod").ZodString;
-            modifier: import("zod").ZodString;
-            additionalData: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            answers: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
-                question: import("zod").ZodString;
-                value: import("zod").ZodOptional<import("zod").ZodUnknown>;
-            }, "strip", import("zod").ZodTypeAny, {
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            url: z.ZodString;
+            organization: z.ZodString;
+            template: z.ZodString;
+            createdAt: z.ZodString;
+            modifiedAt: z.ZodString;
+            modifier: z.ZodString;
+            additionalData: z.ZodOptional<z.ZodUnknown>;
+            answers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                question: z.ZodString;
+                value: z.ZodOptional<z.ZodUnknown>;
+            }, "strip", z.ZodTypeAny, {
                 question: string;
                 value?: unknown;
             }, {
                 question: string;
                 value?: unknown;
             }>, "many">>;
-        }, "strip", import("zod").ZodTypeAny, {
+        }, "strip", z.ZodTypeAny, {
             url: string;
             id: number;
             modifier: string;
@@ -69,7 +70,7 @@ export declare const list: (query: SurveysListQuery) => {
                 value?: unknown;
             }[] | undefined;
         }>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }, "strip", z.ZodTypeAny, {
         results: {
             url: string;
             id: number;
@@ -112,12 +113,17 @@ export declare const list: (query: SurveysListQuery) => {
             totalPages: number;
         };
     }>;
-    readonly query: SurveysListQuery;
-    readonly querySchema: import("zod").ZodObject<{
-        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
-        templateUuid: import("zod").ZodOptional<import("zod").ZodString>;
-        ordering: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-    }, "strip", import("zod").ZodTypeAny, {
+    readonly query: {
+        readonly includeTotal: true;
+        readonly pageSize?: number;
+        readonly templateUuid?: string;
+        readonly ordering?: string[];
+    };
+    readonly querySchema: z.ZodIntersection<z.ZodObject<{
+        pageSize: z.ZodOptional<z.ZodNumber>;
+        templateUuid: z.ZodOptional<z.ZodString>;
+        ordering: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
         pageSize?: number | undefined;
         templateUuid?: string | undefined;
         ordering?: string[] | undefined;
@@ -125,5 +131,11 @@ export declare const list: (query: SurveysListQuery) => {
         pageSize?: number | undefined;
         templateUuid?: string | undefined;
         ordering?: string[] | undefined;
-    }>;
+    }>, z.ZodObject<{
+        includeTotal: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        includeTotal?: boolean | undefined;
+    }, {
+        includeTotal?: boolean | undefined;
+    }>>;
 };

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

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

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

@@ -0,0 +1,4 @@
+export * from './answer';
+export * from './question';
+export * from './survey';
+export * from './surveyTemplate';

package/types/src/surveys/models/question.d.ts

@@ -0,0 +1,6 @@
+export type AnswerType = 'scale';
+export type Question = {
+    uuid: string;
+    text: string;
+    answerType: AnswerType;
+};

package/types/src/surveys/models/question.schema.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const answerTypeSchema: z.ZodLiteral<"scale">;
+export declare const questionSchema: z.ZodObject<{
+    uuid: z.ZodString;
+    text: z.ZodString;
+    answerType: z.ZodLiteral<"scale">;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    uuid: string;
+    answerType: "scale";
+}, {
+    text: string;
+    uuid: string;
+    answerType: "scale";
+}>;

package/types/src/surveys/models/survey.d.ts

@@ -0,0 +1,13 @@
+import { ID, Url } from '../../utils/codecUtils';
+import { Answer } from './answer';
+export type Survey = {
+    id: ID;
+    url: Url;
+    organization: string;
+    template: Url;
+    createdAt: string;
+    modifiedAt: string;
+    modifier: Url;
+    additionalData?: unknown;
+    answers?: Answer[];
+};

package/types/src/surveys/models/surveyTemplate.d.ts

@@ -0,0 +1,6 @@
+import { Question } from './question';
+export type SurveyTemplate = {
+    uuid: string;
+    name: string;
+    questions: Question[];
+};

package/types/src/surveys/models/surveyTemplate.schema.d.ts

@@ -0,0 +1,34 @@
+import { z } from 'zod';
+export declare const surveyTemplateSchema: z.ZodObject<{
+    uuid: z.ZodString;
+    name: z.ZodString;
+    questions: z.ZodArray<z.ZodObject<{
+        uuid: z.ZodString;
+        text: z.ZodString;
+        answerType: z.ZodLiteral<"scale">;
+    }, "strip", z.ZodTypeAny, {
+        text: string;
+        uuid: string;
+        answerType: "scale";
+    }, {
+        text: string;
+        uuid: string;
+        answerType: "scale";
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    uuid: string;
+    questions: {
+        text: string;
+        uuid: string;
+        answerType: "scale";
+    }[];
+}, {
+    name: string;
+    uuid: string;
+    questions: {
+        text: string;
+        uuid: string;
+        answerType: "scale";
+    }[];
+}>;

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

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

package/types/src/tasks/mocks/asyncTask.d.ts

@@ -0,0 +1,17 @@
+import { AsyncTask } from '../models';
+export declare const mockAsyncTask: (params?: {
+    overrides: Partial<AsyncTask>;
+}) => {
+    id: import("../../..").ID;
+    url: import("../../..").Url;
+    code: string;
+    detail: string | null;
+    expiresAt: string;
+    type: import("../models").AsyncTaskType;
+    status: import("../models").AsyncTaskStatus;
+    resultUrl: import("../../..").Url | null;
+    content: {
+        fileName?: string;
+        upload?: string;
+    };
+};

package/types/src/tasks/mocks/index.d.ts

@@ -0,0 +1 @@
+export * from './asyncTask';

package/types/src/tasks/models/asyncTask.d.ts

@@ -0,0 +1,17 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type AsyncTaskType = 'documents_download' | 'upload_created';
+export type AsyncTaskStatus = 'running' | 'succeeded' | 'failed';
+export type AsyncTask = {
+    id: ID;
+    url: Url;
+    code?: string;
+    detail: string | null;
+    expiresAt: string;
+    type: AsyncTaskType;
+    status: AsyncTaskStatus;
+    resultUrl?: Url | null;
+    content?: {
+        fileName?: string;
+        upload?: string;
+    };
+};

package/types/src/tasks/models/asyncTaskResult.d.ts

@@ -0,0 +1,8 @@
+import { ID, Url } from '../../utils/codecUtils';
+export type DocumentsDownloadTaskResult = {
+    id: ID;
+    user?: Url;
+    content: Url;
+    expiresAt: string;
+    fileName: string;
+};

package/types/src/tasks/models/asyncTaskResult.schema.d.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+export declare const documentsDownloadTaskResultSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    user: z.ZodOptional<z.ZodString>;
+    content: z.ZodString;
+    expiresAt: z.ZodString;
+    fileName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    id: number;
+    fileName: string;
+    expiresAt: string;
+    user?: string | undefined;
+}, {
+    content: string;
+    id: number;
+    fileName: string;
+    expiresAt: string;
+    user?: string | undefined;
+}>;

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

@@ -0,0 +1,4 @@
+export * from './asyncTask.schema';
+export * from './asyncTask';
+export * from './asyncTaskResult.schema';
+export * from './asyncTaskResult';

package/types/src/triggers/endpoints/create.d.ts

@@ -22,16 +22,16 @@ export declare const create: (payload: CreateTriggerPayload) => {
         url: string;
         queue: string;
         id: number;
-        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         condition: Record<string, unknown> | null;
+        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         emailTemplates: string[];
         deleteRecommendations: string[];
     }, {
         url: string;
         queue: string;
         id: number;
-        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         condition: Record<string, unknown> | null;
+        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         emailTemplates: string[];
         deleteRecommendations: string[];
     }>;

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

@@ -14,16 +14,16 @@ export declare const get: (triggerUrl: Url) => {
         url: string;
         queue: string;
         id: number;
-        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         condition: Record<string, unknown> | null;
+        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         emailTemplates: string[];
         deleteRecommendations: string[];
     }, {
         url: string;
         queue: string;
         id: number;
-        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         condition: Record<string, unknown> | null;
+        event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
         emailTemplates: string[];
         deleteRecommendations: string[];
     }>;

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

@@ -16,16 +16,16 @@ export declare const triggers: {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }>;
@@ -65,16 +65,16 @@ export declare const triggers: {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }>;
@@ -94,16 +94,16 @@ export declare const triggers: {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
             url: string;
             queue: string;
             id: number;
-            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             condition: Record<string, unknown> | null;
+            event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
             emailTemplates: string[];
             deleteRecommendations: string[];
         }>;
@@ -128,7 +128,7 @@ export declare const triggers: {
         }>;
         readonly payload: Partial<{
             queue: import("../../..").Url;
-            event: import("../models/trigger").TriggerEventType;
+            event: import("..").TriggerEventType;
             condition: unknown;
             emailTemplates: import("../../..").Url[];
             deleteRecommendations: import("../../..").Url[];
@@ -171,16 +171,16 @@ export declare const triggers: {
                 url: string;
                 queue: string;
                 id: number;
-                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 condition: Record<string, unknown> | null;
+                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 emailTemplates: string[];
                 deleteRecommendations: string[];
             }, {
                 url: string;
                 queue: string;
                 id: number;
-                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 condition: Record<string, unknown> | null;
+                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 emailTemplates: string[];
                 deleteRecommendations: string[];
             }>, "many">;
@@ -189,8 +189,8 @@ export declare const triggers: {
                 url: string;
                 queue: string;
                 id: number;
-                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 condition: Record<string, unknown> | null;
+                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 emailTemplates: string[];
                 deleteRecommendations: string[];
             }[];
@@ -205,8 +205,8 @@ export declare const triggers: {
                 url: string;
                 queue: string;
                 id: number;
-                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 condition: Record<string, unknown> | null;
+                event: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported";
                 emailTemplates: string[];
                 deleteRecommendations: string[];
             }[];
@@ -217,12 +217,13 @@ export declare const triggers: {
                 totalPages: number;
             };
         }>;
-        readonly query: Partial<{
-            id: import("../../..").ID;
-            queue: import("../../..").ID;
-            event: import("../models/trigger").TriggerEventType;
-        }>;
-        readonly querySchema: import("zod").ZodObject<{
+        readonly query: {
+            readonly includeTotal: true;
+            readonly id?: number | undefined;
+            readonly queue?: number | undefined;
+            readonly event?: import("..").TriggerEventType | undefined;
+        };
+        readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
             id: import("zod").ZodOptional<import("zod").ZodNumber>;
             queue: import("zod").ZodOptional<import("zod").ZodNumber>;
             event: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"email_with_no_processable_attachments">, import("zod").ZodLiteral<"annotation_created">, import("zod").ZodLiteral<"annotation_imported">, import("zod").ZodLiteral<"annotation_confirmed">, import("zod").ZodLiteral<"annotation_exported">, import("zod").ZodLiteral<"validation">]>>;
@@ -234,6 +235,12 @@ export declare const triggers: {
             id?: number | undefined;
             queue?: number | undefined;
             event?: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
-        }>;
+        }>, import("zod").ZodObject<{
+            includeTotal: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        }, "strip", import("zod").ZodTypeAny, {
+            includeTotal?: boolean | undefined;
+        }, {
+            includeTotal?: boolean | undefined;
+        }>>;
     };
 };