ensend 0.0.1

package/dist/apis/AudienceApi.d.ts

@@ -0,0 +1,27 @@
+import type { HttpClient } from "../lib/types";
+export declare class AudienceApi {
+    private http;
+    constructor(http: HttpClient);
+    CreateProfile(dto: TAudienceApi.CreateProfileDto): Promise<{
+        data: import("../lib/types").HttpClientResponse<TAudienceApi.CreateProfileResponse>;
+        error: import("../lib/types").HttpClientResponse;
+    }>;
+}
+export declare namespace TAudienceApi {
+    type CreateProfileDto = {
+        audienceId: string;
+        name: string;
+        identity: string;
+        sendConsentEmail: boolean;
+    };
+    type CreateProfileResponse = {
+        profile: {
+            ref: string;
+            name: string;
+            identity: string;
+            type: string;
+            status: string;
+            createdAt: string;
+        };
+    };
+}

package/dist/apis/AudienceApi.js

@@ -0,0 +1,12 @@
+export class AudienceApi {
+    constructor(http) {
+        this.http = http;
+    }
+    async CreateProfile(dto) {
+        return this.http({
+            body: dto,
+            method: "POST",
+            path: "/project/audience/profile/create",
+        });
+    }
+}

package/dist/apis/SendApi.d.ts

@@ -0,0 +1,169 @@
+import type { HttpClient } from "../lib/types";
+export declare class SendApi<const I extends readonly string[], const T extends readonly string[]> {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * This API method creates and sends a new mail message or notification.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendMailMessage({
+     *   subject: "Hello Ensend!",
+     *   sender: "noreply@ensend.co",
+     *   recipients: "tenotea@smtpexpress.com"
+     *   message: "<i>reach your customers wherever they are</i>",
+     *   attachments: [{
+     *     name: "Attachment.pdf",
+     *     content?: "data:application/pdf;base64,..."
+     *     url?: "https://link-to-file.pdf"
+     *   }]
+     * });
+     * @see {@link https://docs.ensend.co/send/mail-message | More in the documentation}
+     */
+    SendMailMessage(dto: TSendApi.SendMailMessageDto<I, T>): Promise<{
+        data: import("../lib/types").HttpClientResponse<TSendApi.SendMailMessageResponse>;
+        error: import("../lib/types").HttpClientResponse;
+    }>;
+    /**
+     * This API method Creates and sends a new mail broadcast.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendMailBroadcast({
+     *   subject: "{{profile.firstName}}, Welcome to Ensend!",
+     *   sender: "noreply@ensend.co",
+     *   recipients: ["tenotea@smtpexpress.com"]
+     *   message: "<i>reach your customers wherever they are</i>",
+     *   attachments: [{
+     *     name: "Attachment.pdf",
+     *     content?: "data:application/pdf;base64,..."
+     *     url?: "https://link-to-file.pdf"
+     *   }]
+     * });
+     * @see {@link https://docs.ensend.co/send/mail-broadast | More about personalization in the documentation}
+     */
+    SendMailBroadcast(dto: TSendApi.SendMailBroadcastDto<I, T>): Promise<{
+        data: import("../lib/types").HttpClientResponse<TSendApi.SendMailBroadcastResponse>;
+        error: import("../lib/types").HttpClientResponse;
+    }>;
+    /**
+     * This API method sends a mail message to new recipients in a broadcast.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendExistingMailBroadcast({
+     *   broadcastRef: "ref of a previously created broadcast",
+     *   // new recipients to deliver to
+     *   recipients: ["tenotea@smtpexpress.com"]
+     * });
+     * // No other modifications can me made to a previously processed broadcast.
+     * @see {@link https://docs.ensend.co/send/mail-broadcast | More in the documentation}
+     */
+    SendExistingMailBroadcast(dto: TSendApi.SendExistingMailBroadcastDto): Promise<{
+        data: import("../lib/types").HttpClientResponse<TSendApi.SendMailBroadcastResponse>;
+        error: import("../lib/types").HttpClientResponse;
+    }>;
+}
+export declare namespace TSendApi {
+    type RequiresAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+        [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+    }[Keys];
+    export type SendMailMessageDto<I extends readonly string[] = [], T extends readonly string[] = []> = {
+        subject: string;
+        sender: I[number] | {
+            name?: string;
+            address: I[number];
+        };
+        recipients: string | string[] | {
+            name?: string;
+            address: string;
+        } | Array<{
+            name?: string;
+            address: string;
+        }>;
+        replyAddress?: string;
+        attachments?: Array<{
+            name: string;
+        } & RequiresAtLeastOne<{
+            url: string;
+            content: string;
+        }, "content" | "url">>;
+        invitation?: {
+            title: string;
+            startDate: Date;
+            endDate: Date;
+            url?: string | null;
+            description?: string | null;
+            location?: string | null;
+        };
+        options?: {
+            acquiringAudience?: string | null;
+            storeContent?: boolean | null;
+        } | null;
+    } & RequiresAtLeastOne<{
+        message: string;
+        template: {
+            id: T[number];
+            variables?: Record<string, string>;
+        };
+    }, "message" | "template">;
+    export type SendMailMessageResponse = {
+        ref: string;
+    };
+    export type SendMailBroadcastDto<I extends readonly string[] = [], T extends readonly string[] = []> = {
+        subject: string;
+        sender: I[number] | {
+            name?: string;
+            address: I[number];
+        };
+        replyAddress?: string;
+        attachments?: Array<{
+            name: string;
+        } & RequiresAtLeastOne<{
+            url: string;
+            content: string;
+        }, "content" | "url">>;
+        invitation?: {
+            title: string;
+            startDate: Date;
+            endDate: Date;
+            url?: string | null;
+            description?: string | null;
+            location?: string | null;
+        };
+        options?: {
+            acquiringAudience?: string | null;
+            scheduleFor?: string | null;
+            storeContent?: boolean | null;
+        } | null;
+    } & RequiresAtLeastOne<{
+        message: string;
+        template: {
+            id: T[number];
+            variables?: Record<string, string>;
+        };
+    }, "message" | "template"> & RequiresAtLeastOne<{
+        recipients: string | string[] | {
+            name?: string;
+            address: string;
+        } | Array<{
+            name?: string;
+            address: string;
+        }>;
+        audience: string[];
+    }>;
+    export type SendExistingMailBroadcastDto = {
+        broadcastRef: string;
+        recipients?: string | string[] | {
+            name?: string;
+            address: string;
+        } | Array<{
+            name?: string;
+            address: string;
+        }>;
+    };
+    export type SendMailBroadcastResponse = {
+        broadcast: {
+            ref: string;
+            status: string;
+        };
+    };
+    export {};
+}

package/dist/apis/SendApi.js

@@ -0,0 +1,72 @@
+export class SendApi {
+    constructor(http) {
+        this.http = http;
+    }
+    /**
+     * This API method creates and sends a new mail message or notification.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendMailMessage({
+     *   subject: "Hello Ensend!",
+     *   sender: "noreply@ensend.co",
+     *   recipients: "tenotea@smtpexpress.com"
+     *   message: "<i>reach your customers wherever they are</i>",
+     *   attachments: [{
+     *     name: "Attachment.pdf",
+     *     content?: "data:application/pdf;base64,..."
+     *     url?: "https://link-to-file.pdf"
+     *   }]
+     * });
+     * @see {@link https://docs.ensend.co/send/mail-message | More in the documentation}
+     */
+    async SendMailMessage(dto) {
+        return this.http({
+            method: "POST",
+            path: "/send/mail",
+            body: dto,
+        });
+    }
+    /**
+     * This API method Creates and sends a new mail broadcast.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendMailBroadcast({
+     *   subject: "{{profile.firstName}}, Welcome to Ensend!",
+     *   sender: "noreply@ensend.co",
+     *   recipients: ["tenotea@smtpexpress.com"]
+     *   message: "<i>reach your customers wherever they are</i>",
+     *   attachments: [{
+     *     name: "Attachment.pdf",
+     *     content?: "data:application/pdf;base64,..."
+     *     url?: "https://link-to-file.pdf"
+     *   }]
+     * });
+     * @see {@link https://docs.ensend.co/send/mail-broadast | More about personalization in the documentation}
+     */
+    async SendMailBroadcast(dto) {
+        return this.http({
+            method: "POST",
+            path: "/send/mail/broadast",
+            body: dto,
+        });
+    }
+    /**
+     * This API method sends a mail message to new recipients in a broadcast.
+     * @example
+     * const ensend = new Client({...})
+     * await ensend.SendApi.SendExistingMailBroadcast({
+     *   broadcastRef: "ref of a previously created broadcast",
+     *   // new recipients to deliver to
+     *   recipients: ["tenotea@smtpexpress.com"]
+     * });
+     * // No other modifications can me made to a previously processed broadcast.
+     * @see {@link https://docs.ensend.co/send/mail-broadcast | More in the documentation}
+     */
+    async SendExistingMailBroadcast(dto) {
+        return this.http({
+            method: "POST",
+            path: "/send/mail/broadast",
+            body: dto,
+        });
+    }
+}

package/dist/client.d.ts

@@ -0,0 +1,10 @@
+import { SendApi } from "./apis/SendApi";
+import type { ClientOptions } from "./lib/types";
+export declare class Client<const I extends readonly string[], const T extends readonly string[]> {
+    private ENSEND_BASE_URL;
+    private PROJECT_SECRET;
+    constructor(options?: ClientOptions<I, T>);
+    private http;
+    SendApi: SendApi<I, T>;
+}
+export type { TSendApi as SendApi } from "./apis/SendApi";

package/dist/client.js

@@ -0,0 +1,40 @@
+import fetch from "node-fetch-native";
+import { SendApi } from "./apis/SendApi";
+export class Client {
+    constructor(options) {
+        this.ENSEND_BASE_URL = process.env.ENSEND_BASE_URL || "https://api.ensend.co";
+        this.PROJECT_SECRET = process.env.ENSEND_PROJECT_SECRET;
+        this.http = async (options) => {
+            let data = null;
+            let error = null;
+            await fetch(this.ENSEND_BASE_URL + options.path, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${this.PROJECT_SECRET}`,
+                },
+                method: options.method,
+                body: options.method === "POST" ? JSON.stringify(options.body) : undefined,
+            })
+                .then(async (res) => {
+                const responseData = await res.json();
+                if (res.status === 200) {
+                    data = responseData;
+                }
+                else {
+                    error = responseData;
+                }
+            })
+                .catch((error) => {
+                error = {
+                    message: error.message,
+                    statusCode: 500,
+                };
+            });
+            return { data, error };
+        };
+        this.SendApi = new SendApi(this.http);
+        if (options?.secret) {
+            this.PROJECT_SECRET = options.secret;
+        }
+    }
+}

package/dist/lib/types.d.ts

@@ -0,0 +1,19 @@
+export type HttpClientOptions = {
+    method: "POST" | "GET";
+    path: string;
+    body: Record<string, any>;
+};
+export type HttpClientResponse<T = undefined> = {
+    message: string;
+    statusCode: number;
+    data: T;
+} | null;
+export type HttpClient = <T extends Record<string, any>>(body: HttpClientOptions) => Promise<{
+    data: HttpClientResponse<T>;
+    error: HttpClientResponse;
+}>;
+export type ClientOptions<I extends readonly string[], T extends readonly string[]> = {
+    secret: string;
+    identities?: I;
+    templates?: T;
+};

package/dist/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "ensend",
+  "version": "0.0.1",
+  "type": "module",
+  "private": false,
+  "description": "Official Typescript/Javascript SDK for the new Ensend API. See completed documentation at https://docs.ensend.co",
+  "main": "dist/client.js",
+  "exports": {
+    ".": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "require": "./dist/client.js"
+    }
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "tsc"
+  },
+  "keywords": [
+    "Email",
+    "SMS",
+    "Push Notifications",
+    "SMTP",
+    "Ensend"
+  ],
+  "author": "Tenotea (https://github.com/tenotea)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ensendco/ensend-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ensendco/ensend-ts/issues"
+  },
+  "homepage": "https://github.com/ensendco/ensend-ts#readme",
+  "dependencies": {
+    "node-fetch-native": "^1.6.7"
+  },
+  "devDependencies": {
+    "@types/node": "^25.2.3",
+    "typescript": "^5.9.3"
+  }
+}