mailchannels-sdk 0.7.2 → 0.7.4

package/dist/mailchannels.d.mts

@@ -1,22 +1,23 @@
-import { FetchOptions } from 'ofetch';
+import { FetchOptions } from "ofetch";
 
+//#region src/client.d.ts
 declare class MailChannelsClient {
-    #private;
-    private static BASE_URL;
-    constructor(key: string);
-    protected _fetch<T>(path: string, options?: FetchOptions<"json">): Promise<T>;
-    post<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
-    get<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
-    delete<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
-    put<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
-    patch<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
+  #private;
+  private static BASE_URL;
+  constructor(key: string);
+  protected _fetch<T>(path: string, options?: FetchOptions<"json">): Promise<T>;
+  post<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
+  get<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
+  delete<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
+  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;
 }
-
 interface SuccessResponse {
   /**
    * Whether the operation was successful.
@@ -27,8 +28,7 @@ interface SuccessResponse {
    */
   error: ErrorResponse | null;
 }
-
-type DataResponse$1<T> = {
+type DataResponse<T> = {
   /**
    * The response data.
    */
@@ -47,7 +47,8 @@ type DataResponse$1<T> = {
    */
   error: ErrorResponse;
 };
-
+//#endregion
+//#region src/types/emails/send.d.ts
 interface EmailsSendRecipient {
   /**
    * The email address of the recipient.
@@ -58,7 +59,6 @@ interface EmailsSendRecipient {
    */
   name?: string;
 }
-
 interface EmailsSendAttachment {
   /**
    * The attachment data, encoded in base64.
@@ -73,7 +73,6 @@ interface EmailsSendAttachment {
    */
   type: string;
 }
-
 interface EmailsSendTracking {
   /**
    * Track when a recipient clicks a link in your email.
@@ -86,7 +85,6 @@ interface EmailsSendTracking {
    */
   open?: boolean;
 }
-
 interface EmailsSendOptionsBase {
   /**
    * An array of attachments to be sent with the email.
@@ -235,39 +233,34 @@ interface EmailsSendOptionsBase {
    */
   transactional?: boolean;
 }
-
-type EmailsSendOptions = EmailsSendOptionsBase & (
-  | {
-    /**
-     * The HTML content of the email.
-     * @example
-     * '<p>Hello World</p>'
-     */
-    html: string;
-    /**
-     * The plain text content of the email (optional when html is provided).
-     * @example
-     * 'Hello World'
-     */
-    text?: string;
-  }
-  | {
-    /**
-     * The HTML content of the email (optional when text is provided).
-     * @example
-     * '<p>Hello World</p>'
-     */
-    html?: string;
-    /**
-     * The plain text content of the email.
-     * @example
-     * 'Hello World'
-     */
-    text: string;
-  }
-);
-
-type EmailsSendResponse = SuccessResponse & DataResponse$1<{
+type EmailsSendOptions = EmailsSendOptionsBase & ({
+  /**
+   * The HTML content of the email.
+   * @example
+   * '<p>Hello World</p>'
+   */
+  html: string;
+  /**
+   * The plain text content of the email (optional when html is provided).
+   * @example
+   * 'Hello World'
+   */
+  text?: string;
+} | {
+  /**
+   * The HTML content of the email (optional when text is provided).
+   * @example
+   * '<p>Hello World</p>'
+   */
+  html?: string;
+  /**
+   * The plain text content of the email.
+   * @example
+   * 'Hello World'
+   */
+  text: string;
+});
+type EmailsSendResponse = SuccessResponse & DataResponse<{
   /**
    * Fully rendered message if `dryRun` was set to `true`. A string representation of a rendered message, one per personalization in the request.
    */
@@ -295,18 +288,20 @@ type EmailsSendResponse = SuccessResponse & DataResponse$1<{
     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.
    */
-  queuedAt: string[];
+  queuedAt: string;
   /**
    * Unique identifier for tracking this async request. Will be included in all webhook events for this request.
    */
   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.
@@ -323,9 +318,7 @@ interface EmailsCreateDkimKeyOptions {
    */
   selector: string;
 }
-
 type EmailsDkimKeyStatus = "active" | "retired" | "revoked" | "rotated";
-
 interface EmailsDkimKey {
   /**
    * Algorithm used for the key pair.
@@ -373,9 +366,9 @@ interface EmailsDkimKey {
    */
   statusModifiedAt?: string;
 }
-
-type EmailsCreateDkimKeyResponse = DataResponse$1<EmailsDkimKey>;
-
+type EmailsCreateDkimKeyResponse = DataResponse<EmailsDkimKey>;
+//#endregion
+//#region src/types/emails/check-domain.d.ts
 interface EmailsCheckDomainDkim {
   /**
    * Domain used for DKIM signing.
@@ -390,7 +383,6 @@ interface EmailsCheckDomainDkim {
    */
   selector?: string;
 }
-
 interface EmailsCheckDomainOptions {
   /**
    * Each item may include DKIM `domain`, `selector` and `privateKey`. Up to 10 items are allowed. The absence or presence of these fields affects how DKIM settings are validated:
@@ -411,10 +403,8 @@ interface EmailsCheckDomainOptions {
    */
   senderId?: string;
 }
-
 type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-
-type EmailsCheckDomainResponse = DataResponse$1<{
+type EmailsCheckDomainResponse = DataResponse<{
   dkim: {
     domain: string;
     /**
@@ -467,7 +457,8 @@ type EmailsCheckDomainResponse = DataResponse$1<{
   };
   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.
@@ -493,11 +484,10 @@ interface EmailsGetDkimKeysOptions {
    */
   includeDnsRecord?: boolean;
 }
-
 type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-
-type EmailsGetDkimKeysResponse = DataResponse$1<Optional<EmailsDkimKey, "dnsRecords">[]>;
-
+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.
@@ -511,7 +501,8 @@ interface EmailsUpdateDkimKeyOptions {
    */
   status: Exclude<EmailsDkimKey["status"], "active">;
 }
-
+//#endregion
+//#region src/types/emails/rotate-dkim-key.d.ts
 interface EmailsRotateDkimKeyOptions {
   newKey: {
     /**
@@ -520,134 +511,137 @@ interface EmailsRotateDkimKeyOptions {
     selector: string;
   };
 }
-
-type EmailsRotateDkimKeyResponse = DataResponse$1<{
+type EmailsRotateDkimKeyResponse = DataResponse<{
   new: EmailsDkimKey;
   rotated: EmailsDkimKey;
 }>;
-
+//#endregion
+//#region src/modules/emails.d.ts
 declare class Emails {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    private _sendEmail;
-    /**
-     * Sends an email message to one or more recipients.
-     * @param options - The email options to send.
-     * @param dryRun - When set to `true`, the message will not be sent. Instead, the fully rendered message will be returned in the `data` property of the response. The default value is `false`.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, data, error } = await mailchannels.emails.send({
-     *   to: 'to@example.com',
-     *   from: 'from@example.com',
-     *   subject: 'Test',
-     *   html: 'Test'
-     * })
-     * ```
-     */
-    send(options: EmailsSendOptions, dryRun?: boolean): Promise<EmailsSendResponse>;
-    /**
-     * Queues an email message for asynchronous processing and returns immediately with a request ID.
-     *
-     * The email will be processed in the background, and you'll receive webhook events for all delivery status updates (e.g. `dropped`, `processed`, `delivered`, `hard-bounced`). These webhook events are identical to those sent for the synchronous /send endpoint.
-     *
-     * Use this endpoint when you need to send emails without waiting for processing to complete. This can improve your application's response time, especially when sending to multiple recipients.
-     * @param options - The email options to send.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.emails.sendAsync({
-     *   to: 'to@example.com',
-     *   from: 'from@example.com',
-     *   subject: 'Test',
-     *   html: 'Test'
-     * })
-     * ```
-     */
-    sendAsync(options: EmailsSendOptions): Promise<EmailsSendAsyncResponse>;
-    /**
-     * Validates a domain's email authentication setup by retrieving its DKIM, SPF, and Domain Lockdown status. This endpoint checks whether the domain is properly configured for secure email delivery.
-     * @param options - The domain options to check.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.emails.checkDomain({
-     *   dkim: [{
-     *     domain: 'example.com',
-     *     privateKey: 'your-private-key',
-     *     selector: 'mailchannels'
-     *   }],
-     *   domain: 'example.com',
-     *   senderId: 'sender-id'
-     * })
-     * ```
-     */
-    checkDomain(options: EmailsCheckDomainOptions): Promise<EmailsCheckDomainResponse>;
-    /**
-     * Create a DKIM key pair for a specified domain and selector using the specified algorithm and key length, for the current customer.
-     * @param domain - The domain to create the DKIM key for.
-     * @param options - DKIM key creation options.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.emails.createDkimKey('example.com', {
-     *   selector: 'mailchannels'
-     * })
-     * ```
-     */
-    createDkimKey(domain: string, options: EmailsCreateDkimKeyOptions): Promise<EmailsCreateDkimKeyResponse>;
-    /**
-     * Search for DKIM keys by domain, with optional filters. If selector is provided, at most one key will be returned.
-     * @param domain - The domain to search DKIM keys for.
-     * @param options - The options to filter DKIM keys by.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.getDkimKeys('example.com', {
-     *   includeDnsRecord: true
-     * })
-     * ```
-     */
-    getDkimKeys(domain: string, options?: EmailsGetDkimKeysOptions): Promise<EmailsGetDkimKeysResponse>;
-    /**
-     * Update fields of an existing DKIM key pair for the specified domain and selector, for the current customer. Currently, only the `status` field can be updated.
-     * @param domain - The domain the DKIM key belongs to.
-     * @param options - The options to update the DKIM key.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.emails.updateDkimKey('example.com', {
-     *   selector: 'mailchannels',
-     *   status: 'retired'
-     * })
-     */
-    updateDkimKey(domain: string, options: EmailsUpdateDkimKeyOptions): Promise<SuccessResponse>;
-    /**
-     * Rotate an active DKIM key pair. Mark the original key as `rotated`, and create a new key pair with the required new key selector, reusing the same algorithm and key length. The rotated key remains valid for signing for a 3-day grace period, and is automatically changed to `retired` 2 weeks after rotation. Publish the new key to its DNS TXT record before rotated key expires for signing as emails sent with an unpublished key will fail DKIM validation by receiving providers. After the grace period, only the new key is valid for signing if published.
-     * @param domain - The domain the DKIM key belongs to.
-     * @param selector - The selector of the DKIM key to rotate.
-     * @param options - The options to rotate the DKIM key.
-     * @param options.newKey.selector - The selector for the new key pair. Must be a maximum of 63 characters.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.emails.rotateDkimKey('example.com', 'mailchannels', {
-     *   newKey: {
-     *     selector: 'new-selector'
-     *   }
-     * })
-     * ```
-     */
-    rotateDkimKey(domain: string, selector: string, options: EmailsRotateDkimKeyOptions): Promise<EmailsRotateDkimKeyResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  private _sendEmail;
+  /**
+   * Sends an email message to one or more recipients.
+   * @param options - The email options to send.
+   * @param dryRun - When set to `true`, the message will not be sent. Instead, the fully rendered message will be returned in the `data` property of the response. The default value is `false`.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, data, error } = await mailchannels.emails.send({
+   *   to: 'to@example.com',
+   *   from: 'from@example.com',
+   *   subject: 'Test',
+   *   html: 'Test'
+   * })
+   * ```
+   */
+  send(options: EmailsSendOptions, dryRun?: boolean): Promise<EmailsSendResponse>;
+  /**
+   * Queues an email message for asynchronous processing and returns immediately with a request ID.
+   *
+   * The email will be processed in the background, and you'll receive webhook events for all delivery status updates (e.g. `dropped`, `processed`, `delivered`, `hard-bounced`). These webhook events are identical to those sent for the synchronous /send endpoint.
+   *
+   * Use this endpoint when you need to send emails without waiting for processing to complete. This can improve your application's response time, especially when sending to multiple recipients.
+   * @param options - The email options to send.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.emails.sendAsync({
+   *   to: 'to@example.com',
+   *   from: 'from@example.com',
+   *   subject: 'Test',
+   *   html: 'Test'
+   * })
+   * ```
+   */
+  sendAsync(options: EmailsSendOptions): Promise<EmailsSendAsyncResponse>;
+  /**
+   * Validates a domain's email authentication setup by retrieving its DKIM, SPF, and Domain Lockdown status. This endpoint checks whether the domain is properly configured for secure email delivery.
+   * @param options - The domain options to check.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.emails.checkDomain({
+   *   dkim: [{
+   *     domain: 'example.com',
+   *     privateKey: 'your-private-key',
+   *     selector: 'mailchannels'
+   *   }],
+   *   domain: 'example.com',
+   *   senderId: 'sender-id'
+   * })
+   * ```
+   */
+  checkDomain(options: EmailsCheckDomainOptions): Promise<EmailsCheckDomainResponse>;
+  /**
+   * Create a DKIM key pair for a specified domain and selector using the specified algorithm and key length, for the current customer.
+   * @param domain - The domain to create the DKIM key for.
+   * @param options - DKIM key creation options.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.emails.createDkimKey('example.com', {
+   *   selector: 'mailchannels'
+   * })
+   * ```
+   */
+  createDkimKey(domain: string, options: EmailsCreateDkimKeyOptions): Promise<EmailsCreateDkimKeyResponse>;
+  /**
+   * Search for DKIM keys by domain, with optional filters. If selector is provided, at most one key will be returned.
+   * @param domain - The domain to search DKIM keys for.
+   * @param options - The options to filter DKIM keys by.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.getDkimKeys('example.com', {
+   *   includeDnsRecord: true
+   * })
+   * ```
+   */
+  getDkimKeys(domain: string, options?: EmailsGetDkimKeysOptions): Promise<EmailsGetDkimKeysResponse>;
+  /**
+   * Update fields of an existing DKIM key pair for the specified domain and selector, for the current customer. Currently, only the `status` field can be updated.
+   * @param domain - The domain the DKIM key belongs to.
+   * @param options - The options to update the DKIM key.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.emails.updateDkimKey('example.com', {
+   *   selector: 'mailchannels',
+   *   status: 'retired'
+   * })
+   */
+  updateDkimKey(domain: string, options: EmailsUpdateDkimKeyOptions): Promise<SuccessResponse>;
+  /**
+   * Rotate an active DKIM key pair. Mark the original key as `rotated`, and create a new key pair with the required new key selector, reusing the same algorithm and key length. The rotated key remains valid for signing for a 3-day grace period, and is automatically changed to `retired` 2 weeks after rotation. Publish the new key to its DNS TXT record before rotated key expires for signing as emails sent with an unpublished key will fail DKIM validation by receiving providers. After the grace period, only the new key is valid for signing if published.
+   * @param domain - The domain the DKIM key belongs to.
+   * @param selector - The selector of the DKIM key to rotate.
+   * @param options - The options to rotate the DKIM key.
+   * @param options.newKey.selector - The selector for the new key pair. Must be a maximum of 63 characters.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.emails.rotateDkimKey('example.com', 'mailchannels', {
+   *   newKey: {
+   *     selector: 'new-selector'
+   *   }
+   * })
+   * ```
+   */
+  rotateDkimKey(domain: string, selector: string, options: EmailsRotateDkimKeyOptions): Promise<EmailsRotateDkimKeyResponse>;
 }
-
-type WebhooksListResponse = DataResponse$1<string[]>;
-
-type WebhooksSigningKeyResponse = DataResponse$1<{
+//#endregion
+//#region src/types/webhooks/list.d.ts
+type WebhooksListResponse = DataResponse<string[]>;
+//#endregion
+//#region src/types/webhooks/signing-key.d.ts
+type WebhooksSigningKeyResponse = DataResponse<{
   key: string;
 }>;
-
-type WebhooksValidateResponse = DataResponse$1<{
+//#endregion
+//#region src/types/webhooks/validate.d.ts
+type WebhooksValidateResponse = DataResponse<{
   /**
    * Indicates whether all webhook validations passed.
    */
@@ -679,60 +673,62 @@ type WebhooksValidateResponse = DataResponse$1<{
     } | null;
   }[];
 }>;
-
+//#endregion
+//#region src/modules/webhooks.d.ts
 declare class Webhooks {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Enrolls the customer to receive event notifications via webhooks.
-     * @param endpoint - The URL to receive event notifications. Must be no longer than `8000` characters.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = mailchannels.webhooks.enroll('https://example.com/api/webhooks/mailchannels')
-     * ```
-     */
-    enroll(endpoint: string): Promise<SuccessResponse>;
-    /**
-     * Retrieves all registered webhook endpoints associated with the customer.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.webhooks.list()
-     * ```
-     */
-    list(): Promise<WebhooksListResponse>;
-    /**
-     * Deletes all registered webhook endpoints for the customer.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.webhooks.delete()
-     * ```
-     */
-    delete(): Promise<SuccessResponse>;
-    /**
-     * Retrieves the public key used to verify signatures on incoming webhook payloads.
-     * @param id - The ID of the key.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.webhooks.getSigningKey('key-id')
-     * ```
-     */
-    getSigningKey(id: string): Promise<WebhooksSigningKeyResponse>;
-    /**
-     * Validates whether your enrolled webhook(s) respond with an HTTP `2xx` status code. Sends a test request to each webhook containing your customer handle, a hardcoded event type (`test`), a hardcoded sender email (`test@mailchannels.com`), a timestamp, a request ID (provided or generated), and an SMTP ID. The response includes the HTTP status code and body returned by each webhook.
-     * @param requestId - Optional identifier in the webhook payload. If not provided, a value will be automatically generated. Must not exceed 28 characters.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.webhooks.validate('optional-request-id')
-     * ```
-     */
-    validate(requestId?: string): Promise<WebhooksValidateResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Enrolls the customer to receive event notifications via webhooks.
+   * @param endpoint - The URL to receive event notifications. Must be no longer than `8000` characters.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = mailchannels.webhooks.enroll('https://example.com/api/webhooks/mailchannels')
+   * ```
+   */
+  enroll(endpoint: string): Promise<SuccessResponse>;
+  /**
+   * Retrieves all registered webhook endpoints associated with the customer.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.webhooks.list()
+   * ```
+   */
+  list(): Promise<WebhooksListResponse>;
+  /**
+   * Deletes all registered webhook endpoints for the customer.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.webhooks.delete()
+   * ```
+   */
+  delete(): Promise<SuccessResponse>;
+  /**
+   * Retrieves the public key used to verify signatures on incoming webhook payloads.
+   * @param id - The ID of the key.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.webhooks.getSigningKey('key-id')
+   * ```
+   */
+  getSigningKey(id: string): Promise<WebhooksSigningKeyResponse>;
+  /**
+   * Validates whether your enrolled webhook(s) respond with an HTTP `2xx` status code. Sends a test request to each webhook containing your customer handle, a hardcoded event type (`test`), a hardcoded sender email (`test@mailchannels.com`), a timestamp, a request ID (provided or generated), and an SMTP ID. The response includes the HTTP status code and body returned by each webhook.
+   * @param requestId - Optional identifier in the webhook payload. If not provided, a value will be automatically generated. Must not exceed 28 characters.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.webhooks.validate('optional-request-id')
+   * ```
+   */
+  validate(requestId?: string): Promise<WebhooksValidateResponse>;
 }
-
+//#endregion
+//#region src/types/sub-accounts/create.d.ts
 interface SubAccountsAccount {
   /**
    * The name of the company associated with the sub-account.
@@ -747,9 +743,9 @@ interface SubAccountsAccount {
    */
   handle: string;
 }
-
-type SubAccountsCreateResponse = DataResponse$1<SubAccountsAccount>;
-
+type SubAccountsCreateResponse = DataResponse<SubAccountsAccount>;
+//#endregion
+//#region src/types/sub-accounts/list.d.ts
 interface SubAccountsListOptions {
   /**
    * Possible values are `1` to `1000`.
@@ -762,9 +758,9 @@ interface SubAccountsListOptions {
    */
   offset?: number;
 }
-
-type SubAccountsListResponse = DataResponse$1<SubAccountsAccount[]>;
-
+type SubAccountsListResponse = DataResponse<SubAccountsAccount[]>;
+//#endregion
+//#region src/types/sub-accounts/api-key.d.ts
 interface SubAccountsApiKey {
   /**
    * The API key ID for the sub-account.
@@ -775,9 +771,7 @@ interface SubAccountsApiKey {
    */
   value: string;
 }
-
-type SubAccountsCreateApiKeyResponse = DataResponse$1<SubAccountsApiKey>;
-
+type SubAccountsCreateApiKeyResponse = DataResponse<SubAccountsApiKey>;
 interface SubAccountsListApiKeyOptions {
   /**
    * The maximum number of API keys included in the response. Possible values are `1` to `1000`.
@@ -790,9 +784,9 @@ interface SubAccountsListApiKeyOptions {
    */
   offset?: number;
 }
-
-type SubAccountsListApiKeyResponse = DataResponse$1<SubAccountsApiKey[]>;
-
+type SubAccountsListApiKeyResponse = DataResponse<SubAccountsApiKey[]>;
+//#endregion
+//#region src/types/sub-accounts/smtp-password.d.ts
 interface SubAccountsSmtpPassword {
   /**
    * Whether the SMTP password is enabled.
@@ -807,17 +801,16 @@ interface SubAccountsSmtpPassword {
    */
   value: string;
 }
-
-type SubAccountsCreateSmtpPasswordResponse = DataResponse$1<SubAccountsSmtpPassword>;
-
-type SubAccountsListSmtpPasswordResponse = DataResponse$1<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$1<SubAccountsLimit>;
-
+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).
@@ -834,170 +827,171 @@ interface SubAccountsUsage {
    */
   total: number;
 }
-
-type SubAccountsUsageResponse = DataResponse$1<SubAccountsUsage>;
-
+type SubAccountsUsageResponse = DataResponse<SubAccountsUsage>;
+//#endregion
+//#region src/modules/sub-accounts.d.ts
 declare class SubAccounts {
-    protected mailchannels: MailChannelsClient;
-    private static readonly COMPANY_PATTERN;
-    private static readonly HANDLE_PATTERN;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Creates a new sub-account under the parent account. Each sub-account must have a unique handle composed solely of lowercase alphanumeric characters. If no handle is provided, a random handle will be generated. Note that Sub-accounts are only available to parent accounts on 100K and higher plans.
-     * @param companyName - The name of the company associated with the sub-account. This name is used for display purposes only and does not affect the functionality of the sub-account. The length must be between 3 and 128 characters.
-     * @param handle - A unique name for the sub-account to be created. The length must be between 3 and 128 characters, and it may contain only lowercase letters and numbers. If not provided, a random handle will be generated.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.create('My Company', 'validhandle123')
-     * ```
-     */
-    create(companyName: string, handle?: string): Promise<SubAccountsCreateResponse>;
-    /**
-     * Retrieves all sub-accounts associated with the parent account. The response is paginated with a default limit of 1000 sub-accounts per page and an offset of 0.
-     * @param options - The options to filter the list of sub-accounts.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.list()
-     * ```
-     */
-    list(options?: SubAccountsListOptions): Promise<SubAccountsListResponse>;
-    /**
-     * Deletes the sub-account identified by its handle.
-     * @param handle - Handle of sub-account to be deleted.
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.delete('validhandle123')
-     * ```
-     */
-    delete(handle: string): Promise<SuccessResponse>;
-    /**
-     * Suspends the sub-account identified by its handle. This action disables the account, preventing it from sending any emails until it is reactivated.
-     * @param handle - Handle of sub-account to be suspended.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.suspend('validhandle123')
-     * ```
-     */
-    suspend(handle: string): Promise<SuccessResponse>;
-    /**
-     * Activates a suspended sub-account identified by its handle, restoring its ability to send emails.
-     * @param handle - Handle of sub-account to be activated.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.activate('validhandle123')
-     * ```
-     */
-    activate(handle: string): Promise<SuccessResponse>;
-    /**
-     * Creates a new API key for the specified sub-account.
-     * @param handle - Handle of the sub-account to create API key for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.createApiKey('validhandle123')
-     * ```
-     */
-    createApiKey(handle: string): Promise<SubAccountsCreateApiKeyResponse>;
-    /**
-     * Retrieves details of all API keys associated with the specified sub-account. For security reasons, the full API key is not returned; only the key ID and a partially redacted version are provided.
-     * @param handle - Handle of the sub-account to retrieve the API key for.
-     * @param options - The options to filter the list of API keys.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.listApiKeys('validhandle123')
-     * ```
-     */
-    listApiKeys(handle: string, options?: SubAccountsListApiKeyOptions): Promise<SubAccountsListApiKeyResponse>;
-    /**
-     * Deletes the API key identified by its ID for the specified sub-account.
-     * @param handle - Handle of the sub-account for which the API key should be deleted.
-     * @param id - The ID of the API key to delete.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.deleteApiKey('validhandle123', 1)
-     * ```
-     */
-    deleteApiKey(handle: string, id: number): Promise<SuccessResponse>;
-    /**
-     * Creates a new SMTP password for the specified sub-account.
-     * @param handle - Handle of the sub-account to create SMTP password for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.createSmtpPassword('validhandle123')
-     * ```
-     */
-    createSmtpPassword(handle: string): Promise<SubAccountsCreateSmtpPasswordResponse>;
-    /**
-     * Retrieves details of all SMTP passwords associated with the specified sub-account. For security, the full SMTP password is not returned; only the password ID and a partially redacted version are provided.
-     * @param handle - Handle of the sub-account to retrieve the SMTP password for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.listSmtpPasswords('validhandle123')
-     * ```
-     */
-    listSmtpPasswords(handle: string): Promise<SubAccountsListSmtpPasswordResponse>;
-    /**
-     * Deletes the SMTP password identified by its ID for the specified sub-account.
-     * @param handle - Handle of the sub-account for which the SMTP password should be deleted.
-     * @param id - The ID of the SMTP password to delete.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.deleteSmtpPassword('validhandle123', 1)
-     * ```
-     */
-    deleteSmtpPassword(handle: string, id: number): Promise<SuccessResponse>;
-    /**
-     * Retrieves the limit of a specified sub-account. A value of `-1` indicates that the sub-account inherits the parent account's limit, allowing the sub-account to utilize any remaining capacity within the parent account's allocation.
-     * @param handle - Handle of the sub-account to retrieve the limit for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.getLimit('validhandle123')
-     * ```
-     */
-    getLimit(handle: string): Promise<SubAccountsLimitResponse>;
-    /**
-     * Sets the limit for the specified sub-account.
-     * @param handle - Handle of the sub-account to set limit for.
-     * @param limit - The limits to set for the sub-account. The minimum allowed sends is `0`
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.setLimit('validhandle123', { sends: 1000 })
-     * ```
-     */
-    setLimit(handle: string, limit: SubAccountsLimit): Promise<SuccessResponse>;
-    /**
-     * Deletes the limit for the specified sub-account. After a successful deletion, the specified sub-account will be limited to the parent account's limit.
-     * @param handle - Handle of the sub-account to delete limit for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.subAccounts.deleteLimit('validhandle123')
-     * ```
-     */
-    deleteLimit(handle: string): Promise<SuccessResponse>;
-    /**
-     * Retrieves usage statistics for the specified sub-account during the current billing period.
-     * @param handle - Handle of the sub-account to query usage stats for.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.subAccounts.getUsage('validhandle123')
-     * ```
-     */
-    getUsage(handle: string): Promise<SubAccountsUsageResponse>;
+  protected mailchannels: MailChannelsClient;
+  private static readonly COMPANY_PATTERN;
+  private static readonly HANDLE_PATTERN;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Creates a new sub-account under the parent account. Each sub-account must have a unique handle composed solely of lowercase alphanumeric characters. If no handle is provided, a random handle will be generated. Note that Sub-accounts are only available to parent accounts on 100K and higher plans.
+   * @param companyName - The name of the company associated with the sub-account. This name is used for display purposes only and does not affect the functionality of the sub-account. The length must be between 3 and 128 characters.
+   * @param handle - A unique name for the sub-account to be created. The length must be between 3 and 128 characters, and it may contain only lowercase letters and numbers. If not provided, a random handle will be generated.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.create('My Company', 'validhandle123')
+   * ```
+   */
+  create(companyName: string, handle?: string): Promise<SubAccountsCreateResponse>;
+  /**
+   * Retrieves all sub-accounts associated with the parent account. The response is paginated with a default limit of 1000 sub-accounts per page and an offset of 0.
+   * @param options - The options to filter the list of sub-accounts.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.list()
+   * ```
+   */
+  list(options?: SubAccountsListOptions): Promise<SubAccountsListResponse>;
+  /**
+   * Deletes the sub-account identified by its handle.
+   * @param handle - Handle of sub-account to be deleted.
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.delete('validhandle123')
+   * ```
+   */
+  delete(handle: string): Promise<SuccessResponse>;
+  /**
+   * Suspends the sub-account identified by its handle. This action disables the account, preventing it from sending any emails until it is reactivated.
+   * @param handle - Handle of sub-account to be suspended.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.suspend('validhandle123')
+   * ```
+   */
+  suspend(handle: string): Promise<SuccessResponse>;
+  /**
+   * Activates a suspended sub-account identified by its handle, restoring its ability to send emails.
+   * @param handle - Handle of sub-account to be activated.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.activate('validhandle123')
+   * ```
+   */
+  activate(handle: string): Promise<SuccessResponse>;
+  /**
+   * Creates a new API key for the specified sub-account.
+   * @param handle - Handle of the sub-account to create API key for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.createApiKey('validhandle123')
+   * ```
+   */
+  createApiKey(handle: string): Promise<SubAccountsCreateApiKeyResponse>;
+  /**
+   * Retrieves details of all API keys associated with the specified sub-account. For security reasons, the full API key is not returned; only the key ID and a partially redacted version are provided.
+   * @param handle - Handle of the sub-account to retrieve the API key for.
+   * @param options - The options to filter the list of API keys.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.listApiKeys('validhandle123')
+   * ```
+   */
+  listApiKeys(handle: string, options?: SubAccountsListApiKeyOptions): Promise<SubAccountsListApiKeyResponse>;
+  /**
+   * Deletes the API key identified by its ID for the specified sub-account.
+   * @param handle - Handle of the sub-account for which the API key should be deleted.
+   * @param id - The ID of the API key to delete.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.deleteApiKey('validhandle123', 1)
+   * ```
+   */
+  deleteApiKey(handle: string, id: number): Promise<SuccessResponse>;
+  /**
+   * Creates a new SMTP password for the specified sub-account.
+   * @param handle - Handle of the sub-account to create SMTP password for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.createSmtpPassword('validhandle123')
+   * ```
+   */
+  createSmtpPassword(handle: string): Promise<SubAccountsCreateSmtpPasswordResponse>;
+  /**
+   * Retrieves details of all SMTP passwords associated with the specified sub-account. For security, the full SMTP password is not returned; only the password ID and a partially redacted version are provided.
+   * @param handle - Handle of the sub-account to retrieve the SMTP password for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.listSmtpPasswords('validhandle123')
+   * ```
+   */
+  listSmtpPasswords(handle: string): Promise<SubAccountsListSmtpPasswordResponse>;
+  /**
+   * Deletes the SMTP password identified by its ID for the specified sub-account.
+   * @param handle - Handle of the sub-account for which the SMTP password should be deleted.
+   * @param id - The ID of the SMTP password to delete.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.deleteSmtpPassword('validhandle123', 1)
+   * ```
+   */
+  deleteSmtpPassword(handle: string, id: number): Promise<SuccessResponse>;
+  /**
+   * Retrieves the limit of a specified sub-account. A value of `-1` indicates that the sub-account inherits the parent account's limit, allowing the sub-account to utilize any remaining capacity within the parent account's allocation.
+   * @param handle - Handle of the sub-account to retrieve the limit for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.getLimit('validhandle123')
+   * ```
+   */
+  getLimit(handle: string): Promise<SubAccountsLimitResponse>;
+  /**
+   * Sets the limit for the specified sub-account.
+   * @param handle - Handle of the sub-account to set limit for.
+   * @param limit - The limits to set for the sub-account. The minimum allowed sends is `0`
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.setLimit('validhandle123', { sends: 1000 })
+   * ```
+   */
+  setLimit(handle: string, limit: SubAccountsLimit): Promise<SuccessResponse>;
+  /**
+   * Deletes the limit for the specified sub-account. After a successful deletion, the specified sub-account will be limited to the parent account's limit.
+   * @param handle - Handle of the sub-account to delete limit for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.subAccounts.deleteLimit('validhandle123')
+   * ```
+   */
+  deleteLimit(handle: string): Promise<SuccessResponse>;
+  /**
+   * Retrieves usage statistics for the specified sub-account during the current billing period.
+   * @param handle - Handle of the sub-account to query usage stats for.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.subAccounts.getUsage('validhandle123')
+   * ```
+   */
+  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).
@@ -1015,9 +1009,9 @@ interface MetricsEngagement {
   openTrackingDelivered: number;
   startTime: string;
 }
-
-type MetricsEngagementResponse = DataResponse$1<MetricsEngagement>;
-
+type MetricsEngagementResponse = DataResponse<MetricsEngagement>;
+//#endregion
+//#region src/types/metrics/performance.d.ts
 interface MetricsPerformance {
   /**
    * Count of messages bounced during the specified time range.
@@ -1048,9 +1042,9 @@ interface MetricsPerformance {
    */
   startTime: string;
 }
-
-type MetricsPerformanceResponse = DataResponse$1<MetricsPerformance>;
-
+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).
@@ -1076,9 +1070,9 @@ interface MetricsRecipientBehaviour {
    */
   unsubscribed: number;
 }
-
-type MetricsRecipientBehaviourResponse = DataResponse$1<MetricsRecipientBehaviour>;
-
+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).
@@ -1109,10 +1103,10 @@ interface MetricsVolume {
    */
   startTime: string;
 }
-
-type MetricsVolumeResponse = DataResponse$1<MetricsVolume>;
-
-type MetricsUsageResponse = DataResponse$1<{
+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).
    * @example "2025-04-11"
@@ -1128,9 +1122,9 @@ type MetricsUsageResponse = DataResponse$1<{
    */
   total: number;
 }>;
-
+//#endregion
+//#region src/types/metrics/senders.d.ts
 type MetricsSendersType = "sub-accounts" | "campaigns";
-
 interface MetricsSendersOptions {
   /**
    * The beginning of the time range for retrieving top senders metrics (inclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`. Defaults to one month ago if not provided.
@@ -1158,7 +1152,6 @@ interface MetricsSendersOptions {
    */
   sortOrder?: "asc" | "desc";
 }
-
 interface MetricsSenders {
   endTime: string;
   limit: number;
@@ -1179,9 +1172,9 @@ interface MetricsSenders {
    */
   total: number;
 }
-
-type MetricsSendersResponse = DataResponse$1<MetricsSenders>;
-
+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.
@@ -1192,7 +1185,6 @@ interface MetricsBucket {
    */
   periodStart: string;
 }
-
 interface MetricsOptions {
   /**
    * The beginning of the time range for retrieving message metrics (inclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`. Defaults to one month ago if not provided.
@@ -1214,74 +1206,75 @@ interface MetricsOptions {
    */
   interval?: "hour" | "day" | "week" | "month";
 }
-
+//#endregion
+//#region src/modules/metrics.d.ts
 declare class Metrics {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Retrieve engagement metrics for messages sent from your account, including counts of open and click events. Supports optional filters for time range, and campaign ID.
-     * @param options - Options to filter and customize the engagement metrics retrieval.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.engagement()
-     * ```
-     */
-    engagement(options?: MetricsOptions): Promise<MetricsEngagementResponse>;
-    /**
-     * Retrieve performance metrics for messages sent from your account, including counts of processed, delivered, hard-bounced events. Supports optional filters for time range, and campaign ID.
-     * @param options - Options to filter and customize the performance metrics retrieval.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.performance()
-     * ```
-     */
-    performance(options?: MetricsOptions): Promise<MetricsPerformanceResponse>;
-    /**
-     * Retrieve recipient behaviour metrics for messages sent from your account, including counts of unsubscribed events. Supports optional filters for time range, and campaign ID.
-     * @param options - Options to filter and customize the recipient behaviour metrics retrieval.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.recipientBehaviour()
-     * ```
-     */
-    recipientBehaviour(options?: MetricsOptions): Promise<MetricsRecipientBehaviourResponse>;
-    /**
-     * Retrieve volume metrics for messages sent from your account, including counts of processed, delivered and dropped events. Supports optional filters for time range and campaign ID.
-     * @param options - Options to filter and customize the volume metrics retrieval.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.volume()
-     * ```
-     */
-    volume(options?: MetricsOptions): Promise<MetricsVolumeResponse>;
-    /**
-     * Retrieves usage statistics during the current billing period.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.usage()
-     * ```
-     */
-    usage(): Promise<MetricsUsageResponse>;
-    /**
-     * Retrieves a list of senders, either sub-accounts or campaigns, with their associated message metrics. Sorted by total # of sent messages (processed + dropped). Supports optional filter for time range, and optional settings for limit, offset, and sort order. Note: senders without any messages in the given time range will not be included in the results. The default time range is from one month ago to now, and the default sort order is descending.
-     * @param type - The type of senders to retrieve metrics for. Can be either `sub-accounts` or `campaigns`.
-     * @param options - Optional filter options for time range, limit, offset, and sort order.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.metrics.senders('campaigns')
-     * ```
-     */
-    senders(type: MetricsSendersType, options?: MetricsSendersOptions): Promise<MetricsSendersResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Retrieve engagement metrics for messages sent from your account, including counts of open and click events. Supports optional filters for time range, and campaign ID.
+   * @param options - Options to filter and customize the engagement metrics retrieval.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.engagement()
+   * ```
+   */
+  engagement(options?: MetricsOptions): Promise<MetricsEngagementResponse>;
+  /**
+   * Retrieve performance metrics for messages sent from your account, including counts of processed, delivered, hard-bounced events. Supports optional filters for time range, and campaign ID.
+   * @param options - Options to filter and customize the performance metrics retrieval.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.performance()
+   * ```
+   */
+  performance(options?: MetricsOptions): Promise<MetricsPerformanceResponse>;
+  /**
+   * Retrieve recipient behaviour metrics for messages sent from your account, including counts of unsubscribed events. Supports optional filters for time range, and campaign ID.
+   * @param options - Options to filter and customize the recipient behaviour metrics retrieval.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.recipientBehaviour()
+   * ```
+   */
+  recipientBehaviour(options?: MetricsOptions): Promise<MetricsRecipientBehaviourResponse>;
+  /**
+   * Retrieve volume metrics for messages sent from your account, including counts of processed, delivered and dropped events. Supports optional filters for time range and campaign ID.
+   * @param options - Options to filter and customize the volume metrics retrieval.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.volume()
+   * ```
+   */
+  volume(options?: MetricsOptions): Promise<MetricsVolumeResponse>;
+  /**
+   * Retrieves usage statistics during the current billing period.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.usage()
+   * ```
+   */
+  usage(): Promise<MetricsUsageResponse>;
+  /**
+   * Retrieves a list of senders, either sub-accounts or campaigns, with their associated message metrics. Sorted by total # of sent messages (processed + dropped). Supports optional filter for time range, and optional settings for limit, offset, and sort order. Note: senders without any messages in the given time range will not be included in the results. The default time range is from one month ago to now, and the default sort order is descending.
+   * @param type - The type of senders to retrieve metrics for. Can be either `sub-accounts` or `campaigns`.
+   * @param options - Optional filter options for time range, limit, offset, and sort order.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.metrics.senders('campaigns')
+   * ```
+   */
+  senders(type: MetricsSendersType, options?: MetricsSendersOptions): Promise<MetricsSendersResponse>;
 }
-
+//#endregion
+//#region src/types/suppressions/create.d.ts
 type SuppressionsTypes = "transactional" | "non-transactional";
-
 interface SuppressionsCreateOptions {
   /**
    * If true, the parent account creates suppression entries for all associated sub-accounts. This field is only applicable to parent accounts. Sub-accounts cannot create entries for other sub-accounts.
@@ -1307,9 +1300,9 @@ 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 {
   /**
    * The email address of the suppression entry to search for. If provided, the search will return the suppression entry associated with this recipient. If not provided, the search will return all suppression entries for the account.
@@ -1338,7 +1331,6 @@ interface SuppressionsListOptions {
    */
   offset?: number;
 }
-
 interface SuppressionsListEntry {
   createdAt: string;
   notes?: string;
@@ -1350,48 +1342,48 @@ interface SuppressionsListEntry {
   source: SuppressionsSource;
   types: SuppressionsTypes[];
 }
-
-type SuppressionsListResponse = DataResponse$1<SuppressionsListEntry[]>;
-
+type SuppressionsListResponse = DataResponse<SuppressionsListEntry[]>;
+//#endregion
+//#region src/modules/suppressions.d.ts
 declare class Suppressions {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Creates suppression entries for the specified account. Parent accounts can create suppression entries for all associated sub-accounts. If `types` is not provided, it defaults to `non-transactional`. The operation is atomic, meaning all entries are successfully added or none are added if an error occurs.
-     * @param options - The details of the suppression entries to create.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.suppressions.create({
-     * // ...
-     * });
-     */
-    create(options: SuppressionsCreateOptions): Promise<SuccessResponse>;
-    /**
-     * Deletes suppression entry associated with the account based on the specified recipient and source.
-     * @param recipient - The email address of the suppression entry to delete.
-     * @param source - The source of the suppression entry to be deleted. If source is not provided, it defaults to `api`. If source is set to `all`, all suppression entries related to the specified recipient will be deleted.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.suppressions.delete('name@example.com', 'api');
-     * ```
-     */
-    delete(recipient: string, source?: SuppressionsSource): Promise<SuccessResponse>;
-    /**
-     * Retrieve suppression entries associated with the specified account. Supports filtering by recipient, source and creation date range. The response is paginated, with a default limit of `1000` entries per page and an offset of `0`.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.suppressions.list();
-     * ```
-     * @param options - Options to filter and customize the suppression entries retrieval.
-     */
-    list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Creates suppression entries for the specified account. Parent accounts can create suppression entries for all associated sub-accounts. If `types` is not provided, it defaults to `non-transactional`. The operation is atomic, meaning all entries are successfully added or none are added if an error occurs.
+   * @param options - The details of the suppression entries to create.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.suppressions.create({
+   * // ...
+   * });
+   */
+  create(options: SuppressionsCreateOptions): Promise<SuccessResponse>;
+  /**
+   * Deletes suppression entry associated with the account based on the specified recipient and source.
+   * @param recipient - The email address of the suppression entry to delete.
+   * @param source - The source of the suppression entry to be deleted. If source is not provided, it defaults to `api`. If source is set to `all`, all suppression entries related to the specified recipient will be deleted.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.suppressions.delete('name@example.com', 'api');
+   * ```
+   */
+  delete(recipient: string, source?: SuppressionsSource): Promise<SuccessResponse>;
+  /**
+   * Retrieve suppression entries associated with the specified account. Supports filtering by recipient, source and creation date range. The response is paginated, with a default limit of `1000` entries per page and an offset of `0`.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.suppressions.list();
+   * ```
+   * @param options - Options to filter and customize the suppression entries retrieval.
+   */
+  list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
 }
-
+//#endregion
+//#region src/types/lists/entry.d.ts
 type ListNames = "blocklist" | "safelist" | "blacklist" | "whitelist";
-
 interface ListEntryOptions {
   /**
    * This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
@@ -1402,17 +1394,15 @@ interface ListEntryOptions {
    */
   item: string;
 }
-
 interface ListEntry {
   action: Extract<ListNames, "blocklist" | "safelist">;
   item: string;
   type: "domain" | "email_address" | "ip_address";
 }
-
-type ListEntryResponse = DataResponse$1<ListEntry>;
-
-type ListEntriesResponse = DataResponse$1<ListEntry[]>;
-
+type ListEntryResponse = DataResponse<ListEntry>;
+type ListEntriesResponse = DataResponse<ListEntry[]>;
+//#endregion
+//#region src/types/domains/provision.d.ts
 interface DomainsData {
   /**
    * The domain name.
@@ -1473,8 +1463,7 @@ interface DomainsData {
    */
   subscriptionHandle: string;
 }
-
-interface DomainsProvisionOptions {
+interface DomainsProvisionOptions extends DomainsData {
   /**
    * If present and set to true, the domain will be associated with the api-key that created it. This means that this api-key must be used for inbound-api actions involving this domain (for example adding safe/block list entries, etc).
    */
@@ -1484,12 +1473,9 @@ interface DomainsProvisionOptions {
    */
   overwrite?: boolean;
 }
-
-type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
-
-type DomainsProvisionResponse = DataResponse$1<DomainsData>;
-
-type DomainsBulkProvisionResponse = DataResponse$1<{
+type DomainsBulkProvisionOptions = Pick<DomainsProvisionOptions, "subscriptionHandle" | "associateKey" | "overwrite">;
+type DomainsProvisionResponse = DataResponse<DomainsData>;
+type DomainsBulkProvisionResponse = DataResponse<{
   /**
    * Domains that were successfully provisioned or updated.
    */
@@ -1513,7 +1499,8 @@ type DomainsBulkProvisionResponse = DataResponse$1<{
     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.
@@ -1530,8 +1517,7 @@ interface DomainsListOptions {
    */
   offset?: number;
 }
-
-type DomainsListResponse = DataResponse$1<{
+type DomainsListResponse = DataResponse<{
   /**
    * A list of domains.
    */
@@ -1541,16 +1527,17 @@ type DomainsListResponse = DataResponse$1<{
    */
   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.
    */
   link: string;
 }
-
-type DomainsCreateLoginLinkResponse = DataResponse$1<DomainsCreateLoginLink>;
-
+type DomainsCreateLoginLinkResponse = DataResponse<DomainsCreateLoginLink>;
+//#endregion
+//#region src/types/domains/downstream-addresses.d.ts
 interface DomainsListDownstreamAddressesOptions {
   /**
    * The number of records to return.
@@ -1563,7 +1550,6 @@ interface DomainsListDownstreamAddressesOptions {
    */
   offset?: number;
 }
-
 interface DomainsDownstreamAddress {
   /**
    * TCP port on which the downstream mail server is listening.
@@ -1582,9 +1568,9 @@ interface DomainsDownstreamAddress {
    */
   weight: number;
 }
-
-type DomainsListDownstreamAddressesResponse = DataResponse$1<DomainsDownstreamAddress[]>;
-
+type DomainsListDownstreamAddressesResponse = DataResponse<DomainsDownstreamAddress[]>;
+//#endregion
+//#region src/types/domains/bulk-create-login-links.d.ts
 interface DomainsBulkCreateLoginLinkResult {
   /**
    * The domain the request was for.
@@ -1600,213 +1586,214 @@ interface DomainsBulkCreateLoginLinkResult {
    */
   loginLink: string;
 }
-
 interface DomainsBulkCreateLoginLinks {
   successes: DomainsBulkCreateLoginLinkResult[];
   errors: Omit<DomainsBulkCreateLoginLinkResult, "loginLink">[];
 }
-
-type DomainsBulkCreateLoginLinksResponse = DataResponse$1<DomainsBulkCreateLoginLinks>;
-
+type DomainsBulkCreateLoginLinksResponse = DataResponse<DomainsBulkCreateLoginLinks>;
+//#endregion
+//#region src/modules/domains.d.ts
 declare class Domains {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Provision a single domain to use MailChannels Inbound.
-     * @param options - The provision options and domain data.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.provision({
-     *   domain: 'example.com',
-     *   subscriptionHandle: 'your-subscription-handle'
-     * })
-     * ```
-     */
-    provision(options: DomainsProvisionOptions & DomainsData): Promise<DomainsProvisionResponse>;
-    /**
-     * Provision up to 1000 domains to use MailChannels Inbound.
-     * @param options - The options to provision the domains.
-     * @param domains - A list of domain data to provision.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.bulkProvision({
-     *   subscriptionHandle: 'your-subscription-handle'
-     * }, [
-     *   {
-     *     domain: 'example.com',
-     *     admins: ['support@example.com']
-     *   },
-     *   {
-     *     domain: 'example2.com'
-     *   }
-     * ])
-     * ```
-     */
-    bulkProvision(options: DomainsBulkProvisionOptions, domains: Omit<DomainsData, "subscriptionHandle">[]): Promise<DomainsBulkProvisionResponse>;
-    /**
-     * Fetch a list of all domains associated with this API key.
-     * @param options - The options to filter the list of domains.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.list()
-     * ```
-     */
-    list(options?: DomainsListOptions): Promise<DomainsListResponse>;
-    /**
-     * De-provision a domain to cease protecting it with MailChannels Inbound.
-     * @param domain - The domain name to be removed.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.domains.delete('example.com')
-     * ```
-     */
-    delete(domain: string): Promise<SuccessResponse>;
-    /**
-     * Add an entry to a domain blocklist or safelist.
-     * @param domain - The domain name.
-     * @param options - The options to add a list entry.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.addListEntry('example.com', {
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    addListEntry(domain: string, options: ListEntryOptions): Promise<ListEntryResponse>;
-    /**
-     * Get domain list entries.
-     * @param domain - The domain name.
-     * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.listEntries('example.com', 'safelist')
-     * ```
-     */
-    listEntries(domain: string, listName: ListNames): Promise<ListEntriesResponse>;
-    /**
-     * Delete item from domain list.
-     * @param email - The domain name whose list will be modified.
-     * @param options - The options for the list entry to delete.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.domains.deleteListEntry('example.com', {
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    deleteListEntry(domain: string, options: ListEntryOptions): Promise<SuccessResponse>;
-    /**
-     * Generate a link that allows a user to log in as a domain administrator.
-     * @param domain - The domain name.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.createLoginLink('example.com')
-     * ```
-     */
-    createLoginLink(domain: string): Promise<DomainsCreateLoginLinkResponse>;
-    /**
-     * Sets the list of downstream addresses for the domain. This action deletes any existing downstream address for the domain before creating new ones. If the `records` parameter is an empty array, all downstream address records will be deleted.
-     * @param domain - The domain name.
-     * @param records - The list of records to set for the domain. A maximum of 10 records can be set.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.domains.setDownstreamAddress('example.com', [
-     *   {
-     *     port: 25,
-     *     priority: 10,
-     *     target: 'example.com.',
-     *     weight: 10
-     *   }
-     * ])
-     * ```
-     */
-    setDownstreamAddress(domain: string, records?: DomainsDownstreamAddress[]): Promise<SuccessResponse>;
-    /**
-     * Retrieve stored downstream addresses for the domain.
-     * @param domain - The domain name.
-     * @param options - The options to filter the list of downstream addresses.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.listDownstreamAddresses('example.com')
-     * ```
-     */
-    listDownstreamAddresses(domain: string, options?: DomainsListDownstreamAddressesOptions): Promise<DomainsListDownstreamAddressesResponse>;
-    /**
-     * Update the API key that is associated with a domain.
-     * @param domain - The domain name.
-     * @param key - The new API key to associate with this domain.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.domains.updateApiKey('example.com', 'your-api-key')
-     * ```
-     */
-    updateApiKey(domain: string, key: string): Promise<SuccessResponse>;
-    /**
-     * Generate a batch of links that allow a user to log in as a domain administrator to their different domains.
-     * @param domains - The list of domain names. Maximum of `1000` links per request.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.domains.bulkCreateLoginLinks(['example.com', 'example2.com'])
-     * ```
-     */
-    bulkCreateLoginLinks(domains: string[]): Promise<DomainsBulkCreateLoginLinksResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Provision a single domain to use MailChannels Inbound.
+   * @param options - The provision options and domain data.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.provision({
+   *   domain: 'example.com',
+   *   subscriptionHandle: 'your-subscription-handle'
+   * })
+   * ```
+   */
+  provision(options: DomainsProvisionOptions): Promise<DomainsProvisionResponse>;
+  /**
+   * Provision up to 1000 domains to use MailChannels Inbound.
+   * @param options - The options to provision the domains.
+   * @param domains - A list of domain data to provision.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.bulkProvision({
+   *   subscriptionHandle: 'your-subscription-handle'
+   * }, [
+   *   {
+   *     domain: 'example.com',
+   *     admins: ['support@example.com']
+   *   },
+   *   {
+   *     domain: 'example2.com'
+   *   }
+   * ])
+   * ```
+   */
+  bulkProvision(options: DomainsBulkProvisionOptions, domains: Omit<DomainsData, "subscriptionHandle">[]): Promise<DomainsBulkProvisionResponse>;
+  /**
+   * Fetch a list of all domains associated with this API key.
+   * @param options - The options to filter the list of domains.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.list()
+   * ```
+   */
+  list(options?: DomainsListOptions): Promise<DomainsListResponse>;
+  /**
+   * De-provision a domain to cease protecting it with MailChannels Inbound.
+   * @param domain - The domain name to be removed.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.domains.delete('example.com')
+   * ```
+   */
+  delete(domain: string): Promise<SuccessResponse>;
+  /**
+   * Add an entry to a domain blocklist or safelist.
+   * @param domain - The domain name.
+   * @param options - The options to add a list entry.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.addListEntry('example.com', {
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  addListEntry(domain: string, options: ListEntryOptions): Promise<ListEntryResponse>;
+  /**
+   * Get domain list entries.
+   * @param domain - The domain name.
+   * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.listEntries('example.com', 'safelist')
+   * ```
+   */
+  listEntries(domain: string, listName: ListNames): Promise<ListEntriesResponse>;
+  /**
+   * Delete item from domain list.
+   * @param email - The domain name whose list will be modified.
+   * @param options - The options for the list entry to delete.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.domains.deleteListEntry('example.com', {
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  deleteListEntry(domain: string, options: ListEntryOptions): Promise<SuccessResponse>;
+  /**
+   * Generate a link that allows a user to log in as a domain administrator.
+   * @param domain - The domain name.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.createLoginLink('example.com')
+   * ```
+   */
+  createLoginLink(domain: string): Promise<DomainsCreateLoginLinkResponse>;
+  /**
+   * Sets the list of downstream addresses for the domain. This action deletes any existing downstream address for the domain before creating new ones. If the `records` parameter is an empty array, all downstream address records will be deleted.
+   * @param domain - The domain name.
+   * @param records - The list of records to set for the domain. A maximum of 10 records can be set.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.domains.setDownstreamAddress('example.com', [
+   *   {
+   *     port: 25,
+   *     priority: 10,
+   *     target: 'example.com.',
+   *     weight: 10
+   *   }
+   * ])
+   * ```
+   */
+  setDownstreamAddress(domain: string, records: DomainsDownstreamAddress[]): Promise<SuccessResponse>;
+  /**
+   * Retrieve stored downstream addresses for the domain.
+   * @param domain - The domain name.
+   * @param options - The options to filter the list of downstream addresses.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.listDownstreamAddresses('example.com')
+   * ```
+   */
+  listDownstreamAddresses(domain: string, options?: DomainsListDownstreamAddressesOptions): Promise<DomainsListDownstreamAddressesResponse>;
+  /**
+   * Update the API key that is associated with a domain.
+   * @param domain - The domain name.
+   * @param key - The new API key to associate with this domain.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.domains.updateApiKey('example.com', 'your-api-key')
+   * ```
+   */
+  updateApiKey(domain: string, key: string): Promise<SuccessResponse>;
+  /**
+   * Generate a batch of links that allow a user to log in as a domain administrator to their different domains.
+   * @param domains - The list of domain names. Maximum of `1000` links per request.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.domains.bulkCreateLoginLinks(['example.com', 'example2.com'])
+   * ```
+   */
+  bulkCreateLoginLinks(domains: string[]): Promise<DomainsBulkCreateLoginLinksResponse>;
 }
-
+//#endregion
+//#region src/modules/lists.d.ts
 declare class Lists {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Add item to account-level list
-     * @param options - The options for the list entry to add.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.lists.addListEntry({
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    addListEntry(options: ListEntryOptions): Promise<ListEntryResponse>;
-    /**
-     * Get account-level list entries.
-     * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.lists.listEntries('safelist')
-     * ```
-     */
-    listEntries(listName: ListNames): Promise<ListEntriesResponse>;
-    /**
-     * Delete item from account-level list.
-     * @param options - The options for the list entry to delete.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.lists.deleteListEntry({
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    deleteListEntry(options: ListEntryOptions): Promise<SuccessResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Add item to account-level list
+   * @param options - The options for the list entry to add.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.lists.addListEntry({
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  addListEntry(options: ListEntryOptions): Promise<ListEntryResponse>;
+  /**
+   * Get account-level list entries.
+   * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.lists.listEntries('safelist')
+   * ```
+   */
+  listEntries(listName: ListNames): Promise<ListEntriesResponse>;
+  /**
+   * Delete item from account-level list.
+   * @param options - The options for the list entry to delete.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.lists.deleteListEntry({
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  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.
@@ -1829,8 +1816,7 @@ interface UsersCreateOptions {
     safelist?: string[];
   };
 }
-
-type UsersCreateResponse = DataResponse$1<{
+type UsersCreateResponse = DataResponse<{
   email: string;
   roles: string[];
   filter?: boolean;
@@ -1840,65 +1826,67 @@ type UsersCreateResponse = DataResponse$1<{
     action: "safelist" | "blocklist";
   }[];
 }>;
-
+//#endregion
+//#region src/modules/users.d.ts
 declare class Users {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Create a recipient user.
-     * @param email - The email address of the user to create.
-     * @param options - The options for the user to create.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.users.create("name@example.com", {
-     *   admin: true
-     * })
-     * ```
-     */
-    create(email: string, options?: UsersCreateOptions): Promise<UsersCreateResponse>;
-    /**
-     * Add item to recipient user list
-     * @param email - The email address of the recipient whose list will be modified.
-     * @param options - The options for the list entry to add.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.users.addListEntry('name@example.com', {
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    addListEntry(email: string, options: ListEntryOptions): Promise<ListEntryResponse>;
-    /**
-     * Get recipient list entries.
-     * @param email - The email address of the recipient whose list will be fetched.
-     * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.users.listEntries('name@example.com', 'safelist')
-     * ```
-     */
-    listEntries(email: string, listName: ListNames): Promise<ListEntriesResponse>;
-    /**
-     * Delete item from recipient list.
-     * @param email - The email address of the recipient whose list will be modified.
-     * @param options - The options for the list entry to delete.
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.users.deleteListEntry('name@example.com', {
-     *   listName: 'safelist',
-     *   item: 'name@domain.com'
-     * })
-     * ```
-     */
-    deleteListEntry(email: string, options: ListEntryOptions): Promise<SuccessResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Create a recipient user.
+   * @param email - The email address of the user to create.
+   * @param options - The options for the user to create.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.users.create("name@example.com", {
+   *   admin: true
+   * })
+   * ```
+   */
+  create(email: string, options?: UsersCreateOptions): Promise<UsersCreateResponse>;
+  /**
+   * Add item to recipient user list
+   * @param email - The email address of the recipient whose list will be modified.
+   * @param options - The options for the list entry to add.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.users.addListEntry('name@example.com', {
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  addListEntry(email: string, options: ListEntryOptions): Promise<ListEntryResponse>;
+  /**
+   * Get recipient list entries.
+   * @param email - The email address of the recipient whose list will be fetched.
+   * @param listName - The name of the list to fetch. This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.users.listEntries('name@example.com', 'safelist')
+   * ```
+   */
+  listEntries(email: string, listName: ListNames): Promise<ListEntriesResponse>;
+  /**
+   * Delete item from recipient list.
+   * @param email - The email address of the recipient whose list will be modified.
+   * @param options - The options for the list entry to delete.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.users.deleteListEntry('name@example.com', {
+   *   listName: 'safelist',
+   *   item: 'name@domain.com'
+   * })
+   * ```
+   */
+  deleteListEntry(email: string, options: ListEntryOptions): Promise<SuccessResponse>;
 }
-
-type ServiceSubscriptionsResponse = DataResponse$1<{
+//#endregion
+//#region src/types/service/subscriptions.d.ts
+type ServiceSubscriptionsResponse = DataResponse<{
   active: boolean;
   activeAccountsCount: number;
   handle: string;
@@ -1911,7 +1899,8 @@ type ServiceSubscriptionsResponse = DataResponse$1<{
     name: string;
   };
 }[]>;
-
+//#endregion
+//#region src/types/service/report.d.ts
 interface ServiceReportOptions {
   /**
    * The report type. It can be either `false_negative` or `false_positive`.
@@ -1936,54 +1925,55 @@ interface ServiceReportOptions {
     name: string;
   };
 }
-
+//#endregion
+//#region src/modules/service.d.ts
 declare class Service {
-    protected mailchannels: MailChannelsClient;
-    constructor(mailchannels: MailChannelsClient);
-    /**
-     * Retrieve the condition of the service
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.service.status()
-     * ```
-     */
-    status(): Promise<SuccessResponse>;
-    /**
-     * Get a list of your subscriptions to MailChannels Inbound
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { data, error } = await mailchannels.service.subscriptions()
-     * ```
-     */
-    subscriptions(): Promise<ServiceSubscriptionsResponse>;
-    /**
-     * Submit a false negative or false positive report.
-     * @param options - The report options
-     * @example
-     * ```ts
-     * const mailchannels = new MailChannels('your-api-key')
-     * const { success, error } = await mailchannels.service.report({
-     * // ...
-     * })
-     * ```
-     */
-    report(options: ServiceReportOptions): Promise<SuccessResponse>;
+  protected mailchannels: MailChannelsClient;
+  constructor(mailchannels: MailChannelsClient);
+  /**
+   * Retrieve the condition of the service
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.service.status()
+   * ```
+   */
+  status(): Promise<SuccessResponse>;
+  /**
+   * Get a list of your subscriptions to MailChannels Inbound
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.service.subscriptions()
+   * ```
+   */
+  subscriptions(): Promise<ServiceSubscriptionsResponse>;
+  /**
+   * Submit a false negative or false positive report.
+   * @param options - The report options
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { success, error } = await mailchannels.service.report({
+   * // ...
+   * })
+   * ```
+   */
+  report(options: ServiceReportOptions): Promise<SuccessResponse>;
 }
-
+//#endregion
+//#region src/mailchannels.d.ts
 declare class MailChannels extends MailChannelsClient {
-    readonly emails: Emails;
-    readonly webhooks: Webhooks;
-    readonly subAccounts: SubAccounts;
-    readonly metrics: Metrics;
-    readonly suppressions: Suppressions;
-    readonly domains: Domains;
-    readonly lists: Lists;
-    readonly users: Users;
-    readonly service: Service;
-    constructor(key: string);
+  readonly emails: Emails;
+  readonly webhooks: Webhooks;
+  readonly subAccounts: SubAccounts;
+  readonly metrics: Metrics;
+  readonly suppressions: Suppressions;
+  readonly domains: Domains;
+  readonly lists: Lists;
+  readonly users: Users;
+  readonly service: Service;
+  constructor(key: string);
 }
-
-export { Domains, Emails, Lists, MailChannels, MailChannelsClient, Metrics, Service, SubAccounts, Suppressions, Users, Webhooks };
-export type { DataResponse$1 as DataResponse, DomainsBulkCreateLoginLinkResult, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, EmailsCheckDomainDkim, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendOptionsBase, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Optional, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, UsersCreateOptions, UsersCreateResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };
+//#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, Webhooks, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };