mailisk 2.1.1 → 2.2.2

package/README.md

@@ -1,10 +1,11 @@
 # Mailisk Node Client
 
-Mailisk is an end-to-end email testing platform. It allows you to receive emails with code and automate email tests.
+Mailisk is an end-to-end email and SMS testing platform. It allows you to receive emails and SMS messages with code to automate tests.
 
 - Get a unique subdomain and unlimited email addresses for free.
 - Easily automate E2E password reset and account verification by catching emails.
-- Virtual SMTP support to test outbound email without 3rd party clients.
+- Receive SMS messages and automate SMS tests.
+- Virtual SMTP and SMS support to test without 3rd party clients.
 
 ## Get started
 
@@ -52,9 +53,9 @@ console.log(result);
 
 This library wraps the REST API endpoints. Find out more in the [API Reference](https://docs.mailisk.com/api-reference/).
 
-## Client functions
+## Client functions (Email)
 
-### `searchInbox(namespace, params?)`
+### `searchInbox(namespace, params?, requestOptions?)`
 
 Use `searchInbox` to fetch messages that arrived in a given namespace, optionally waiting until the first new mail shows up.
 
@@ -70,13 +71,13 @@ Default behaviour:
 
 ```js
 // wait up to the default 5 min for *any* new mail
-const { data: emails } = await mailisk.searchInbox(namespace);
-
+await mailisk.searchInbox(namespace);
 // custom 60-second timeout
 await mailisk.searchInbox(namespace, {}, { timeout: 1000 * 60 });
-
 // polling pattern — return immediately, even if inbox is empty
 await mailisk.searchInbox(namespace, { wait: false });
+// returns the last 20 emails in the namespace immediately
+await mailisk.searchInbox(namespace, { wait: false, from_timestamp: 0, limit: 20 });
 ```
 
 #### Filter by destination address
@@ -105,17 +106,15 @@ await mailisk.sendVirtualEmail(namespace, {
 });
 ```
 
-This does not call an API endpoint but rather uses nodemailer to send an email using SMTP.
-
 ### `listNamespaces()`
 
 List all namespaces associated with the current API Key.
 
 ```js
-const namespacesResponse = await mailisk.listNamespaces();
+const { data: namespaces } = await mailisk.listNamespaces();
 
 // will be ['namespace1', 'namespace2']
-const namespaces = namespacesResponse.map((nr) => nr.namespace);
+const namespacesList = namespaces.map((nr) => nr.namespace);
 ```
 
 ### `getAttachment(attachmentId)`
@@ -158,3 +157,56 @@ const res = await fetch(meta.download_url);
 const fileStream = fs.createWriteStream(filename);
 await new Promise((ok, err) => res.body.pipe(fileStream).on("finish", ok).on("error", err));
 ```
+
+## Client functions (SMS)
+
+### `searchSmsMessages(phoneNumber, params?, requestOptions?)`
+
+Fetch recent SMS messages that were delivered to one of your Mailisk phone numbers.  
+For the full parameter list see the [Search SMS reference](https://docs.mailisk.com/api-reference/search-sms-messages.html#request).
+
+Default behaviour:
+
+- Waits until at least one SMS matches the filters (override with `wait: false`).
+- Times out after 5 minutes if nothing shows up (adjust via `requestOptions.timeout`).
+- Ignores messages older than 15 minutes (change via `from_date`).
+
+#### Quick examples
+
+```js
+// get or wait for SMS messages sent to ths number
+const { data: sms } = await mailisk.searchSmsMessages(phoneNumber);
+
+// look for a verification code coming from a known sender
+await mailisk.searchSmsMessages(phoneNumber, {
+  from_number: "+1800555",
+  body: "Your code",
+});
+
+// polling pattern — return immediately even if nothing matched
+await mailisk.searchSmsMessages(
+  phoneNumber,
+  { wait: false, limit: 10, from_date: new Date(Date.now() - 1000 * 60 * 5).toISOString() },
+  { timeout: 10_000 }
+);
+```
+
+### `listSmsNumbers()`
+
+List all SMS phone numbers associated with the current account.
+
+```js
+const { data: phoneNumbers } = await mailisk.listSmsNumbers();
+```
+
+### `sendVirtualSms(params)`
+
+Send a virtual SMS message to a phone number you have access to.
+
+```js
+await mailisk.sendVirtualSms({
+  from_number: "15551234567",
+  to_number: "15557654321",
+  body: "Test message",
+});
+```

package/dist/index.d.ts

@@ -47,6 +47,40 @@ interface Email {
     /** The attachments of the email */
     attachments?: EmailAttachment[];
 }
+interface SmsMessage {
+    /** Unique identifier for the message */
+    id: string;
+    /** Unique identifier for the SMS phone number */
+    sms_phone_number_id: string;
+    /** Body of the message */
+    body: string;
+    /** From number of the message */
+    from_number: string;
+    /** To number of the message */
+    to_number: string;
+    /** Provider message ID */
+    provider_message_id?: string;
+    /** Date and time the message was created */
+    created_at: string;
+    /** Direction of the message */
+    direction: "inbound" | "outbound";
+}
+interface SmsNumber {
+    /** Unique identifier for the SMS number */
+    id: string;
+    /** Unique identifier for the organisation */
+    organisation_id: string;
+    /** Status of the SMS number */
+    status: "requested" | "active" | "disabled";
+    /** Country of the SMS number */
+    country: string;
+    /** SMS Phone number */
+    phone_number?: string;
+    /** Date and time the SMS number was created */
+    created_at: string;
+    /** Date and time the SMS number was updated */
+    updated_at: string;
+}
 interface SearchInboxParams {
     /**
      * The maximum number of emails that can be returned in this request, used alongside `offset` for pagination.
@@ -122,12 +156,11 @@ interface GetAttachmentResponse {
     };
 }
 interface ListNamespacesResponse {
-    data: [
-        {
-            id: string;
-            namespace: string;
-        }
-    ];
+    total_count: number;
+    data: {
+        id: string;
+        namespace: string;
+    }[];
 }
 interface SendVirtualEmailParams {
     /** Sender of email */
@@ -149,6 +182,55 @@ interface SendVirtualEmailParams {
     /** Attachments to the email */
     attachments?: Attachment[];
 }
+interface SearchSmsMessagesParams {
+    /**
+     * The maximum number of SMS messages returned (1-100), used alongside `offset` for pagination.
+     */
+    limit?: number;
+    /**
+     * The number of SMS messages to skip/ignore, used alongside `limit` for pagination.
+     */
+    offset?: number;
+    /**
+     * Filter messages by body contents (case insensitive).
+     */
+    body?: string;
+    /**
+     * Filter messages by sender phone number prefix.
+     */
+    from_number?: string;
+    /**
+     * Filter messages created on or after this date.
+     * Provide an ISO 8601 timestamp string.
+     */
+    from_date?: string;
+    /**
+     * Filter messages created on or before this date.
+     * Provide an ISO 8601 timestamp string.
+     */
+    to_date?: string;
+    /**
+     * When true, keep the request open until at least one SMS is returned.
+     */
+    wait?: boolean;
+}
+interface SearchSmsMessagesResponse {
+    total_count: number;
+    options: SearchSmsMessagesParams;
+    data: SmsMessage[];
+}
+interface ListSmsNumbersResponse {
+    total_count: number;
+    data: SmsNumber[];
+}
+interface SendVirtualSmsParams {
+    /** The phone number to send the SMS from */
+    from_number: string;
+    /** The phone number to send the SMS to */
+    to_number: string;
+    /** The body of the SMS message */
+    body: string;
+}
 
 declare class MailiskClient {
     constructor({ apiKey, baseUrl, auth }: {
@@ -157,6 +239,27 @@ declare class MailiskClient {
         auth?: AxiosBasicCredentials;
     });
     private readonly axiosInstance;
+    /**
+     * Search SMS messages sent to a phone number.
+     *
+     * @example
+     * Search for SMS messages sent to a phone number
+     * ```typescript
+     * const { data: smsMessages } = await client.searchSmsMessages("1234567890");
+     * ```
+     */
+    searchSmsMessages(phoneNumber: string, params?: SearchSmsMessagesParams, config?: AxiosRequestConfig): Promise<SearchSmsMessagesResponse>;
+    /**
+     * List all SMS phone numbers associated with the current account.
+     *
+     * @example
+     * List all SMS phone numbers
+     * ```typescript
+     * const { data: smsNumbers } = await client.listSmsNumbers();
+     * ```
+     */
+    listSmsNumbers(): Promise<ListSmsNumbersResponse>;
+    sendVirtualSms(params: SendVirtualSmsParams): Promise<void>;
     /**
      * List all namespaces that belong to the current account (API key).
      */
@@ -182,12 +285,12 @@ declare class MailiskClient {
      * Search inbox of a namespace.
      *
      * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.
-     * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.
+     * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.
      *
      * Both of these settings can be overriden by passing them in the `params` object.
      *
      * @example
-     * Get the latest emails in the namespace
+     * Get the latest emails
      * ```typescript
      * const { data: emails } = await client.searchInbox(namespace);
      * ```
@@ -196,7 +299,17 @@ declare class MailiskClient {
      * Get the latest emails for a specific email address
      * ```typescript
      * const { data: emails } = await client.searchInbox(namespace, {
-     *  to_addr_prefix: 'john@mynamespace.mailisk.net'
+     *   to_addr_prefix: 'john@mynamespace.mailisk.net'
+     * });
+     * ```
+     *
+     * @example
+     * Get the last 20 emails in the namespace
+     * ```typescript
+     * const { data: emails } = await mailisk.searchInbox(namespace, {
+     *   wait: false,
+     *   from_timestamp: 0,
+     *   limit: 20
      * });
      * ```
      */

package/dist/index.js

@@ -45,6 +45,37 @@ var MailiskClient = class {
     });
   }
   axiosInstance;
+  async searchSmsMessages(phoneNumber, params, config) {
+    let _params = { ...params };
+    if (params?.from_date === void 0 || params?.from_date === null) {
+      _params.from_date = new Date(Date.now() - 15 * 60 * 1e3).toISOString();
+    }
+    if (params?.wait !== false) {
+      _params.wait = true;
+    }
+    let _config = { ...config };
+    if (config?.maxRedirects === void 0) {
+      _config.maxRedirects = 99999;
+    }
+    if (_params.wait && config?.timeout === void 0) {
+      _config.timeout = 1e3 * 60 * 5;
+    }
+    const requestParams = {
+      ..._params,
+      from_date: _params.from_date ?? void 0,
+      to_date: _params.to_date ?? void 0
+    };
+    return (await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {
+      ..._config,
+      params: requestParams
+    })).data;
+  }
+  async listSmsNumbers() {
+    return (await this.axiosInstance.get("api/sms/numbers")).data;
+  }
+  async sendVirtualSms(params) {
+    return (await this.axiosInstance.post("api/sms/virtual", params)).data;
+  }
   async listNamespaces() {
     return (await this.axiosInstance.get("api/namespaces")).data;
   }
@@ -80,10 +111,10 @@ var MailiskClient = class {
       _params.wait = true;
     }
     let _config = { ...config };
-    if (!config?.maxRedirects) {
+    if (config?.maxRedirects === void 0) {
       _config.maxRedirects = 99999;
     }
-    if (_params.wait && !config?.timeout) {
+    if (_params.wait && config?.timeout === void 0) {
       _config.timeout = 1e3 * 60 * 5;
     }
     return (await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/mailisk.ts"],"sourcesContent":["export * from \"./mailisk\";\n","import axios, { AxiosBasicCredentials, AxiosRequestConfig } from \"axios\";\nimport {\n  GetAttachmentResponse,\n  ListNamespacesResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SendVirtualEmailParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl, auth }: { apiKey: string; baseUrl?: string; auth?: AxiosBasicCredentials }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n      auth,\n    });\n  }\n\n  private readonly axiosInstance;\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html, headers, attachments } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n      headers,\n      attachments,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails in the namespace\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *  to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (!config?.maxRedirects) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && !config?.timeout) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n\n  async getAttachment(attachmentId: string): Promise<GetAttachmentResponse> {\n    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);\n    return result.data;\n  }\n\n  /**\n   * Download an attachment from an attachment ID.\n   *\n   * @example\n   * Download an attachment from an email\n   * ```typescript\n   * const attachment = email.attachments[0];\n   * const attachmentBuffer = await client.downloadAttachment(attachment.id);\n   *\n   * // save to file\n   * fs.writeFileSync(attachment.filename, attachmentBuffer);\n   * ```\n   */\n  async downloadAttachment(attachmentId: string): Promise<Buffer> {\n    const result = await this.getAttachment(attachmentId);\n\n    const response = await axios.get(result.data.download_url, { responseType: \"arraybuffer\" });\n    return Buffer.from(response.data);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAiE;AASjE,wBAAuB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,SAAS,KAAK,GAAuE;AACzG,SAAK,gBAAgB,aAAAA,QAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAKjB,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAEzD,UAAM,YAAY,kBAAAC,QAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,MAAM,SAAS,YAAY,IAAI;AAEhE,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAwBA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,CAAC,QAAQ,cAAc;AACzB,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,CAAC,QAAQ,SAAS;AACpC,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,cAAc;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA,EAeA,MAAM,mBAAmB,cAAuC;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,YAAY;AAEpD,UAAM,WAAW,MAAM,aAAAD,QAAM,IAAI,OAAO,KAAK,cAAc,EAAE,cAAc,cAAc,CAAC;AAC1F,WAAO,OAAO,KAAK,SAAS,IAAI;AAAA,EAClC;AACF;AA1Ja;","names":["axios","nodemailer"]}
+{"version":3,"sources":["../src/index.ts","../src/mailisk.ts"],"sourcesContent":["export * from \"./mailisk\";\n","import axios, { AxiosBasicCredentials, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport {\n  GetAttachmentResponse,\n  ListNamespacesResponse,\n  ListSmsNumbersResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SearchSmsMessagesParams,\n  SearchSmsMessagesResponse,\n  SendVirtualEmailParams,\n  SendVirtualSmsParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl, auth }: { apiKey: string; baseUrl?: string; auth?: AxiosBasicCredentials }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n      auth,\n    });\n  }\n\n  private readonly axiosInstance: AxiosInstance;\n\n  /**\n   * Search SMS messages sent to a phone number.\n   *\n   * @example\n   * Search for SMS messages sent to a phone number\n   * ```typescript\n   * const { data: smsMessages } = await client.searchSmsMessages(\"1234567890\");\n   * ```\n   */\n  async searchSmsMessages(\n    phoneNumber: string,\n    params?: SearchSmsMessagesParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchSmsMessagesResponse> {\n    let _params: SearchSmsMessagesParams = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_date === undefined || params?.from_date === null) {\n      _params.from_date = new Date(Date.now() - 15 * 60 * 1000).toISOString();\n    }\n\n    // by default wait for sms\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    const requestParams = {\n      ..._params,\n      from_date: _params.from_date ?? undefined,\n      to_date: _params.to_date ?? undefined,\n    };\n\n    return (\n      await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {\n        ..._config,\n        params: requestParams,\n      })\n    ).data;\n  }\n\n  /**\n   * List all SMS phone numbers associated with the current account.\n   *\n   * @example\n   * List all SMS phone numbers\n   * ```typescript\n   * const { data: smsNumbers } = await client.listSmsNumbers();\n   * ```\n   */\n  async listSmsNumbers(): Promise<ListSmsNumbersResponse> {\n    return (await this.axiosInstance.get(\"api/sms/numbers\")).data;\n  }\n\n  async sendVirtualSms(params: SendVirtualSmsParams): Promise<void> {\n    return (await this.axiosInstance.post(\"api/sms/virtual\", params)).data;\n  }\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html, headers, attachments } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n      headers,\n      attachments,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *   to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   *\n   * @example\n   * Get the last 20 emails in the namespace\n   * ```typescript\n   * const { data: emails } = await mailisk.searchInbox(namespace, {\n   *   wait: false,\n   *   from_timestamp: 0,\n   *   limit: 20\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n\n  async getAttachment(attachmentId: string): Promise<GetAttachmentResponse> {\n    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);\n    return result.data;\n  }\n\n  /**\n   * Download an attachment from an attachment ID.\n   *\n   * @example\n   * Download an attachment from an email\n   * ```typescript\n   * const attachment = email.attachments[0];\n   * const attachmentBuffer = await client.downloadAttachment(attachment.id);\n   *\n   * // save to file\n   * fs.writeFileSync(attachment.filename, attachmentBuffer);\n   * ```\n   */\n  async downloadAttachment(attachmentId: string): Promise<Buffer> {\n    const result = await this.getAttachment(attachmentId);\n\n    const response = await axios.get(result.data.download_url, { responseType: \"arraybuffer\" });\n    return Buffer.from(response.data);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAgF;AAahF,wBAAuB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,SAAS,KAAK,GAAuE;AACzG,SAAK,gBAAgB,aAAAA,QAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAWjB,MAAM,kBACJ,aACA,QACA,QACoC;AACpC,QAAI,UAAmC,EAAE,GAAG,OAAO;AAGnD,QAAI,QAAQ,cAAc,UAAa,QAAQ,cAAc,MAAM;AACjE,cAAQ,YAAY,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,GAAI,EAAE,YAAY;AAAA,IACxE;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,UAAM,gBAAgB;AAAA,MACpB,GAAG;AAAA,MACH,WAAW,QAAQ,aAAa;AAAA,MAChC,SAAS,QAAQ,WAAW;AAAA,IAC9B;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,WAAW,wBAAwB;AAAA,MAC9D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAWA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,iBAAiB,GAAG;AAAA,EAC3D;AAAA,EAEA,MAAM,eAAe,QAA6C;AAChE,YAAQ,MAAM,KAAK,cAAc,KAAK,mBAAmB,MAAM,GAAG;AAAA,EACpE;AAAA,EAKA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAEzD,UAAM,YAAY,kBAAAC,QAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,MAAM,SAAS,YAAY,IAAI;AAEhE,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAkCA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,cAAc;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA,EAeA,MAAM,mBAAmB,cAAuC;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,YAAY;AAEpD,UAAM,WAAW,MAAM,aAAAD,QAAM,IAAI,OAAO,KAAK,cAAc,EAAE,cAAc,cAAc,CAAC;AAC1F,WAAO,OAAO,KAAK,SAAS,IAAI;AAAA,EAClC;AACF;AAxOa;","names":["axios","nodemailer"]}

package/dist/index.mjs

@@ -15,6 +15,37 @@ var MailiskClient = class {
     });
   }
   axiosInstance;
+  async searchSmsMessages(phoneNumber, params, config) {
+    let _params = { ...params };
+    if (params?.from_date === void 0 || params?.from_date === null) {
+      _params.from_date = new Date(Date.now() - 15 * 60 * 1e3).toISOString();
+    }
+    if (params?.wait !== false) {
+      _params.wait = true;
+    }
+    let _config = { ...config };
+    if (config?.maxRedirects === void 0) {
+      _config.maxRedirects = 99999;
+    }
+    if (_params.wait && config?.timeout === void 0) {
+      _config.timeout = 1e3 * 60 * 5;
+    }
+    const requestParams = {
+      ..._params,
+      from_date: _params.from_date ?? void 0,
+      to_date: _params.to_date ?? void 0
+    };
+    return (await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {
+      ..._config,
+      params: requestParams
+    })).data;
+  }
+  async listSmsNumbers() {
+    return (await this.axiosInstance.get("api/sms/numbers")).data;
+  }
+  async sendVirtualSms(params) {
+    return (await this.axiosInstance.post("api/sms/virtual", params)).data;
+  }
   async listNamespaces() {
     return (await this.axiosInstance.get("api/namespaces")).data;
   }
@@ -50,10 +81,10 @@ var MailiskClient = class {
       _params.wait = true;
     }
     let _config = { ...config };
-    if (!config?.maxRedirects) {
+    if (config?.maxRedirects === void 0) {
       _config.maxRedirects = 99999;
     }
-    if (_params.wait && !config?.timeout) {
+    if (_params.wait && config?.timeout === void 0) {
       _config.timeout = 1e3 * 60 * 5;
     }
     return (await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/mailisk.ts"],"sourcesContent":["import axios, { AxiosBasicCredentials, AxiosRequestConfig } from \"axios\";\nimport {\n  GetAttachmentResponse,\n  ListNamespacesResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SendVirtualEmailParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl, auth }: { apiKey: string; baseUrl?: string; auth?: AxiosBasicCredentials }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n      auth,\n    });\n  }\n\n  private readonly axiosInstance;\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html, headers, attachments } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n      headers,\n      attachments,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails in the namespace\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *  to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (!config?.maxRedirects) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && !config?.timeout) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n\n  async getAttachment(attachmentId: string): Promise<GetAttachmentResponse> {\n    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);\n    return result.data;\n  }\n\n  /**\n   * Download an attachment from an attachment ID.\n   *\n   * @example\n   * Download an attachment from an email\n   * ```typescript\n   * const attachment = email.attachments[0];\n   * const attachmentBuffer = await client.downloadAttachment(attachment.id);\n   *\n   * // save to file\n   * fs.writeFileSync(attachment.filename, attachmentBuffer);\n   * ```\n   */\n  async downloadAttachment(attachmentId: string): Promise<Buffer> {\n    const result = await this.getAttachment(attachmentId);\n\n    const response = await axios.get(result.data.download_url, { responseType: \"arraybuffer\" });\n    return Buffer.from(response.data);\n  }\n}\n"],"mappings":";;;;AAAA,OAAO,WAA0D;AASjE,OAAO,gBAAgB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,SAAS,KAAK,GAAuE;AACzG,SAAK,gBAAgB,MAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAKjB,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAEzD,UAAM,YAAY,WAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,MAAM,SAAS,YAAY,IAAI;AAEhE,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAwBA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,CAAC,QAAQ,cAAc;AACzB,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,CAAC,QAAQ,SAAS;AACpC,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,cAAc;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA,EAeA,MAAM,mBAAmB,cAAuC;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,YAAY;AAEpD,UAAM,WAAW,MAAM,MAAM,IAAI,OAAO,KAAK,cAAc,EAAE,cAAc,cAAc,CAAC;AAC1F,WAAO,OAAO,KAAK,SAAS,IAAI;AAAA,EAClC;AACF;AA1Ja;","names":[]}
+{"version":3,"sources":["../src/mailisk.ts"],"sourcesContent":["import axios, { AxiosBasicCredentials, AxiosInstance, AxiosRequestConfig } from \"axios\";\nimport {\n  GetAttachmentResponse,\n  ListNamespacesResponse,\n  ListSmsNumbersResponse,\n  SearchInboxParams,\n  SearchInboxResponse,\n  SearchSmsMessagesParams,\n  SearchSmsMessagesResponse,\n  SendVirtualEmailParams,\n  SendVirtualSmsParams,\n  SmtpSettings,\n} from \"./mailisk.interfaces\";\nimport nodemailer from \"nodemailer\";\n\nexport class MailiskClient {\n  constructor({ apiKey, baseUrl, auth }: { apiKey: string; baseUrl?: string; auth?: AxiosBasicCredentials }) {\n    this.axiosInstance = axios.create({\n      headers: {\n        \"X-Api-Key\": apiKey,\n      },\n      baseURL: baseUrl || \"https://api.mailisk.com/\",\n      auth,\n    });\n  }\n\n  private readonly axiosInstance: AxiosInstance;\n\n  /**\n   * Search SMS messages sent to a phone number.\n   *\n   * @example\n   * Search for SMS messages sent to a phone number\n   * ```typescript\n   * const { data: smsMessages } = await client.searchSmsMessages(\"1234567890\");\n   * ```\n   */\n  async searchSmsMessages(\n    phoneNumber: string,\n    params?: SearchSmsMessagesParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchSmsMessagesResponse> {\n    let _params: SearchSmsMessagesParams = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_date === undefined || params?.from_date === null) {\n      _params.from_date = new Date(Date.now() - 15 * 60 * 1000).toISOString();\n    }\n\n    // by default wait for sms\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    const requestParams = {\n      ..._params,\n      from_date: _params.from_date ?? undefined,\n      to_date: _params.to_date ?? undefined,\n    };\n\n    return (\n      await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {\n        ..._config,\n        params: requestParams,\n      })\n    ).data;\n  }\n\n  /**\n   * List all SMS phone numbers associated with the current account.\n   *\n   * @example\n   * List all SMS phone numbers\n   * ```typescript\n   * const { data: smsNumbers } = await client.listSmsNumbers();\n   * ```\n   */\n  async listSmsNumbers(): Promise<ListSmsNumbersResponse> {\n    return (await this.axiosInstance.get(\"api/sms/numbers\")).data;\n  }\n\n  async sendVirtualSms(params: SendVirtualSmsParams): Promise<void> {\n    return (await this.axiosInstance.post(\"api/sms/virtual\", params)).data;\n  }\n\n  /**\n   * List all namespaces that belong to the current account (API key).\n   */\n  async listNamespaces(): Promise<ListNamespacesResponse> {\n    return (await this.axiosInstance.get(\"api/namespaces\")).data;\n  }\n\n  /**\n   * Send an email using the Virtual SMTP.\n   *\n   * These emails can only be sent to valid Mailisk namespaces, i.e. emails that end in @mynamespace.mailisk.net\n   *\n   * @example\n   * For example, sending a test email:\n   * ```typescript\n   * client.sendVirtualEmail(namespace, {\n   *   from: \"test@example.com\",\n   *   to: `john@${namespace}.mailisk.net`,\n   *   subject: \"This is a test\",\n   *   text: \"Testing\",\n   * });\n   * ```\n   */\n  async sendVirtualEmail(namespace: string, params: SendVirtualEmailParams): Promise<void> {\n    const smtpSettings = await this.getSmtpSettings(namespace);\n\n    const transport = nodemailer.createTransport({\n      host: smtpSettings.data.host,\n      port: smtpSettings.data.port,\n      secure: false,\n      auth: {\n        user: smtpSettings.data.username,\n        pass: smtpSettings.data.password,\n      },\n    });\n\n    const { from, to, subject, text, html, headers, attachments } = params;\n\n    await transport.sendMail({\n      from,\n      to,\n      subject,\n      text,\n      html,\n      headers,\n      attachments,\n    });\n\n    transport.close();\n  }\n\n  /**\n   * Search inbox of a namespace.\n   *\n   * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.\n   * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.\n   *\n   * Both of these settings can be overriden by passing them in the `params` object.\n   *\n   * @example\n   * Get the latest emails\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace);\n   * ```\n   *\n   * @example\n   * Get the latest emails for a specific email address\n   * ```typescript\n   * const { data: emails } = await client.searchInbox(namespace, {\n   *   to_addr_prefix: 'john@mynamespace.mailisk.net'\n   * });\n   * ```\n   *\n   * @example\n   * Get the last 20 emails in the namespace\n   * ```typescript\n   * const { data: emails } = await mailisk.searchInbox(namespace, {\n   *   wait: false,\n   *   from_timestamp: 0,\n   *   limit: 20\n   * });\n   * ```\n   */\n  async searchInbox(\n    namespace: string,\n    params?: SearchInboxParams,\n    config?: AxiosRequestConfig\n  ): Promise<SearchInboxResponse> {\n    let _params = { ...params };\n\n    // default from timestamp, 15 minutes before starting this request\n    if (params?.from_timestamp === undefined || params?.from_timestamp === null) {\n      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;\n    }\n\n    // by default wait for email\n    if (params?.wait !== false) {\n      _params.wait = true;\n    }\n\n    let _config = { ...config };\n\n    if (config?.maxRedirects === undefined) {\n      _config.maxRedirects = 99999;\n    }\n\n    // by default, wait 5 minutes for emails before timing out\n    if (_params.wait && config?.timeout === undefined) {\n      _config.timeout = 1000 * 60 * 5;\n    }\n\n    return (\n      await this.axiosInstance.get(`api/emails/${namespace}/inbox`, {\n        ..._config,\n        params: _params,\n      })\n    ).data;\n  }\n\n  /**\n   * Get the SMTP settings for a namespace.\n   */\n  async getSmtpSettings(namespace: string): Promise<SmtpSettings> {\n    const result = await this.axiosInstance.get(`api/smtp/${namespace}`);\n    return result.data;\n  }\n\n  async getAttachment(attachmentId: string): Promise<GetAttachmentResponse> {\n    const result = await this.axiosInstance.get(`api/attachments/${attachmentId}`);\n    return result.data;\n  }\n\n  /**\n   * Download an attachment from an attachment ID.\n   *\n   * @example\n   * Download an attachment from an email\n   * ```typescript\n   * const attachment = email.attachments[0];\n   * const attachmentBuffer = await client.downloadAttachment(attachment.id);\n   *\n   * // save to file\n   * fs.writeFileSync(attachment.filename, attachmentBuffer);\n   * ```\n   */\n  async downloadAttachment(attachmentId: string): Promise<Buffer> {\n    const result = await this.getAttachment(attachmentId);\n\n    const response = await axios.get(result.data.download_url, { responseType: \"arraybuffer\" });\n    return Buffer.from(response.data);\n  }\n}\n"],"mappings":";;;;AAAA,OAAO,WAAyE;AAahF,OAAO,gBAAgB;AAEhB,IAAM,gBAAN,MAAoB;AAAA,EACzB,YAAY,EAAE,QAAQ,SAAS,KAAK,GAAuE;AACzG,SAAK,gBAAgB,MAAM,OAAO;AAAA,MAChC,SAAS;AAAA,QACP,aAAa;AAAA,MACf;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEiB;AAAA,EAWjB,MAAM,kBACJ,aACA,QACA,QACoC;AACpC,QAAI,UAAmC,EAAE,GAAG,OAAO;AAGnD,QAAI,QAAQ,cAAc,UAAa,QAAQ,cAAc,MAAM;AACjE,cAAQ,YAAY,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,GAAI,EAAE,YAAY;AAAA,IACxE;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,UAAM,gBAAgB;AAAA,MACpB,GAAG;AAAA,MACH,WAAW,QAAQ,aAAa;AAAA,MAChC,SAAS,QAAQ,WAAW;AAAA,IAC9B;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,WAAW,wBAAwB;AAAA,MAC9D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAWA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,iBAAiB,GAAG;AAAA,EAC3D;AAAA,EAEA,MAAM,eAAe,QAA6C;AAChE,YAAQ,MAAM,KAAK,cAAc,KAAK,mBAAmB,MAAM,GAAG;AAAA,EACpE;AAAA,EAKA,MAAM,iBAAkD;AACtD,YAAQ,MAAM,KAAK,cAAc,IAAI,gBAAgB,GAAG;AAAA,EAC1D;AAAA,EAkBA,MAAM,iBAAiB,WAAmB,QAA+C;AACvF,UAAM,eAAe,MAAM,KAAK,gBAAgB,SAAS;AAEzD,UAAM,YAAY,WAAW,gBAAgB;AAAA,MAC3C,MAAM,aAAa,KAAK;AAAA,MACxB,MAAM,aAAa,KAAK;AAAA,MACxB,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ,MAAM,aAAa,KAAK;AAAA,QACxB,MAAM,aAAa,KAAK;AAAA,MAC1B;AAAA,IACF,CAAC;AAED,UAAM,EAAE,MAAM,IAAI,SAAS,MAAM,MAAM,SAAS,YAAY,IAAI;AAEhE,UAAM,UAAU,SAAS;AAAA,MACvB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,cAAU,MAAM;AAAA,EAClB;AAAA,EAkCA,MAAM,YACJ,WACA,QACA,QAC8B;AAC9B,QAAI,UAAU,EAAE,GAAG,OAAO;AAG1B,QAAI,QAAQ,mBAAmB,UAAa,QAAQ,mBAAmB,MAAM;AAC3E,cAAQ,iBAAiB,KAAK,MAAM,IAAI,KAAK,EAAE,QAAQ,IAAI,GAAI,IAAI,KAAK;AAAA,IAC1E;AAGA,QAAI,QAAQ,SAAS,OAAO;AAC1B,cAAQ,OAAO;AAAA,IACjB;AAEA,QAAI,UAAU,EAAE,GAAG,OAAO;AAE1B,QAAI,QAAQ,iBAAiB,QAAW;AACtC,cAAQ,eAAe;AAAA,IACzB;AAGA,QAAI,QAAQ,QAAQ,QAAQ,YAAY,QAAW;AACjD,cAAQ,UAAU,MAAO,KAAK;AAAA,IAChC;AAEA,YACE,MAAM,KAAK,cAAc,IAAI,cAAc,mBAAmB;AAAA,MAC5D,GAAG;AAAA,MACH,QAAQ;AAAA,IACV,CAAC,GACD;AAAA,EACJ;AAAA,EAKA,MAAM,gBAAgB,WAA0C;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,YAAY,WAAW;AACnE,WAAO,OAAO;AAAA,EAChB;AAAA,EAEA,MAAM,cAAc,cAAsD;AACxE,UAAM,SAAS,MAAM,KAAK,cAAc,IAAI,mBAAmB,cAAc;AAC7E,WAAO,OAAO;AAAA,EAChB;AAAA,EAeA,MAAM,mBAAmB,cAAuC;AAC9D,UAAM,SAAS,MAAM,KAAK,cAAc,YAAY;AAEpD,UAAM,WAAW,MAAM,MAAM,IAAI,OAAO,KAAK,cAAc,EAAE,cAAc,cAAc,CAAC;AAC1F,WAAO,OAAO,KAAK,SAAS,IAAI;AAAA,EAClC;AACF;AAxOa;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailisk",
-  "version": "2.1.1",
+  "version": "2.2.2",
   "description": "Mailisk library for NodeJS",
   "keywords": [
     "mailisk",
@@ -26,7 +26,7 @@
     "jest-mock-axios": "^4.8.0",
     "ts-jest": "^29.2.6",
     "tsup": "^6.2.3",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.5"
   },
   "dependencies": {
     "axios": "^1.1.2",

package/src/mailisk.interfaces.ts

@@ -49,6 +49,42 @@ export interface Email {
   attachments?: EmailAttachment[];
 }
 
+export interface SmsMessage {
+  /** Unique identifier for the message */
+  id: string;
+  /** Unique identifier for the SMS phone number */
+  sms_phone_number_id: string;
+  /** Body of the message */
+  body: string;
+  /** From number of the message */
+  from_number: string;
+  /** To number of the message */
+  to_number: string;
+  /** Provider message ID */
+  provider_message_id?: string;
+  /** Date and time the message was created */
+  created_at: string;
+  /** Direction of the message */
+  direction: "inbound" | "outbound";
+}
+
+export interface SmsNumber {
+  /** Unique identifier for the SMS number */
+  id: string;
+  /** Unique identifier for the organisation */
+  organisation_id: string;
+  /** Status of the SMS number */
+  status: "requested" | "active" | "disabled";
+  /** Country of the SMS number */
+  country: string;
+  /** SMS Phone number */
+  phone_number?: string;
+  /** Date and time the SMS number was created */
+  created_at: string;
+  /** Date and time the SMS number was updated */
+  updated_at: string;
+}
+
 export interface SearchInboxParams {
   /**
    * The maximum number of emails that can be returned in this request, used alongside `offset` for pagination.
@@ -128,12 +164,8 @@ export interface GetAttachmentResponse {
 }
 
 export interface ListNamespacesResponse {
-  data: [
-    {
-      id: string;
-      namespace: string;
-    }
-  ];
+  total_count: number;
+  data: { id: string; namespace: string }[];
 }
 
 export interface SendVirtualEmailParams {
@@ -156,3 +188,56 @@ export interface SendVirtualEmailParams {
   /** Attachments to the email */
   attachments?: Attachment[];
 }
+
+export interface SearchSmsMessagesParams {
+  /**
+   * The maximum number of SMS messages returned (1-100), used alongside `offset` for pagination.
+   */
+  limit?: number;
+  /**
+   * The number of SMS messages to skip/ignore, used alongside `limit` for pagination.
+   */
+  offset?: number;
+  /**
+   * Filter messages by body contents (case insensitive).
+   */
+  body?: string;
+  /**
+   * Filter messages by sender phone number prefix.
+   */
+  from_number?: string;
+  /**
+   * Filter messages created on or after this date.
+   * Provide an ISO 8601 timestamp string.
+   */
+  from_date?: string;
+  /**
+   * Filter messages created on or before this date.
+   * Provide an ISO 8601 timestamp string.
+   */
+  to_date?: string;
+  /**
+   * When true, keep the request open until at least one SMS is returned.
+   */
+  wait?: boolean;
+}
+
+export interface SearchSmsMessagesResponse {
+  total_count: number;
+  options: SearchSmsMessagesParams;
+  data: SmsMessage[];
+}
+
+export interface ListSmsNumbersResponse {
+  total_count: number;
+  data: SmsNumber[];
+}
+
+export interface SendVirtualSmsParams {
+  /** The phone number to send the SMS from */
+  from_number: string;
+  /** The phone number to send the SMS to */
+  to_number: string;
+  /** The body of the SMS message */
+  body: string;
+}

package/src/mailisk.ts

@@ -1,10 +1,14 @@
-import axios, { AxiosBasicCredentials, AxiosRequestConfig } from "axios";
+import axios, { AxiosBasicCredentials, AxiosInstance, AxiosRequestConfig } from "axios";
 import {
   GetAttachmentResponse,
   ListNamespacesResponse,
+  ListSmsNumbersResponse,
   SearchInboxParams,
   SearchInboxResponse,
+  SearchSmsMessagesParams,
+  SearchSmsMessagesResponse,
   SendVirtualEmailParams,
+  SendVirtualSmsParams,
   SmtpSettings,
 } from "./mailisk.interfaces";
 import nodemailer from "nodemailer";
@@ -20,7 +24,75 @@ export class MailiskClient {
     });
   }
 
-  private readonly axiosInstance;
+  private readonly axiosInstance: AxiosInstance;
+
+  /**
+   * Search SMS messages sent to a phone number.
+   *
+   * @example
+   * Search for SMS messages sent to a phone number
+   * ```typescript
+   * const { data: smsMessages } = await client.searchSmsMessages("1234567890");
+   * ```
+   */
+  async searchSmsMessages(
+    phoneNumber: string,
+    params?: SearchSmsMessagesParams,
+    config?: AxiosRequestConfig
+  ): Promise<SearchSmsMessagesResponse> {
+    let _params: SearchSmsMessagesParams = { ...params };
+
+    // default from timestamp, 15 minutes before starting this request
+    if (params?.from_date === undefined || params?.from_date === null) {
+      _params.from_date = new Date(Date.now() - 15 * 60 * 1000).toISOString();
+    }
+
+    // by default wait for sms
+    if (params?.wait !== false) {
+      _params.wait = true;
+    }
+
+    let _config = { ...config };
+
+    if (config?.maxRedirects === undefined) {
+      _config.maxRedirects = 99999;
+    }
+
+    // by default, wait 5 minutes for emails before timing out
+    if (_params.wait && config?.timeout === undefined) {
+      _config.timeout = 1000 * 60 * 5;
+    }
+
+    const requestParams = {
+      ..._params,
+      from_date: _params.from_date ?? undefined,
+      to_date: _params.to_date ?? undefined,
+    };
+
+    return (
+      await this.axiosInstance.get(`api/sms/${phoneNumber}/messages`, {
+        ..._config,
+        params: requestParams,
+      })
+    ).data;
+  }
+
+  /**
+   * List all SMS phone numbers associated with the current account.
+   *
+   * @example
+   * List all SMS phone numbers
+   * ```typescript
+   * const { data: smsNumbers } = await client.listSmsNumbers();
+   * ```
+   */
+  async listSmsNumbers(): Promise<ListSmsNumbersResponse> {
+    return (await this.axiosInstance.get("api/sms/numbers")).data;
+  }
+
+  async sendVirtualSms(params: SendVirtualSmsParams): Promise<void> {
+    return (await this.axiosInstance.post("api/sms/virtual", params)).data;
+  }
 
   /**
    * List all namespaces that belong to the current account (API key).
@@ -77,12 +149,12 @@ export class MailiskClient {
    * Search inbox of a namespace.
    *
    * By default, this calls the api using the `wait` flag. This means the call won't timeout until at least one email is received or 5 minutes pass.
-   * It also uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored.
+   * It also uses a default `from_timestamp` of **current timestamp - 15 minutes**. This means that older emails will be ignored.
    *
    * Both of these settings can be overriden by passing them in the `params` object.
    *
    * @example
-   * Get the latest emails in the namespace
+   * Get the latest emails
    * ```typescript
    * const { data: emails } = await client.searchInbox(namespace);
    * ```
@@ -91,7 +163,17 @@ export class MailiskClient {
    * Get the latest emails for a specific email address
    * ```typescript
    * const { data: emails } = await client.searchInbox(namespace, {
-   *  to_addr_prefix: 'john@mynamespace.mailisk.net'
+   *   to_addr_prefix: 'john@mynamespace.mailisk.net'
+   * });
+   * ```
+   *
+   * @example
+   * Get the last 20 emails in the namespace
+   * ```typescript
+   * const { data: emails } = await mailisk.searchInbox(namespace, {
+   *   wait: false,
+   *   from_timestamp: 0,
+   *   limit: 20
    * });
    * ```
    */
@@ -114,12 +196,12 @@ export class MailiskClient {
 
     let _config = { ...config };
 
-    if (!config?.maxRedirects) {
+    if (config?.maxRedirects === undefined) {
       _config.maxRedirects = 99999;
     }
 
     // by default, wait 5 minutes for emails before timing out
-    if (_params.wait && !config?.timeout) {
+    if (_params.wait && config?.timeout === undefined) {
       _config.timeout = 1000 * 60 * 5;
     }
 

package/tests/mocks/axios-mocks.ts

@@ -1,9 +1,10 @@
 // Mock namespace response data
 export const mockNamespacesResponse = {
-  namespaces: [
+  total_count: 1,
+  data: [
     {
-      name: "test-namespace",
-      created_at: new Date().toISOString(),
+      id: "0fde5afa-a8a8-41a4-9ca4-21d83efc37d8",
+      namespace: "test-namespace",
       expires_at: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
     },
   ],
@@ -11,39 +12,97 @@ export const mockNamespacesResponse = {
 
 // Mock email response data
 export const mockEmailsResponse = {
-  emails: [
+  total_count: 1,
+  options: {
+    wait: true,
+  },
+  data: [
     {
-      id: "email-123",
-      from: { address: "sender@example.com", name: "Sender" },
-      to: [{ address: "recipient@test-namespace.mailisk.net", name: "Recipient" }],
-      subject: "Test Email",
-      html: "<p>Test content</p>",
-      text: "Test content",
-      received_date: new Date().toISOString(),
-      received_timestamp: Math.floor(Date.now() / 1000),
-      expires_timestamp: Math.floor(Date.now() / 1000) + 30 * 24 * 60 * 60,
+      id: "1763808382384-m-m-dEmYI7ic5",
+      from: {
+        address: "sender@example.com",
+        name: "Sender",
+      },
+      to: [
+        {
+          address: "recipient@test-namespace.mailisk.net",
+          name: "Recipient",
+        },
+      ],
+      subject: "test",
+      html: "false",
+      text: "test",
+      received_date: "2025-11-22T10:46:22.000Z",
+      received_timestamp: 1763808382,
+      expires_timestamp: 1764672382,
+      spam_score: null,
     },
   ],
-  count: 1,
 };
 
 // Mock attachment response data
 export const mockAttachmentResponse = {
-  id: "attachment-123",
-  filename: "test.txt",
-  content_type: "text/plain",
-  size: 100,
-  expires_at: "Fri, 23 Jun 2025 02:29:13 GMT",
-  download_url: "https://example.com/attachment-123.txt",
+  data: {
+    id: "b04730be-9c13-4f23-a2b7-a4a9a943cd31",
+    filename: "Sample.png",
+    content_type: "image/png",
+    size: 140551,
+    expires_at: "2025-09-09T10:03:33.000Z",
+    download_url: "url",
+  },
 };
 
 // Mock SMTP settings response
 export const mockSmtpSettingsResponse = {
-  host: "smtp.mailisk.com",
-  port: 25,
-  secure: false,
-  auth: {
-    user: "test-namespace",
-    pass: "mock-password",
+  data: {
+    host: "smtp.mailisk.net",
+    port: 587,
+    username: "test-namespace",
+    password: "mock-password",
+  },
+};
+
+// Mock SMS messages response data
+export const mockSmsMessagesResponse = {
+  total_count: 1,
+  options: {
+    limit: 20,
+    offset: 0,
   },
+  data: [
+    {
+      id: "37a2bc57-c2c7-4c08-a9dc-d143bc17643f",
+      sms_phone_number_id: "ba548be2-bff9-4e3f-a54b-e034c415e906",
+      body: "test newline \\n\\n test2",
+      from_number: "+18777804236",
+      to_number: "+19285639871",
+      provider_message_id: "SMf72eb72b6281a02e60a0114f38e34e36",
+      created_at: "2020-11-24T16:48:22.170Z",
+      direction: "inbound",
+    },
+  ],
+};
+
+// Mock SMS numbers response data
+export const mockSmsNumbersResponse = {
+  total_count: 2,
+  data: [
+    {
+      id: "13c4551e-a5be-4959-9ea5-82931dcfc74d",
+      organisation_id: "c02bdb84-22df-4c18-85ba-2defdd04eccb",
+      status: "requested",
+      country: "US",
+      created_at: "2020-11-22T16:59:25.462Z",
+      updated_at: "2020-11-22T16:59:25.462Z",
+    },
+    {
+      id: "6bf073d6-d333-45c9-b009-c77f0cac7657",
+      organisation_id: "ddec2c7b-b087-45b6-a81d-b195f25d457f",
+      status: "active",
+      country: "US",
+      phone_number: "+19285639871",
+      created_at: "2020-11-22T16:41:40.329Z",
+      updated_at: "2020-11-22T16:41:40.329Z",
+    },
+  ],
 };

package/tests/unit/mailisk.test.ts

@@ -9,6 +9,8 @@ import {
   mockEmailsResponse,
   mockSmtpSettingsResponse,
   mockAttachmentResponse,
+  mockSmsMessagesResponse,
+  mockSmsNumbersResponse,
 } from "../mocks/axios-mocks";
 
 const setupMockAxios = () => {
@@ -132,7 +134,7 @@ describe("MailiskClient", () => {
   describe("downloadAttachment", () => {
     it("should download and return attachment data", async () => {
       const getAttachmentSpy = jest.spyOn(MailiskClient.prototype, "getAttachment");
-      getAttachmentSpy.mockResolvedValueOnce({ data: mockAttachmentResponse });
+      getAttachmentSpy.mockResolvedValueOnce(mockAttachmentResponse);
 
       const mockBuffer = Buffer.from("test content");
       (axios.get as jest.Mock).mockResolvedValueOnce({ data: mockBuffer });
@@ -140,11 +142,145 @@ describe("MailiskClient", () => {
       const client = new MailiskClient({ apiKey: "test-key" });
       const result = await client.downloadAttachment("attachment-123");
 
-      expect(axios.get).toHaveBeenCalledWith(mockAttachmentResponse.download_url, { responseType: "arraybuffer" });
+      expect(axios.get).toHaveBeenCalledWith(mockAttachmentResponse.data.download_url, { responseType: "arraybuffer" });
       expect(result).toEqual(mockBuffer);
     });
   });
 
+  describe("searchSmsMessages", () => {
+    it("should fetch and return SMS messages with default parameters", async () => {
+      const { mockGet } = setupMockAxios();
+      mockGet.mockResolvedValueOnce({ data: mockSmsMessagesResponse });
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+      const result = await client.searchSmsMessages("1234567890");
+
+      expect(mockGet).toHaveBeenCalledWith("api/sms/1234567890/messages", {
+        maxRedirects: 99999,
+        timeout: 1000 * 60 * 5,
+        params: {
+          from_date: expect.any(String),
+          wait: true,
+        },
+      });
+
+      expect(result).toEqual(mockSmsMessagesResponse);
+    });
+
+    it("should use custom parameters if provided", async () => {
+      const { mockGet } = setupMockAxios();
+      mockGet.mockResolvedValueOnce({ data: mockSmsMessagesResponse });
+
+      const customParams = {
+        limit: 5,
+        offset: 2,
+        body: "verification",
+        from_number: "+18005550123",
+        from_date: "2023-01-01T00:00:00.000Z",
+        to_date: "2023-02-01T00:00:00.000Z",
+        wait: false,
+      };
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+      const result = await client.searchSmsMessages("+1234567890", customParams);
+
+      const expectedParams = { ...customParams };
+
+      expect(mockGet).toHaveBeenCalledWith("api/sms/+1234567890/messages", {
+        maxRedirects: 99999,
+        params: expectedParams,
+      });
+
+      expect(result).toEqual(mockSmsMessagesResponse);
+    });
+
+    it("should use custom axios config if provided", async () => {
+      const { mockGet } = setupMockAxios();
+      mockGet.mockResolvedValueOnce({ data: mockSmsMessagesResponse });
+
+      const customConfig = {
+        timeout: 10000,
+        maxRedirects: 5,
+      };
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+      const result = await client.searchSmsMessages("+1234567890", undefined, customConfig);
+
+      expect(mockGet).toHaveBeenCalledWith("api/sms/+1234567890/messages", {
+        ...customConfig,
+        params: {
+          from_date: expect.any(String),
+          wait: true,
+        },
+      });
+
+      expect(result).toEqual(mockSmsMessagesResponse);
+    });
+
+    it("should handle errors correctly", async () => {
+      const { mockGet } = setupMockAxios();
+      const error = new Error("Search SMS Error");
+      mockGet.mockRejectedValueOnce(error);
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+
+      await expect(client.searchSmsMessages("+1234567890")).rejects.toThrow("Search SMS Error");
+    });
+  });
+
+  describe("listSmsNumbers", () => {
+    it("should fetch and return SMS numbers", async () => {
+      const { mockGet } = setupMockAxios();
+      mockGet.mockResolvedValueOnce({ data: mockSmsNumbersResponse });
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+      const result = await client.listSmsNumbers();
+
+      expect(mockGet).toHaveBeenCalledWith("api/sms/numbers");
+      expect(result).toEqual(mockSmsNumbersResponse);
+    });
+
+    it("should handle errors correctly", async () => {
+      const { mockGet } = setupMockAxios();
+      const error = new Error("List SMS Numbers Error");
+      mockGet.mockRejectedValueOnce(error);
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+
+      await expect(client.listSmsNumbers()).rejects.toThrow("List SMS Numbers Error");
+    });
+  });
+
+  describe("sendVirtualSms", () => {
+    it("should send an SMS through the API", async () => {
+      const { mockPost } = setupMockAxios();
+      mockPost.mockResolvedValueOnce({ data: {} });
+
+      const smsParams = {
+        from_number: "15551234567",
+        to_number: "15557654321",
+        body: "Test message",
+      };
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+      await client.sendVirtualSms(smsParams);
+
+      expect(mockPost).toHaveBeenCalledWith("api/sms/virtual", smsParams);
+    });
+
+    it("should handle errors when sending SMS", async () => {
+      const { mockPost } = setupMockAxios();
+      const error = new Error("Send SMS Error");
+      mockPost.mockRejectedValueOnce(error);
+
+      const client = new MailiskClient({ apiKey: "test-key" });
+
+      await expect(
+        client.sendVirtualSms({ from_number: "+15551234567", to_number: "+15557654321", body: "Test message" })
+      ).rejects.toThrow("Send SMS Error");
+    });
+  });
+
   describe("searchInbox", () => {
     it("should fetch and return emails with default parameters", async () => {
       const { mockGet } = setupMockAxios();