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

@rossum/api-client 0.1.25 → 0.1.26

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 (802) hide show

package/types/src/surveys/endpoints/fromTemplate.d.ts CHANGED Viewed

@@ -24,11 +24,11 @@ export declare const fromTemplate: (surveyTemplateUuid: string) => {
             value?: unknown;
         }>, "many">>;
     }, "strip", import("zod").ZodTypeAny, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;
@@ -37,11 +37,11 @@ export declare const fromTemplate: (surveyTemplateUuid: string) => {
             value?: unknown;
         }[] | undefined;
     }, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;

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

@@ -22,11 +22,11 @@ export declare const get: (surveyId: ID) => {
             value?: unknown;
         }>, "many">>;
     }, "strip", import("zod").ZodTypeAny, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;
@@ -35,11 +35,11 @@ export declare const get: (surveyId: ID) => {
             value?: unknown;
         }[] | undefined;
     }, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;

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

@@ -23,11 +23,11 @@ export declare const surveys: {
                 value?: unknown;
             }>, "many">>;
         }, "strip", import("zod").ZodTypeAny, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -36,11 +36,11 @@ export declare const surveys: {
                 value?: unknown;
             }[] | undefined;
         }, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -83,11 +83,11 @@ export declare const surveys: {
                 value?: unknown;
             }>, "many">>;
         }, "strip", import("zod").ZodTypeAny, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -96,11 +96,11 @@ export declare const surveys: {
                 value?: unknown;
             }[] | undefined;
         }, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -155,11 +155,11 @@ export declare const surveys: {
                 value?: unknown;
             }>, "many">>;
         }, "strip", import("zod").ZodTypeAny, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -168,11 +168,11 @@ export declare const surveys: {
                 value?: unknown;
             }[] | undefined;
         }, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -222,11 +222,11 @@ export declare const surveys: {
                     value?: unknown;
                 }>, "many">>;
             }, "strip", import("zod").ZodTypeAny, {
+                url: string;
                 id: number;
                 modifier: string;
                 createdAt: string;
                 modifiedAt: string;
-                url: string;
                 organization: string;
                 template: string;
                 additionalData?: unknown;
@@ -235,11 +235,11 @@ export declare const surveys: {
                     value?: unknown;
                 }[] | undefined;
             }, {
+                url: string;
                 id: number;
                 modifier: string;
                 createdAt: string;
                 modifiedAt: string;
-                url: string;
                 organization: string;
                 template: string;
                 additionalData?: unknown;
@@ -250,11 +250,11 @@ export declare const surveys: {
             }>, "many">;
         }, "strip", import("zod").ZodTypeAny, {
             results: {
+                url: string;
                 id: number;
                 modifier: string;
                 createdAt: string;
                 modifiedAt: string;
-                url: string;
                 organization: string;
                 template: string;
                 additionalData?: unknown;
@@ -271,11 +271,11 @@ export declare const surveys: {
             };
         }, {
             results: {
+                url: string;
                 id: number;
                 modifier: string;
                 createdAt: string;
                 modifiedAt: string;
-                url: string;
                 organization: string;
                 template: string;
                 additionalData?: unknown;

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

@@ -43,11 +43,11 @@ export declare const list: (query: SurveysListQuery) => {
                 value?: unknown;
             }>, "many">>;
         }, "strip", import("zod").ZodTypeAny, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -56,11 +56,11 @@ export declare const list: (query: SurveysListQuery) => {
                 value?: unknown;
             }[] | undefined;
         }, {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -71,11 +71,11 @@ export declare const list: (query: SurveysListQuery) => {
         }>, "many">;
     }, "strip", import("zod").ZodTypeAny, {
         results: {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;
@@ -92,11 +92,11 @@ export declare const list: (query: SurveysListQuery) => {
         };
     }, {
         results: {
+            url: string;
             id: number;
             modifier: string;
             createdAt: string;
             modifiedAt: string;
-            url: string;
             organization: string;
             template: string;
             additionalData?: unknown;

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

@@ -27,11 +27,11 @@ export declare const patch: (surveyId: ID, payload?: SurveyPatchPayload) => {
             value?: unknown;
         }>, "many">>;
     }, "strip", import("zod").ZodTypeAny, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;
@@ -40,11 +40,11 @@ export declare const patch: (surveyId: ID, payload?: SurveyPatchPayload) => {
             value?: unknown;
         }[] | undefined;
     }, {
+        url: string;
         id: number;
         modifier: string;
         createdAt: string;
         modifiedAt: string;
-        url: string;
         organization: string;
         template: string;
         additionalData?: unknown;

package/types/src/surveys/models/survey.schema.d.ts CHANGED Viewed

@@ -19,11 +19,11 @@ export declare const surveySchema: z.ZodObject<{
         value?: unknown;
     }>, "many">>;
 }, "strip", z.ZodTypeAny, {
+    url: string;
     id: number;
     modifier: string;
     createdAt: string;
     modifiedAt: string;
-    url: string;
     organization: string;
     template: string;
     additionalData?: unknown;
@@ -32,11 +32,11 @@ export declare const surveySchema: z.ZodObject<{
         value?: unknown;
     }[] | undefined;
 }, {
+    url: string;
     id: number;
     modifier: string;
     createdAt: string;
     modifiedAt: string;
-    url: string;
     organization: string;
     template: string;
     additionalData?: unknown;

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

@@ -26,10 +26,10 @@ export declare const get: (taskId: ID, query: GetAsyncTaskQuery, signal?: AbortS
         }>>;
     }, "strip", import("zod").ZodTypeAny, {
         type: "documents_download" | "upload_created";
-        status: "running" | "succeeded" | "failed";
+        status: "failed" | "running" | "succeeded";
+        url: string;
         id: number;
         detail: string | null;
-        url: string;
         expiresAt: string;
         code?: string | undefined;
         resultUrl?: string | null | undefined;
@@ -39,10 +39,10 @@ export declare const get: (taskId: ID, query: GetAsyncTaskQuery, signal?: AbortS
         } | undefined;
     }, {
         type: "documents_download" | "upload_created";
-        status: "running" | "succeeded" | "failed";
+        status: "failed" | "running" | "succeeded";
+        url: string;
         id: number;
         detail: string | null;
-        url: string;
         expiresAt: string;
         code?: string | undefined;
         resultUrl?: string | null | undefined;

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

@@ -23,10 +23,10 @@ export declare const tasks: {
             }>>;
         }, "strip", import("zod").ZodTypeAny, {
             type: "documents_download" | "upload_created";
-            status: "running" | "succeeded" | "failed";
+            status: "failed" | "running" | "succeeded";
+            url: string;
             id: number;
             detail: string | null;
-            url: string;
             expiresAt: string;
             code?: string | undefined;
             resultUrl?: string | null | undefined;
@@ -36,10 +36,10 @@ export declare const tasks: {
             } | undefined;
         }, {
             type: "documents_download" | "upload_created";
-            status: "running" | "succeeded" | "failed";
+            status: "failed" | "running" | "succeeded";
+            url: string;
             id: number;
             detail: string | null;
-            url: string;
             expiresAt: string;
             code?: string | undefined;
             resultUrl?: string | null | undefined;

package/types/src/tasks/models/asyncTask.schema.d.ts CHANGED Viewed

@@ -22,10 +22,10 @@ export declare const asyncTaskSchema: z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     type: "documents_download" | "upload_created";
-    status: "running" | "succeeded" | "failed";
+    status: "failed" | "running" | "succeeded";
+    url: string;
     id: number;
     detail: string | null;
-    url: string;
     expiresAt: string;
     code?: string | undefined;
     resultUrl?: string | null | undefined;
@@ -35,10 +35,10 @@ export declare const asyncTaskSchema: z.ZodObject<{
     } | undefined;
 }, {
     type: "documents_download" | "upload_created";
-    status: "running" | "succeeded" | "failed";
+    status: "failed" | "running" | "succeeded";
+    url: string;
     id: number;
     detail: string | null;
-    url: string;
     expiresAt: string;
     code?: string | undefined;
     resultUrl?: string | null | undefined;

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

@@ -19,17 +19,17 @@ export declare const create: (payload: CreateTriggerPayload) => {
         emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
         deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
-        queue: 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;
         emailTemplates: string[];
         deleteRecommendations: string[];
     }, {
-        id: number;
-        queue: 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;
         emailTemplates: string[];

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

@@ -11,17 +11,17 @@ export declare const get: (triggerUrl: Url) => {
         emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
         deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
     }, "strip", import("zod").ZodTypeAny, {
-        id: number;
-        queue: 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;
         emailTemplates: string[];
         deleteRecommendations: string[];
     }, {
-        id: number;
-        queue: 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;
         emailTemplates: string[];

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

@@ -13,17 +13,17 @@ export declare const triggers: {
             emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
             deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
@@ -62,17 +62,17 @@ export declare const triggers: {
             emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
             deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
@@ -91,17 +91,17 @@ export declare const triggers: {
             emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
             deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
         }, "strip", import("zod").ZodTypeAny, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
             deleteRecommendations: string[];
         }, {
-            id: number;
-            queue: 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;
             emailTemplates: string[];
@@ -139,4 +139,101 @@ export declare const triggers: {
         readonly method: "DELETE";
         readonly responseSchema: import("zod").ZodUnknown;
     };
+    list: (query: import("./list").TriggersListQuery) => {
+        readonly endpoint: "/triggers";
+        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;
+                url: import("zod").ZodString;
+                queue: import("zod").ZodString;
+                event: 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">]>;
+                condition: import("zod").ZodNullable<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>>;
+                emailTemplates: import("zod").ZodArray<import("zod").ZodString, "many">;
+                deleteRecommendations: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                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;
+                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;
+                emailTemplates: string[];
+                deleteRecommendations: string[];
+            }>, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            results: {
+                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;
+                emailTemplates: string[];
+                deleteRecommendations: string[];
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }, {
+            results: {
+                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;
+                emailTemplates: string[];
+                deleteRecommendations: string[];
+            }[];
+            pagination: {
+                next: string | null;
+                previous: string | null;
+                total: number;
+                totalPages: number;
+            };
+        }>;
+        readonly query: Partial<{
+            id: import("../../..").ID;
+            queue: import("../../..").ID;
+            event: import("../models/trigger").TriggerEventType;
+        }>;
+        readonly querySchema: 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">]>>;
+        }, "strip", import("zod").ZodTypeAny, {
+            id?: number | undefined;
+            queue?: number | undefined;
+            event?: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        }, {
+            id?: number | undefined;
+            queue?: number | undefined;
+            event?: "validation" | "email_with_no_processable_attachments" | "annotation_created" | "annotation_imported" | "annotation_confirmed" | "annotation_exported" | undefined;
+        }>;
+    };
 };