mailchannels-sdk 0.7.2 → 0.7.4

package/dist/mailchannels.d.ts

@@ -1,1989 +0,0 @@
-import { FetchOptions } from 'ofetch';
-
-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>;
-}
-
-interface ErrorResponse {
-  message: string;
-  statusCode: number | null;
-}
-
-interface SuccessResponse {
-  /**
-   * Whether the operation was successful.
-   */
-  success: boolean;
-  /**
-   * Error information if the operation failed.
-   */
-  error: ErrorResponse | null;
-}
-
-type DataResponse$1<T> = {
-  /**
-   * The response data.
-   */
-  data: T;
-  /**
-   * Error information if the operation failed.
-   */
-  error: null;
-} | {
-  /**
-   * The response data.
-   */
-  data: null;
-  /**
-   * Error information if the operation failed.
-   */
-  error: ErrorResponse;
-};
-
-interface EmailsSendRecipient {
-  /**
-   * The email address of the recipient.
-   */
-  email: string;
-  /**
-   * The name of the recipient. Display name in raw text, e.g. John Doe, 张三.
-   */
-  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;
-  };
-  /**
-   * Optional envelope sender address. If not set, the envelope sender defaults to the `from.email` field. Can be overridden per-personalization. Only the email portion is used; the name field is ignored.
-   * @example
-   * { email: 'email@example.com', name: 'Example' }
-   * @example
-   * 'email@example.com'
-   * @example
-   * 'Name <email@example.com>'
-   */
-  envelopeFrom?: EmailsSendRecipient | 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;
-  /**
-   * An object containing key-value pairs, where both keys (header names) and values must be strings. These pairs represent custom headers to be substituted.
-   *
-   * Please note the following restrictions and behavior:
-   * - **Reserved headers**: The following headers cannot be modified: `Authentication-Results`, `BCC`, `CC`, `Content-Transfer-Encoding`, `Content-Type`, `DKIM-Signature`, `From`, `Message-ID`, `Received`, `Reply-To`, `Subject`, `To`.
-   * - **Header precedence**: If a header is defined in both the personalizations object and the root headers, the value from personalizations will be used.
-   * - **Case sensitivity**: Headers are treated as case-insensitive. If multiple headers differ only by case, only one will be used, with no guarantee of which one.
-   */
-  headers?: Record<string, 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.
-   *
-   * Only links (`<a>` tags) meeting all of the following conditions are processed for click tracking:
-   * - The URL is non-empty.
-   * - The URL starts with `http` or `https`.
-   * - The link does not have a `clicktracking` attribute set to `off`.
-   */
-  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;
-  }
-);
-
-type EmailsSendResponse = SuccessResponse & DataResponse$1<{
-  /**
-   * Fully rendered message if `dryRun` was set to `true`. A string representation of a rendered message, one per personalization in the request.
-   */
-  rendered?: string[];
-  /**
-   * The Request ID is a unique identifier generated by the service to track the HTTP request. It will also be included in all webhooks for reference.
-   */
-  requestId?: string;
-  results?: {
-    /**
-     * The index of the personalization in the request. Starts at 0.
-     */
-    index?: number;
-    /**
-     * The Message ID is a unique identifier generated by the service. Each personalization has a distinct Message ID, which is also used in the `Message-Id` header and included in webhooks.
-     */
-    messageId: string;
-    /**
-     * A human-readable explanation of the status.
-     */
-    reason?: string;
-    /**
-     * The status of the message. Note that 'sent' is a temporary status; the final status will be provided through webhooks, if configured.
-     */
-    status: "sent" | "failed";
-  }[];
-}>;
-
-type EmailsSendAsyncResponse = DataResponse<{
-  /**
-   * ISO 8601 timestamp when the request was queued for processing.
-   */
-  queuedAt: string[];
-  /**
-   * Unique identifier for tracking this async request. Will be included in all webhook events for this request.
-   */
-  requestId: string;
-}>;
-
-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;
-}
-
-type EmailsDkimKeyStatus = "active" | "retired" | "revoked" | "rotated";
-
-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;
-  /**
-   * UTC timestamp after which you can no longer use the rotated key for signing.
-   */
-  gracePeriodExpiresAt?: string;
-  /**
-   * Key length in bits.
-   */
-  length: 1024 | 2048 | 3072 | 4096;
-  publicKey: string;
-  /**
-   * UTC timestamp when a rotated key pair is retired.
-   */
-  retiresAt?: string;
-  /**
-   * Selector assigned to the key pair.
-   */
-  selector: string;
-  /**
-   * Status of the key.
-   */
-  status: EmailsDkimKeyStatus;
-  /**
-   * Timestamp when the key was last modified.
-   */
-  statusModifiedAt?: string;
-}
-
-type EmailsCreateDkimKeyResponse = DataResponse$1<EmailsDkimKey>;
-
-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 {
-  /**
-   * 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:
-   * 1. If `domain`, `selector`, and `privateKey` are all present, verify using the provided domain, selector, and key.
-   * 2. If `domain` and `selector` are present, use the stored private key for the given domain and selector.
-   * 3. If only `domain` is present, use all stored keys for the given domain.
-   * 4. If none are present, use all stored keys for the `domain` provided in the domain field of the request.
-   * 5. If `privateKey` is present, `selector` must be present.
-   * 6. If `selector` is present and `domain` is not, the domain will be taken from the domain field of the request.
-   */
-  dkim?: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
-  /**
-   * Domain used for sending emails. If `dkim` settings are not provided, or `dkim` settings are provided with no `domain`, the stored dkim settings for this domain will be used.
-   */
-  domain: string;
-  /**
-   * Used exclusively for [Domain Lockdown](https://support.mailchannels.com/hc/en-us/articles/16918954360845-Secure-your-domain-name-against-spoofing-with-Domain-Lockdown) verification. If you're not using senderid to associate your domain with your account, you can disregard this field. The corresponding value is included in the `X-MailChannels-SenderId` header of emails sent via MailChannels.
-   */
-  senderId?: string;
-}
-
-type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-
-type EmailsCheckDomainResponse = DataResponse$1<{
-  dkim: {
-    domain: string;
-    /**
-     * The human readable status of the DKIM key used for verification.
-     */
-    keyStatus?: EmailsDkimKey["status"] | "provided";
-    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">;
-  };
-  /**
-   * These results are here to help avoid [SDNF](https://support.mailchannels.com/hc/en-us/articles/203155500-550-5-2-1-SDNF-Sender-Domain-Not-Found) (Sender Domain Not Found) blocks. For messages not to get blocked by SDNF, we require either an MX or A record to exist for the sender domain.
-   */
-  senderDomain: {
-    a: {
-      /**
-       * A human-readable explanation of A record check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    };
-    mx: {
-      /**
-       * A human-readable explanation of MX record check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    };
-    /**
-     * Overall verdict. Passed if either A or MX record check passed.
-     */
-    verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-  };
-  spf: {
-    /**
-     * A human-readable explanation of SPF check.
-     */
-    reason?: string;
-    verdict: EmailsCheckDomainVerdict;
-  };
-  references?: string[];
-}>;
-
-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>>;
-
-type EmailsGetDkimKeysResponse = DataResponse$1<Optional<EmailsDkimKey, "dnsRecords">[]>;
-
-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.
-   * - `rotated`: Indicates that the key is going through the rotation process. Only active key pairs can be updated to this status, and no new key pair is created. The rotated key can be used to sign emails for 3 days after the status update, and will automatically change to `retired` 2 weeks after update. For a smooth key transition, it is recommended to create and publish a new key pair before signing is disabled for the rotated key.
-   */
-  status: Exclude<EmailsDkimKey["status"], "active">;
-}
-
-interface EmailsRotateDkimKeyOptions {
-  newKey: {
-    /**
-     * Selector for the new key pair. Must be a maximum of 63 characters.
-     */
-    selector: string;
-  };
-}
-
-type EmailsRotateDkimKeyResponse = DataResponse$1<{
-  new: EmailsDkimKey;
-  rotated: EmailsDkimKey;
-}>;
-
-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>;
-}
-
-type WebhooksListResponse = DataResponse$1<string[]>;
-
-type WebhooksSigningKeyResponse = DataResponse$1<{
-  key: string;
-}>;
-
-type WebhooksValidateResponse = DataResponse$1<{
-  /**
-   * 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;
-  }[];
-}>;
-
-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>;
-}
-
-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;
-}
-
-type SubAccountsCreateResponse = DataResponse$1<SubAccountsAccount>;
-
-interface SubAccountsListOptions {
-  /**
-   * Possible values are `1` to `1000`.
-   * @default 1000
-   */
-  limit?: number;
-  /**
-   * The offset for pagination.
-   * @default 0
-   */
-  offset?: number;
-}
-
-type SubAccountsListResponse = DataResponse$1<SubAccountsAccount[]>;
-
-interface SubAccountsApiKey {
-  /**
-   * The API key ID for the sub-account.
-   */
-  id: number;
-  /**
-   * API key for the sub-account.
-   */
-  value: string;
-}
-
-type SubAccountsCreateApiKeyResponse = DataResponse$1<SubAccountsApiKey>;
-
-interface SubAccountsListApiKeyOptions {
-  /**
-   * The maximum number of API keys included in the response. Possible values are `1` to `1000`.
-   * @default 100
-   */
-  limit?: number;
-  /**
-   * Offset into the list of API keys to return.
-   * @default 0
-   */
-  offset?: number;
-}
-
-type SubAccountsListApiKeyResponse = DataResponse$1<SubAccountsApiKey[]>;
-
-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;
-}
-
-type SubAccountsCreateSmtpPasswordResponse = DataResponse$1<SubAccountsSmtpPassword>;
-
-type SubAccountsListSmtpPasswordResponse = DataResponse$1<SubAccountsSmtpPassword[]>;
-
-interface SubAccountsLimit {
-  sends: number;
-}
-
-type SubAccountsLimitResponse = DataResponse$1<SubAccountsLimit>;
-
-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;
-}
-
-type SubAccountsUsageResponse = DataResponse$1<SubAccountsUsage>;
-
-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>;
-}
-
-interface MetricsEngagement {
-  /**
-   * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
-   */
-  buckets: {
-    click: MetricsBucket[];
-    clickTrackingDelivered: MetricsBucket[];
-    open: MetricsBucket[];
-    openTrackingDelivered: MetricsBucket[];
-  };
-  click: number;
-  clickTrackingDelivered: number;
-  endTime: string;
-  open: number;
-  openTrackingDelivered: number;
-  startTime: string;
-}
-
-type MetricsEngagementResponse = DataResponse$1<MetricsEngagement>;
-
-interface MetricsPerformance {
-  /**
-   * Count of messages bounced during the specified time range.
-   */
-  bounced: number;
-  /**
-   * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
-   */
-  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;
-}
-
-type MetricsPerformanceResponse = DataResponse$1<MetricsPerformance>;
-
-interface MetricsRecipientBehaviour {
-  /**
-   * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
-   */
-  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;
-}
-
-type MetricsRecipientBehaviourResponse = DataResponse$1<MetricsRecipientBehaviour>;
-
-interface MetricsVolume {
-  /**
-   * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
-   */
-  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;
-}
-
-type MetricsVolumeResponse = DataResponse$1<MetricsVolume>;
-
-type MetricsUsageResponse = DataResponse$1<{
-  /**
-   * 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;
-}>;
-
-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.
-   * @example "2025-11-02T03:13:35.761763554Z"
-   */
-  startTime?: string;
-  /**
-   * The end of the time range for retrieving top senders metrics (exclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`. Defaults to the current time if not provided.
-   * @example "2025-12-02T03:13:35.761763554Z"
-   */
-  endTime?: string;
-  /**
-   * The maximum number of senders to return. Possible values are 1 to 1000.
-   * @default 10
-   */
-  limit?: number;
-  /**
-   * The number of senders to skip before returning results.
-   * @default 0
-   */
-  offset?: number;
-  /**
-   * The order in which to sort the results, based on total messages (processed + dropped).
-   * @default "desc"
-   */
-  sortOrder?: "asc" | "desc";
-}
-
-interface MetricsSenders {
-  endTime: string;
-  limit: number;
-  offset: number;
-  senders: {
-    bounced: number;
-    delivered: number;
-    dropped: number;
-    /**
-     * Maximum character length: 255
-     */
-    name: string;
-    processed: number;
-  }[];
-  startTime: string;
-  /**
-   * The total number of senders in this category that sent messages in the given time range.
-   */
-  total: number;
-}
-
-type MetricsSendersResponse = DataResponse$1<MetricsSenders>;
-
-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 {
-    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>;
-}
-
-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[];
-}
-
-type SuppressionsListResponse = DataResponse$1<SuppressionsListEntry[]>;
-
-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>;
-}
-
-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";
-}
-
-type ListEntryResponse = DataResponse$1<ListEntry>;
-
-type ListEntriesResponse = DataResponse$1<ListEntry[]>;
-
-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">;
-
-type DomainsProvisionResponse = DataResponse$1<DomainsData>;
-
-type DomainsBulkProvisionResponse = DataResponse$1<{
-  /**
-   * Domains that were successfully provisioned or updated.
-   */
-  successes: {
-    /**
-     * The provisioned domain data.
-     */
-    domain: DomainsData;
-    code: number;
-    comment?: string;
-  }[];
-  /**
-   * Domains that were not successfully provisioned.
-   */
-  errors: {
-    /**
-     * The failed to provision domain data.
-     */
-    domain: DomainsData;
-    code: number;
-    comment?: string;
-  }[];
-}>;
-
-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;
-}
-
-type DomainsListResponse = DataResponse$1<{
-  /**
-   * 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;
-}>;
-
-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>;
-
-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;
-}
-
-type DomainsListDownstreamAddressesResponse = DataResponse$1<DomainsDownstreamAddress[]>;
-
-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">[];
-}
-
-type DomainsBulkCreateLoginLinksResponse = DataResponse$1<DomainsBulkCreateLoginLinks>;
-
-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>;
-}
-
-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>;
-}
-
-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[];
-  };
-}
-
-type UsersCreateResponse = DataResponse$1<{
-  email: string;
-  roles: string[];
-  filter?: boolean;
-  listEntries: {
-    item: string;
-    type: "domain" | "email_address" | "ip_address";
-    action: "safelist" | "blocklist";
-  }[];
-}>;
-
-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>;
-}
-
-type ServiceSubscriptionsResponse = DataResponse$1<{
-  active: boolean;
-  activeAccountsCount: number;
-  handle: string;
-  limits: {
-    featureHandle: string;
-    value: string;
-  }[];
-  plan: {
-    handle: string;
-    name: string;
-  };
-}[]>;
-
-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);
-    /**
-     * 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>;
-}
-
-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);
-}
-
-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 };