@unsent/sdk 0.25.2

package/dist/index.d.mts

@@ -0,0 +1,1054 @@
+import * as React from 'react';
+
+type ErrorResponse = {
+    message: string;
+    code: string;
+};
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+interface paths {
+    "/v1/domains": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve domains accessible by the API key */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description The ID of the domain
+                             * @example 1
+                             */
+                            id: number;
+                            /**
+                             * @description The name of the domain
+                             * @example example.com
+                             */
+                            name: string;
+                            /**
+                             * @description The ID of the team
+                             * @example 1
+                             */
+                            teamId: number;
+                            /** @enum {string} */
+                            status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                            /** @default us-east-1 */
+                            region: string;
+                            /** @default false */
+                            clickTracking: boolean;
+                            /** @default false */
+                            openTracking: boolean;
+                            publicKey: string;
+                            dkimStatus?: string | null;
+                            spfDetails?: string | null;
+                            createdAt: string;
+                            updatedAt: string;
+                            /** @default false */
+                            dmarcAdded: boolean;
+                            /** @default false */
+                            isVerifying: boolean;
+                            errorMessage?: string | null;
+                            subdomain?: string | null;
+                            verificationError?: string | null;
+                            lastCheckedTime?: string | null;
+                            dnsRecords: {
+                                /**
+                                 * @description DNS record type
+                                 * @example TXT
+                                 * @enum {string}
+                                 */
+                                type: "MX" | "TXT";
+                                /**
+                                 * @description DNS record name
+                                 * @example mail
+                                 */
+                                name: string;
+                                /**
+                                 * @description DNS record value
+                                 * @example v=spf1 include:amazonses.com ~all
+                                 */
+                                value: string;
+                                /**
+                                 * @description DNS record TTL
+                                 * @example Auto
+                                 */
+                                ttl: string;
+                                /**
+                                 * @description DNS record priority
+                                 * @example 10
+                                 */
+                                priority?: string | null;
+                                /** @enum {string} */
+                                status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                                /** @description Whether the record is recommended */
+                                recommended?: boolean;
+                            }[];
+                        }[];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        name: string;
+                        region: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Create a new domain */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description The ID of the domain
+                             * @example 1
+                             */
+                            id: number;
+                            /**
+                             * @description The name of the domain
+                             * @example example.com
+                             */
+                            name: string;
+                            /**
+                             * @description The ID of the team
+                             * @example 1
+                             */
+                            teamId: number;
+                            /** @enum {string} */
+                            status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                            /** @default us-east-1 */
+                            region: string;
+                            /** @default false */
+                            clickTracking: boolean;
+                            /** @default false */
+                            openTracking: boolean;
+                            publicKey: string;
+                            dkimStatus?: string | null;
+                            spfDetails?: string | null;
+                            createdAt: string;
+                            updatedAt: string;
+                            /** @default false */
+                            dmarcAdded: boolean;
+                            /** @default false */
+                            isVerifying: boolean;
+                            errorMessage?: string | null;
+                            subdomain?: string | null;
+                            verificationError?: string | null;
+                            lastCheckedTime?: string | null;
+                            dnsRecords: {
+                                /**
+                                 * @description DNS record type
+                                 * @example TXT
+                                 * @enum {string}
+                                 */
+                                type: "MX" | "TXT";
+                                /**
+                                 * @description DNS record name
+                                 * @example mail
+                                 */
+                                name: string;
+                                /**
+                                 * @description DNS record value
+                                 * @example v=spf1 include:amazonses.com ~all
+                                 */
+                                value: string;
+                                /**
+                                 * @description DNS record TTL
+                                 * @example Auto
+                                 */
+                                ttl: string;
+                                /**
+                                 * @description DNS record priority
+                                 * @example 10
+                                 */
+                                priority?: string | null;
+                                /** @enum {string} */
+                                status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                                /** @description Whether the record is recommended */
+                                recommended?: boolean;
+                            }[];
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/domains/{id}/verify": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: number | null;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Verify domain */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            message: string;
+                        };
+                    };
+                };
+                /** @description Forbidden - API key doesn't have access to this domain */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                        };
+                    };
+                };
+                /** @description Domain not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
+                        };
+                    };
+                };
+            };
+        };
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/domains/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: number | null;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve the domain */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description The ID of the domain
+                             * @example 1
+                             */
+                            id: number;
+                            /**
+                             * @description The name of the domain
+                             * @example example.com
+                             */
+                            name: string;
+                            /**
+                             * @description The ID of the team
+                             * @example 1
+                             */
+                            teamId: number;
+                            /** @enum {string} */
+                            status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                            /** @default us-east-1 */
+                            region: string;
+                            /** @default false */
+                            clickTracking: boolean;
+                            /** @default false */
+                            openTracking: boolean;
+                            publicKey: string;
+                            dkimStatus?: string | null;
+                            spfDetails?: string | null;
+                            createdAt: string;
+                            updatedAt: string;
+                            /** @default false */
+                            dmarcAdded: boolean;
+                            /** @default false */
+                            isVerifying: boolean;
+                            errorMessage?: string | null;
+                            subdomain?: string | null;
+                            verificationError?: string | null;
+                            lastCheckedTime?: string | null;
+                            dnsRecords: {
+                                /**
+                                 * @description DNS record type
+                                 * @example TXT
+                                 * @enum {string}
+                                 */
+                                type: "MX" | "TXT";
+                                /**
+                                 * @description DNS record name
+                                 * @example mail
+                                 */
+                                name: string;
+                                /**
+                                 * @description DNS record value
+                                 * @example v=spf1 include:amazonses.com ~all
+                                 */
+                                value: string;
+                                /**
+                                 * @description DNS record TTL
+                                 * @example Auto
+                                 */
+                                ttl: string;
+                                /**
+                                 * @description DNS record priority
+                                 * @example 10
+                                 */
+                                priority?: string | null;
+                                /** @enum {string} */
+                                status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
+                                /** @description Whether the record is recommended */
+                                recommended?: boolean;
+                            }[];
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/emails/{emailId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    emailId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve the email */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            teamId: number;
+                            to: string | string[];
+                            replyTo?: string | string[];
+                            cc?: string | string[];
+                            bcc?: string | string[];
+                            from: string;
+                            subject: string;
+                            html: string | null;
+                            text: string | null;
+                            createdAt: string;
+                            updatedAt: string;
+                            emailEvents: {
+                                emailId: string;
+                                /** @enum {string} */
+                                status: "SCHEDULED" | "QUEUED" | "SENT" | "DELIVERY_DELAYED" | "BOUNCED" | "REJECTED" | "RENDERING_FAILURE" | "DELIVERED" | "OPENED" | "CLICKED" | "COMPLAINED" | "FAILED" | "CANCELLED" | "SUPPRESSED";
+                                createdAt: string;
+                                data?: unknown;
+                            }[];
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    emailId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** Format: date-time */
+                        scheduledAt: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Retrieve the user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            emailId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        trace?: never;
+    };
+    "/v1/emails": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: {
+                    page?: string;
+                    limit?: string;
+                    startDate?: string;
+                    endDate?: string;
+                    domainId?: string | string[];
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve a list of emails */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                to: string | string[];
+                                replyTo?: string | string[] | unknown;
+                                cc?: string | string[] | unknown;
+                                bcc?: string | string[] | unknown;
+                                from: string;
+                                subject: string;
+                                html: string | null;
+                                text: string | null;
+                                createdAt: string;
+                                updatedAt: string;
+                                /** @enum {string|null} */
+                                latestStatus: "SCHEDULED" | "QUEUED" | "SENT" | "DELIVERY_DELAYED" | "BOUNCED" | "REJECTED" | "RENDERING_FAILURE" | "DELIVERED" | "OPENED" | "CLICKED" | "COMPLAINED" | "FAILED" | "CANCELLED" | "SUPPRESSED" | null;
+                                /** Format: date-time */
+                                scheduledAt: string | null;
+                                domainId: number | null;
+                            }[];
+                            count: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        to: string | string[];
+                        from: string;
+                        /** @description Optional when templateId is provided */
+                        subject?: string;
+                        /** @description ID of a template from the dashboard */
+                        templateId?: string;
+                        variables?: {
+                            [key: string]: string;
+                        };
+                        replyTo?: string | string[];
+                        cc?: string | string[];
+                        bcc?: string | string[];
+                        text?: string | null;
+                        html?: string | null;
+                        /** @description Custom headers to included with the emails */
+                        headers?: {
+                            [key: string]: string;
+                        };
+                        attachments?: {
+                            filename: string;
+                            content: string;
+                        }[];
+                        /** Format: date-time */
+                        scheduledAt?: string;
+                        inReplyToId?: string | null;
+                    };
+                };
+            };
+            responses: {
+                /** @description Retrieve the user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            emailId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/emails/batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        to: string | string[];
+                        from: string;
+                        /** @description Optional when templateId is provided */
+                        subject?: string;
+                        /** @description ID of a template from the dashboard */
+                        templateId?: string;
+                        variables?: {
+                            [key: string]: string;
+                        };
+                        replyTo?: string | string[];
+                        cc?: string | string[];
+                        bcc?: string | string[];
+                        text?: string | null;
+                        html?: string | null;
+                        /** @description Custom headers to included with the emails */
+                        headers?: {
+                            [key: string]: string;
+                        };
+                        attachments?: {
+                            filename: string;
+                            content: string;
+                        }[];
+                        /** Format: date-time */
+                        scheduledAt?: string;
+                        inReplyToId?: string | null;
+                    }[];
+                };
+            };
+            responses: {
+                /** @description List of successfully created email IDs */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                emailId: string;
+                            }[];
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/emails/{emailId}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    emailId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve the user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            emailId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/contactBooks/{contactBookId}/contacts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: {
+                    emails?: string;
+                    page?: number;
+                    limit?: number;
+                    ids?: string;
+                };
+                header?: never;
+                path: {
+                    contactBookId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve multiple contacts */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            firstName?: string | null;
+                            lastName?: string | null;
+                            email: string;
+                            /** @default true */
+                            subscribed: boolean;
+                            properties: {
+                                [key: string]: string;
+                            };
+                            contactBookId: string;
+                            createdAt: string;
+                            updatedAt: string;
+                        }[];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    contactBookId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        email: string;
+                        firstName?: string;
+                        lastName?: string;
+                        properties?: {
+                            [key: string]: string;
+                        };
+                        subscribed?: boolean;
+                    };
+                };
+            };
+            responses: {
+                /** @description Retrieve the user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            contactId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/contactBooks/{contactBookId}/contacts/{contactId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    contactBookId: string;
+                    contactId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Retrieve the contact */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            firstName?: string | null;
+                            lastName?: string | null;
+                            email: string;
+                            /** @default true */
+                            subscribed: boolean;
+                            properties: {
+                                [key: string]: string;
+                            };
+                            contactBookId: string;
+                            createdAt: string;
+                            updatedAt: string;
+                        };
+                    };
+                };
+            };
+        };
+        put: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    contactBookId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        email: string;
+                        firstName?: string;
+                        lastName?: string;
+                        properties?: {
+                            [key: string]: string;
+                        };
+                        subscribed?: boolean;
+                    };
+                };
+            };
+            responses: {
+                /** @description Contact upserted successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            contactId: string;
+                        };
+                    };
+                };
+            };
+        };
+        post?: never;
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    contactBookId: string;
+                    contactId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Contact deleted successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                        };
+                    };
+                };
+            };
+        };
+        options?: never;
+        head?: never;
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    contactBookId: string;
+                    contactId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        firstName?: string;
+                        lastName?: string;
+                        properties?: {
+                            [key: string]: string;
+                        };
+                        subscribed?: boolean;
+                    };
+                };
+            };
+            responses: {
+                /** @description Retrieve the user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            contactId?: string;
+                        };
+                    };
+                };
+            };
+        };
+        trace?: never;
+    };
+}
+
+type CreateContactPayload = paths["/v1/contactBooks/{contactBookId}/contacts"]["post"]["requestBody"]["content"]["application/json"];
+type CreateContactResponse = {
+    data: CreateContactResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type CreateContactResponseSuccess = paths["/v1/contactBooks/{contactBookId}/contacts"]["post"]["responses"]["200"]["content"]["application/json"];
+type GetContactResponseSuccess = paths["/v1/contactBooks/{contactBookId}/contacts/{contactId}"]["get"]["responses"]["200"]["content"]["application/json"];
+type GetContactResponse = {
+    data: GetContactResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type UpdateContactPayload = paths["/v1/contactBooks/{contactBookId}/contacts/{contactId}"]["patch"]["requestBody"]["content"]["application/json"];
+type UpdateContactResponseSuccess = paths["/v1/contactBooks/{contactBookId}/contacts/{contactId}"]["patch"]["responses"]["200"]["content"]["application/json"];
+type UpdateContactResponse = {
+    data: UpdateContactResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type UpsertContactPayload = paths["/v1/contactBooks/{contactBookId}/contacts/{contactId}"]["put"]["requestBody"]["content"]["application/json"];
+type UpsertContactResponseSuccess = paths["/v1/contactBooks/{contactBookId}/contacts/{contactId}"]["put"]["responses"]["200"]["content"]["application/json"];
+type UpsertContactResponse = {
+    data: UpsertContactResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type DeleteContactResponse = {
+    data: {
+        success: boolean;
+    } | null;
+    error: ErrorResponse | null;
+};
+declare class Contacts {
+    private readonly unsent;
+    constructor(unsent: unsent);
+    create(contactBookId: string, payload: CreateContactPayload): Promise<CreateContactResponse>;
+    get(contactBookId: string, contactId: string): Promise<GetContactResponse>;
+    update(contactBookId: string, contactId: string, payload: UpdateContactPayload): Promise<UpdateContactResponse>;
+    upsert(contactBookId: string, contactId: string, payload: UpsertContactPayload): Promise<UpsertContactResponse>;
+    delete(contactBookId: string, contactId: string): Promise<DeleteContactResponse>;
+}
+
+type SendEmailPayload = paths["/v1/emails"]["post"]["requestBody"]["content"]["application/json"] & {
+    react?: React.ReactElement;
+};
+type CreateEmailResponse = {
+    data: CreateEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type CreateEmailResponseSuccess = paths["/v1/emails"]["post"]["responses"]["200"]["content"]["application/json"];
+type GetEmailResponseSuccess = paths["/v1/emails/{emailId}"]["get"]["responses"]["200"]["content"]["application/json"];
+type GetEmailResponse = {
+    data: GetEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type UpdateEmailPayload = paths["/v1/emails/{emailId}"]["patch"]["requestBody"]["content"]["application/json"] & {
+    react?: React.ReactElement;
+};
+type UpdateEmailResponse = {
+    data: UpdateEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type UpdateEmailResponseSuccess = paths["/v1/emails/{emailId}"]["patch"]["responses"]["200"]["content"]["application/json"];
+type CancelEmailResponse = {
+    data: CancelEmailResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type CancelEmailResponseSuccess = paths["/v1/emails/{emailId}/cancel"]["post"]["responses"]["200"]["content"]["application/json"];
+/**
+ * Payload for sending multiple emails in a single batch request.
+ */
+type BatchEmailPayload = paths["/v1/emails/batch"]["post"]["requestBody"]["content"]["application/json"];
+/**
+ * Successful response schema for batch email send.
+ */
+type BatchEmailResponseSuccess = paths["/v1/emails/batch"]["post"]["responses"]["200"]["content"]["application/json"];
+/**
+ * Response structure for the batch method.
+ */
+type BatchEmailResponse = {
+    data: BatchEmailResponseSuccess["data"] | null;
+    error: ErrorResponse | null;
+};
+declare class Emails {
+    private readonly unsent;
+    constructor(unsent: unsent);
+    send(payload: SendEmailPayload): Promise<CreateEmailResponse>;
+    create(payload: SendEmailPayload): Promise<CreateEmailResponse>;
+    /**
+     * Send up to 100 emails in a single request.
+     *
+     * @param payload An array of email payloads. Max 100 emails.
+     * @returns A promise that resolves to the list of created email IDs or an error.
+     */
+    batch(payload: BatchEmailPayload): Promise<BatchEmailResponse>;
+    get(id: string): Promise<GetEmailResponse>;
+    update(id: string, payload: UpdateEmailPayload): Promise<UpdateEmailResponse>;
+    cancel(id: string): Promise<CancelEmailResponse>;
+}
+
+declare class unsent {
+    readonly key?: string | undefined;
+    private readonly headers;
+    readonly emails: Emails;
+    readonly contacts: Contacts;
+    url: string;
+    constructor(key?: string | undefined, url?: string);
+    fetchRequest<T>(path: string, options?: {}): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    post<T>(path: string, body: unknown): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    get<T>(path: string): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    put<T>(path: string, body: any): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    patch<T>(path: string, body: any): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+    delete<T>(path: string, body?: unknown): Promise<{
+        data: T | null;
+        error: ErrorResponse | null;
+    }>;
+}
+
+export { unsent };