npm - @rossum/api-client - Versions diffs - 0.1.25 → 0.1.30 - Mend

@rossum/api-client 0.1.25 → 0.1.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (817) hide show

package/types/src/documentRelations/endpoints/list.d.ts ADDED Viewed

@@ -0,0 +1,112 @@
+import { ID } from '../../utils/codecUtils';
+import { PaginationQuery } from '../../utils/listQuery';
+export type RelationListQuery = Partial<{
+    id: ID[];
+    type: 'export' | 'einvoice';
+    annotation: ID[];
+    key: string;
+    documents: ID[];
+}> & PaginationQuery;
+export declare const list: (query?: RelationListQuery) => {
+    readonly endpoint: "/document_relations";
+    readonly method: "GET";
+    readonly responseSchema: import("zod").ZodObject<{
+        pagination: import("zod").ZodObject<{
+            next: import("zod").ZodNullable<import("zod").ZodString>;
+            previous: import("zod").ZodNullable<import("zod").ZodString>;
+            total: import("zod").ZodNumber;
+            totalPages: import("zod").ZodNumber;
+        }, "strip", import("zod").ZodTypeAny, {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        }, {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        }>;
+        results: import("zod").ZodArray<import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"export">, import("zod").ZodLiteral<"einvoice">]>;
+            key: import("zod").ZodNullable<import("zod").ZodString>;
+            annotation: import("zod").ZodString;
+            documents: import("zod").ZodArray<import("zod").ZodString, "many">;
+            url: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "einvoice" | "export";
+            annotation: string;
+            url: string;
+            id: number;
+            documents: string[];
+            key: string | null;
+        }, {
+            type: "einvoice" | "export";
+            annotation: string;
+            url: string;
+            id: number;
+            documents: string[];
+            key: string | null;
+        }>, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        results: {
+            type: "einvoice" | "export";
+            annotation: string;
+            url: string;
+            id: number;
+            documents: string[];
+            key: string | null;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }, {
+        results: {
+            type: "einvoice" | "export";
+            annotation: string;
+            url: string;
+            id: number;
+            documents: string[];
+            key: string | null;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }>;
+    readonly query: RelationListQuery;
+    readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+        type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"export">, import("zod").ZodLiteral<"einvoice">]>>;
+        annotation: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+        key: import("zod").ZodOptional<import("zod").ZodString>;
+        documents: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodNumber, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        id?: number[] | undefined;
+        type?: "einvoice" | "export" | undefined;
+        annotation?: number[] | undefined;
+        key?: string | undefined;
+        documents?: number[] | undefined;
+    }, {
+        id?: number[] | undefined;
+        type?: "einvoice" | "export" | undefined;
+        annotation?: number[] | undefined;
+        key?: string | undefined;
+        documents?: number[] | undefined;
+    }>, import("zod").ZodObject<{
+        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
+        page: import("zod").ZodOptional<import("zod").ZodNumber>;
+    }, "strip", import("zod").ZodTypeAny, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+    }>>;
+};

package/types/src/documentRelations/endpoints/list.schema.d.ts ADDED Viewed

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export declare const relationListQuerySchema: z.ZodIntersection<z.ZodObject<{
+    id: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    type: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"export">, z.ZodLiteral<"einvoice">]>>;
+    annotation: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+    key: z.ZodOptional<z.ZodString>;
+    documents: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id?: number[] | undefined;
+    type?: "einvoice" | "export" | undefined;
+    annotation?: number[] | undefined;
+    key?: string | undefined;
+    documents?: number[] | undefined;
+}, {
+    id?: number[] | undefined;
+    type?: "einvoice" | "export" | undefined;
+    annotation?: number[] | undefined;
+    key?: string | undefined;
+    documents?: number[] | undefined;
+}>, z.ZodObject<{
+    pageSize: z.ZodOptional<z.ZodNumber>;
+    page: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    pageSize?: number | undefined;
+    page?: number | undefined;
+}, {
+    pageSize?: number | undefined;
+    page?: number | undefined;
+}>>;

package/types/src/documentRelations/models/relations.schema.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+import { z } from "zod";
+export declare const relationTypeSchema: z.ZodUnion<[z.ZodLiteral<"export">, z.ZodLiteral<"einvoice">]>;
+export declare const relationSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    type: z.ZodUnion<[z.ZodLiteral<"export">, z.ZodLiteral<"einvoice">]>;
+    key: z.ZodNullable<z.ZodString>;
+    annotation: z.ZodString;
+    documents: z.ZodArray<z.ZodString, "many">;
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "einvoice" | "export";
+    annotation: string;
+    url: string;
+    id: number;
+    documents: string[];
+    key: string | null;
+}, {
+    type: "einvoice" | "export";
+    annotation: string;
+    url: string;
+    id: number;
+    documents: string[];
+    key: string | null;
+}>;

package/types/src/documents/endpoints/get.d.ts CHANGED Viewed

@@ -19,13 +19,13 @@ export declare const get: (documentId: ID) => {
         annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         annotations: string[];
+        url: string;
+        originalFileName: string | null;
         content: string | null;
         id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         email: string | null;
-        originalFileName: string | null;
         s3Name: string | null;
         parent: string | null;
         mimeType: string;
@@ -34,13 +34,13 @@ export declare const get: (documentId: ID) => {
         metadata?: unknown;
     }, {
         annotations: string[];
+        url: string;
+        originalFileName: string | null;
         content: string | null;
         id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         email: string | null;
-        originalFileName: string | null;
         s3Name: string | null;
         parent: string | null;
         mimeType: string;

package/types/src/documents/endpoints/index.d.ts CHANGED Viewed

@@ -20,13 +20,13 @@ export declare const documents: {
             annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -35,13 +35,13 @@ export declare const documents: {
             metadata?: unknown;
         }, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -87,13 +87,13 @@ export declare const documents: {
                 annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
             }, "strip", import("zod").ZodTypeAny, {
                 annotations: string[];
+                url: string;
+                originalFileName: string | null;
                 content: string | null;
                 id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 email: string | null;
-                originalFileName: string | null;
                 s3Name: string | null;
                 parent: string | null;
                 mimeType: string;
@@ -102,13 +102,13 @@ export declare const documents: {
                 metadata?: unknown;
             }, {
                 annotations: string[];
+                url: string;
+                originalFileName: string | null;
                 content: string | null;
                 id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 email: string | null;
-                originalFileName: string | null;
                 s3Name: string | null;
                 parent: string | null;
                 mimeType: string;
@@ -119,13 +119,13 @@ export declare const documents: {
         }, "strip", import("zod").ZodTypeAny, {
             results: {
                 annotations: string[];
+                url: string;
+                originalFileName: string | null;
                 content: string | null;
                 id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 email: string | null;
-                originalFileName: string | null;
                 s3Name: string | null;
                 parent: string | null;
                 mimeType: string;
@@ -142,13 +142,13 @@ export declare const documents: {
         }, {
             results: {
                 annotations: string[];
+                url: string;
+                originalFileName: string | null;
                 content: string | null;
                 id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 email: string | null;
-                originalFileName: string | null;
                 s3Name: string | null;
                 parent: string | null;
                 mimeType: string;
@@ -222,13 +222,13 @@ export declare const documents: {
             annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -237,13 +237,13 @@ export declare const documents: {
             metadata?: unknown;
         }, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;

package/types/src/documents/endpoints/list.d.ts CHANGED Viewed

@@ -47,13 +47,13 @@ export declare const list: (query?: DocumentsListQuery) => {
             annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -62,13 +62,13 @@ export declare const list: (query?: DocumentsListQuery) => {
             metadata?: unknown;
         }, {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -79,13 +79,13 @@ export declare const list: (query?: DocumentsListQuery) => {
     }, "strip", import("zod").ZodTypeAny, {
         results: {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;
@@ -102,13 +102,13 @@ export declare const list: (query?: DocumentsListQuery) => {
     }, {
         results: {
             annotations: string[];
+            url: string;
+            originalFileName: string | null;
             content: string | null;
             id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             email: string | null;
-            originalFileName: string | null;
             s3Name: string | null;
             parent: string | null;
             mimeType: string;

package/types/src/documents/endpoints/patch.d.ts CHANGED Viewed

@@ -21,13 +21,13 @@ export declare const patch: (documentID: ID, payload?: DocumentPayload) => {
         annotations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         annotations: string[];
+        url: string;
+        originalFileName: string | null;
         content: string | null;
         id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         email: string | null;
-        originalFileName: string | null;
         s3Name: string | null;
         parent: string | null;
         mimeType: string;
@@ -36,13 +36,13 @@ export declare const patch: (documentID: ID, payload?: DocumentPayload) => {
         metadata?: unknown;
     }, {
         annotations: string[];
+        url: string;
+        originalFileName: string | null;
         content: string | null;
         id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         email: string | null;
-        originalFileName: string | null;
         s3Name: string | null;
         parent: string | null;
         mimeType: string;

package/types/src/documents/models/document.schema.d.ts CHANGED Viewed

@@ -16,13 +16,13 @@ export declare const documentSchema: z.ZodObject<{
     annotations: z.ZodArray<z.ZodString, "many">;
 }, "strip", z.ZodTypeAny, {
     annotations: string[];
+    url: string;
+    originalFileName: string | null;
     content: string | null;
     id: number;
     creator: string | null;
     createdAt: string;
-    url: string;
     email: string | null;
-    originalFileName: string | null;
     s3Name: string | null;
     parent: string | null;
     mimeType: string;
@@ -31,13 +31,13 @@ export declare const documentSchema: z.ZodObject<{
     metadata?: unknown;
 }, {
     annotations: string[];
+    url: string;
+    originalFileName: string | null;
     content: string | null;
     id: number;
     creator: string | null;
     createdAt: string;
-    url: string;
     email: string | null;
-    originalFileName: string | null;
     s3Name: string | null;
     parent: string | null;
     mimeType: string;

package/types/src/email/endpoints/get.d.ts CHANGED Viewed

@@ -86,14 +86,14 @@ export declare const get: (emailUrl: Url) => {
     }, "strip", import("zod").ZodTypeAny, {
         type: "incoming" | "outgoing";
         annotations: string[];
-        id: number;
+        url: string;
         queue: string;
+        children: string[];
+        id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         emailThread: string | null;
         labels: string[];
-        children: string[];
         documents: string[];
         parent: string | null;
         subject: string;
@@ -131,14 +131,14 @@ export declare const get: (emailUrl: Url) => {
     }, {
         type: "incoming" | "outgoing";
         annotations: string[];
-        id: number;
+        url: string;
         queue: string;
+        children: string[];
+        id: number;
         creator: string | null;
         createdAt: string;
-        url: string;
         emailThread: string | null;
         labels: string[];
-        children: string[];
         documents: string[];
         parent: string | null;
         subject: string;

package/types/src/email/endpoints/index.d.ts CHANGED Viewed

@@ -104,14 +104,14 @@ export declare const email: {
             }, "strip", import("zod").ZodTypeAny, {
                 type: "incoming" | "outgoing";
                 annotations: string[];
-                id: number;
+                url: string;
                 queue: string;
+                children: string[];
+                id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 emailThread: string | null;
                 labels: string[];
-                children: string[];
                 documents: string[];
                 parent: string | null;
                 subject: string;
@@ -149,14 +149,14 @@ export declare const email: {
             }, {
                 type: "incoming" | "outgoing";
                 annotations: string[];
-                id: number;
+                url: string;
                 queue: string;
+                children: string[];
+                id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 emailThread: string | null;
                 labels: string[];
-                children: string[];
                 documents: string[];
                 parent: string | null;
                 subject: string;
@@ -196,14 +196,14 @@ export declare const email: {
             results: {
                 type: "incoming" | "outgoing";
                 annotations: string[];
-                id: number;
+                url: string;
                 queue: string;
+                children: string[];
+                id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 emailThread: string | null;
                 labels: string[];
-                children: string[];
                 documents: string[];
                 parent: string | null;
                 subject: string;
@@ -249,14 +249,14 @@ export declare const email: {
             results: {
                 type: "incoming" | "outgoing";
                 annotations: string[];
-                id: number;
+                url: string;
                 queue: string;
+                children: string[];
+                id: number;
                 creator: string | null;
                 createdAt: string;
-                url: string;
                 emailThread: string | null;
                 labels: string[];
-                children: string[];
                 documents: string[];
                 parent: string | null;
                 subject: string;
@@ -426,6 +426,7 @@ export declare const email: {
             }>;
             relatedAnnotations: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
             relatedDocuments: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            resetRelatedAnnotationsEmailThread: import("zod").ZodOptional<import("zod").ZodBoolean>;
             attachments: import("zod").ZodOptional<import("zod").ZodObject<{
                 documents: import("zod").ZodArray<import("zod").ZodString, "many">;
             }, "strip", import("zod").ZodTypeAny, {
@@ -458,6 +459,7 @@ export declare const email: {
             parentEmail?: string | undefined;
             relatedAnnotations?: string[] | undefined;
             relatedDocuments?: string[] | undefined;
+            resetRelatedAnnotationsEmailThread?: boolean | undefined;
             attachments?: {
                 documents: string[];
             } | undefined;
@@ -485,6 +487,7 @@ export declare const email: {
             parentEmail?: string | undefined;
             relatedAnnotations?: string[] | undefined;
             relatedDocuments?: string[] | undefined;
+            resetRelatedAnnotationsEmailThread?: boolean | undefined;
             attachments?: {
                 documents: string[];
             } | undefined;
@@ -579,14 +582,14 @@ export declare const email: {
         }, "strip", import("zod").ZodTypeAny, {
             type: "incoming" | "outgoing";
             annotations: string[];
-            id: number;
+            url: string;
             queue: string;
+            children: string[];
+            id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             emailThread: string | null;
             labels: string[];
-            children: string[];
             documents: string[];
             parent: string | null;
             subject: string;
@@ -624,14 +627,14 @@ export declare const email: {
         }, {
             type: "incoming" | "outgoing";
             annotations: string[];
-            id: number;
+            url: string;
             queue: string;
+            children: string[];
+            id: number;
             creator: string | null;
             createdAt: string;
-            url: string;
             emailThread: string | null;
             labels: string[];
-            children: string[];
             documents: string[];
             parent: string | null;
             subject: string;