@rossum/api-client 0.1.20 → 0.1.22

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

@@ -1,6 +1,3 @@
-import { ListResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { EmailTemplate } from '../models/emailTemplate';
 export type EmailTemplateListQuery = {
     pageSize?: number;
     page?: number;
@@ -8,4 +5,328 @@ export type EmailTemplateListQuery = {
     ordering?: string[];
     queue?: number;
 };
-export declare const list: (query?: EmailTemplateListQuery) => ElisRequestConfig<ListResponse<EmailTemplate>, EmailTemplateListQuery, never>;
+export declare const list: (query?: EmailTemplateListQuery) => {
+    readonly endpoint: "/email_templates";
+    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").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            url: import("zod").ZodString;
+            name: import("zod").ZodString;
+            queue: import("zod").ZodString;
+            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"rejection">, import("zod").ZodLiteral<"custom">]>;
+            automate: import("zod").ZodBoolean;
+            triggers: import("zod").ZodArray<import("zod").ZodString, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "custom" | "rejection";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        }, {
+            type: "custom" | "rejection";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        }>, import("zod").ZodObject<{
+            subject: import("zod").ZodString;
+            message: import("zod").ZodString;
+            bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+            to: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+            cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+        }, "strip", import("zod").ZodTypeAny, {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }, {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
+            id: import("zod").ZodNumber;
+            url: import("zod").ZodString;
+            name: import("zod").ZodString;
+            queue: import("zod").ZodString;
+            type: import("zod").ZodUnion<[import("zod").ZodLiteral<"rejection_default">, import("zod").ZodLiteral<"email_with_no_processable_attachments">]>;
+            automate: import("zod").ZodBoolean;
+            triggers: import("zod").ZodArray<import("zod").ZodString, "many">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "email_with_no_processable_attachments" | "rejection_default";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        }, {
+            type: "email_with_no_processable_attachments" | "rejection_default";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        }>, import("zod").ZodObject<{
+            subject: import("zod").ZodString;
+            message: import("zod").ZodString;
+            bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+            to: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+            cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+            }>, "many">>;
+        }, "strip", import("zod").ZodTypeAny, {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }, {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }>>]>, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        results: (({
+            type: "custom" | "rejection";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        } & {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }) | ({
+            type: "email_with_no_processable_attachments" | "rejection_default";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        } & {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }))[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }, {
+        results: (({
+            type: "custom" | "rejection";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        } & {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }) | ({
+            type: "email_with_no_processable_attachments" | "rejection_default";
+            url: string;
+            queue: string;
+            id: number;
+            name: string;
+            triggers: string[];
+            automate: boolean;
+        } & {
+            message: string;
+            subject: string;
+            bcc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            to?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+            cc?: {
+                email: string;
+                name?: string | undefined;
+            }[] | undefined;
+        }))[];
+        pagination: {
+            next: string | null;
+            previous: string | null;
+            total: number;
+            totalPages: number;
+        };
+    }>;
+    readonly query: EmailTemplateListQuery;
+    readonly querySchema: import("zod").ZodObject<{
+        pageSize: import("zod").ZodOptional<import("zod").ZodNumber>;
+        page: import("zod").ZodOptional<import("zod").ZodNumber>;
+        fields: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+        ordering: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+        queue: import("zod").ZodOptional<import("zod").ZodNumber>;
+    }, "strip", import("zod").ZodTypeAny, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+        fields?: string[] | undefined;
+        ordering?: string[] | undefined;
+        queue?: number | undefined;
+    }, {
+        pageSize?: number | undefined;
+        page?: number | undefined;
+        fields?: string[] | undefined;
+        ordering?: string[] | undefined;
+        queue?: number | undefined;
+    }>;
+};

package/types/src/emailTemplates/endpoints/patch.d.ts

@@ -1,5 +1,256 @@
 import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { EmailTemplate, EmailTemplatePayloadBase } from '../models/emailTemplate';
+import { EmailTemplatePayloadBase } from '../models/emailTemplate';
 export type EmailTemplatePatchPayload = Partial<EmailTemplatePayloadBase>;
-export declare const patch: (emailTemplateId: ID, payload: EmailTemplatePatchPayload) => ElisRequestConfig<EmailTemplate, never, EmailTemplatePatchPayload>;
+export declare const patch: (emailTemplateId: ID, payload: EmailTemplatePatchPayload) => {
+    readonly endpoint: `/email_templates/${number}`;
+    readonly method: "PATCH";
+    readonly responseSchema: import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        url: import("zod").ZodString;
+        name: import("zod").ZodString;
+        queue: import("zod").ZodString;
+        type: import("zod").ZodUnion<[import("zod").ZodLiteral<"rejection">, import("zod").ZodLiteral<"custom">]>;
+        automate: import("zod").ZodBoolean;
+        triggers: import("zod").ZodArray<import("zod").ZodString, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: "custom" | "rejection";
+        url: string;
+        queue: string;
+        id: number;
+        name: string;
+        triggers: string[];
+        automate: boolean;
+    }, {
+        type: "custom" | "rejection";
+        url: string;
+        queue: string;
+        id: number;
+        name: string;
+        triggers: string[];
+        automate: boolean;
+    }>, import("zod").ZodObject<{
+        subject: import("zod").ZodString;
+        message: import("zod").ZodString;
+        bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        to: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
+        id: import("zod").ZodNumber;
+        url: import("zod").ZodString;
+        name: import("zod").ZodString;
+        queue: import("zod").ZodString;
+        type: import("zod").ZodUnion<[import("zod").ZodLiteral<"rejection_default">, import("zod").ZodLiteral<"email_with_no_processable_attachments">]>;
+        automate: import("zod").ZodBoolean;
+        triggers: import("zod").ZodArray<import("zod").ZodString, "many">;
+    }, "strip", import("zod").ZodTypeAny, {
+        type: "email_with_no_processable_attachments" | "rejection_default";
+        url: string;
+        queue: string;
+        id: number;
+        name: string;
+        triggers: string[];
+        automate: boolean;
+    }, {
+        type: "email_with_no_processable_attachments" | "rejection_default";
+        url: string;
+        queue: string;
+        id: number;
+        name: string;
+        triggers: string[];
+        automate: boolean;
+    }>, import("zod").ZodObject<{
+        subject: import("zod").ZodString;
+        message: import("zod").ZodString;
+        bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        to: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }>>]>;
+    readonly payloadSchema: import("zod").ZodObject<{
+        name: import("zod").ZodOptional<import("zod").ZodString>;
+        queue: import("zod").ZodOptional<import("zod").ZodString>;
+        subject: import("zod").ZodOptional<import("zod").ZodString>;
+        message: import("zod").ZodOptional<import("zod").ZodString>;
+        automate: import("zod").ZodOptional<import("zod").ZodBoolean>;
+        bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        to: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        name?: string | undefined;
+        queue?: string | undefined;
+        subject?: string | undefined;
+        message?: string | undefined;
+        automate?: boolean | undefined;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }, {
+        name?: string | undefined;
+        queue?: string | undefined;
+        subject?: string | undefined;
+        message?: string | undefined;
+        automate?: boolean | undefined;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }>;
+    readonly payload: Partial<EmailTemplatePayloadBase>;
+};

package/types/src/emailTemplates/endpoints/render.d.ts

@@ -1,9 +1,88 @@
 import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { EmailTemplateValues } from '../models/emailTemplate';
 export type RenderEmailTemplatePayload = {
     parentEmail?: string;
     documentList?: string[];
     annotationList?: string[];
 };
-export declare const render: (emailTemplateId: ID, payload: RenderEmailTemplatePayload) => ElisRequestConfig<EmailTemplateValues, never, RenderEmailTemplatePayload>;
+export declare const render: (emailTemplateId: ID, payload: RenderEmailTemplatePayload) => {
+    readonly endpoint: `/email_templates/${number}/render`;
+    readonly method: "POST";
+    readonly responseSchema: import("zod").ZodObject<{
+        subject: import("zod").ZodString;
+        message: import("zod").ZodString;
+        bcc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        to: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+        cc: import("zod").ZodOptional<import("zod").ZodArray<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;
+        }>, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }, {
+        message: string;
+        subject: string;
+        bcc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        to?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+        cc?: {
+            email: string;
+            name?: string | undefined;
+        }[] | undefined;
+    }>;
+    readonly payload: RenderEmailTemplatePayload;
+    readonly payloadSchema: import("zod").ZodObject<{
+        parentEmail: import("zod").ZodOptional<import("zod").ZodString>;
+        documentList: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+        annotationList: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+    }, "strip", import("zod").ZodTypeAny, {
+        parentEmail?: string | undefined;
+        documentList?: string[] | undefined;
+        annotationList?: string[] | undefined;
+    }, {
+        parentEmail?: string | undefined;
+        documentList?: string[] | undefined;
+        annotationList?: string[] | undefined;
+    }>;
+};