@unsent/sdk 0.25.3 → 1.0.0

package/dist/index.d.mts

@@ -36,9 +36,9 @@ interface paths {
                         "application/json": {
                             /**
                              * @description The ID of the domain
-                             * @example 1
+                             * @example 0Lleb1FOUnB60jSueJ/mkPId1vrdB68T8/u9tiInsi4=
                              */
-                            id: number;
+                            id: string;
                             /**
                              * @description The name of the domain
                              * @example example.com
@@ -46,9 +46,9 @@ interface paths {
                             name: string;
                             /**
                              * @description The ID of the team
-                             * @example 1
+                             * @example jonVNF8M+EbJObaRAz2XBHnoJ6Add/tazP9lfOiPJ3E=
                              */
-                            teamId: number;
+                            teamId: string;
                             /** @enum {string} */
                             status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
                             /** @default us-east-1 */
@@ -133,9 +133,9 @@ interface paths {
                         "application/json": {
                             /**
                              * @description The ID of the domain
-                             * @example 1
+                             * @example 0Lleb1FOUnB60jSueJ/mkPId1vrdB68T8/u9tiInsi4=
                              */
-                            id: number;
+                            id: string;
                             /**
                              * @description The name of the domain
                              * @example example.com
@@ -143,9 +143,9 @@ interface paths {
                             name: string;
                             /**
                              * @description The ID of the team
-                             * @example 1
+                             * @example jonVNF8M+EbJObaRAz2XBHnoJ6Add/tazP9lfOiPJ3E=
                              */
-                            teamId: number;
+                            teamId: string;
                             /** @enum {string} */
                             status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
                             /** @default us-east-1 */
@@ -223,7 +223,7 @@ interface paths {
                 query?: never;
                 header?: never;
                 path: {
-                    id: number | null;
+                    id: string;
                 };
                 cookie?: never;
             };
@@ -283,7 +283,7 @@ interface paths {
                 query?: never;
                 header?: never;
                 path: {
-                    id: number | null;
+                    id: string;
                 };
                 cookie?: never;
             };
@@ -298,9 +298,9 @@ interface paths {
                         "application/json": {
                             /**
                              * @description The ID of the domain
-                             * @example 1
+                             * @example 0Lleb1FOUnB60jSueJ/mkPId1vrdB68T8/u9tiInsi4=
                              */
-                            id: number;
+                            id: string;
                             /**
                              * @description The name of the domain
                              * @example example.com
@@ -308,9 +308,9 @@ interface paths {
                             name: string;
                             /**
                              * @description The ID of the team
-                             * @example 1
+                             * @example jonVNF8M+EbJObaRAz2XBHnoJ6Add/tazP9lfOiPJ3E=
                              */
-                            teamId: number;
+                            teamId: string;
                             /** @enum {string} */
                             status: "NOT_STARTED" | "PENDING" | "SUCCESS" | "FAILED" | "TEMPORARY_FAILURE";
                             /** @default us-east-1 */
@@ -376,7 +376,7 @@ interface paths {
                 query?: never;
                 header?: never;
                 path: {
-                    id: number;
+                    id: string;
                 };
                 cookie?: never;
             };
@@ -389,74 +389,26 @@ interface paths {
                     };
                     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;
-                            }[];
+                            success: boolean;
+                            message: string;
+                        };
+                    };
+                };
+                /** @description Forbidden - API key doesn't have access */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Domain not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: string;
                         };
                     };
                 };
@@ -493,7 +445,7 @@ interface paths {
                     content: {
                         "application/json": {
                             id: string;
-                            teamId: number;
+                            teamId: string;
                             to: string | string[];
                             replyTo?: string | string[];
                             cc?: string | string[];
@@ -599,7 +551,7 @@ interface paths {
                                 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;
+                                domainId: string | null;
                             }[];
                             count: number;
                         };
@@ -1009,6 +961,282 @@ interface paths {
         };
         trace?: never;
     };
+    "/v1/campaigns": {
+        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": {
+                        name: string;
+                        from: string;
+                        subject: string;
+                        previewText?: string;
+                        contactBookId: string;
+                        content?: string;
+                        html?: string;
+                        replyTo?: string | string[];
+                        cc?: string | string[];
+                        bcc?: string | string[];
+                        sendNow?: boolean;
+                        /** @description Timestamp in ISO 8601 format or natural language (e.g., 'tomorrow 9am', 'next monday 10:30') */
+                        scheduledAt?: string;
+                        batchSize?: number;
+                    };
+                };
+            };
+            responses: {
+                /** @description Create a campaign */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            name: string;
+                            from: string;
+                            subject: string;
+                            previewText: string | null;
+                            contactBookId: string | null;
+                            html: string | null;
+                            content: string | null;
+                            status: string;
+                            /** Format: date-time */
+                            scheduledAt: string | null;
+                            batchSize: number;
+                            batchWindowMinutes: number;
+                            total: number;
+                            sent: number;
+                            delivered: number;
+                            opened: number;
+                            clicked: number;
+                            unsubscribed: number;
+                            bounced: number;
+                            hardBounced: number;
+                            complained: number;
+                            replyTo: string[];
+                            cc: string[];
+                            bcc: string[];
+                            /** Format: date-time */
+                            createdAt: string;
+                            /** Format: date-time */
+                            updatedAt: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/campaigns/{campaignId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    campaignId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Get campaign details */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            id: string;
+                            name: string;
+                            from: string;
+                            subject: string;
+                            previewText: string | null;
+                            contactBookId: string | null;
+                            html: string | null;
+                            content: string | null;
+                            status: string;
+                            /** Format: date-time */
+                            scheduledAt: string | null;
+                            batchSize: number;
+                            batchWindowMinutes: number;
+                            total: number;
+                            sent: number;
+                            delivered: number;
+                            opened: number;
+                            clicked: number;
+                            unsubscribed: number;
+                            bounced: number;
+                            hardBounced: number;
+                            complained: number;
+                            replyTo: string[];
+                            cc: string[];
+                            bcc: string[];
+                            /** Format: date-time */
+                            createdAt: string;
+                            /** Format: date-time */
+                            updatedAt: string;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/campaigns/{campaignId}/schedule": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    campaignId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description Timestamp in ISO 8601 format or natural language (e.g., 'tomorrow 9am', 'next monday 10:30') */
+                        scheduledAt?: string;
+                        batchSize?: number;
+                    };
+                };
+            };
+            responses: {
+                /** @description Schedule a campaign */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/campaigns/{campaignId}/pause": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    campaignId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Pause a campaign */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/campaigns/{campaignId}/resume": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    campaignId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Resume a campaign */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 
 type CreateContactPayload = paths["/v1/contactBooks/{contactBookId}/contacts"]["post"]["requestBody"]["content"]["application/json"];
@@ -1144,12 +1372,47 @@ declare class Domains {
     delete(id: number): Promise<DeleteDomainResponse>;
 }
 
+type CreateCampaignPayload = paths["/v1/campaigns"]["post"]["requestBody"]["content"]["application/json"];
+type CreateCampaignResponseSuccess = paths["/v1/campaigns"]["post"]["responses"]["200"]["content"]["application/json"];
+type CreateCampaignResponse = {
+    data: CreateCampaignResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type GetCampaignResponseSuccess = paths["/v1/campaigns/{campaignId}"]["get"]["responses"]["200"]["content"]["application/json"];
+type GetCampaignResponse = {
+    data: GetCampaignResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type ScheduleCampaignPayload = paths["/v1/campaigns/{campaignId}/schedule"]["post"]["requestBody"]["content"]["application/json"];
+type ScheduleCampaignResponseSuccess = paths["/v1/campaigns/{campaignId}/schedule"]["post"]["responses"]["200"]["content"]["application/json"];
+type ScheduleCampaignResponse = {
+    data: ScheduleCampaignResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+type CampaignActionResponseSuccess = {
+    success: boolean;
+};
+type CampaignActionResponse = {
+    data: CampaignActionResponseSuccess | null;
+    error: ErrorResponse | null;
+};
+declare class Campaigns {
+    private readonly unsent;
+    constructor(unsent: unsent);
+    create(payload: CreateCampaignPayload): Promise<CreateCampaignResponse>;
+    get(campaignId: string): Promise<GetCampaignResponse>;
+    schedule(campaignId: string, payload: ScheduleCampaignPayload): Promise<ScheduleCampaignResponse>;
+    pause(campaignId: string): Promise<CampaignActionResponse>;
+    resume(campaignId: string): Promise<CampaignActionResponse>;
+}
+
 declare class unsent {
     readonly key?: string | undefined;
     private readonly headers;
-    readonly emails: Emails;
     readonly domains: Domains;
+    readonly emails: Emails;
     readonly contacts: Contacts;
+    readonly campaigns: Campaigns;
     url: string;
     constructor(key?: string | undefined, url?: string);
     fetchRequest<T>(path: string, options?: {}): Promise<{
@@ -1178,4 +1441,4 @@ declare class unsent {
     }>;
 }
 
-export { unsent };
+export { Campaigns as campaigns, unsent };