mailchannels-sdk 0.7.5 → 0.7.6

package/README.md

@@ -12,10 +12,10 @@ Node.js SDK to integrate [MailChannels API](https://docs.mailchannels.net/) into
 This library provides a simple way to interact with the [MailChannels API](https://docs.mailchannels.net/). It is written in TypeScript and can be used in both JavaScript and TypeScript projects and in different runtimes.
 <!-- #endregion overview -->
 
-<!-- #region note -->
+<!-- #region disclaimer -->
 > [!IMPORTANT]
 > **Disclaimer**: This library is not associated with [MailChannels Corporation](https://mailchannels.com/).
-<!-- #endregion note -->
+<!-- #endregion disclaimer -->
 
 - [✨ Release Notes](CHANGELOG.md)
 - [📖 Documentation](https://mailchannels.yizack.com)
@@ -24,13 +24,19 @@ This library provides a simple way to interact with the [MailChannels API](https
 
 - 🚀 [Features](#features)
 - 📏 [Requirements](#requirements)
-- 🏃 [Quick setup](#quick-setup)
-- 🚧 [Roadmap](#roadmap)
+- 📦 [Installation](#installation)
+- 📚 [Usage](#usage)
+- 📐 [Naming Conventions](#naming-conventions)
 - ⚖️ [License](#license)
 - 💻 [Development](#development)
 
 ## <a name="features">🚀 Features</a>
 
+<!-- #region features -->
+This SDK fully supports all features and operations available in the [MailChannels API](https://docs.mailchannels.net/). It is actively maintained to ensure compatibility and to quickly add support for new API features as they are released.
+
+Some of the things you can do with the SDK:
+
 - Send transactional emails
 - Check DKIM, SPF & Domain Lockdown
 - Configure DKIM keys
@@ -41,14 +47,18 @@ This library provides a simple way to interact with the [MailChannels API](https
 - Configure inbound domains
 - Manage account and recipient lists
 
+> [!TIP]
+> For a detailed reference mapping each SDK method to its corresponding MailChannels API endpoint reference, see the [SDK-API Mapping](https://mailchannels.yizack.com/sdk-api-mapping)
+<!-- #endregion features -->
+
 ## <a name="requirements">📏 Requirements</a>
 
 - [Create a MailChannels account](https://www.mailchannels.com/pricing/#for_devs)
 - [Create an API key](https://console.mailchannels.net/settings/accountSettings#APIKeys)
 
-## <a name="quick-setup">🏃 Quick setup</a>
+## <a name="installation">📦 Installation</a>
 
-1. Add `mailchannels-sdk` dependency to your project
+Add `mailchannels-sdk` dependency to your project
 
 ```sh
 # npm
@@ -61,92 +71,43 @@ yarn add mailchannels-sdk
 pnpm add mailchannels-sdk
 ```
 
+## <a name="usage">📚 Usage</a>
+
+To authenticate, you'll need an API key. You can create and manage API keys in **Dashboard** > **Account Settings** > **API Keys**.
+
+Pass your API key while initializing a new MailChannels client.
+
+```ts
+import { MailChannels } from 'mailchannels-sdk'
+
+const mailchannels = new MailChannels('your-api-key')
+```
+
+Send an email:
+
+```ts
+const { data, error } = await mailchannels.emails.send({
+  from: 'Name <from@example.com>',
+  to: 'to@example.com',
+  subject: 'Test email',
+  html: '<p>Hello World</p>'
+})
+```
+
+## <a name="naming-conventions">📐 Naming Conventions</a>
+
+<!-- #region naming-conventions -->
+Most properties in the MailChannels API use `snake_case`. To follow JavaScript conventions, the SDK adopts `camelCase` for all properties. This means:
+
+- Most options and responses match the API docs, but field names are `camelCase` rather than `snake_case`.
+- Some fields are grouped into nested objects or renamed for simplicity and better developer experience.
+- While most fields match the API docs (just with `camelCase`), a few may be simplified or reorganized to feel more natural for JavaScript developers.
+<!-- #endregion naming-conventions -->
+
 ## <a name="license">⚖️ License</a>
 
 [MIT License](LICENSE)
 
-<!-- #region roadmap -->
-## <a name="roadmap">🚧 Roadmap</a>
-
-Already implemented features are marked with a checkmark. Please open an issue if you find any bugs or missing features.
-
-> [!NOTE]
-> Links below point to the official MailChannels API documentation, options and responses may differ slightly when using this SDK. Please refer to the [documentation](https://mailchannels.yizack.com) for the correct usage of each feature.
-
-### [Email API](https://docs.mailchannels.net/email-api/api-reference/email-api)
-
-- 📧 Emails
-  - ✅ [Send an Email](https://docs.mailchannels.net/email-api/api-reference/send-an-email)
-  - ✅ [Send an Email Asynchronously](https://docs.mailchannels.net/email-api/api-reference/send-an-email-asynchronously)
-  - ✅ [DKIM, SPF & Domain Lockdown Check](https://docs.mailchannels.net/email-api/api-reference/dkim-spf-domain-lockdown-check)
-  - ✅ [Create DKIM Key Pair](https://docs.mailchannels.net/email-api/api-reference/create-dkim-key-pair)
-  - ✅ [Retrieve DKIM Keys](https://docs.mailchannels.net/email-api/api-reference/retrieve-dkim-keys)
-  - ✅ [Update DKIM Key Status](https://docs.mailchannels.net/email-api/api-reference/update-dkim-key-status)
-  - ✅ [Rotate DKIM Key Pair](https://docs.mailchannels.net/email-api/api-reference/rotate-dkim-key-pair)
-- 📢 Webhooks
-  - ✅ [Enroll for Webhook Notifications](https://docs.mailchannels.net/email-api/api-reference/enroll-for-webhook-notifications)
-  - ✅ [Retrieve Customer Webhooks](https://docs.mailchannels.net/email-api/api-reference/retrieve-customer-webhooks)
-  - ✅ [Delete Customer Webhooks](https://docs.mailchannels.net/email-api/api-reference/delete-customer-webhooks)
-  - ✅ [Retrieve Webhook Signing Key](https://docs.mailchannels.net/email-api/api-reference/retrieve-webhook-signing-key)
-  - ✅ [Validate Enrolled Webhook](https://docs.mailchannels.net/email-api/api-reference/validate-enrolled-webhook)
-- 🪪 Sub-accounts
-  - ✅ [Create Sub-account](https://docs.mailchannels.net/email-api/api-reference/create-sub-account)
-  - ✅ [Retrieve Sub-accounts](https://docs.mailchannels.net/email-api/api-reference/retrieve-sub-accounts)
-  - ✅ [Delete Sub-account](https://docs.mailchannels.net/email-api/api-reference/delete-sub-account)
-  - ✅ [Suspend Sub-account](https://docs.mailchannels.net/email-api/api-reference/suspend-sub-account)
-  - ✅ [Activate Sub-account](https://docs.mailchannels.net/email-api/api-reference/activate-sub-account)
-  - ✅ [Create Sub-account API Key](https://docs.mailchannels.net/email-api/api-reference/create-sub-account-api-key)
-  - ✅ [Delete Sub-account API Key](https://docs.mailchannels.net/email-api/api-reference/delete-sub-account-api-key)
-  - ✅ [Retrieve Sub-account API Keys](https://docs.mailchannels.net/email-api/api-reference/retrieve-sub-account-api-keys)
-  - ✅ [Create Sub-account SMTP Password](https://docs.mailchannels.net/email-api/api-reference/create-sub-account-smtp-password)
-  - ✅ [Delete Sub-account SMTP Password](https://docs.mailchannels.net/email-api/api-reference/delete-sub-account-smtp-password)
-  - ✅ [Retrieve Sub-account SMTP Passwords](https://docs.mailchannels.net/email-api/api-reference/retrieve-sub-account-smtp-passwords)
-  - ✅ [Retrieve Sub-account Limit](https://docs.mailchannels.net/email-api/api-reference/retrieve-sub-account-limit)
-  - ✅ [Set Sub-account Limit](https://docs.mailchannels.net/email-api/api-reference/set-sub-account-limit)
-  - ✅ [Delete Sub-account Limit](https://docs.mailchannels.net/email-api/api-reference/delete-sub-account-limit)
-  - ✅ [Retrieve Sub-account Usage Stats](https://docs.mailchannels.net/email-api/api-reference/retrieve-sub-account-usage-stats)
-- 📊 Metrics
-  - ✅ [Retrieve Engagement Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-engagement-metrics)
-  - ✅ [Retrieve Performance Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-performance-metrics)
-  - ✅ [Retrieve Recipient Behaviour Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-recipient-behaviour-metrics)
-  - ✅ [Retrieve Usage Stats](https://docs.mailchannels.net/email-api/api-reference/retrieve-usage-stats)
-  - ✅ [Retrieve Volume Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-volume-metrics)
-  - ✅ [Retrieve Sender Metrics](https://docs.mailchannels.net/email-api/api-reference/retrieve-sender-metrics)
-- 🚫 Suppressions
-  - ✅ [Create Suppression Entries](https://docs.mailchannels.net/email-api/api-reference/create-suppression-entries)
-  - ✅ [Delete Suppression Entry](https://docs.mailchannels.net/email-api/api-reference/delete-suppression-entry)
-  - ✅ [Retrieve Suppression List](https://docs.mailchannels.net/email-api/api-reference/retrieve-suppression-list)
-
-### [Inbound API](https://docs.mailchannels.net/inbound-api/API-reference/inbound-api)
-
-- 🌐 Domains
-  - ✅ [Provision domain](https://docs.mailchannels.net/inbound-api/API-reference/provision-domain)
-  - ✅ [Remove domain](https://docs.mailchannels.net/inbound-api/API-reference/remove-domain)
-  - ✅ [List domains](https://docs.mailchannels.net/inbound-api/API-reference/list-domains)
-  - ✅ [Bulk provision domains](https://docs.mailchannels.net/inbound-api/API-reference/bulk-provision-domains)
-  - ✅ [Add domain list entry](https://docs.mailchannels.net/inbound-api/API-reference/add-domain-list-entry)
-  - ✅ [Get domain list entries](https://docs.mailchannels.net/inbound-api/API-reference/get-domain-list-entries)
-  - ✅ [Delete domain list entry](https://docs.mailchannels.net/inbound-api/API-reference/delete-domain-list-entry)
-  - ✅ [Create login link](https://docs.mailchannels.net/inbound-api/API-reference/create-login-link)
-  - ✅ [Bulk create login links](https://docs.mailchannels.net/inbound-api/API-reference/bulk-create-login-links)
-  - ✅ [Set downstream address](https://docs.mailchannels.net/inbound-api/API-reference/set-downstream-address)
-  - ✅ [Fetch downstream addresses](https://docs.mailchannels.net/inbound-api/API-reference/fetch-downstream-addresses)
-  - ✅ [Update API key](https://docs.mailchannels.net/inbound-api/API-reference/update-api-key)
-- 📋 Lists
-  - ✅ [Add item to customer list](https://docs.mailchannels.net/inbound-api/API-reference/add-item-to-customer-list)
-  - ✅ [Delete item from customer list](https://docs.mailchannels.net/inbound-api/API-reference/delete-item-from-customer-list)
-  - ✅ [Get customer list entries](https://docs.mailchannels.net/inbound-api/API-reference/get-customer-list-entries)
-- 📥 Users
-  - ✅ [Create a recipient](https://docs.mailchannels.net/inbound-api/API-reference/create-a-recipient)
-  - ✅ [Add item to recipient list](https://docs.mailchannels.net/inbound-api/API-reference/add-item-to-recipient-list)
-  - ✅ [Get recipient list entries](https://docs.mailchannels.net/inbound-api/API-reference/get-recipient-list-entries)
-  - ✅ [Delete item from recipient list](https://docs.mailchannels.net/inbound-api/API-reference/delete-item-from-recipient-list)
-- ⚙️ Service
-  - ✅ [Retrieve the condition of the service](https://docs.mailchannels.net/inbound-api/API-reference/retrieve-the-condition-of-the-service)
-  - ✅ [Submit a false negative or false positive report](https://docs.mailchannels.net/inbound-api/API-reference/submit-a-false-negative-or-false-positive-report)
-  - ✅ [Get a list of your subscriptions to MailChannels Inbound](https://docs.mailchannels.net/inbound-api/API-reference/get-a-list-of-your-subscriptions-to-mail-channels-inbound)
-<!-- #endregion roadmap -->
-
 ## <a name="development">💻 Development</a>
 
 <details>

package/dist/mailchannels.d.mts

@@ -1,6 +1,4 @@
 import { FetchOptions } from "ofetch";
-
-//#region src/client.d.ts
 declare class MailChannelsClient {
   #private;
   private static BASE_URL;
@@ -12,8 +10,6 @@ declare class MailChannelsClient {
   put<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
   patch<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
 }
-//#endregion
-//#region src/types/responses.d.ts
 interface ErrorResponse {
   message: string;
   statusCode: number | null;
@@ -47,8 +43,6 @@ type DataResponse<T> = {
    */
   error: ErrorResponse;
 };
-//#endregion
-//#region src/types/emails/send.d.ts
 interface EmailsSendRecipient {
   /**
    * The email address of the recipient.
@@ -288,8 +282,6 @@ type EmailsSendResponse = SuccessResponse & DataResponse<{
     status: "sent" | "failed";
   }[];
 }>;
-//#endregion
-//#region src/types/emails/send-async.d.ts
 type EmailsSendAsyncResponse = DataResponse<{
   /**
    * ISO 8601 timestamp when the request was queued for processing.
@@ -300,8 +292,6 @@ type EmailsSendAsyncResponse = DataResponse<{
    */
   requestId: string;
 }>;
-//#endregion
-//#region src/types/emails/create-dkim-key.d.ts
 interface EmailsCreateDkimKeyOptions {
   /**
    * Algorithm used for the new key pair Currently, only RSA is supported.
@@ -367,8 +357,6 @@ interface EmailsDkimKey {
   statusModifiedAt?: string;
 }
 type EmailsCreateDkimKeyResponse = DataResponse<EmailsDkimKey>;
-//#endregion
-//#region src/types/emails/check-domain.d.ts
 interface EmailsCheckDomainDkim {
   /**
    * Domain used for DKIM signing.
@@ -457,8 +445,6 @@ type EmailsCheckDomainResponse = DataResponse<{
   };
   references?: string[];
 }>;
-//#endregion
-//#region src/types/emails/get-dkim-keys.d.ts
 interface EmailsGetDkimKeysOptions {
   /**
    * Selector to filter keys by. Must be a maximum of 63 characters.
@@ -486,8 +472,6 @@ interface EmailsGetDkimKeysOptions {
 }
 type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type EmailsGetDkimKeysResponse = DataResponse<Optional<EmailsDkimKey, "dnsRecords">[]>;
-//#endregion
-//#region src/types/emails/update-dkim-key.d.ts
 interface EmailsUpdateDkimKeyOptions {
   /**
    * Selector of the DKIM key pair to update. Must be a maximum of 63 characters.
@@ -501,8 +485,6 @@ interface EmailsUpdateDkimKeyOptions {
    */
   status: Exclude<EmailsDkimKey["status"], "active">;
 }
-//#endregion
-//#region src/types/emails/rotate-dkim-key.d.ts
 interface EmailsRotateDkimKeyOptions {
   newKey: {
     /**
@@ -515,8 +497,6 @@ type EmailsRotateDkimKeyResponse = DataResponse<{
   new: EmailsDkimKey;
   rotated: EmailsDkimKey;
 }>;
-//#endregion
-//#region src/modules/emails.d.ts
 declare class Emails {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -631,11 +611,7 @@ declare class Emails {
    */
   rotateDkimKey(domain: string, selector: string, options: EmailsRotateDkimKeyOptions): Promise<EmailsRotateDkimKeyResponse>;
 }
-//#endregion
-//#region src/types/webhooks/list.d.ts
 type WebhooksListResponse = DataResponse<string[]>;
-//#endregion
-//#region src/types/webhooks/signing-key.d.ts
 type WebhooksSigningKeyResponse = DataResponse<{
   /**
    * The ID of the key.
@@ -646,8 +622,6 @@ type WebhooksSigningKeyResponse = DataResponse<{
    */
   key: string;
 }>;
-//#endregion
-//#region src/types/webhooks/validate.d.ts
 type WebhooksValidateResponse = DataResponse<{
   /**
    * Indicates whether all webhook validations passed.
@@ -680,8 +654,6 @@ type WebhooksValidateResponse = DataResponse<{
     } | null;
   }[];
 }>;
-//#endregion
-//#region src/types/webhooks/verify.d.ts
 interface WebhooksVerifyOptions {
   /**
    * The raw body of the incoming webhook request as a string. This should be the exact payload received from the webhook, without any modifications or parsing, to ensure accurate signature verification.
@@ -700,8 +672,74 @@ interface WebhooksVerifyOptions {
    */
   publicKey?: string;
 }
-//#endregion
-//#region src/modules/webhooks.d.ts
+type WebhooksBatchStatus = "1xx" | "2xx" | "3xx" | "4xx" | "5xx" | "no_response";
+type WebhooksBatchResponseStatus = "1xx_response" | "2xx_response" | "3xx_response" | "4xx_response" | "5xx_response" | "no_response";
+interface WebhooksBatchesOptions {
+  /**
+   * Inclusive lower bound (UTC) for filtering webhook batches by creation time. Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`.
+   */
+  createdAfter?: string;
+  /**
+   * Exclusive upper bound (UTC) for filtering webhook batches by creation time. Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`.
+   */
+  createdBefore?: string;
+  /**
+   * Filters webhook batches by webhook response status category. If not provided, batches with all categories are returned.
+   */
+  statuses?: WebhooksBatchStatus[];
+  /**
+   * Filters webhook batches by the webhook endpoint to which events in the batch were posted.
+   */
+  webhook?: string;
+  /**
+   * The maximum number of webhook batches to return. Must be between `1` and `500`.
+   * @default 500
+   */
+  limit?: number;
+  /**
+   * The number of webhook batches to skip before starting to collect the result set.
+   * @default 0
+   */
+  offset?: number;
+}
+interface WebhooksBatch {
+  /**
+   * Unique identifier for the webhook batch.
+   */
+  batchId: number;
+  /**
+   * Timestamp of when the webhook batch was created.
+   */
+  createdAt: string;
+  /**
+   * Customer handle associated with the webhook batch.
+   */
+  customerHandle: string;
+  /**
+   * Duration of the webhook batch, measured from the time the request was sent to the webhook endpoint until the response was received.
+   */
+  duration?: {
+    unit: "milliseconds";
+    value: number;
+  };
+  /**
+   * Number of events in the webhook batch.
+   */
+  eventCount: number;
+  /**
+   * Status of the webhook batch.
+   */
+  status: WebhooksBatchResponseStatus;
+  /**
+   * HTTP status code returned by the webhook endpoint.
+   */
+  statusCode: number | null;
+  /**
+   * Webhook endpoint to which events in the batch were posted.
+   */
+  webhook: string;
+}
+type WebhooksBatchesResponse = DataResponse<WebhooksBatch[]>;
 declare class Webhooks {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -772,9 +810,17 @@ declare class Webhooks {
    * ```
    */
   verify(options: WebhooksVerifyOptions): Promise<boolean>;
+  /**
+   * Retrieves paged webhook batches associated with the customer. The time range specified by `createdAfter` and `createdBefore` must not exceed 31 days. If neither is specified, the default time range is the last 3 days.
+   * @param options - The options for listing webhook batches.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.webhooks.batches()
+   * ```
+   */
+  batches(options?: WebhooksBatchesOptions): Promise<WebhooksBatchesResponse>;
 }
-//#endregion
-//#region src/types/sub-accounts/create.d.ts
 interface SubAccountsAccount {
   /**
    * The name of the company associated with the sub-account.
@@ -790,8 +836,6 @@ interface SubAccountsAccount {
   handle: string;
 }
 type SubAccountsCreateResponse = DataResponse<SubAccountsAccount>;
-//#endregion
-//#region src/types/sub-accounts/list.d.ts
 interface SubAccountsListOptions {
   /**
    * Possible values are `1` to `1000`.
@@ -805,8 +849,6 @@ interface SubAccountsListOptions {
   offset?: number;
 }
 type SubAccountsListResponse = DataResponse<SubAccountsAccount[]>;
-//#endregion
-//#region src/types/sub-accounts/api-key.d.ts
 interface SubAccountsApiKey {
   /**
    * The API key ID for the sub-account.
@@ -831,8 +873,6 @@ interface SubAccountsListApiKeyOptions {
   offset?: number;
 }
 type SubAccountsListApiKeyResponse = DataResponse<SubAccountsApiKey[]>;
-//#endregion
-//#region src/types/sub-accounts/smtp-password.d.ts
 interface SubAccountsSmtpPassword {
   /**
    * Whether the SMTP password is enabled.
@@ -849,14 +889,10 @@ interface SubAccountsSmtpPassword {
 }
 type SubAccountsCreateSmtpPasswordResponse = DataResponse<SubAccountsSmtpPassword>;
 type SubAccountsListSmtpPasswordResponse = DataResponse<SubAccountsSmtpPassword[]>;
-//#endregion
-//#region src/types/sub-accounts/limit.d.ts
 interface SubAccountsLimit {
   sends: number;
 }
 type SubAccountsLimitResponse = DataResponse<SubAccountsLimit>;
-//#endregion
-//#region src/types/sub-accounts/usage.d.ts
 interface SubAccountsUsage {
   /**
    * The end date of the current billing period (ISO 8601 format).
@@ -874,8 +910,6 @@ interface SubAccountsUsage {
   total: number;
 }
 type SubAccountsUsageResponse = DataResponse<SubAccountsUsage>;
-//#endregion
-//#region src/modules/sub-accounts.d.ts
 declare class SubAccounts {
   protected mailchannels: MailChannelsClient;
   private static readonly COMPANY_PATTERN;
@@ -1037,8 +1071,6 @@ declare class SubAccounts {
    */
   getUsage(handle: string): Promise<SubAccountsUsageResponse>;
 }
-//#endregion
-//#region src/types/metrics/engagement.d.ts
 interface MetricsEngagement {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
@@ -1057,8 +1089,6 @@ interface MetricsEngagement {
   startTime: string;
 }
 type MetricsEngagementResponse = DataResponse<MetricsEngagement>;
-//#endregion
-//#region src/types/metrics/performance.d.ts
 interface MetricsPerformance {
   /**
    * Count of messages bounced during the specified time range.
@@ -1090,8 +1120,6 @@ interface MetricsPerformance {
   startTime: string;
 }
 type MetricsPerformanceResponse = DataResponse<MetricsPerformance>;
-//#endregion
-//#region src/types/metrics/recipient-behaviour.d.ts
 interface MetricsRecipientBehaviour {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
@@ -1118,8 +1146,6 @@ interface MetricsRecipientBehaviour {
   unsubscribed: number;
 }
 type MetricsRecipientBehaviourResponse = DataResponse<MetricsRecipientBehaviour>;
-//#endregion
-//#region src/types/metrics/volume.d.ts
 interface MetricsVolume {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
@@ -1151,8 +1177,6 @@ interface MetricsVolume {
   startTime: string;
 }
 type MetricsVolumeResponse = DataResponse<MetricsVolume>;
-//#endregion
-//#region src/types/metrics/usage.d.ts
 type MetricsUsageResponse = DataResponse<{
   /**
    * The end date of the current billing period (ISO 8601 format).
@@ -1169,8 +1193,6 @@ type MetricsUsageResponse = DataResponse<{
    */
   total: number;
 }>;
-//#endregion
-//#region src/types/metrics/senders.d.ts
 type MetricsSendersType = "sub-accounts" | "campaigns";
 interface MetricsSendersOptions {
   /**
@@ -1220,8 +1242,6 @@ interface MetricsSenders {
   total: number;
 }
 type MetricsSendersResponse = DataResponse<MetricsSenders>;
-//#endregion
-//#region src/types/metrics/index.d.ts
 interface MetricsBucket {
   /**
    * The number of events or occurrences aggregated within this time period.
@@ -1253,8 +1273,6 @@ interface MetricsOptions {
    */
   interval?: "hour" | "day" | "week" | "month";
 }
-//#endregion
-//#region src/modules/metrics.d.ts
 declare class Metrics {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -1319,8 +1337,6 @@ declare class Metrics {
    */
   senders(type: MetricsSendersType, options?: MetricsSendersOptions): Promise<MetricsSendersResponse>;
 }
-//#endregion
-//#region src/types/suppressions/create.d.ts
 type SuppressionsTypes = "transactional" | "non-transactional";
 interface SuppressionsCreateOptions {
   /**
@@ -1347,8 +1363,6 @@ interface SuppressionsCreateOptions {
     types?: SuppressionsTypes[];
   }[];
 }
-//#endregion
-//#region src/types/suppressions/list.d.ts
 type SuppressionsSource = "api" | "unsubscribe_link" | "list_unsubscribe" | "hard_bounce" | "spam_complaint" | "all";
 interface SuppressionsListOptions {
   /**
@@ -1390,8 +1404,6 @@ interface SuppressionsListEntry {
   types: SuppressionsTypes[];
 }
 type SuppressionsListResponse = DataResponse<SuppressionsListEntry[]>;
-//#endregion
-//#region src/modules/suppressions.d.ts
 declare class Suppressions {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -1428,8 +1440,6 @@ declare class Suppressions {
    */
   list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
 }
-//#endregion
-//#region src/types/lists/entry.d.ts
 type ListNames = "blocklist" | "safelist" | "blacklist" | "whitelist";
 interface ListEntryOptions {
   /**
@@ -1448,8 +1458,6 @@ interface ListEntry {
 }
 type ListEntryResponse = DataResponse<ListEntry>;
 type ListEntriesResponse = DataResponse<ListEntry[]>;
-//#endregion
-//#region src/types/domains/provision.d.ts
 interface DomainsData {
   /**
    * The domain name.
@@ -1546,8 +1554,6 @@ type DomainsBulkProvisionResponse = DataResponse<{
     comment?: string;
   }[];
 }>;
-//#endregion
-//#region src/types/domains/list.d.ts
 interface DomainsListOptions {
   /**
    * A list of domains to fetch. If this parameter is present, only domains whose name matches an item in this list are returned.
@@ -1574,8 +1580,6 @@ type DomainsListResponse = DataResponse<{
    */
   total: number;
 }>;
-//#endregion
-//#region src/types/domains/create-login-link.d.ts
 interface DomainsCreateLoginLink {
   /**
    * If a user browses to this URL, they will be automatically logged in as a domain admin.
@@ -1583,8 +1587,6 @@ interface DomainsCreateLoginLink {
   link: string;
 }
 type DomainsCreateLoginLinkResponse = DataResponse<DomainsCreateLoginLink>;
-//#endregion
-//#region src/types/domains/downstream-addresses.d.ts
 interface DomainsListDownstreamAddressesOptions {
   /**
    * The number of records to return.
@@ -1616,8 +1618,6 @@ interface DomainsDownstreamAddress {
   weight: number;
 }
 type DomainsListDownstreamAddressesResponse = DataResponse<DomainsDownstreamAddress[]>;
-//#endregion
-//#region src/types/domains/bulk-create-login-links.d.ts
 interface DomainsBulkCreateLoginLinkResult {
   /**
    * The domain the request was for.
@@ -1638,8 +1638,6 @@ interface DomainsBulkCreateLoginLinks {
   errors: Omit<DomainsBulkCreateLoginLinkResult, "loginLink">[];
 }
 type DomainsBulkCreateLoginLinksResponse = DataResponse<DomainsBulkCreateLoginLinks>;
-//#endregion
-//#region src/modules/domains.d.ts
 declare class Domains {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -1797,8 +1795,6 @@ declare class Domains {
    */
   bulkCreateLoginLinks(domains: string[]): Promise<DomainsBulkCreateLoginLinksResponse>;
 }
-//#endregion
-//#region src/modules/lists.d.ts
 declare class Lists {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -1839,8 +1835,6 @@ declare class Lists {
    */
   deleteListEntry(options: ListEntryOptions): Promise<SuccessResponse>;
 }
-//#endregion
-//#region src/types/users/create.d.ts
 interface UsersCreateOptions {
   /**
    * Flag to indicate if the user is a domain admin or a regular user.
@@ -1873,8 +1867,6 @@ type UsersCreateResponse = DataResponse<{
     action: "safelist" | "blocklist";
   }[];
 }>;
-//#endregion
-//#region src/modules/users.d.ts
 declare class Users {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -1931,8 +1923,6 @@ declare class Users {
    */
   deleteListEntry(email: string, options: ListEntryOptions): Promise<SuccessResponse>;
 }
-//#endregion
-//#region src/types/service/subscriptions.d.ts
 type ServiceSubscriptionsResponse = DataResponse<{
   active: boolean;
   activeAccountsCount: number;
@@ -1946,8 +1936,6 @@ type ServiceSubscriptionsResponse = DataResponse<{
     name: string;
   };
 }[]>;
-//#endregion
-//#region src/types/service/report.d.ts
 interface ServiceReportOptions {
   /**
    * The report type. It can be either `false_negative` or `false_positive`.
@@ -1972,8 +1960,6 @@ interface ServiceReportOptions {
     name?: string;
   };
 }
-//#endregion
-//#region src/modules/service.d.ts
 declare class Service {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -2008,8 +1994,6 @@ declare class Service {
    */
   report(options: ServiceReportOptions): Promise<SuccessResponse>;
 }
-//#endregion
-//#region src/types/webhooks/events.d.ts
 type WebhookEventType = "processed" | "delivered" | "open" | "click" | "hard-bounced" | "soft-bounced" | "dropped" | "complained" | "unsubscribed" | "test";
 interface WebhookEventBase<T extends WebhookEventType> {
   /**
@@ -2083,8 +2067,6 @@ interface WebhookEventUnsubscribed extends WebhookEventBase<"unsubscribed"> {}
 interface WebhookEventTest extends Omit<WebhookEventBase<"test">, "recipients" | "campaign_id"> {}
 type WebhookEvent = WebhookEventProcessed | WebhookEventDelivered | WebhookEventOpen | WebhookEventClick | WebhookEventHardBounced | WebhookEventSoftBounced | WebhookEventDropped | WebhookEventComplained | WebhookEventUnsubscribed | WebhookEventTest;
 type WebhookEvents = WebhookEvent[];
-//#endregion
-//#region src/mailchannels.d.ts
 declare class MailChannels extends MailChannelsClient {
   readonly emails: Emails;
   readonly webhooks: Webhooks;
@@ -2097,5 +2079,4 @@ declare class MailChannels extends MailChannelsClient {
   readonly service: Service;
   constructor(key: string);
 }
-//#endregion
-export { DataResponse, Domains, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, Emails, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, Lists, MailChannels, MailChannelsClient, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Service, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, Users, UsersCreateOptions, UsersCreateResponse, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions };
+export { DataResponse, Domains, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, Emails, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, Lists, MailChannels, MailChannelsClient, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Service, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, Users, UsersCreateOptions, UsersCreateResponse, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions };