mailchannels-sdk 0.4.0 → 0.4.2

package/dist/shared/{mailchannels-sdk.DUD1k4jz.d.mts → mailchannels-sdk.ug4M5nbx.d.mts}

@@ -9,281 +9,404 @@ declare class MailChannelsClient {
     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>;
 }
 
-interface EmailsSendRecipient {
-  /**
-   * The email address of the recipient.
-   */
-  email: string;
-  /**
-   * The name of the recipient.
-   */
-  name?: string;
-}
-
-interface EmailsSendAttachment {
-  /**
-   * The attachment data, encoded in base64.
-   */
-  content: string;
-  /**
-   * The name of the attachment file.
-   */
-  filename: string;
-  /**
-   * The MIME type of the attachment.
-   */
-  type: string;
-}
-
-interface EmailsSendTracking {
-  /**
-   * Track when a recipient clicks a link in your email.
-   * @default false
-   */
-  click?: boolean;
-  /**
-   * Track when a recipient opens your email. Please note that some email clients may not support open tracking.
-   * @default false
-   */
-  open?: boolean;
-}
-
-interface EmailsSendOptionsBase {
-  /**
-   * An array of attachments to be sent with the email.
-   */
-  attachments?: EmailsSendAttachment[];
-  /**
-   * The campaign identifier. If specified, this ID will be included in all relevant webhooks. It can be up to 48 UTF-8 characters long and must not contain spaces.
-   */
-  campaignId?: string;
-  /**
-   * The BCC recipients of the email. Can be an array of email addresses or an array of objects with email and name properties or a single email address string or an object with email and name properties.
-   * @example
-   * [
-   *   { email: 'email1@example.com', name: 'Example1' },
-   *   { email: 'email2@example.com', name: 'Example2' }
-   * ]
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * ['email1@example.com', 'email2@example.com']
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  bcc?: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
-  /**
-   * The CC recipients of the email. Can be an array of email addresses or an array of objects with email and name properties or a single email address string or an object with email and name properties.
-   * @example
-   * [
-   *   { email: 'email1@example.com', name: 'Example1' },
-   *   { email: 'email2@example.com', name: 'Example2' }
-   * ]
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * ['email1@example.com', 'email2@example.com']
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  cc?: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
-  /**
-   * The DKIM settings for the email.
-   */
-  dkim?: {
-    /**
-     * Domain used for DKIM signing.
-     */
-    domain: string;
-    /**
-     * DKIM private key encoded in Base64.
-     */
-    privateKey: string;
-    /**
-     * DKIM selector in the domain DNS records.
-     */
-    selector: string;
-  };
-  /**
-   * The sender of the email. Can be a string or an object with email and name properties.
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  from: EmailsSendRecipient | string;
-  /**
-   * The recipient of the email. Can be an array of email addresses or an array of objects with `email` and `name` properties or a single email address string or an object with `email` and `name` properties.
-   * @example
-   * [
-   *   { email: 'email1@example.com', name: 'Example1' },
-   *   { email: 'email2@example.com', name: 'Example2' },
-   * ]
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * ['email1@example.com', 'email2@example.com']
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  to: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
-  /**
-   * Adjust open and click tracking for the message. Please note that enabling tracking for your messages requires a subscription that supports open and click tracking.
-   */
-  tracking?: EmailsSendTracking;
-  /**
-   * A single `replyTo` recipient object, or a single email address.
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  replyTo?: EmailsSendRecipient | string;
-  /**
-   * The subject of the email.
-   */
-  subject: string;
-  /**
-   * Data to be used if the email is a mustache template, key-value pairs of variables to set for template rendering. Keys must be strings.
-   *
-   * the values can be one of the following types:
-   * - string
-   * - number
-   * - boolean
-   * - list, whose values are all of permitted types
-   * - map, whose keys must be strings, and whose values are all of permitted types
-   */
-  mustaches?: Record<string, unknown>;
-  /**
-   * Mark these messages as transactional or non-transactional. In order for a message to be marked as non-transactional, it must have exactly one recipient per personalization, and it must be DKIM signed. 400 Bad Request will be returned if there are more than one recipient in any personalization for non-transactional messages. If a message is marked as non-transactional, it changes the sending process as follows:
-   *
-   * List-Unsubscribe headers will be added.
-   * @default true
-   */
-  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;
-  }
-);
-
-interface EmailsSendResponse {
-  /**
-   * Indicates if the email was successfully sent
-   */
-  success: boolean;
-  /**
-   * Fully rendered message if `dryRun` was set to `true`
-   */
-  data?: string[];
-  error: string | null;
-}
-
-interface EmailsCheckDomainDkim {
-  /**
-   * Domain used for DKIM signing.
-   */
-  domain: string;
-  /**
-   * DKIM private key encoded in Base64.
-   */
-  privateKey: string;
-  /**
-   * DKIM selector in the domain DNS records.
-   */
-  selector: string;
-}
-
-interface EmailsCheckDomainOptions {
-  /**
-   * Up to 10 DKIM checks are allowed.
-   */
-  dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
-  /**
-   * Domain used for sending emails.
-   */
-  domain: string;
-  /**
-   * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
-   */
-  senderId: string;
-}
-
-type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-
-interface EmailsCheckDomainResponse {
-  /**
-   * The results of the domain checks.
-   */
-  results: {
-    dkim: {
-      domain: string;
-      selector: string;
-      /**
-       * A human-readable explanation of DKIM check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    }[];
-    domainLockdown: {
-      /**
-       * A human-readable explanation of Domain Lockdown check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    };
-    spf: {
-      /**
-       * A human-readable explanation of SPF check.
-       */
-      reason?: string;
-      verdict: EmailsCheckDomainVerdict;
-    };
-    references?: string[];
-  } | null;
-  /**
-   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
-   */
-  error: string | null;
+interface SuccessResponse {
+  /**
+   * Whether the operation was successful.
+   */
+  success: boolean;
+  error: string | null;
+}
+
+interface EmailsSendRecipient {
+  /**
+   * The email address of the recipient.
+   */
+  email: string;
+  /**
+   * The name of the recipient.
+   */
+  name?: string;
+}
+
+interface EmailsSendAttachment {
+  /**
+   * The attachment data, encoded in base64.
+   */
+  content: string;
+  /**
+   * The name of the attachment file.
+   */
+  filename: string;
+  /**
+   * The MIME type of the attachment.
+   */
+  type: string;
+}
+
+interface EmailsSendTracking {
+  /**
+   * Track when a recipient clicks a link in your email.
+   * @default false
+   */
+  click?: boolean;
+  /**
+   * Track when a recipient opens your email. Please note that some email clients may not support open tracking.
+   * @default false
+   */
+  open?: boolean;
+}
+
+interface EmailsSendOptionsBase {
+  /**
+   * An array of attachments to be sent with the email.
+   */
+  attachments?: EmailsSendAttachment[];
+  /**
+   * The campaign identifier. If specified, this ID will be included in all relevant webhooks. It can be up to 48 UTF-8 characters long and must not contain spaces.
+   */
+  campaignId?: string;
+  /**
+   * The BCC recipients of the email. Can be an array of email addresses or an array of objects with email and name properties or a single email address string or an object with email and name properties.
+   * @example
+   * [
+   *   { email: 'email1@example.com', name: 'Example1' },
+   *   { email: 'email2@example.com', name: 'Example2' }
+   * ]
+   * @example
+   * { email: 'email@example.com', name: 'Example' }
+   * @example
+   * ['email1@example.com', 'email2@example.com']
+   * @example
+   * 'email@example.com'
+   * @example
+   * 'Name <email@example.com>'
+   */
+  bcc?: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
+  /**
+   * The CC recipients of the email. Can be an array of email addresses or an array of objects with email and name properties or a single email address string or an object with email and name properties.
+   * @example
+   * [
+   *   { email: 'email1@example.com', name: 'Example1' },
+   *   { email: 'email2@example.com', name: 'Example2' }
+   * ]
+   * @example
+   * { email: 'email@example.com', name: 'Example' }
+   * @example
+   * ['email1@example.com', 'email2@example.com']
+   * @example
+   * 'email@example.com'
+   * @example
+   * 'Name <email@example.com>'
+   */
+  cc?: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
+  /**
+   * The DKIM settings for the email.
+   */
+  dkim?: {
+    /**
+     * Domain used for DKIM signing.
+     */
+    domain: string;
+    /**
+     * DKIM private key encoded in Base64.
+     */
+    privateKey: string;
+    /**
+     * DKIM selector in the domain DNS records.
+     */
+    selector: string;
+  };
+  /**
+   * The sender of the email. Can be a string or an object with email and name properties.
+   * @example
+   * { email: 'email@example.com', name: 'Example' }
+   * @example
+   * 'email@example.com'
+   * @example
+   * 'Name <email@example.com>'
+   */
+  from: EmailsSendRecipient | string;
+  /**
+   * The recipient of the email. Can be an array of email addresses or an array of objects with `email` and `name` properties or a single email address string or an object with `email` and `name` properties.
+   * @example
+   * [
+   *   { email: 'email1@example.com', name: 'Example1' },
+   *   { email: 'email2@example.com', name: 'Example2' },
+   * ]
+   * @example
+   * { email: 'email@example.com', name: 'Example' }
+   * @example
+   * ['email1@example.com', 'email2@example.com']
+   * @example
+   * 'email@example.com'
+   * @example
+   * 'Name <email@example.com>'
+   */
+  to: EmailsSendRecipient[] | EmailsSendRecipient | string[] | string;
+  /**
+   * Adjust open and click tracking for the message. Please note that enabling tracking for your messages requires a subscription that supports open and click tracking.
+   */
+  tracking?: EmailsSendTracking;
+  /**
+   * A single `replyTo` recipient object, or a single email address.
+   * @example
+   * { email: 'email@example.com', name: 'Example' }
+   * @example
+   * 'email@example.com'
+   * @example
+   * 'Name <email@example.com>'
+   */
+  replyTo?: EmailsSendRecipient | string;
+  /**
+   * The subject of the email.
+   */
+  subject: string;
+  /**
+   * Data to be used if the email is a mustache template, key-value pairs of variables to set for template rendering. Keys must be strings.
+   *
+   * the values can be one of the following types:
+   * - string
+   * - number
+   * - boolean
+   * - list, whose values are all of permitted types
+   * - map, whose keys must be strings, and whose values are all of permitted types
+   */
+  mustaches?: Record<string, unknown>;
+  /**
+   * Mark these messages as transactional or non-transactional. In order for a message to be marked as non-transactional, it must have exactly one recipient per personalization, and it must be DKIM signed. 400 Bad Request will be returned if there are more than one recipient in any personalization for non-transactional messages. If a message is marked as non-transactional, it changes the sending process as follows:
+   *
+   * List-Unsubscribe headers will be added.
+   * @default true
+   */
+  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;
+  }
+);
+
+interface EmailsSendResponse {
+  /**
+   * Indicates if the email was successfully sent
+   */
+  success: boolean;
+  /**
+   * Fully rendered message if `dryRun` was set to `true`
+   */
+  data?: string[];
+  error: string | null;
+}
+
+interface EmailsCheckDomainDkim {
+  /**
+   * Domain used for DKIM signing.
+   */
+  domain: string;
+  /**
+   * DKIM private key encoded in Base64.
+   */
+  privateKey: string;
+  /**
+   * DKIM selector in the domain DNS records.
+   */
+  selector: string;
+}
+
+interface EmailsCheckDomainOptions {
+  /**
+   * Up to 10 DKIM checks are allowed.
+   */
+  dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
+  /**
+   * Domain used for sending emails.
+   */
+  domain: string;
+  /**
+   * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
+   */
+  senderId: string;
+}
+
+type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
+
+interface EmailsCheckDomainResponse {
+  /**
+   * The results of the domain checks.
+   */
+  results: {
+    dkim: {
+      domain: string;
+      selector: string;
+      /**
+       * A human-readable explanation of DKIM check.
+       */
+      reason?: string;
+      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
+    }[];
+    domainLockdown: {
+      /**
+       * A human-readable explanation of Domain Lockdown check.
+       */
+      reason?: string;
+      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
+    };
+    spf: {
+      /**
+       * A human-readable explanation of SPF check.
+       */
+      reason?: string;
+      verdict: EmailsCheckDomainVerdict;
+    };
+    references?: string[];
+  } | null;
+  /**
+   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
+   */
+  error: string | null;
+}
+
+interface EmailsCreateDkimKeyOptions {
+  /**
+   * Algorithm used for the new key pair Currently, only RSA is supported.
+   * @default "rsa"
+   */
+  algorithm?: "rsa";
+  /**
+   * Key length in bits. For RSA, must be a multiple of 1024. Common values: 1024 or 2048.
+   * @default 2048
+   */
+  length?: 1024 | 2048 | 3072 | 4096;
+  /**
+   * Selector for the new key pair. Must be a maximum of 63 characters.
+   */
+  selector: string;
+}
+
+interface EmailsDkimKey {
+  /**
+   * Algorithm used for the key pair.
+   */
+  algorithm: string;
+  /**
+   * Timestamp when the key pair was created.
+   */
+  createdAt: string;
+  /**
+   * Suggested DNS records for the DKIM key.
+   */
+  dnsRecords: {
+    name: string;
+    type: string;
+    value: string;
+  }[];
+  /**
+   * Domain associated with the key pair.
+   */
+  domain: string;
+  /**
+   * Key length in bits.
+   */
+  length: 1024 | 2048 | 3072 | 4096;
+  publicKey: string;
+  /**
+   * Selector assigned to the key pair.
+   */
+  selector: string;
+  /**
+   * Status of the key.
+   */
+  status: "active" | "revoked" | "retired";
+  /**
+   * Timestamp when the key was last modified.
+   */
+  statusModifiedAt: string;
+}
+
+interface EmailsCreateDkimKeyResponse {
+  /**
+   * The created DKIM key information.
+   */
+  key: EmailsDkimKey | null;
+  error: string | null;
+}
+
+interface EmailsGetDkimKeysOptions {
+  /**
+   * Selector to filter keys by. Must be a maximum of 63 characters.
+   */
+  selector?: string;
+  /**
+   * Status to filter keys by.
+   */
+  status?: EmailsDkimKey["status"];
+  /**
+   * Number of keys to skip before returning results.
+   * @default 0
+   */
+  offset?: number;
+  /**
+   * Maximum number of keys to return. Maximum is `100` and minimum is `1`.
+   * @default 10
+   */
+  limit?: number;
+  /**
+   * If `true`, includes the suggested DKIM DNS record for each returned key.
+   * @default false
+   */
+  includeDnsRecord?: boolean;
+}
+
+type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+interface EmailsGetDkimKeysResponse {
+  /**
+   * List of keys matching the filter. Empty if no keys match the filter.
+   */
+  keys: Optional<EmailsDkimKey, "dnsRecords">[];
+  error: string | null;
+}
+
+interface EmailsUpdateDkimKeyOptions {
+  /**
+   * Selector of the DKIM key pair to update. Must be a maximum of 63 characters.
+   */
+  selector: string;
+  /**
+   * New status of the DKIM key pair
+   * - `revoked`: Indicates that the key is compromised and should not be used.
+   * - `retired`: Indicates that the key has been rotated and is no longer in use.
+   */
+  status: Exclude<EmailsDkimKey["status"], "active">;
 }
 
 declare class Emails {
@@ -323,58 +446,89 @@ declare class Emails {
      * ```
      */
     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 { key, error } = await mailchannels.emails.createDkimKey('example.com', {
+     *   selector: 'mailchannels'
+     * })
+     * ```
+     */
+    createDkimKey(domain: string, options: EmailsCreateDkimKeyOptions): Promise<EmailsCreateDkimKeyResponse>;
+    /**
+     * Search for DKIM keys by customer handle and 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 { keys } = 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 } = await mailchannels.emails.updateDkimKey('example.com', {
+     *   selector: 'mailchannels',
+     *   status: 'retired'
+     * })
+     */
+    updateDkimKey(domain: string, options: EmailsUpdateDkimKeyOptions): Promise<SuccessResponse>;
+}
+
+interface WebhooksListResponse {
+  webhooks: string[];
+  error: string | null;
 }
 
-interface SuccessResponse {
-  /**
-   * Whether the operation was successful.
-   */
-  success: boolean;
-  error: string | null;
-}
-
-interface WebhooksListResponse {
-  webhooks: string[];
-  error: string | null;
-}
-
-interface WebhooksSigningKeyResponse {
-  key: string | null;
-  error: string | null;
-}
-
-interface WebhooksValidateResponse {
-  /**
-   * Indicates whether all webhook validations passed
-   */
-  allPassed: boolean;
-  /**
-   * Detailed results for each tested webhook, including whether it returned a 2xx status code, along with its response status code and body.
-   */
-  results: {
-    /**
-     * Indicates whether the webhook responded with a 2xx HTTP status code
-     */
-    result: "passed" | "failed";
-    /**
-     * The webhook that was validated
-     */
-    webhook: string;
-    /**
-     * The HTTP response returned by the webhook, including status code and response body. A null value indicates no response was received. Possible reasons include timeouts, connection failures, or other network-related issues.
-     */
-    response: {
-      /**
-       * Response body from webhook. Returns an error if unprocessable or too large.
-       */
-      body?: string;
-      /**
-       * HTTP status code returned by the webhook
-       */
-      status: number;
-    } | null;
-  }[];
-  error: string | null;
+interface WebhooksSigningKeyResponse {
+  key: string | null;
+  error: string | null;
+}
+
+interface WebhooksValidateResponse {
+  /**
+   * Indicates whether all webhook validations passed
+   */
+  allPassed: boolean;
+  /**
+   * Detailed results for each tested webhook, including whether it returned a 2xx status code, along with its response status code and body.
+   */
+  results: {
+    /**
+     * Indicates whether the webhook responded with a 2xx HTTP status code
+     */
+    result: "passed" | "failed";
+    /**
+     * The webhook that was validated
+     */
+    webhook: string;
+    /**
+     * The HTTP response returned by the webhook, including status code and response body. A null value indicates no response was received. Possible reasons include timeouts, connection failures, or other network-related issues.
+     */
+    response: {
+      /**
+       * Response body from webhook. Returns an error if unprocessable or too large.
+       */
+      body?: string;
+      /**
+       * HTTP status code returned by the webhook
+       */
+      status: number;
+    } | null;
+  }[];
+  error: string | null;
 }
 
 declare class Webhooks {
@@ -430,119 +584,119 @@ declare class Webhooks {
     validate(requestId?: string): Promise<WebhooksValidateResponse>;
 }
 
-interface SubAccountsAccount {
-  /**
-   * The name of the company associated with the sub-account.
-   */
-  companyName: string;
-  /**
-   * If the sub-account is enabled.
-   */
-  enabled: boolean;
-  /**
-   * The handle for the sub-account.
-   */
-  handle: string;
-}
-
-interface SubAccountsCreateResponse {
-  account: SubAccountsAccount | null;
-  error: string | null;
-}
-
-interface SubAccountsListOptions {
-  /**
-   * Possible values are `1` to `1000`.
-   * @default 1000
-   */
-  limit?: number;
-  /**
-   * The offset for pagination.
-   * @default 0
-   */
-  offset?: number;
-}
-
-interface SubAccountsListResponse {
-  accounts: SubAccountsAccount[];
-  error: string | null;
-}
-
-interface SubAccountsApiKey {
-  /**
-   * The API key ID for the sub-account.
-   */
-  id: number;
-  /**
-   * API key for the sub-account.
-   */
-  value: string;
-}
-
-interface SubAccountsCreateApiKeyResponse {
-  key: SubAccountsApiKey | null;
-  error: string | null;
-}
-
-interface SubAccountsListApiKeyResponse {
-  keys: SubAccountsApiKey[];
-  error: string | null;
-}
-
-interface SubAccountsSmtpPassword {
-  /**
-   * Whether the SMTP password is enabled.
-   */
-  enabled: boolean;
-  /**
-   * The SMTP password ID for the sub-account.
-   */
-  id: number;
-  /**
-   * SMTP password for the sub-account.
-   */
-  value: string;
-}
-
-interface SubAccountsCreateSmtpPasswordResponse {
-  password: SubAccountsSmtpPassword | null;
-  error: string | null;
-}
-
-interface SubAccountsListSmtpPasswordResponse {
-  passwords: SubAccountsSmtpPassword[];
-  error: string | null;
-}
-
-interface SubAccountsLimit {
-  sends: number;
-}
-
-interface SubAccountsLimitResponse {
-  limit: SubAccountsLimit | null;
-  error: string | null;
-}
-
-interface SubAccountsUsage {
-  /**
-   * The end date of the current billing period (ISO 8601 format).
-   * @example "2025-04-11"
-   */
-  endDate?: string;
-  /**
-   * The start date of the current billing period (ISO 8601 format).
-   * @example "2025-03-12"
-   */
-  startDate?: string;
-  /**
-   * The total usage for the current billing period.
-   */
-  total: number;
-}
-
-interface SubAccountsUsageResponse {
-  usage: SubAccountsUsage | null;
-  error: string | null;
+interface SubAccountsAccount {
+  /**
+   * The name of the company associated with the sub-account.
+   */
+  companyName: string;
+  /**
+   * If the sub-account is enabled.
+   */
+  enabled: boolean;
+  /**
+   * The handle for the sub-account.
+   */
+  handle: string;
+}
+
+interface SubAccountsCreateResponse {
+  account: SubAccountsAccount | null;
+  error: string | null;
+}
+
+interface SubAccountsListOptions {
+  /**
+   * Possible values are `1` to `1000`.
+   * @default 1000
+   */
+  limit?: number;
+  /**
+   * The offset for pagination.
+   * @default 0
+   */
+  offset?: number;
+}
+
+interface SubAccountsListResponse {
+  accounts: SubAccountsAccount[];
+  error: string | null;
+}
+
+interface SubAccountsApiKey {
+  /**
+   * The API key ID for the sub-account.
+   */
+  id: number;
+  /**
+   * API key for the sub-account.
+   */
+  value: string;
+}
+
+interface SubAccountsCreateApiKeyResponse {
+  key: SubAccountsApiKey | null;
+  error: string | null;
+}
+
+interface SubAccountsListApiKeyResponse {
+  keys: SubAccountsApiKey[];
+  error: string | null;
+}
+
+interface SubAccountsSmtpPassword {
+  /**
+   * Whether the SMTP password is enabled.
+   */
+  enabled: boolean;
+  /**
+   * The SMTP password ID for the sub-account.
+   */
+  id: number;
+  /**
+   * SMTP password for the sub-account.
+   */
+  value: string;
+}
+
+interface SubAccountsCreateSmtpPasswordResponse {
+  password: SubAccountsSmtpPassword | null;
+  error: string | null;
+}
+
+interface SubAccountsListSmtpPasswordResponse {
+  passwords: SubAccountsSmtpPassword[];
+  error: string | null;
+}
+
+interface SubAccountsLimit {
+  sends: number;
+}
+
+interface SubAccountsLimitResponse {
+  limit: SubAccountsLimit | null;
+  error: string | null;
+}
+
+interface SubAccountsUsage {
+  /**
+   * The end date of the current billing period (ISO 8601 format).
+   * @example "2025-04-11"
+   */
+  endDate?: string;
+  /**
+   * The start date of the current billing period (ISO 8601 format).
+   * @example "2025-03-12"
+   */
+  startDate?: string;
+  /**
+   * The total usage for the current billing period.
+   */
+  total: number;
+}
+
+interface SubAccountsUsageResponse {
+  usage: SubAccountsUsage | null;
+  error: string | null;
 }
 
 declare class SubAccounts {
@@ -705,171 +859,171 @@ declare class SubAccounts {
     getUsage(handle: string): Promise<SubAccountsUsageResponse>;
 }
 
-interface MetricsEngagement {
-  buckets: {
-    click: MetricsBucket[];
-    clickTrackingDelivered: MetricsBucket[];
-    open: MetricsBucket[];
-    openTrackingDelivered: MetricsBucket[];
-  };
-  click: number;
-  clickTrackingDelivered: number;
-  endTime: string;
-  open: number;
-  openTrackingDelivered: number;
-  startTime: string;
-}
-
-interface MetricsEngagementResponse {
-  engagement: MetricsEngagement | null;
-  error: string | null;
-}
-
-interface MetricsPerformance {
-  /**
-   * Count of messages bounced during the specified time range.
-   */
-  bounced: number;
-  buckets: {
-    bounced: MetricsBucket[];
-    delivered: MetricsBucket[];
-    processed: MetricsBucket[];
-  };
-  /**
-   * Count of messages delivered during the specified time range.
-   */
-  delivered: number;
-  /**
-   * The end of the time range for retrieving message performance metrics (exclusive).
-   */
-  endTime: string;
-  /**
-   * Count of messages processed during the specified time range.
-   */
-  processed: number;
-  /**
-   * The beginning of the time range for retrieving message performance metrics (inclusive).
-   */
-  startTime: string;
-}
-
-interface MetricsPerformanceResponse {
-  performance: MetricsPerformance | null;
-  error: string | null;
-}
-
-interface MetricsRecipientBehaviour {
-  buckets: {
-    unsubscribeDelivered: MetricsBucket[];
-    unsubscribed: MetricsBucket[];
-  };
-  /**
-   * The end of the time range for retrieving recipient behaviour metrics (exclusive).
-   */
-  endTime: string;
-  /**
-   * The beginning of the time range for retrieving recipient behaviour metrics (inclusive).
-   */
-  startTime: string;
-  /**
-   * Count of recipients of delivered messages that include at least one of the unsubscribe link or unsubscribe headers. Since the unsubscribe feature requires exactly one recipient per message, this count also represents the total number of delivered messages.
-   */
-  unsubscribeDelivered: number;
-  /**
-   * Count of unsubscribed events by recipients.
-   */
-  unsubscribed: number;
-}
-
-interface MetricsRecipientBehaviourResponse {
-  behaviour: MetricsRecipientBehaviour | null;
-  error: string | null;
-}
-
-interface MetricsVolume {
-  buckets: {
-    delivered: MetricsBucket[];
-    dropped: MetricsBucket[];
-    processed: MetricsBucket[];
-  };
-  /**
-   * Count of messages delivered during the specified time range.
-   */
-  delivered: number;
-  /**
-   * Count of messages dropped during the specified time range.
-   */
-  dropped: number;
-  /**
-   * The end of the time range for retrieving message volume metrics (exclusive).
-   */
-  endTime: string;
-  /**
-   * Count of messages processed during the specified time range.
-   */
-  processed: number;
-  /**
-   * The beginning of the time range for retrieving message volume metrics (inclusive).
-   */
-  startTime: string;
-}
-
-interface MetricsVolumeResponse {
-  volume: MetricsVolume | null;
-  error: string | null;
-}
-
-interface MetricsUsageResponse {
-  usage: {
-    /**
-     * The end date of the current billing period (ISO 8601 format).
-     * @example "2025-04-11"
-     */
-    endDate: string;
-    /**
-     * The start date of the current billing period (ISO 8601 format).
-     * @example "2025-03-12"
-     */
-    startDate: string;
-    /**
-     * The total usage for the current billing period.
-     */
-    total: number;
-  } | null;
-  error: string | null;
-}
-
-interface MetricsBucket {
-  /**
-   * The number of events or occurrences aggregated within this time period.
-   */
-  count: number;
-  /**
-   * The starting date and time of the time period this bucket represents.
-   */
-  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.
-   * @example "2025-05-26"
-   */
-  startTime?: string;
-  /**
-   * The end of the time range for retrieving message metrics (exclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`. Defaults to the current time if not provided.
-   * @example "2025-05-31T15:16:17Z"
-   */
-  endTime?: string;
-  /**
-   * The ID of the campaign to filter metrics by. If not provided, metrics for all campaigns will be returned.
-   */
-  campaignId?: string;
-  /**
-   * The interval for aggregating metrics data.
-   * @default "day"
-   */
-  interval?: "hour" | "day" | "week" | "month";
+interface MetricsEngagement {
+  buckets: {
+    click: MetricsBucket[];
+    clickTrackingDelivered: MetricsBucket[];
+    open: MetricsBucket[];
+    openTrackingDelivered: MetricsBucket[];
+  };
+  click: number;
+  clickTrackingDelivered: number;
+  endTime: string;
+  open: number;
+  openTrackingDelivered: number;
+  startTime: string;
+}
+
+interface MetricsEngagementResponse {
+  engagement: MetricsEngagement | null;
+  error: string | null;
+}
+
+interface MetricsPerformance {
+  /**
+   * Count of messages bounced during the specified time range.
+   */
+  bounced: number;
+  buckets: {
+    bounced: MetricsBucket[];
+    delivered: MetricsBucket[];
+    processed: MetricsBucket[];
+  };
+  /**
+   * Count of messages delivered during the specified time range.
+   */
+  delivered: number;
+  /**
+   * The end of the time range for retrieving message performance metrics (exclusive).
+   */
+  endTime: string;
+  /**
+   * Count of messages processed during the specified time range.
+   */
+  processed: number;
+  /**
+   * The beginning of the time range for retrieving message performance metrics (inclusive).
+   */
+  startTime: string;
+}
+
+interface MetricsPerformanceResponse {
+  performance: MetricsPerformance | null;
+  error: string | null;
+}
+
+interface MetricsRecipientBehaviour {
+  buckets: {
+    unsubscribeDelivered: MetricsBucket[];
+    unsubscribed: MetricsBucket[];
+  };
+  /**
+   * The end of the time range for retrieving recipient behaviour metrics (exclusive).
+   */
+  endTime: string;
+  /**
+   * The beginning of the time range for retrieving recipient behaviour metrics (inclusive).
+   */
+  startTime: string;
+  /**
+   * Count of recipients of delivered messages that include at least one of the unsubscribe link or unsubscribe headers. Since the unsubscribe feature requires exactly one recipient per message, this count also represents the total number of delivered messages.
+   */
+  unsubscribeDelivered: number;
+  /**
+   * Count of unsubscribed events by recipients.
+   */
+  unsubscribed: number;
+}
+
+interface MetricsRecipientBehaviourResponse {
+  behaviour: MetricsRecipientBehaviour | null;
+  error: string | null;
+}
+
+interface MetricsVolume {
+  buckets: {
+    delivered: MetricsBucket[];
+    dropped: MetricsBucket[];
+    processed: MetricsBucket[];
+  };
+  /**
+   * Count of messages delivered during the specified time range.
+   */
+  delivered: number;
+  /**
+   * Count of messages dropped during the specified time range.
+   */
+  dropped: number;
+  /**
+   * The end of the time range for retrieving message volume metrics (exclusive).
+   */
+  endTime: string;
+  /**
+   * Count of messages processed during the specified time range.
+   */
+  processed: number;
+  /**
+   * The beginning of the time range for retrieving message volume metrics (inclusive).
+   */
+  startTime: string;
+}
+
+interface MetricsVolumeResponse {
+  volume: MetricsVolume | null;
+  error: string | null;
+}
+
+interface MetricsUsageResponse {
+  usage: {
+    /**
+     * The end date of the current billing period (ISO 8601 format).
+     * @example "2025-04-11"
+     */
+    endDate: string;
+    /**
+     * The start date of the current billing period (ISO 8601 format).
+     * @example "2025-03-12"
+     */
+    startDate: string;
+    /**
+     * The total usage for the current billing period.
+     */
+    total: number;
+  } | null;
+  error: string | null;
+}
+
+interface MetricsBucket {
+  /**
+   * The number of events or occurrences aggregated within this time period.
+   */
+  count: number;
+  /**
+   * The starting date and time of the time period this bucket represents.
+   */
+  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.
+   * @example "2025-05-26"
+   */
+  startTime?: string;
+  /**
+   * The end of the time range for retrieving message metrics (exclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`. Defaults to the current time if not provided.
+   * @example "2025-05-31T15:16:17Z"
+   */
+  endTime?: string;
+  /**
+   * The ID of the campaign to filter metrics by. If not provided, metrics for all campaigns will be returned.
+   */
+  campaignId?: string;
+  /**
+   * The interval for aggregating metrics data.
+   * @default "day"
+   */
+  interval?: "hour" | "day" | "week" | "month";
 }
 
 declare class Metrics {
@@ -926,366 +1080,80 @@ declare class Metrics {
     usage(): Promise<MetricsUsageResponse>;
 }
 
-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.
-   * @default false
-   */
-  addToSubAccounts?: boolean;
-  /**
-   * The total number of suppression entries to create, for the parent and/or its sub-accounts, must not exceed `1000`.
-   */
-  entries: {
-    /**
-     * Must be less than `1024` characters.
-     */
-    notes?: string;
-    /**
-     * The email address to suppress. Must be a valid email address format and less than `255` characters.
-     */
-    recipient: string;
-    /**
-     * An array of types of suppression to apply to the recipient.
-     * @default ["non-transactional"]
-     */
-    types?: SuppressionsTypes[];
-  }[];
-}
-
-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.
-   */
-  recipient?: string;
-  /**
-   * The source of the suppression entries to filter by. If not provided, suppression entries from all sources will be returned.
-   */
-  source?: Exclude<SuppressionsSource, "all">;
-  /**
-   * The date and/or time before which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`
-   */
-  createdBefore?: string;
-  /**
-   * The date and/or time after which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`
-   */
-  createdAfter?: string;
-  /**
-   * The maximum number of suppression entries to return. Must be between `1` and `1000`.
-   * @default 1000
-   */
-  limit?: number;
-  /**
-   * The number of suppression entries to skip before returning results.
-   * @default 0
-   */
-  offset?: number;
-}
-
-interface SuppressionsListEntry {
-  createdAt: string;
-  notes?: string;
-  /**
-   * The email address that is suppressed.
-   */
-  recipient: string;
-  sender?: string;
-  source: SuppressionsSource;
-  types: SuppressionsTypes[];
-}
-
-interface SuppressionsListResponse {
-  list: SuppressionsListEntry[];
-  error: string | null;
-}
-
-interface DomainsData {
-  /**
-   * The domain name.
-   */
-  domain: string;
-  /**
-   * The abuse policy settings for the domain. These settings determine how spam messages are handled.
-   */
-  settings?: Partial<{
-    /**
-     * The abuse policy.
-     */
-    abusePolicy: "block" | "flag" | "quarantine";
-    /**
-     * If `true`, this abuse policy overrides the recipient abuse policy.
-     */
-    abusePolicyOverride: boolean;
-    /**
-     * The spam header name to use if the abuse policy is set to `flag`.
-     */
-    spamHeaderName: string;
-    /**
-     * The spam header value to use if the abuse policy is set to `flag`.
-     */
-    spamHeaderValue: string;
-  }>;
-  /**
-   * A list of email addresses that are the domain admins for the domain.
-   */
-  admins?: string[] | null;
-  /**
-   * The locations of mail servers to which messages will be delivered after filtering.
-   */
-  downstreamAddresses?: {
-    /**
-     * The priority of the downstream address. Only addresses with the highest priority (the lowest numerical value) are selected.
-     */
-    priority: number;
-    /**
-     * Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.
-     */
-    weight: number;
-    /**
-     * TCP port on which the downstream mail server is listening.
-     */
-    port: number;
-    /**
-     * The canonical hostname of the host providing the service, ending in a dot.
-     */
-    target: string;
-  }[] | null;
-  /**
-   * A list of aliases for the domain. Mail is accepted for these domains and routed to the `downstreamAddresses` defined for the domain. Must be <= 255 characters
-   */
-  aliases?: string[] | null;
-  /**
-   * The subscription `handle` that identifies the subscription that this domain should be provisioned against. Subscription handles can be retrieved from the `subscriptions` service method.
-   */
-  subscriptionHandle: string;
-}
-
-interface DomainsProvisionOptions {
-  /**
-   * 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).
-   */
-  associateKey?: boolean;
-  /**
-   * If present and set to true, the settings (domain settings, downstream addresses, aliases and admins) for the domain will be overwritten with the ones in the request if the domain already exists, unless a section is not included in the request or there is problem updating a setting in which case the previous settings are carried forward.
-   */
-  overwrite?: boolean;
-}
-
-type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
-
-interface DomainsProvisionResponse {
-  data: DomainsData | null;
-  error: string | null;
-}
-
-interface DomainsBulkProvisionResponse {
-  /**
-   * If the request was processed successfully, this does not necessarily mean all the domains in the request were successfully provisioned.
-   */
-  results: {
-    /**
-     * Domains that were successfully provisioned or updated.
-     */
-    successes: {
-      domain: DomainsData;
-      code: number;
-      comment?: string;
-    }[];
-    /**
-     * Domains that were not successfully provisioned.
-     */
-    errors: {
-      domain: DomainsData;
-      code: number;
-      comment?: string;
-    }[];
-  } | null;
-  error: string | null;
-}
-
-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.
-   */
-  domains?: string[];
-  /**
-   * The maximum number of domains included in the response. Possible values are 1 to 5000
-   * @default 10
-   */
-  limit?: number;
-  /**
-   * Offset into the list of domains to return.
-   * @default 0
-   */
-  offset?: number;
-}
-
-interface DomainsListResponse {
-  /**
-   * A list of domains
-   */
-  domains: DomainsData[];
-  /**
-   * The total number of domains that are accessible with the given API key that match the list of domains in the 'domains' parameter. If there is no 'domains' parameter, this field is the total number of domains that are accessible with with this API key. A domain is accessible with a given API key if it is associated with that API key, or if it is not associated with any API key.
-   */
-  total: number;
-  error: string | null;
-}
-
-interface DomainsCreateLoginLinkResponse {
-  /**
-   * If a user browses to this URL, they will be automatically logged in as a domain admin.
-   */
-  link: string | null;
-  error: string | null;
-}
-
-interface DomainsListDownstreamAddressesOptions {
-  /**
-   * The number of records to return.
-   * @default 10
-   */
-  limit?: number;
-  /**
-   * The offset into the records to return.
-   * @default 0
-   */
-  offset?: number;
-}
-
-interface DomainsDownstreamAddress {
-  /**
-   * TCP port on which the downstream mail server is listening.
-   */
-  port: number;
-  /**
-   * The priority of the downstream address. Only addresses with the highest priority (the lowest numerical value) are selected.
-   */
-  priority: number;
-  /**
-   * The canonical hostname of the host providing the service, ending in a dot.
-   */
-  target: string;
-  /**
-   * Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.
-   */
-  weight: number;
-}
-
-interface DomainsListDownstreamAddressesResponse {
-  records: DomainsDownstreamAddress[];
-  error: string | null;
-}
-
-type ListNames = "blocklist" | "safelist" | "blacklist" | "whitelist";
-
-interface ListEntryOptions {
-  /**
-   * This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
-   */
-  listName: ListNames;
-  /**
-   *  This can be a domain, email address, or IP address. The type of the entry is automatically determined based on the value.
-   */
-  item: string;
-}
-
-interface ListEntry {
-  action: Extract<ListNames, "blocklist" | "safelist">;
-  item: string;
-  type: "domain" | "email_address" | "ip_address";
-}
-
-interface ListEntryResponse {
-  entry: ListEntry | null;
-  error: string | null;
-}
-
-interface ListEntriesResponse {
-  entries: ListEntry[];
-  error: string | null;
-}
-
-interface UsersCreateOptions {
-  /**
-   * Flag to indicate if the user is a domain admin or a regular user
-   * @default false
-   */
-  admin?: boolean;
-  /**
-   * Whether or not to filter mail for this recipient. There are three valid values.
-   * - `false` -  Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, return an error.
-   * - `true` - Filtering policy will not be applied to messages intended for this recipient.
-   * - `compute` - Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, filtering policy will not be applied, and no error will be returned.
-   * @default 'compute'
-   */
-  filter?: boolean | "compute";
-  /**
-   * safelist and blocklist entries to be added
-   */
-  listEntries?: {
-    blocklist?: string[];
-    safelist?: string[];
-  };
-}
-
-interface UsersCreateResponse {
-  user: {
-    email: string;
-    roles: string[];
-    filter?: boolean;
-    listEntries: {
-      item: string;
-      type: "domain" | "email_address" | "ip_address";
-      action: "safelist" | "blocklist";
-    }[];
-  } | null;
-  error: string | null;
-}
-
-interface ServiceSubscriptionsResponse {
-  subscriptions: {
-    active: boolean;
-    activeAccountsCount: number;
-    handle: string;
-    limits: {
-      featureHandle: string;
-      value: string;
-    }[];
-    plan: {
-      handle: string;
-      name: string;
-    };
-  }[];
-  error: string | null;
-}
-
-interface ServiceReportOptions {
-  /**
-   * The report type. It can be either `false_negative` or `false_positive`.
-   */
-  type: "false_negative" | "false_positive";
-  /**
-   * The full, unaltered message content in accordance with the RFC 2822 specifications without dot stuffing.
-   */
-  messageContent: string;
-  /**
-   * The SMTP envelope information
-   */
-  smtpEnvelopeInformation?: {
-    ehlo: string;
-    mailFrom: string;
-    rcptTo: string;
-  };
-  /**
-   * The sending host information.
-   */
-  sendingHostInformation?: {
-    name: string;
-  };
+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.
+   * @default false
+   */
+  addToSubAccounts?: boolean;
+  /**
+   * The total number of suppression entries to create, for the parent and/or its sub-accounts, must not exceed `1000`.
+   */
+  entries: {
+    /**
+     * Must be less than `1024` characters.
+     */
+    notes?: string;
+    /**
+     * The email address to suppress. Must be a valid email address format and less than `255` characters.
+     */
+    recipient: string;
+    /**
+     * An array of types of suppression to apply to the recipient.
+     * @default ["non-transactional"]
+     */
+    types?: SuppressionsTypes[];
+  }[];
+}
+
+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.
+   */
+  recipient?: string;
+  /**
+   * The source of the suppression entries to filter by. If not provided, suppression entries from all sources will be returned.
+   */
+  source?: Exclude<SuppressionsSource, "all">;
+  /**
+   * The date and/or time before which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`
+   */
+  createdBefore?: string;
+  /**
+   * The date and/or time after which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`
+   */
+  createdAfter?: string;
+  /**
+   * The maximum number of suppression entries to return. Must be between `1` and `1000`.
+   * @default 1000
+   */
+  limit?: number;
+  /**
+   * The number of suppression entries to skip before returning results.
+   * @default 0
+   */
+  offset?: number;
+}
+
+interface SuppressionsListEntry {
+  createdAt: string;
+  notes?: string;
+  /**
+   * The email address that is suppressed.
+   */
+  recipient: string;
+  sender?: string;
+  source: SuppressionsSource;
+  types: SuppressionsTypes[];
+}
+
+interface SuppressionsListResponse {
+  list: SuppressionsListEntry[];
+  error: string | null;
 }
 
 declare class Suppressions {
@@ -1297,7 +1165,7 @@ declare class Suppressions {
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
-     * const response = await mailchannels.suppressions.create({
+     * const { success } = await mailchannels.suppressions.create({
      * // ...
      * });
      */
@@ -1309,7 +1177,7 @@ declare class Suppressions {
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
-     * const response = await mailchannels.suppressions.delete('name@example.com', 'api');
+     * const { success } = await mailchannels.suppressions.delete('name@example.com', 'api');
      * ```
      */
     delete(recipient: string, source?: SuppressionsSource): Promise<SuccessResponse>;
@@ -1318,13 +1186,246 @@ declare class Suppressions {
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
-     * const response = await mailchannels.suppressions.list();
+     * const { list }= await mailchannels.suppressions.list();
      * ```
      * @param options - Options to filter and customize the suppression entries retrieval.
      */
     list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
 }
 
+type ListNames = "blocklist" | "safelist" | "blacklist" | "whitelist";
+
+interface ListEntryOptions {
+  /**
+   * This can be a `blocklist`, `safelist`, `blacklist`, or `whitelist`.
+   */
+  listName: ListNames;
+  /**
+   *  This can be a domain, email address, or IP address. The type of the entry is automatically determined based on the value.
+   */
+  item: string;
+}
+
+interface ListEntry {
+  action: Extract<ListNames, "blocklist" | "safelist">;
+  item: string;
+  type: "domain" | "email_address" | "ip_address";
+}
+
+interface ListEntryResponse {
+  entry: ListEntry | null;
+  error: string | null;
+}
+
+interface ListEntriesResponse {
+  entries: ListEntry[];
+  error: string | null;
+}
+
+interface DomainsData {
+  /**
+   * The domain name.
+   */
+  domain: string;
+  /**
+   * The abuse policy settings for the domain. These settings determine how spam messages are handled.
+   */
+  settings?: Partial<{
+    /**
+     * The abuse policy.
+     */
+    abusePolicy: "block" | "flag" | "quarantine";
+    /**
+     * If `true`, this abuse policy overrides the recipient abuse policy.
+     */
+    abusePolicyOverride: boolean;
+    /**
+     * The spam header name to use if the abuse policy is set to `flag`.
+     */
+    spamHeaderName: string;
+    /**
+     * The spam header value to use if the abuse policy is set to `flag`.
+     */
+    spamHeaderValue: string;
+  }>;
+  /**
+   * A list of email addresses that are the domain admins for the domain.
+   */
+  admins?: string[] | null;
+  /**
+   * The locations of mail servers to which messages will be delivered after filtering.
+   */
+  downstreamAddresses?: {
+    /**
+     * The priority of the downstream address. Only addresses with the highest priority (the lowest numerical value) are selected.
+     */
+    priority: number;
+    /**
+     * Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.
+     */
+    weight: number;
+    /**
+     * TCP port on which the downstream mail server is listening.
+     */
+    port: number;
+    /**
+     * The canonical hostname of the host providing the service, ending in a dot.
+     */
+    target: string;
+  }[] | null;
+  /**
+   * A list of aliases for the domain. Mail is accepted for these domains and routed to the `downstreamAddresses` defined for the domain. Must be <= 255 characters
+   */
+  aliases?: string[] | null;
+  /**
+   * The subscription `handle` that identifies the subscription that this domain should be provisioned against. Subscription handles can be retrieved from the `subscriptions` service method.
+   */
+  subscriptionHandle: string;
+}
+
+interface DomainsProvisionOptions {
+  /**
+   * 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).
+   */
+  associateKey?: boolean;
+  /**
+   * If present and set to true, the settings (domain settings, downstream addresses, aliases and admins) for the domain will be overwritten with the ones in the request if the domain already exists, unless a section is not included in the request or there is problem updating a setting in which case the previous settings are carried forward.
+   */
+  overwrite?: boolean;
+}
+
+type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
+
+interface DomainsProvisionResponse {
+  data: DomainsData | null;
+  error: string | null;
+}
+
+interface DomainsBulkProvisionResponse {
+  /**
+   * If the request was processed successfully, this does not necessarily mean all the domains in the request were successfully provisioned.
+   */
+  results: {
+    /**
+     * Domains that were successfully provisioned or updated.
+     */
+    successes: {
+      domain: DomainsData;
+      code: number;
+      comment?: string;
+    }[];
+    /**
+     * Domains that were not successfully provisioned.
+     */
+    errors: {
+      domain: DomainsData;
+      code: number;
+      comment?: string;
+    }[];
+  } | null;
+  error: string | null;
+}
+
+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.
+   */
+  domains?: string[];
+  /**
+   * The maximum number of domains included in the response. Possible values are 1 to 5000
+   * @default 10
+   */
+  limit?: number;
+  /**
+   * Offset into the list of domains to return.
+   * @default 0
+   */
+  offset?: number;
+}
+
+interface DomainsListResponse {
+  /**
+   * A list of domains
+   */
+  domains: DomainsData[];
+  /**
+   * The total number of domains that are accessible with the given API key that match the list of domains in the 'domains' parameter. If there is no 'domains' parameter, this field is the total number of domains that are accessible with with this API key. A domain is accessible with a given API key if it is associated with that API key, or if it is not associated with any API key.
+   */
+  total: number;
+  error: string | null;
+}
+
+interface DomainsCreateLoginLinkResponse {
+  /**
+   * If a user browses to this URL, they will be automatically logged in as a domain admin.
+   */
+  link: string | null;
+  error: string | null;
+}
+
+interface DomainsListDownstreamAddressesOptions {
+  /**
+   * The number of records to return.
+   * @default 10
+   */
+  limit?: number;
+  /**
+   * The offset into the records to return.
+   * @default 0
+   */
+  offset?: number;
+}
+
+interface DomainsDownstreamAddress {
+  /**
+   * TCP port on which the downstream mail server is listening.
+   */
+  port: number;
+  /**
+   * The priority of the downstream address. Only addresses with the highest priority (the lowest numerical value) are selected.
+   */
+  priority: number;
+  /**
+   * The canonical hostname of the host providing the service, ending in a dot.
+   */
+  target: string;
+  /**
+   * Downstream addresses are selected in proportion to their weights. For example, if there are two downstream addresses, A with weight 40, and B with weight 10, then A is selected 80% of the time and B is selected 20% of the time.
+   */
+  weight: number;
+}
+
+interface DomainsListDownstreamAddressesResponse {
+  records: DomainsDownstreamAddress[];
+  error: string | null;
+}
+
+interface DomainsBulkCreateLoginLinkResult {
+  /**
+   * The domain the request was for.
+   */
+  domain: string;
+  code: 200 | 400 | 401 | 403 | 404 | 500;
+  /**
+   * More information about the result of creating the login link.
+   */
+  comment?: string;
+  /**
+   * If a user browses to this URL, they will be automatically logged in as a domain admin.
+   */
+  loginLink: string;
+}
+
+interface DomainsBulkCreateLoginLinks {
+  successes: DomainsBulkCreateLoginLinkResult[];
+  errors: Omit<DomainsBulkCreateLoginLinkResult, "loginLink">[];
+}
+
+interface DomainsBulkCreateLoginLinksResponse {
+  results: DomainsBulkCreateLoginLinks | null;
+  error: string | null;
+}
+
 declare class Domains {
     protected mailchannels: MailChannelsClient;
     constructor(mailchannels: MailChannelsClient);
@@ -1432,7 +1533,7 @@ declare class Domains {
      */
     createLoginLink(domain: string): Promise<DomainsCreateLoginLinkResponse>;
     /**
-     * Sets the list of downstream addreses 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.
+     * 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
@@ -1471,6 +1572,16 @@ declare class Domains {
      * ```
      */
     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 { results } = await mailchannels.domains.bulkCreateLoginLinks(['example.com', 'example2.com'])
+     * ```
+     */
+    bulkCreateLoginLinks(domains: string[]): Promise<DomainsBulkCreateLoginLinksResponse>;
 }
 
 declare class Lists {
@@ -1514,6 +1625,43 @@ declare class Lists {
     deleteListEntry(options: ListEntryOptions): Promise<SuccessResponse>;
 }
 
+interface UsersCreateOptions {
+  /**
+   * Flag to indicate if the user is a domain admin or a regular user
+   * @default false
+   */
+  admin?: boolean;
+  /**
+   * Whether or not to filter mail for this recipient. There are three valid values.
+   * - `false` -  Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, return an error.
+   * - `true` - Filtering policy will not be applied to messages intended for this recipient.
+   * - `compute` - Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, filtering policy will not be applied, and no error will be returned.
+   * @default 'compute'
+   */
+  filter?: boolean | "compute";
+  /**
+   * safelist and blocklist entries to be added
+   */
+  listEntries?: {
+    blocklist?: string[];
+    safelist?: string[];
+  };
+}
+
+interface UsersCreateResponse {
+  user: {
+    email: string;
+    roles: string[];
+    filter?: boolean;
+    listEntries: {
+      item: string;
+      type: "domain" | "email_address" | "ip_address";
+      action: "safelist" | "blocklist";
+    }[];
+  } | null;
+  error: string | null;
+}
+
 declare class Users {
     protected mailchannels: MailChannelsClient;
     constructor(mailchannels: MailChannelsClient);
@@ -1571,6 +1719,48 @@ declare class Users {
     deleteListEntry(email: string, options: ListEntryOptions): Promise<SuccessResponse>;
 }
 
+interface ServiceSubscriptionsResponse {
+  subscriptions: {
+    active: boolean;
+    activeAccountsCount: number;
+    handle: string;
+    limits: {
+      featureHandle: string;
+      value: string;
+    }[];
+    plan: {
+      handle: string;
+      name: string;
+    };
+  }[];
+  error: string | null;
+}
+
+interface ServiceReportOptions {
+  /**
+   * The report type. It can be either `false_negative` or `false_positive`.
+   */
+  type: "false_negative" | "false_positive";
+  /**
+   * The full, unaltered message content in accordance with the RFC 2822 specifications without dot stuffing.
+   */
+  messageContent: string;
+  /**
+   * The SMTP envelope information
+   */
+  smtpEnvelopeInformation?: {
+    ehlo: string;
+    mailFrom: string;
+    rcptTo: string;
+  };
+  /**
+   * The sending host information.
+   */
+  sendingHostInformation?: {
+    name: string;
+  };
+}
+
 declare class Service {
     protected mailchannels: MailChannelsClient;
     constructor(mailchannels: MailChannelsClient);
@@ -1607,4 +1797,4 @@ declare class Service {
 }
 
 export { Domains as D, Emails as E, Lists as L, MailChannelsClient as M, SubAccounts as S, Users as U, Webhooks as W, Metrics as a, Suppressions as b, Service as c };
-export type { SuppressionsListResponse as $, SubAccountsLimit as A, SubAccountsLimitResponse as B, SubAccountsUsage as C, SubAccountsUsageResponse as F, MetricsBucket as G, MetricsOptions as H, MetricsEngagement as I, MetricsEngagementResponse as J, MetricsPerformance as K, MetricsPerformanceResponse as N, MetricsRecipientBehaviour as O, MetricsRecipientBehaviourResponse as P, MetricsVolume as Q, MetricsVolumeResponse as R, MetricsUsageResponse as T, SuppressionsTypes as V, SuppressionsCreateOptions as X, SuppressionsSource as Y, SuppressionsListOptions as Z, SuppressionsListEntry as _, DomainsData as a0, DomainsProvisionOptions as a1, DomainsBulkProvisionOptions as a2, DomainsProvisionResponse as a3, DomainsBulkProvisionResponse as a4, DomainsListOptions as a5, DomainsListResponse as a6, DomainsCreateLoginLinkResponse as a7, DomainsListDownstreamAddressesOptions as a8, DomainsDownstreamAddress as a9, DomainsListDownstreamAddressesResponse as aa, ListNames as ab, ListEntryOptions as ac, ListEntry as ad, ListEntryResponse as ae, ListEntriesResponse as af, UsersCreateOptions as ag, UsersCreateResponse as ah, ServiceSubscriptionsResponse as ai, ServiceReportOptions as aj, SuccessResponse as ak, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, WebhooksListResponse as n, WebhooksSigningKeyResponse as o, WebhooksValidateResponse as p, SubAccountsAccount as q, SubAccountsCreateResponse as r, SubAccountsListOptions as s, SubAccountsListResponse as t, SubAccountsApiKey as u, SubAccountsCreateApiKeyResponse as v, SubAccountsListApiKeyResponse as w, SubAccountsSmtpPassword as x, SubAccountsCreateSmtpPasswordResponse as y, SubAccountsListSmtpPasswordResponse as z };
+export type { MetricsVolumeResponse as $, SubAccountsApiKey as A, SubAccountsCreateApiKeyResponse as B, SubAccountsListApiKeyResponse as C, SubAccountsSmtpPassword as F, SubAccountsCreateSmtpPasswordResponse as G, SubAccountsListSmtpPasswordResponse as H, SubAccountsLimit as I, SubAccountsLimitResponse as J, SubAccountsUsage as K, SubAccountsUsageResponse as N, Optional as O, MetricsBucket as P, MetricsOptions as Q, MetricsEngagement as R, MetricsEngagementResponse as T, MetricsPerformance as V, MetricsPerformanceResponse as X, MetricsRecipientBehaviour as Y, MetricsRecipientBehaviourResponse as Z, MetricsVolume as _, MetricsUsageResponse as a0, SuppressionsTypes as a1, SuppressionsCreateOptions as a2, SuppressionsSource as a3, SuppressionsListOptions as a4, SuppressionsListEntry as a5, SuppressionsListResponse as a6, DomainsData as a7, DomainsProvisionOptions as a8, DomainsBulkProvisionOptions as a9, DomainsProvisionResponse as aa, DomainsBulkProvisionResponse as ab, DomainsListOptions as ac, DomainsListResponse as ad, DomainsCreateLoginLinkResponse as ae, DomainsListDownstreamAddressesOptions as af, DomainsDownstreamAddress as ag, DomainsListDownstreamAddressesResponse as ah, DomainsBulkCreateLoginLinkResult as ai, DomainsBulkCreateLoginLinks as aj, DomainsBulkCreateLoginLinksResponse as ak, ListNames as al, ListEntryOptions as am, ListEntry as an, ListEntryResponse as ao, ListEntriesResponse as ap, UsersCreateOptions as aq, UsersCreateResponse as ar, ServiceSubscriptionsResponse as as, ServiceReportOptions as at, SuccessResponse as au, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, EmailsCreateDkimKeyOptions as n, EmailsDkimKey as o, EmailsCreateDkimKeyResponse as p, EmailsGetDkimKeysOptions as q, EmailsGetDkimKeysResponse as r, EmailsUpdateDkimKeyOptions as s, WebhooksListResponse as t, WebhooksSigningKeyResponse as u, WebhooksValidateResponse as v, SubAccountsAccount as w, SubAccountsCreateResponse as x, SubAccountsListOptions as y, SubAccountsListResponse as z };