@rossum/api-client 0.1.20 → 0.1.22

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

@@ -0,0 +1,245 @@
+import { PaginationQuery } from '../../utils/listQuery';
+export type EmailThreadsListQuery = Partial<{
+    queue: number;
+    hasRootEmail: boolean;
+    hasReplies: boolean;
+    hasNewReplies: boolean;
+    createdAtBefore: string;
+    createdAtAfter: string;
+    lastEmailCreatedAtBefore: string;
+    lastEmailCreatedAtAfter: string;
+    recentWithNoDocumentsNotReplied: boolean;
+    search: string;
+    ordering: string;
+}> & PaginationQuery;
+export declare const list: (query?: EmailThreadsListQuery) => {
+    readonly endpoint: "/email_threads";
+    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;
+            organization: import("zod").ZodString;
+            queue: import("zod").ZodString;
+            rootEmail: import("zod").ZodNullable<import("zod").ZodString>;
+            hasReplies: import("zod").ZodBoolean;
+            hasNewReplies: import("zod").ZodBoolean;
+            rootEmailRead: import("zod").ZodBoolean;
+            lastEmailCreatedAt: import("zod").ZodNullable<import("zod").ZodString>;
+            subject: import("zod").ZodNullable<import("zod").ZodString>;
+            createdAt: import("zod").ZodNullable<import("zod").ZodString>;
+            from: import("zod").ZodNullable<import("zod").ZodObject<{
+                email: import("zod").ZodString;
+                name: import("zod").ZodOptional<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                email: string;
+                name?: string | undefined;
+            }, {
+                email: string;
+                name?: string | undefined;
+            }>>;
+            labels: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+            annotationCounts: import("zod").ZodObject<{
+                annotations: import("zod").ZodNumber;
+                annotationsProcessed: import("zod").ZodNumber;
+                annotationsRejected: import("zod").ZodNumber;
+                annotationsUnprocessed: import("zod").ZodNumber;
+                annotationsPurged: import("zod").ZodNullable<import("zod").ZodNumber>;
+                relatedAnnotations: import("zod").ZodNullable<import("zod").ZodNumber>;
+            }, "strip", import("zod").ZodTypeAny, {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            }, {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            }>;
+        }, "strip", import("zod").ZodTypeAny, {
+            url: string;
+            queue: string;
+            id: number;
+            createdAt: string | null;
+            organization: string;
+            subject: string | null;
+            annotationCounts: {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            };
+            from: {
+                email: string;
+                name?: string | undefined;
+            } | null;
+            rootEmail: string | null;
+            hasReplies: boolean;
+            hasNewReplies: boolean;
+            rootEmailRead: boolean;
+            lastEmailCreatedAt: string | null;
+            labels?: string[] | undefined;
+        }, {
+            url: string;
+            queue: string;
+            id: number;
+            createdAt: string | null;
+            organization: string;
+            subject: string | null;
+            annotationCounts: {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            };
+            from: {
+                email: string;
+                name?: string | undefined;
+            } | null;
+            rootEmail: string | null;
+            hasReplies: boolean;
+            hasNewReplies: boolean;
+            rootEmailRead: boolean;
+            lastEmailCreatedAt: string | null;
+            labels?: string[] | undefined;
+        }>, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        results: {
+            url: string;
+            queue: string;
+            id: number;
+            createdAt: string | null;
+            organization: string;
+            subject: string | null;
+            annotationCounts: {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            };
+            from: {
+                email: string;
+                name?: string | undefined;
+            } | null;
+            rootEmail: string | null;
+            hasReplies: boolean;
+            hasNewReplies: boolean;
+            rootEmailRead: boolean;
+            lastEmailCreatedAt: string | null;
+            labels?: string[] | undefined;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }, {
+        results: {
+            url: string;
+            queue: string;
+            id: number;
+            createdAt: string | null;
+            organization: string;
+            subject: string | null;
+            annotationCounts: {
+                annotations: number;
+                annotationsProcessed: number;
+                annotationsRejected: number;
+                annotationsUnprocessed: number;
+                annotationsPurged: number | null;
+                relatedAnnotations: number | null;
+            };
+            from: {
+                email: string;
+                name?: string | undefined;
+            } | null;
+            rootEmail: string | null;
+            hasReplies: boolean;
+            hasNewReplies: boolean;
+            rootEmailRead: boolean;
+            lastEmailCreatedAt: string | null;
+            labels?: string[] | undefined;
+        }[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }>;
+    readonly query: EmailThreadsListQuery;
+    readonly querySchema: import("zod").ZodIntersection<import("zod").ZodObject<{
+        queue: import("zod").ZodOptional<import("zod").ZodNumber>;
+        hasRootEmail: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        hasReplies: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        hasNewReplies: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        createdAtBefore: import("zod").ZodOptional<import("zod").ZodString>;
+        createdAtAfter: import("zod").ZodOptional<import("zod").ZodString>;
+        lastEmailCreatedAtBefore: import("zod").ZodOptional<import("zod").ZodString>;
+        lastEmailCreatedAtAfter: import("zod").ZodOptional<import("zod").ZodString>;
+        recentWithNoDocumentsNotReplied: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        search: import("zod").ZodOptional<import("zod").ZodString>;
+        ordering: import("zod").ZodOptional<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        queue?: number | undefined;
+        hasRootEmail?: boolean | undefined;
+        hasReplies?: boolean | undefined;
+        hasNewReplies?: boolean | undefined;
+        createdAtBefore?: string | undefined;
+        createdAtAfter?: string | undefined;
+        lastEmailCreatedAtBefore?: string | undefined;
+        lastEmailCreatedAtAfter?: string | undefined;
+        recentWithNoDocumentsNotReplied?: boolean | undefined;
+        search?: string | undefined;
+        ordering?: string | undefined;
+    }, {
+        queue?: number | undefined;
+        hasRootEmail?: boolean | undefined;
+        hasReplies?: boolean | undefined;
+        hasNewReplies?: boolean | undefined;
+        createdAtBefore?: string | undefined;
+        createdAtAfter?: string | undefined;
+        lastEmailCreatedAtBefore?: string | undefined;
+        lastEmailCreatedAtAfter?: string | undefined;
+        recentWithNoDocumentsNotReplied?: boolean | undefined;
+        search?: string | undefined;
+        ordering?: string | 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/emailThreads/endpoints/list.schema.d.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+export declare const emailThreadsListQuerySchema: z.ZodIntersection<z.ZodObject<{
+    queue: z.ZodOptional<z.ZodNumber>;
+    hasRootEmail: z.ZodOptional<z.ZodBoolean>;
+    hasReplies: z.ZodOptional<z.ZodBoolean>;
+    hasNewReplies: z.ZodOptional<z.ZodBoolean>;
+    createdAtBefore: z.ZodOptional<z.ZodString>;
+    createdAtAfter: z.ZodOptional<z.ZodString>;
+    lastEmailCreatedAtBefore: z.ZodOptional<z.ZodString>;
+    lastEmailCreatedAtAfter: z.ZodOptional<z.ZodString>;
+    recentWithNoDocumentsNotReplied: z.ZodOptional<z.ZodBoolean>;
+    search: z.ZodOptional<z.ZodString>;
+    ordering: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    queue?: number | undefined;
+    hasRootEmail?: boolean | undefined;
+    hasReplies?: boolean | undefined;
+    hasNewReplies?: boolean | undefined;
+    createdAtBefore?: string | undefined;
+    createdAtAfter?: string | undefined;
+    lastEmailCreatedAtBefore?: string | undefined;
+    lastEmailCreatedAtAfter?: string | undefined;
+    recentWithNoDocumentsNotReplied?: boolean | undefined;
+    search?: string | undefined;
+    ordering?: string | undefined;
+}, {
+    queue?: number | undefined;
+    hasRootEmail?: boolean | undefined;
+    hasReplies?: boolean | undefined;
+    hasNewReplies?: boolean | undefined;
+    createdAtBefore?: string | undefined;
+    createdAtAfter?: string | undefined;
+    lastEmailCreatedAtBefore?: string | undefined;
+    lastEmailCreatedAtAfter?: string | undefined;
+    recentWithNoDocumentsNotReplied?: boolean | undefined;
+    search?: string | undefined;
+    ordering?: string | 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/emailThreads/endpoints/patch.d.ts

@@ -1,7 +1,112 @@
 import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { EmailThread } from '../models/emailThreads';
 export type EmailThreadPatchPayload = {
     hasNewReplies?: boolean;
 };
-export declare const patch: (emailId: ID, payload: EmailThreadPatchPayload) => ElisRequestConfig<EmailThread, never, EmailThreadPatchPayload>;
+export declare const patch: (emailId: ID, payload: EmailThreadPatchPayload) => {
+    readonly endpoint: `email_threads/${number}`;
+    readonly method: "PATCH";
+    readonly responseSchema: import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        url: import("zod").ZodString;
+        organization: import("zod").ZodString;
+        queue: import("zod").ZodString;
+        rootEmail: import("zod").ZodNullable<import("zod").ZodString>;
+        hasReplies: import("zod").ZodBoolean;
+        hasNewReplies: import("zod").ZodBoolean;
+        rootEmailRead: import("zod").ZodBoolean;
+        lastEmailCreatedAt: import("zod").ZodNullable<import("zod").ZodString>;
+        subject: import("zod").ZodNullable<import("zod").ZodString>;
+        createdAt: import("zod").ZodNullable<import("zod").ZodString>;
+        from: import("zod").ZodNullable<import("zod").ZodObject<{
+            email: import("zod").ZodString;
+            name: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            email: string;
+            name?: string | undefined;
+        }, {
+            email: string;
+            name?: string | undefined;
+        }>>;
+        labels: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+        annotationCounts: import("zod").ZodObject<{
+            annotations: import("zod").ZodNumber;
+            annotationsProcessed: import("zod").ZodNumber;
+            annotationsRejected: import("zod").ZodNumber;
+            annotationsUnprocessed: import("zod").ZodNumber;
+            annotationsPurged: import("zod").ZodNullable<import("zod").ZodNumber>;
+            relatedAnnotations: import("zod").ZodNullable<import("zod").ZodNumber>;
+        }, "strip", import("zod").ZodTypeAny, {
+            annotations: number;
+            annotationsProcessed: number;
+            annotationsRejected: number;
+            annotationsUnprocessed: number;
+            annotationsPurged: number | null;
+            relatedAnnotations: number | null;
+        }, {
+            annotations: number;
+            annotationsProcessed: number;
+            annotationsRejected: number;
+            annotationsUnprocessed: number;
+            annotationsPurged: number | null;
+            relatedAnnotations: number | null;
+        }>;
+    }, "strip", import("zod").ZodTypeAny, {
+        url: string;
+        queue: string;
+        id: number;
+        createdAt: string | null;
+        organization: string;
+        subject: string | null;
+        annotationCounts: {
+            annotations: number;
+            annotationsProcessed: number;
+            annotationsRejected: number;
+            annotationsUnprocessed: number;
+            annotationsPurged: number | null;
+            relatedAnnotations: number | null;
+        };
+        from: {
+            email: string;
+            name?: string | undefined;
+        } | null;
+        rootEmail: string | null;
+        hasReplies: boolean;
+        hasNewReplies: boolean;
+        rootEmailRead: boolean;
+        lastEmailCreatedAt: string | null;
+        labels?: string[] | undefined;
+    }, {
+        url: string;
+        queue: string;
+        id: number;
+        createdAt: string | null;
+        organization: string;
+        subject: string | null;
+        annotationCounts: {
+            annotations: number;
+            annotationsProcessed: number;
+            annotationsRejected: number;
+            annotationsUnprocessed: number;
+            annotationsPurged: number | null;
+            relatedAnnotations: number | null;
+        };
+        from: {
+            email: string;
+            name?: string | undefined;
+        } | null;
+        rootEmail: string | null;
+        hasReplies: boolean;
+        hasNewReplies: boolean;
+        rootEmailRead: boolean;
+        lastEmailCreatedAt: string | null;
+        labels?: string[] | undefined;
+    }>;
+    readonly payloadSchema: import("zod").ZodObject<{
+        hasNewReplies: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    }, "strip", import("zod").ZodTypeAny, {
+        hasNewReplies?: boolean | undefined;
+    }, {
+        hasNewReplies?: boolean | undefined;
+    }>;
+    readonly payload: EmailThreadPatchPayload;
+};

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

@@ -8,20 +8,25 @@ export type EmailThread = {
     hasReplies: boolean;
     hasNewReplies: boolean;
     rootEmailRead: boolean;
-    lastEmailCreatedAt: string;
+    lastEmailCreatedAt: string | null;
     subject: string | null;
     createdAt: string | null;
     from: {
         email: string;
         name?: string;
     } | null;
-    labels?: unknown;
+    labels?: string[];
     annotationCounts: {
         annotations: number;
         annotationsProcessed: number;
         annotationsRejected: number;
         annotationsUnprocessed: number;
-        annotationsPurged?: number;
-        relatedAnnotations?: number;
+        annotationsPurged: number | null;
+        relatedAnnotations: number | null;
     };
 };
+export type EmailThreadCounts = {
+    withReplies: number;
+    withNewReplies: number;
+    recentWithNoDocumentsNotReplied: number;
+};

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

@@ -8,7 +8,7 @@ export declare const emailThreadSchema: z.ZodObject<{
     hasReplies: z.ZodBoolean;
     hasNewReplies: z.ZodBoolean;
     rootEmailRead: z.ZodBoolean;
-    lastEmailCreatedAt: z.ZodString;
+    lastEmailCreatedAt: z.ZodNullable<z.ZodString>;
     subject: z.ZodNullable<z.ZodString>;
     createdAt: z.ZodNullable<z.ZodString>;
     from: z.ZodNullable<z.ZodObject<{
@@ -21,28 +21,28 @@ export declare const emailThreadSchema: z.ZodObject<{
         email: string;
         name?: string | undefined;
     }>>;
-    labels: z.ZodOptional<z.ZodUnknown>;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     annotationCounts: z.ZodObject<{
         annotations: z.ZodNumber;
         annotationsProcessed: z.ZodNumber;
         annotationsRejected: z.ZodNumber;
         annotationsUnprocessed: z.ZodNumber;
-        annotationsPurged: z.ZodOptional<z.ZodNumber>;
-        relatedAnnotations: z.ZodOptional<z.ZodNumber>;
+        annotationsPurged: z.ZodNullable<z.ZodNumber>;
+        relatedAnnotations: z.ZodNullable<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         annotations: number;
         annotationsProcessed: number;
         annotationsRejected: number;
         annotationsUnprocessed: number;
-        annotationsPurged?: number | undefined;
-        relatedAnnotations?: number | undefined;
+        annotationsPurged: number | null;
+        relatedAnnotations: number | null;
     }, {
         annotations: number;
         annotationsProcessed: number;
         annotationsRejected: number;
         annotationsUnprocessed: number;
-        annotationsPurged?: number | undefined;
-        relatedAnnotations?: number | undefined;
+        annotationsPurged: number | null;
+        relatedAnnotations: number | null;
     }>;
 }, "strip", z.ZodTypeAny, {
     url: string;
@@ -56,8 +56,8 @@ export declare const emailThreadSchema: z.ZodObject<{
         annotationsProcessed: number;
         annotationsRejected: number;
         annotationsUnprocessed: number;
-        annotationsPurged?: number | undefined;
-        relatedAnnotations?: number | undefined;
+        annotationsPurged: number | null;
+        relatedAnnotations: number | null;
     };
     from: {
         email: string;
@@ -67,8 +67,8 @@ export declare const emailThreadSchema: z.ZodObject<{
     hasReplies: boolean;
     hasNewReplies: boolean;
     rootEmailRead: boolean;
-    lastEmailCreatedAt: string;
-    labels?: unknown;
+    lastEmailCreatedAt: string | null;
+    labels?: string[] | undefined;
 }, {
     url: string;
     queue: string;
@@ -81,8 +81,8 @@ export declare const emailThreadSchema: z.ZodObject<{
         annotationsProcessed: number;
         annotationsRejected: number;
         annotationsUnprocessed: number;
-        annotationsPurged?: number | undefined;
-        relatedAnnotations?: number | undefined;
+        annotationsPurged: number | null;
+        relatedAnnotations: number | null;
     };
     from: {
         email: string;
@@ -92,6 +92,19 @@ export declare const emailThreadSchema: z.ZodObject<{
     hasReplies: boolean;
     hasNewReplies: boolean;
     rootEmailRead: boolean;
-    lastEmailCreatedAt: string;
-    labels?: unknown;
+    lastEmailCreatedAt: string | null;
+    labels?: string[] | undefined;
+}>;
+export declare const emailThreadCountsSchema: z.ZodObject<{
+    withReplies: z.ZodNumber;
+    withNewReplies: z.ZodNumber;
+    recentWithNoDocumentsNotReplied: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    withReplies: number;
+    withNewReplies: number;
+    recentWithNoDocumentsNotReplied: number;
+}, {
+    withReplies: number;
+    withNewReplies: number;
+    recentWithNoDocumentsNotReplied: number;
 }>;

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

@@ -0,0 +1,40 @@
+import { ID } from '../../utils/codecUtils';
+export type GenericEngineGetQuery = Partial<{
+    fields: ('id' | 'name' | 'url' | 'schema' | 'description')[];
+}>;
+export declare const get: (engineId: ID, query?: GenericEngineGetQuery) => {
+    readonly endpoint: `/generic_engines/${number}`;
+    readonly method: "GET";
+    readonly responseSchema: import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        name: import("zod").ZodString;
+        url: import("zod").ZodString;
+        schema: import("zod").ZodNullable<import("zod").ZodString>;
+        description: import("zod").ZodString;
+        documentationUrl: import("zod").ZodNullable<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        url: string;
+        id: number;
+        schema: string | null;
+        name: string;
+        description: string;
+        documentationUrl: string | null;
+    }, {
+        url: string;
+        id: number;
+        schema: string | null;
+        name: string;
+        description: string;
+        documentationUrl: string | null;
+    }>;
+    readonly query: Partial<{
+        fields: ('id' | 'name' | 'url' | 'schema' | 'description')[];
+    }>;
+    readonly querySchema: import("zod").ZodObject<{
+        fields: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodLiteral<"id">, import("zod").ZodLiteral<"name">, import("zod").ZodLiteral<"url">, import("zod").ZodLiteral<"schema">, import("zod").ZodLiteral<"description">]>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        fields?: ("url" | "id" | "schema" | "name" | "description")[] | undefined;
+    }, {
+        fields?: ("url" | "id" | "schema" | "name" | "description")[] | undefined;
+    }>;
+};

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

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const genericEngineGetQuerySchema: z.ZodObject<{
+    fields: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodLiteral<"id">, z.ZodLiteral<"name">, z.ZodLiteral<"url">, z.ZodLiteral<"schema">, z.ZodLiteral<"description">]>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    fields?: ("url" | "id" | "schema" | "name" | "description")[] | undefined;
+}, {
+    fields?: ("url" | "id" | "schema" | "name" | "description")[] | undefined;
+}>;