@ohunkohun/termii-sdk 1.0.0

package/README.md

@@ -0,0 +1,208 @@
+# Termii SDK for Node.js
+
+A TypeScript/Node.js SDK for interacting with the [Termii](https://developers.termii.com/) API.
+
+## Coverage
+
+This SDK currently supports Termii's messaging APIs, including SMS, bulk messaging, WhatsApp messaging/templates, Sender ID management, and email notifications.
+
+## Installation
+
+You can install the published npm package directly:
+
+```bash
+npm install @ohunkohun/termii-sdk
+```
+
+Then import and initialize the SDK:
+
+```ts
+import { Termii } from "@ohunkohun/termii-sdk";
+
+const client = Termii({
+    api_key: "YOUR_API_KEY",
+    base_url: "https://BASE_URL",
+});
+```
+
+You can now use the available API resources through the client:
+
+```ts
+const response = await client.sms.send({
+    to: "234XXXXXXXXXX",
+    from: "YourSender",
+    sms: "Hello from Termii SDK",
+    channel: "generic",
+    type: "plain",
+});
+```
+
+> Replace the package name and API configuration with the values appropriate for your environment.
+
+---
+
+## Working With the Repository
+
+If you have cloned this repository and want to work with the source code directly, install the dependencies first:
+
+```bash
+npm install
+```
+
+Build the SDK with:
+
+```bash
+npm run build
+```
+
+The compiled package will be generated in the `dist` directory.
+
+---
+
+## Testing the SDK Locally
+
+There are two ways to test the SDK after cloning the repository.
+
+### Use the source directly
+
+Some examples and development utilities in this repository are intended to run locally.
+
+If an example uses environment variables, create a `.env` file in the root of the project:
+
+```env
+IS_LOCAL_MACHINE="true"
+API_KEY="your-api-key"
+BASE_URL="https://your-base-url"
+```
+
+Some variables and constants used in the examples are loaded from the `.env` file. You can also define these values directly in your code instead of using environment variables.
+
+For example:
+
+```ts
+const config = {
+    api_key: "your-api-key",
+    base_url: "https://your-base-url",
+};
+```
+
+### Test the SDK as an installed npm package
+
+If you want to test the SDK exactly as a consumer would, you can install the published npm package instead of working directly with the source files.
+
+```bash
+npm install @ohunkohun/termii-sdk
+```
+
+This is useful for testing the package's:
+
+-   Public exports
+-   TypeScript declarations
+-   Auto-completion
+-   API surface
+-   Package entry points
+-   Production build
+
+You can then import the SDK normally:
+
+```ts
+import { Termii } from "@ohunkohun/termii-sdk";
+```
+
+---
+
+## Testing a Local Package Build
+
+If you want to test the **current local changes** before publishing them to npm, you can create a package archive with:
+
+```bash
+npm run build
+npm run pack
+```
+
+This generates a `.tgz` file, for example:
+
+```
+ohunkohun-termii-sdk-1.0.0.tgz
+```
+
+You can install that package in another project:
+
+```bash
+npm install C://absolute/or/relative/path/to/ohunkohun-termii-sdk-1.0.0.tgz
+```
+
+This allows you to test the SDK as an actual installed npm package while still using your local, unpublished changes.
+
+---
+
+## Development
+
+Start the development environment with:
+
+```bash
+npm run dev
+```
+
+To watch for TypeScript errors without generating build files:
+
+```bash
+npm run types:watch
+```
+
+To create a production build:
+
+```bash
+npm run build
+```
+
+---
+
+## Environment Variables
+
+Environment variables are only required for examples or local development that use them.
+
+A typical `.env` file may look like:
+
+```env
+IS_LOCAL_MACHINE="true"
+API_KEY="your-api-key"
+BASE_URL="https://your-base-url"
+SEND_SMS_FROM="YourSender"
+SEND_SMS_TO="234XXXXXXXXXX"
+```
+
+You are not required to use `.env`. Configuration values can be supplied directly when initializing the SDK:
+
+```ts
+const client = Termii({
+    api_key: "your-api-key",
+    base_url: "https://your-base-url",
+});
+```
+
+---
+
+## Package vs. Repository
+
+If you only want to **use the SDK**, installing the npm package is recommended:
+
+```bash
+npm install @ohunkohun/termii-sdk
+```
+
+If you want to **contribute to, modify, or inspect the SDK source code**, clone this repository and install its dependencies:
+
+```bash
+git clone <repository-url>
+cd <repository-folder>
+npm install
+```
+
+If you want to test your local changes as a real npm package without publishing them, use `npm run pack` and install the generated `.tgz` file in another project.
+
+---
+
+## Disclaimer
+
+This is a community-built, unofficial Node.js/TypeScript SDK for the Termii API. It is not an official Termii package unless otherwise stated by Termii.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { Termii } from "./resources/client.js";
+export type * from "./types/api-response.js";
+export type * from "./types/config.js";
+export type * from "./types/email.js";
+export type * from "./types/sender-id.js";
+export type * from "./types/sms.js";
+export type * from "./types/whatsapp.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE/C,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,gBAAgB,CAAC;AACpC,mBAAmB,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { Termii } from "./resources/client.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/resources/client.d.ts

@@ -0,0 +1,23 @@
+import { ApiErrorResponse } from "../types/api-response.js";
+import { TermiiConfig } from "../types/config.js";
+import { SendEmailTemplateBody, SendEmailTemplateResponse } from "../types/email.js";
+import { ListSenderIdParams, ListSenderIdResponse, RequestSenderIdBody, RequestSenderIdResponse } from "../types/sender-id.js";
+import { BulkSmsBody, SendSmsBody, SmsResponse } from "../types/sms.js";
+import { SendWhatsAppTemplateBody } from "../types/whatsapp.js";
+export declare const Termii: (config: TermiiConfig) => {
+    sender_id: {
+        list: (query?: ListSenderIdParams) => Promise<ApiErrorResponse | ListSenderIdResponse | undefined>;
+        request: (body: RequestSenderIdBody) => Promise<ApiErrorResponse | RequestSenderIdResponse | undefined>;
+    };
+    sms: {
+        send: (body: SendSmsBody) => Promise<ApiErrorResponse | SmsResponse | undefined>;
+        send_bulk: (body: BulkSmsBody) => Promise<ApiErrorResponse | SmsResponse | undefined>;
+    };
+    email_template: {
+        send: (body: SendEmailTemplateBody) => Promise<ApiErrorResponse | SendEmailTemplateResponse | undefined>;
+    };
+    whatsapp_template: {
+        send: (body: SendWhatsAppTemplateBody) => Promise<ApiErrorResponse | RequestSenderIdResponse | undefined>;
+    };
+};
+//# sourceMappingURL=client.d.ts.map

package/dist/resources/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/resources/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAC/H,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAGhE,eAAO,MAAM,MAAM,WAAY,YAAY;;QAuB/B,IAAI,WAAiB,kBAAkB;QACvC,OAAO,SAAe,mBAAmB;;;QAGzC,IAAI,SAAe,WAAW;QAC9B,SAAS,SAAe,WAAW;;;QAGnC,IAAI,SAAe,qBAAqB;;;QAGxC,IAAI,SAAe,wBAAwB;;CAKtD,CAAC"}

package/dist/resources/client.js

@@ -0,0 +1,38 @@
+import { create } from "axios";
+import { useTryCatch } from "./hooks.js";
+export const Termii = (config) => {
+    const trycatch = useTryCatch();
+    const req = create({
+        baseURL: config.base_url,
+        headers: {
+            "Content-Type": "application/json",
+        },
+    });
+    const callApi = async (method, urlPath, data) => {
+        return await trycatch.wrap(async () => {
+            const resp = await (method === 'post' ? req.post(urlPath, { api_key: config.api_key, ...data }) :
+                req.get(urlPath, { params: { api_key: config.api_key, ...data } }));
+            return resp?.data;
+        }, (error) => {
+            return error?.response?.data;
+        });
+    };
+    const handles = {
+        sender_id: {
+            list: async (query) => await callApi('get', `/api/sender-id`, query),
+            request: async (body) => await callApi('post', `/api/sender-id/request`, body),
+        },
+        sms: {
+            send: async (body) => await callApi('post', `/api/sms/send`, body),
+            send_bulk: async (body) => await callApi('post', `/api/sms/send/bulk`, body),
+        },
+        email_template: {
+            send: async (body) => await callApi('post', `/api/templates/send-email`, body),
+        },
+        whatsapp_template: {
+            send: async (body) => await callApi('post', `/api/send/template${Object.keys(body.media || {}).length ? `/media` : ``}`, body),
+        },
+    };
+    return { ...handles };
+};
+//# sourceMappingURL=client.js.map

package/dist/resources/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/resources/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAO/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,MAAoB,EAAE,EAAE;IAC3C,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,GAAG,GAAG,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE;YACL,cAAc,EAAE,kBAAkB;SACrC;KACJ,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,KAAK,EAAM,MAAsB,EAAE,OAAe,EAAE,IAAqC,EAAE,EAAE;QACzG,OAAO,MAAM,QAAQ,CAAC,IAAI,CAAuB,KAAK,IAAI,EAAE;YACxD,MAAM,IAAI,GAAG,MAAM,CACf,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,EAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,EAAC,CAAC,CAAC,CAAC;gBAC3E,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,EAAC,MAAM,EAAE,EAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,EAAC,EAAC,CAAC,CACjE,CAAC;YACF,OAAO,IAAI,EAAE,IAAI,CAAC;QACtB,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;YACT,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC;QACjC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG;QACZ,SAAS,EAAE;YACP,IAAI,EAAE,KAAK,EAAE,KAA0B,EAAE,EAAE,CAAC,MAAM,OAAO,CAAuB,KAAK,EAAE,gBAAgB,EAAE,KAAK,CAAC;YAC/G,OAAO,EAAE,KAAK,EAAE,IAAyB,EAAE,EAAE,CAAC,MAAM,OAAO,CAA0B,MAAM,EAAE,wBAAwB,EAAE,IAAI,CAAC;SAC/H;QACD,GAAG,EAAE;YACD,IAAI,EAAE,KAAK,EAAE,IAAiB,EAAE,EAAE,CAAC,MAAM,OAAO,CAAc,MAAM,EAAE,eAAe,EAAE,IAAI,CAAC;YAC5F,SAAS,EAAE,KAAK,EAAE,IAAiB,EAAE,EAAE,CAAC,MAAM,OAAO,CAAc,MAAM,EAAE,oBAAoB,EAAE,IAAI,CAAC;SACzG;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,KAAK,EAAE,IAA2B,EAAE,EAAE,CAAC,MAAM,OAAO,CAA4B,MAAM,EAAE,2BAA2B,EAAE,IAAI,CAAC;SACnI;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,KAAK,EAAE,IAA8B,EAAE,EAAE,CAAC,MAAM,OAAO,CAA0B,MAAM,EAAE,qBAAqB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC;SACpL;KACJ,CAAC;IAEF,OAAO,EAAC,GAAG,OAAO,EAAC,CAAC;AACxB,CAAC,CAAC"}

package/dist/resources/hooks.d.ts

@@ -0,0 +1,4 @@
+export declare const useTryCatch: () => {
+    wrap: <T>(callback: () => Promise<T> | T, onErrorCaught?: (err?: any) => Promise<T> | T) => Promise<T | undefined>;
+};
+//# sourceMappingURL=hooks.d.ts.map

package/dist/resources/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/resources/hooks.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,WAAW;WAEF,CAAC,YAAY,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,KAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;CAW9H,CAAC"}

package/dist/resources/hooks.js

@@ -0,0 +1,16 @@
+export const useTryCatch = () => {
+    const handles = {
+        wrap: async (callback, onErrorCaught) => {
+            try {
+                return await callback();
+            }
+            catch (err) {
+                // console.log('--tryCatchWrapper', err);
+                if (onErrorCaught)
+                    return await onErrorCaught?.(err);
+            }
+        },
+    };
+    return { ...handles };
+};
+//# sourceMappingURL=hooks.js.map

package/dist/resources/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/resources/hooks.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE;IAC5B,MAAM,OAAO,GAAG;QACX,IAAI,EAAE,KAAK,EAAK,QAA8B,EAAE,aAA6C,EAA0B,EAAE;YACtH,IAAI,CAAC;gBACD,OAAO,MAAM,QAAQ,EAAE,CAAC;YAC5B,CAAC;YACD,OAAM,GAAG,EAAC,CAAC;gBACP,yCAAyC;gBACzC,IAAG,aAAa;oBAAE,OAAO,MAAM,aAAa,EAAE,CAAC,GAAG,CAAC,CAAA;YACvD,CAAC;QACL,CAAC;KACJ,CAAC;IACF,OAAO,EAAC,GAAG,OAAO,EAAC,CAAA;AACvB,CAAC,CAAC"}

package/dist/types/api-response.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Error response returned by the API.
+ */
+export interface ApiErrorResponse {
+    /**
+     * Error code returned by the API.
+     */
+    code?: string;
+    /**
+     * Human-readable error message.
+     */
+    message?: string;
+    /**
+     * HTTP status code.
+     */
+    status?: number;
+    /**
+     * API endpoint that generated the error.
+     */
+    path?: string;
+    /**
+     * Time at which the error occurred.
+     */
+    timestamp?: string;
+    /**
+     * Additional error description.
+     */
+    error?: string;
+}
+//# sourceMappingURL=api-response.d.ts.map

package/dist/types/api-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.d.ts","sourceRoot":"","sources":["../../src/types/api-response.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/api-response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api-response.js.map

package/dist/types/api-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.js","sourceRoot":"","sources":["../../src/types/api-response.ts"],"names":[],"mappings":""}

package/dist/types/config.d.ts

@@ -0,0 +1,5 @@
+export interface TermiiConfig {
+    api_key: string;
+    base_url: string;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/types/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.js.map

package/dist/types/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":""}

package/dist/types/email.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Dynamic variables used to populate an email template.
+ *
+ * Each key should correspond to a variable defined
+ * in the email template.
+ */
+export type EmailTemplateVariables = Record<string, string | number | boolean>;
+/**
+ * Request body for sending a templated email notification.
+ */
+export interface SendEmailTemplateBody {
+    /**
+     * Recipient's email address.
+     *
+     * Example: `test@termii.com`
+     */
+    email: string;
+    /**
+     * Subject line displayed in the recipient's inbox.
+     */
+    subject: string;
+    /**
+     * ID of the email configuration created
+     * on the Termii dashboard.
+     */
+    email_configuration_id: string;
+    /**
+     * ID of the email template created
+     * on the Termii dashboard.
+     */
+    template_id: string;
+    /**
+     * Dynamic values used to populate variables
+     * defined in the email template.
+     *
+     * Example:
+     * {
+     *     name: "Priscilla",
+     *     balance: "333444"
+     * }
+     */
+    variables: EmailTemplateVariables;
+}
+/**
+ * Response returned after successfully
+ * sending a templated email.
+ */
+export interface SendEmailTemplateResponse {
+    /**
+     * Indicates whether the email was successfully sent.
+     */
+    code: "ok";
+    /**
+     * Remaining account balance.
+     *
+     * The API currently returns this value as a string.
+     */
+    balance: string | number;
+    /**
+     * Unique ID of the sent message.
+     */
+    message_id: string;
+    /**
+     * Human-readable response message.
+     */
+    message: string;
+    /**
+     * Name of the user associated with the account.
+     */
+    user: string;
+}
+//# sourceMappingURL=email.d.ts.map

package/dist/types/email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../../src/types/email.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACvC,MAAM,EACN,MAAM,GAAG,MAAM,GAAG,OAAO,CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,SAAS,EAAE,sBAAsB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;OAIG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/dist/types/email.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=email.js.map

package/dist/types/email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.js","sourceRoot":"","sources":["../../src/types/email.ts"],"names":[],"mappings":""}

package/dist/types/sender-id.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Supported Sender ID statuses.
+ */
+export type SenderIdStatus = "active" | "pending" | "blocked";
+/**
+ * Query parameters for fetching Sender IDs.
+ *
+ * Both parameters are optional and can be used to filter
+ * Sender IDs by name and/or registration status.
+ */
+export interface ListSenderIdParams {
+    /**
+     * Filter results by Sender ID name.
+     */
+    name?: string;
+    /**
+     * Filter results by Sender ID status.
+     */
+    status?: SenderIdStatus;
+}
+/**
+ * A registered Sender ID associated with an account.
+ *
+ * `company` and `usecase` are only returned for some
+ * Sender IDs, such as pending registration requests.
+ */
+export interface SenderId {
+    /**
+     * Country associated with the Sender ID.
+     */
+    country: string;
+    /**
+     * Current registration status.
+     */
+    status: SenderIdStatus;
+    /**
+     * Date and time the Sender ID was created.
+     *
+     * Format: YYYY-MM-DD HH:mm:ss
+     */
+    createdAt: string;
+    /**
+     * The registered Sender ID.
+     */
+    sender_id: string;
+    /**
+     * Company associated with the Sender ID.
+     */
+    company?: string;
+    /**
+     * Use case associated with the Sender ID.
+     *
+     * Note: The API returns this property as `usecase`.
+     */
+    usecase?: string;
+}
+/**
+ * Sort information returned by the Sender ID API.
+ */
+export interface SenderIdSort {
+    /**
+     * Whether the sort configuration is empty.
+     */
+    empty: boolean;
+    /**
+     * Whether the results are sorted.
+     */
+    sorted: boolean;
+    /**
+     * Whether the results are unsorted.
+     */
+    unsorted: boolean;
+}
+/**
+ * Pagination information returned by the Sender ID API.
+ */
+export interface SenderIdPageable {
+    sort: SenderIdSort;
+    offset: number;
+    pageNumber: number;
+    pageSize: number;
+    paged: boolean;
+    unpaged: boolean;
+}
+/**
+ * Response returned when fetching Sender IDs.
+ */
+export interface ListSenderIdResponse {
+    content: SenderId[];
+    pageable: SenderIdPageable;
+    totalElements: number;
+    last: boolean;
+    totalPages: number;
+    sort: SenderIdSort;
+    size: number;
+    number: number;
+    first: boolean;
+    numberOfElements: number;
+    empty: boolean;
+}
+/**
+ * Request body for registering a new Sender ID.
+ */
+export interface RequestSenderIdBody {
+    /**
+     * Sender ID to register.
+     *
+     * Can be alphanumeric or numeric.
+     * Alphanumeric Sender IDs must be between 3 and 11 characters.
+     */
+    sender_id: string;
+    /**
+     * A sample of the type of message that will be sent.
+     */
+    use_case: string;
+    /**
+     * Name of the company associated with the Sender ID.
+     */
+    company: string;
+}
+/**
+ * Response returned after submitting a Sender ID registration request.
+ */
+export interface RequestSenderIdResponse {
+    /**
+     * Indicates whether the request was successful.
+     */
+    code: "ok";
+    /**
+     * Confirmation message from the API.
+     */
+    message: string;
+}
+//# sourceMappingURL=sender-id.d.ts.map

package/dist/types/sender-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sender-id.d.ts","sourceRoot":"","sources":["../../src/types/sender-id.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GACpB,QAAQ,GACR,SAAS,GACT,SAAS,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;IAEvB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,YAAY,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;IAEf,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,OAAO,CAAC;IAEf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,OAAO,EAAE,QAAQ,EAAE,CAAC;IAEpB,QAAQ,EAAE,gBAAgB,CAAC;IAE3B,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,OAAO,CAAC;IAEd,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,YAAY,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,OAAO,CAAC;IAEf,gBAAgB,EAAE,MAAM,CAAC;IAEzB,KAAK,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/sender-id.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sender-id.js.map

package/dist/types/sender-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sender-id.js","sourceRoot":"","sources":["../../src/types/sender-id.ts"],"names":[],"mappings":""}

package/dist/types/sms.d.ts

@@ -0,0 +1,173 @@
+export interface SmsRecipient {
+    /**
+     * Destination phone number(s) in international format.
+     *
+     * A maximum of 100 phone numbers can be provided.
+     *
+     * Example: `23490126727`
+     */
+    to: string | string[];
+}
+export interface SmsSender {
+    /**
+     * Sender ID.
+     *
+     * Alphanumeric sender IDs must be between 3 and 11 characters.
+     *
+     * Example: `CompanyName`
+     */
+    from: string;
+}
+export interface SmsContent {
+    /**
+     * Text message to be delivered.
+     *
+     * For voice messages containing verification codes,
+     * add spaces between the digits for better text-to-speech
+     * interpretation.
+     */
+    sms: string;
+}
+export interface SmsEncryptionOptions {
+    /**
+     * Encryption algorithm.
+     *
+     * AES is strongly recommended.
+     */
+    algorithm: string;
+    /**
+     * Secret key used for encryption.
+     */
+    secret_key: string;
+    /**
+     * Initialization vector.
+     *
+     * Required depending on the selected encryption mode.
+     */
+    iv: string;
+}
+export interface SmsMedia {
+    /**
+     * URL of the media resource.
+     */
+    url: string;
+    /**
+     * Optional caption for the media.
+     */
+    caption?: string;
+}
+type SmsBase = SmsRecipient & SmsSender;
+/**
+ * Standard SMS message.
+ */
+export type PlainSmsBody = SmsBase & SmsContent & {
+    channel: "dnd" | "generic";
+    type: "plain";
+};
+/**
+ * Unicode SMS message for special characters
+ * or non-Latin scripts.
+ */
+export type UnicodeSmsBody = SmsBase & SmsContent & {
+    channel: "dnd" | "generic";
+    type: "unicode";
+};
+/**
+ * Encrypted SMS message.
+ */
+export type EncryptedSmsBody = SmsBase & SmsContent & {
+    channel: "dnd" | "generic";
+    type: "encrypted";
+    encryption: SmsEncryptionOptions;
+};
+/**
+ * Voice message.
+ */
+export type VoiceSmsBody = SmsBase & SmsContent & {
+    channel: "voice";
+    type: "voice";
+};
+/**
+ * WhatsApp text message.
+ */
+export type WhatsappTextBody = SmsBase & SmsContent & {
+    channel: "whatsapp";
+    type: "plain";
+};
+/**
+ * WhatsApp media message.
+ *
+ * The `sms` field must not be provided when sending media.
+ */
+export type WhatsappMediaBody = SmsBase & {
+    channel: "whatsapp";
+    type: "plain";
+    media: SmsMedia;
+};
+/**
+ * Request body for sending a single message.
+ */
+export type SendSmsBody = PlainSmsBody | UnicodeSmsBody | EncryptedSmsBody | VoiceSmsBody | WhatsappTextBody | WhatsappMediaBody;
+/**
+ * Base fields shared by bulk SMS requests.
+ */
+type BulkSmsBase = Omit<SmsBase, "to"> & {
+    /**
+     * Destination phone numbers.
+     *
+     * A maximum of 100 phone numbers can be provided.
+     */
+    to: string[];
+};
+/**
+ * Standard bulk SMS message.
+ */
+export type BulkPlainSmsBody = BulkSmsBase & SmsContent & {
+    channel: "dnd" | "generic";
+    type: "plain" | "unicode";
+};
+/**
+ * Encrypted bulk SMS message.
+ */
+export type BulkEncryptedSmsBody = BulkSmsBase & SmsContent & {
+    channel: "dnd" | "generic";
+    type: "encrypted";
+    encryption: SmsEncryptionOptions;
+};
+/**
+ * Request body for bulk SMS.
+ */
+export type BulkSmsBody = BulkPlainSmsBody | BulkEncryptedSmsBody;
+export type SmsChannel = SendSmsBody['channel'];
+export type SmsType = SendSmsBody['type'];
+/**
+ * Successful response returned by the messaging endpoints.
+ */
+export interface SmsResponse {
+    /**
+     * Indicates the result of the request.
+     */
+    code: "ok";
+    /**
+     * Remaining account balance.
+     */
+    balance: number;
+    /**
+     * Unique identifier for the sent message.
+     */
+    message_id: string;
+    /**
+     * Human-readable response message.
+     */
+    message: string;
+    /**
+     * Name of the account user.
+     */
+    user: string;
+    /**
+     * Message ID represented as a string.
+     */
+    message_id_str: string;
+}
+export {};
+//# sourceMappingURL=sms.d.ts.map

package/dist/types/sms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sms.d.ts","sourceRoot":"","sources":["../../src/types/sms.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IACzB;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACtB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACvB;;;;;;OAMG;IACH,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,KAAK,OAAO,GAAG,YAAY,GAAG,SAAS,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAC9B,UAAU,GAAG;IACT,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAChC,UAAU,GAAG;IACT,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,SAAS,CAAC;CACnB,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAClC,UAAU,GAAG;IACT,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE,oBAAoB,CAAC;CACpC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAC9B,UAAU,GAAG;IACT,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAClC,UAAU,GAAG;IACT,OAAO,EAAE,UAAU,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;CACjB,CAAC;AAEN;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG;IACtC,OAAO,EAAE,UAAU,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GACjB,YAAY,GACZ,cAAc,GACd,gBAAgB,GAChB,YAAY,GACZ,gBAAgB,GAChB,iBAAiB,CAAC;AAExB;;GAEG;AACH,KAAK,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG;IACrC;;;;OAIG;IACH,EAAE,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,GACtC,UAAU,GAAG;IACT,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAC1C,UAAU,GAAG;IACT,OAAO,EAAE,KAAK,GAAG,SAAS,CAAC;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,UAAU,EAAE,oBAAoB,CAAC;CACpC,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,WAAW,GACjB,gBAAgB,GAChB,oBAAoB,CAAC;AAG3B,MAAM,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;AAEhD,MAAM,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAG1C;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CAC1B"}

package/dist/types/sms.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sms.js.map

package/dist/types/sms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sms.js","sourceRoot":"","sources":["../../src/types/sms.ts"],"names":[],"mappings":""}

package/dist/types/whatsapp.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Variables used to populate placeholders in a WhatsApp template.
+ *
+ * For authentication (OTP) templates, only `otp` is supported.
+ */
+export type WhatsAppTemplateData = Record<string, string | number>;
+/**
+ * Media attachment included in a WhatsApp template message.
+ */
+export interface WhatsAppTemplateMedia {
+    /**
+     * Caption describing the attached media.
+     */
+    caption: string;
+    /**
+     * Publicly accessible and downloadable URL
+     * of the media file.
+     */
+    url: string;
+}
+/**
+ * Request body for sending a WhatsApp template message.
+ *
+ * Media is optional. When provided, the template message
+ * will include the specified media attachment.
+ */
+export interface SendWhatsAppTemplateBody {
+    /**
+     * Destination phone number in international format.
+     *
+     * Example: `23490126727`
+     */
+    phone_number: string;
+    /**
+     * WhatsApp Device ID.
+     */
+    device_id: string;
+    /**
+     * ID of the approved WhatsApp template.
+     */
+    template_id: string;
+    /**
+     * Variables used to populate the template placeholders.
+     */
+    data: WhatsAppTemplateData;
+    /**
+     * Optional media attachment.
+     *
+     * Authentication (OTP) templates do not support media.
+     */
+    media?: WhatsAppTemplateMedia;
+}
+/**
+ * Response returned after successfully sending
+ * a WhatsApp template message.
+ */
+export interface SendWhatsAppTemplateResponse {
+    /**
+     * Indicates whether the message was successfully sent.
+     */
+    code: "ok";
+    /**
+     * Remaining account balance.
+     */
+    balance: number;
+    /**
+     * Message ID returned by Termii.
+     */
+    message_id: string;
+    /**
+     * Human-readable response message.
+     */
+    message: string;
+    /**
+     * Name of the user associated with the account.
+     */
+    user: string;
+    /**
+     * Message ID returned as a string.
+     */
+    message_id_str: string;
+}
+//# sourceMappingURL=whatsapp.d.ts.map

package/dist/types/whatsapp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whatsapp.d.ts","sourceRoot":"","sources":["../../src/types/whatsapp.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACrC,MAAM,EACN,MAAM,GAAG,MAAM,CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,qBAAqB,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IACzC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CAC1B"}

package/dist/types/whatsapp.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=whatsapp.js.map

package/dist/types/whatsapp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whatsapp.js","sourceRoot":"","sources":["../../src/types/whatsapp.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@ohunkohun/termii-sdk",
+  "version": "1.0.0",
+  "description": "A TypeScript SDK for the Termii API",
+  "scripts": {
+    "dev": "tsx watch examples/server.ts",
+    "build": "tsc",
+    "types:watch": "npx tsc --noEmit --watch",
+    "pack:dry": "npm pack --dry-run",
+    "pack": "npm pack",
+    "publish": "npm publish --access public"
+  },
+  "keywords": ["termii", "sdk", "typescript", "javascript", "node", "js", "ts"],
+  "author": "Ohunkóhun",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+      ".": {
+          "types": "./dist/index.d.ts",
+          "import": "./dist/index.js",
+          "default": "./dist/index.js"
+      }
+  },
+  "files": ["dist"],
+  "dependencies": {
+    "axios": "^1.20.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "@types/node": "^26.5.1",
+    "dotenv": "^17.4.2",
+    "express": "^5.2.1",
+    "tsx": "^4.23.13",
+    "typescript": "^7.0.2"
+  }
+}