mailchannels-sdk 1.5.1 → 1.6.0

package/README.md

@@ -205,13 +205,13 @@ The SDK provides a transport for Nodemailer that allows you to send emails using
 
 ```sh
 # npm
-npm i mailchannels-sdk nodemailer && npm i -D @types/nodemailer
+npm i mailchannels-sdk nodemailer
 
 # yarn
-yarn add mailchannels-sdk nodemailer && yarn add -D @types/nodemailer
+yarn add mailchannels-sdk nodemailer
 
 # pnpm
-pnpm add mailchannels-sdk nodemailer && pnpm add -D @types/nodemailer
+pnpm add mailchannels-sdk nodemailer
 ```
 
 ### Sending

package/dist/_chunks/mailchannels.d.mts

@@ -1,5 +1,5 @@
 import { FetchOptions } from "ofetch";
-interface MailChannelsClientOptions {
+export interface MailChannelsClientOptions {
   /**
    * Override the MailChannels API base URL.
    * Useful for local testing against a simulator.
@@ -31,7 +31,7 @@ interface MailChannelsClientOptions {
    */
   signal?: AbortSignal;
 }
-declare class MailChannelsClient {
+export declare class MailChannelsClient {
   #private;
   private static readonly DEFAULT_BASE_URL;
   private static readonly DEFAULT_TIMEOUT;
@@ -44,8 +44,8 @@ declare class MailChannelsClient {
   put<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
   patch<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
 }
-type ErrorType = "invalid_request_error" | "authentication_error" | "permission_error" | "not_found" | "conflict_error" | "payload_too_large_error" | "unprocessable_entity_error" | "rate_limit_error" | "internal_server_error" | "validation_error" | "application_error" | "api_error";
-interface ErrorResponse {
+export type ErrorType = "invalid_request_error" | "authentication_error" | "permission_error" | "not_found" | "conflict_error" | "payload_too_large_error" | "unprocessable_entity_error" | "rate_limit_error" | "internal_server_error" | "validation_error" | "application_error" | "api_error";
+export interface ErrorResponse {
   /**
    * A human-readable description of the error.
    */
@@ -68,7 +68,7 @@ interface ErrorResponse {
    */
   response: Record<string, unknown> | null;
 }
-interface SuccessResponse {
+export interface SuccessResponse {
   /**
    * Whether the operation was successful.
    */
@@ -78,7 +78,7 @@ interface SuccessResponse {
    */
   error: ErrorResponse | null;
 }
-type DataResponse<T> = {
+export type DataResponse<T> = {
   /**
    * The response data.
    */
@@ -97,7 +97,7 @@ type DataResponse<T> = {
    */
   error: ErrorResponse;
 };
-interface EmailsSendRecipient {
+export interface EmailsSendRecipient {
   /**
    * The email address of the recipient.
    */
@@ -107,7 +107,7 @@ interface EmailsSendRecipient {
    */
   name?: string;
 }
-interface EmailsSendAttachment {
+export interface EmailsSendAttachment {
   /**
    * The attachment data, encoded in base64.
    */
@@ -127,7 +127,7 @@ interface EmailsSendAttachment {
    */
   contentId?: string;
 }
-interface EmailsSendTracking {
+export interface EmailsSendTracking {
   /**
    * Track when a recipient clicks a link in your email.
    */
@@ -159,11 +159,11 @@ interface EmailsSendTracking {
     enable?: boolean;
   };
 }
-type EmailsSendTemplateType = "mustache";
-type EmailsSendTemplateValue = string | boolean | number | EmailsSendTemplateValue[] | {
+export type EmailsSendTemplateType = "mustache";
+export type EmailsSendTemplateValue = string | boolean | number | EmailsSendTemplateValue[] | {
   [key: string]: EmailsSendTemplateValue;
 };
-interface EmailsSendTemplate {
+export interface EmailsSendTemplate {
   /**
    * The template type of the content
    */
@@ -181,7 +181,7 @@ interface EmailsSendTemplate {
    */
   data?: Record<string, EmailsSendTemplateValue>;
 }
-interface EmailsSendContent {
+export interface EmailsSendContent {
   /**
    * The MIME type of the content you are including in your email.
    */
@@ -191,8 +191,8 @@ interface EmailsSendContent {
    */
   value: string;
 }
-type EmailsSendRecipientInput = EmailsSendRecipient | string | (EmailsSendRecipient | string)[];
-interface EmailsSendDkim {
+export type EmailsSendRecipientInput = EmailsSendRecipient | string | (EmailsSendRecipient | string)[];
+export interface EmailsSendDkim {
   /**
    * Domain used for DKIM signing.
    */
@@ -206,7 +206,7 @@ interface EmailsSendDkim {
    */
   selector?: string;
 }
-interface EmailsSendPersonalization {
+export interface EmailsSendPersonalization {
   /**
    * The BCC recipients for this personalization.
    */
@@ -410,7 +410,7 @@ type EmailsSendTargetOptions = {
   cc?: EmailsSendRecipientInput;
   bcc?: EmailsSendRecipientInput;
 };
-type EmailsSendOptions = EmailsSendOptionsBase & EmailsSendTargetOptions & ({
+export type EmailsSendOptions = EmailsSendOptionsBase & EmailsSendTargetOptions & ({
   /**
    * The HTML content of the email.
    * @example
@@ -462,7 +462,7 @@ type EmailsSendOptions = EmailsSendOptionsBase & EmailsSendTargetOptions & ({
    */
   content: EmailsSendContent[];
 });
-type EmailsSendResponse = DataResponse<{
+export type EmailsSendResponse = DataResponse<{
   /**
    * Fully rendered message if `dryRun` was set to `true`. A string representation of a rendered message, one per personalization in the request.
    */
@@ -490,7 +490,7 @@ type EmailsSendResponse = DataResponse<{
     status: "sent" | "failed";
   }[];
 }>;
-type EmailsQueueResponse = DataResponse<{
+export type EmailsQueueResponse = DataResponse<{
   /**
    * ISO 8601 timestamp when the request was queued for processing.
    */
@@ -501,8 +501,8 @@ type EmailsQueueResponse = DataResponse<{
   requestId: string;
 }>;
 /** @deprecated Use `EmailsQueueResponse` instead. */
-type EmailsSendAsyncResponse = EmailsQueueResponse;
-declare class Emails {
+export type EmailsSendAsyncResponse = EmailsQueueResponse;
+export declare class Emails {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
   private _sendEmail;
@@ -546,7 +546,7 @@ declare class Emails {
    */
   sendAsync(options: EmailsSendOptions): Promise<EmailsQueueResponse>;
 }
-interface DomainsDkimCreateOptions {
+export interface DomainsDkimCreateOptions {
   /**
    * Algorithm used for the new key pair Currently, only RSA is supported.
    * @default "rsa"
@@ -562,8 +562,8 @@ interface DomainsDkimCreateOptions {
    */
   selector: string;
 }
-type DomainsDkimKeyStatus = "active" | "retired" | "revoked" | "rotated";
-interface DomainsDkimKey {
+export type DomainsDkimKeyStatus = "active" | "retired" | "revoked" | "rotated";
+export interface DomainsDkimKey {
   /**
    * Algorithm used for the key pair.
    */
@@ -610,8 +610,8 @@ interface DomainsDkimKey {
    */
   statusModifiedAt?: string;
 }
-type DomainsDkimCreateResponse = DataResponse<DomainsDkimKey>;
-interface DomainsDkimListOptions {
+export type DomainsDkimCreateResponse = DataResponse<DomainsDkimKey>;
+export interface DomainsDkimListOptions {
   /**
    * Selector to filter keys by. Must be a maximum of 63 characters.
    */
@@ -637,8 +637,8 @@ interface DomainsDkimListOptions {
   includeDnsRecord?: boolean;
 }
 type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-type DomainsDkimListResponse = DataResponse<Optional<DomainsDkimKey, "dnsRecords">[]>;
-interface DomainsDkimUpdateStatusOptions {
+export type DomainsDkimListResponse = DataResponse<Optional<DomainsDkimKey, "dnsRecords">[]>;
+export interface DomainsDkimUpdateStatusOptions {
   /**
    * Selector of the DKIM key pair to update. Must be a maximum of 63 characters.
    */
@@ -651,7 +651,7 @@ interface DomainsDkimUpdateStatusOptions {
    */
   status: Exclude<DomainsDkimKey["status"], "active">;
 }
-interface DomainsDkimRotateOptions {
+export interface DomainsDkimRotateOptions {
   newKey: {
     /**
      * Selector for the new key pair. Must be a maximum of 63 characters.
@@ -659,12 +659,14 @@ interface DomainsDkimRotateOptions {
     selector: string;
   };
 }
-type DomainsDkimRotateResponse = DataResponse<{
+export type DomainsDkimRotateResponse = DataResponse<{
   new: DomainsDkimKey;
   rotated: DomainsDkimKey;
 }>;
 declare class DomainsDkim {
   private mailchannels;
+  private static readonly UPDATE_STATUS_VALUES;
+  private static readonly STATUS_VALUES;
   constructor(mailchannels: MailChannelsClient);
   /**
    * Create a DKIM key pair for a specified domain and selector using the specified algorithm and key length, for the current customer.
@@ -723,8 +725,8 @@ declare class DomainsDkim {
    */
   rotate(domain: string, selector: string, options: DomainsDkimRotateOptions): Promise<DomainsDkimRotateResponse>;
 }
-type DomainsCustomTrackingScope = "click" | "open" | "unsubscribe";
-interface DomainsCustomTrackingDomain {
+export type DomainsCustomTrackingScope = "click" | "open" | "unsubscribe";
+export interface DomainsCustomTrackingDomain {
   /**
    * The label for this custom tracking domain.
    */
@@ -746,7 +748,7 @@ interface DomainsCustomTrackingDomain {
    */
   createdAt: string;
 }
-interface DomainsCustomTrackingDnsSetupRequired {
+export interface DomainsCustomTrackingDnsSetupRequired {
   /**
    * UUID v4 nonce; also the TXT record value to set. Present only when TXT ownership verification is pending.
    * @example "550e8400-e29b-41d4-a716-446655440000"
@@ -767,7 +769,7 @@ interface DomainsCustomTrackingDnsSetupRequired {
    */
   instructions?: string;
 }
-type DomainsCustomTrackingWithDnsSetupRequired<T extends 202 | 201 | 200 | undefined = undefined> = T extends undefined ? DomainsCustomTrackingDomain & {
+export type DomainsCustomTrackingWithDnsSetupRequired<T extends 202 | 201 | 200 | undefined = undefined> = T extends undefined ? DomainsCustomTrackingDomain & {
   dnsSetupRequired: false;
 } | DomainsCustomTrackingDnsSetupRequired & {
   dnsSetupRequired: true;
@@ -776,8 +778,8 @@ type DomainsCustomTrackingWithDnsSetupRequired<T extends 202 | 201 | 200 | undef
 } : DomainsCustomTrackingDomain & {
   dnsSetupRequired: false;
 };
-type DomainsCustomTrackingCreateResponse = DataResponse<DomainsCustomTrackingWithDnsSetupRequired>;
-interface DomainsCustomTrackingListOptions {
+export type DomainsCustomTrackingCreateResponse = DataResponse<DomainsCustomTrackingWithDnsSetupRequired>;
+export interface DomainsCustomTrackingListOptions {
   /**
    * Filter by custom tracking domain label.
    */
@@ -801,7 +803,7 @@ interface DomainsCustomTrackingListOptions {
    */
   offset?: number;
 }
-type DomainsCustomTrackingListResponse = DataResponse<{
+export type DomainsCustomTrackingListResponse = DataResponse<{
   /**
    * List of custom tracking domains matching the filter criteria.
    */
@@ -811,7 +813,7 @@ type DomainsCustomTrackingListResponse = DataResponse<{
    */
   total: number;
 }>;
-interface DomainsCustomTrackingUpdateOptions {
+export interface DomainsCustomTrackingUpdateOptions {
   /**
    * New label for this custom tracking domain. Maximum length is `64` characters. Must match the pattern `^[a-z0-9-]+$`.
    */
@@ -821,7 +823,7 @@ interface DomainsCustomTrackingUpdateOptions {
    */
   status?: "active" | "disabled";
 }
-type DomainsCustomTrackingUpdateResponse = DataResponse<DomainsCustomTrackingWithDnsSetupRequired>;
+export type DomainsCustomTrackingUpdateResponse = DataResponse<DomainsCustomTrackingWithDnsSetupRequired>;
 declare class DomainsCustomTracking {
   private mailchannels;
   private static readonly SCOPE_VALUES;
@@ -902,7 +904,7 @@ interface DomainsCheckDkim {
    */
   selector?: string;
 }
-interface DomainsCheckOptions {
+export interface DomainsCheckOptions {
   /**
    * 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.
@@ -925,8 +927,8 @@ interface DomainsCheckOptions {
    */
   senderId?: string;
 }
-type DomainsCheckVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-type DomainsCheckResponse = DataResponse<{
+export type DomainsCheckVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
+export type DomainsCheckResponse = DataResponse<{
   dkim: {
     domain: string;
     /**
@@ -987,7 +989,7 @@ type DomainsCheckResponse = DataResponse<{
   };
   references?: string[];
 }>;
-declare class Domains {
+export declare class Domains {
   protected mailchannels: MailChannelsClient;
   readonly dkim: DomainsDkim;
   readonly customTracking: DomainsCustomTracking;
@@ -1011,13 +1013,13 @@ declare class Domains {
    */
   check(domain: string, options?: DomainsCheckOptions): Promise<DomainsCheckResponse>;
 }
-type WebhooksListResponse = DataResponse<{
+export type WebhooksListResponse = DataResponse<{
   /**
    * A customer's webhook that events will be sent to
    */
   webhook: string;
 }[]>;
-type WebhooksSigningKeyResponse = DataResponse<{
+export type WebhooksSigningKeyResponse = DataResponse<{
   /**
    * The ID of the key.
    */
@@ -1027,7 +1029,7 @@ type WebhooksSigningKeyResponse = DataResponse<{
    */
   key: string;
 }>;
-type WebhooksValidateResponse = DataResponse<{
+export type WebhooksValidateResponse = DataResponse<{
   /**
    * Indicates whether all webhook validations passed.
    */
@@ -1059,7 +1061,7 @@ type WebhooksValidateResponse = DataResponse<{
     } | null;
   }[];
 }>;
-type WebhookEventType = "processed" | "delivered" | "open" | "click" | "hard-bounced" | "soft-bounced" | "dropped" | "complained" | "unsubscribed" | "test";
+export type WebhookEventType = "processed" | "delivered" | "open" | "click" | "hard-bounced" | "soft-bounced" | "dropped" | "complained" | "unsubscribed" | "test";
 interface WebhookEventBase<T extends WebhookEventType> {
   /**
    * The sender's email address
@@ -1095,8 +1097,8 @@ interface WebhookEventBase<T extends WebhookEventType> {
    */
   recipients?: string[];
 }
-interface WebhookEventProcessed extends WebhookEventBase<"processed"> {}
-interface WebhookEventDelivered extends WebhookEventBase<"delivered"> {}
+export interface WebhookEventProcessed extends WebhookEventBase<"processed"> {}
+export interface WebhookEventDelivered extends WebhookEventBase<"delivered"> {}
 interface WebhookEventWithTracking {
   /**
    * The User-Agent header given when the recipient opened the message
@@ -1107,8 +1109,8 @@ interface WebhookEventWithTracking {
    */
   ip?: string;
 }
-interface WebhookEventOpen extends WebhookEventBase<"open">, WebhookEventWithTracking {}
-interface WebhookEventClick extends WebhookEventBase<"click">, WebhookEventWithTracking {
+export interface WebhookEventOpen extends WebhookEventBase<"open">, WebhookEventWithTracking {}
+export interface WebhookEventClick extends WebhookEventBase<"click">, WebhookEventWithTracking {
   /**
    * The URL that was clicked by the recipient
    */
@@ -1124,14 +1126,14 @@ interface WebhookEventWithStatus {
    */
   reason?: string;
 }
-interface WebhookEventHardBounced extends WebhookEventBase<"hard-bounced">, WebhookEventWithStatus {}
-interface WebhookEventSoftBounced extends WebhookEventBase<"soft-bounced">, WebhookEventWithStatus {}
-interface WebhookEventDropped extends WebhookEventBase<"dropped">, WebhookEventWithStatus {}
-interface WebhookEventComplained extends WebhookEventBase<"complained"> {}
-interface WebhookEventUnsubscribed extends WebhookEventBase<"unsubscribed"> {}
-interface WebhookEventTest extends Omit<WebhookEventBase<"test">, "recipients" | "campaignId"> {}
-type WebhookEvent = WebhookEventProcessed | WebhookEventDelivered | WebhookEventOpen | WebhookEventClick | WebhookEventHardBounced | WebhookEventSoftBounced | WebhookEventDropped | WebhookEventComplained | WebhookEventUnsubscribed | WebhookEventTest;
-interface WebhooksVerifyOptions {
+export interface WebhookEventHardBounced extends WebhookEventBase<"hard-bounced">, WebhookEventWithStatus {}
+export interface WebhookEventSoftBounced extends WebhookEventBase<"soft-bounced">, WebhookEventWithStatus {}
+export interface WebhookEventDropped extends WebhookEventBase<"dropped">, WebhookEventWithStatus {}
+export interface WebhookEventComplained extends WebhookEventBase<"complained"> {}
+export interface WebhookEventUnsubscribed extends WebhookEventBase<"unsubscribed"> {}
+export interface WebhookEventTest extends Omit<WebhookEventBase<"test">, "recipients" | "campaignId"> {}
+export type WebhookEvent = WebhookEventProcessed | WebhookEventDelivered | WebhookEventOpen | WebhookEventClick | WebhookEventHardBounced | WebhookEventSoftBounced | WebhookEventDropped | WebhookEventComplained | WebhookEventUnsubscribed | WebhookEventTest;
+export interface WebhooksVerifyOptions {
   /**
    * The raw body of the incoming webhook request as a string. This should be the exact payload received from the webhook, without any modifications or parsing, to ensure accurate signature verification.
    */
@@ -1154,10 +1156,10 @@ interface WebhooksVerifyOptions {
    */
   cache?: boolean;
 }
-type WebhooksVerifyResponse = DataResponse<WebhookEvent[]>;
-type WebhooksBatchStatus = "1xx" | "2xx" | "3xx" | "4xx" | "5xx" | "no_response";
-type WebhooksBatchResponseStatus = "1xx_response" | "2xx_response" | "3xx_response" | "4xx_response" | "5xx_response" | "no_response";
-interface WebhooksBatchesOptions {
+export type WebhooksVerifyResponse = DataResponse<WebhookEvent[]>;
+export type WebhooksBatchStatus = "1xx" | "2xx" | "3xx" | "4xx" | "5xx" | "no_response";
+export type WebhooksBatchResponseStatus = "1xx_response" | "2xx_response" | "3xx_response" | "4xx_response" | "5xx_response" | "no_response";
+export interface WebhooksBatchesOptions {
   /**
    * Inclusive lower bound (UTC) for filtering webhook batches by creation time. Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` or a `Date` object.
    */
@@ -1185,7 +1187,7 @@ interface WebhooksBatchesOptions {
    */
   offset?: number;
 }
-interface WebhooksBatch {
+export interface WebhooksBatch {
   /**
    * Unique identifier for the webhook batch.
    */
@@ -1222,8 +1224,8 @@ interface WebhooksBatch {
    */
   webhook: string;
 }
-type WebhooksBatchesResponse = DataResponse<WebhooksBatch[]>;
-interface WebhooksResendBatch {
+export type WebhooksBatchesResponse = DataResponse<WebhooksBatch[]>;
+export interface WebhooksResendBatch {
   /**
    * Unique identifier for the webhook batch.
    */
@@ -1253,9 +1255,10 @@ interface WebhooksResendBatch {
    */
   statusCode: number | null;
 }
-type WebhooksResendBatchResponse = DataResponse<WebhooksResendBatch>;
-declare class Webhooks {
+export type WebhooksResendBatchResponse = DataResponse<WebhooksResendBatch>;
+export declare class Webhooks {
   protected mailchannels: MailChannelsClient;
+  private static readonly STATUS_VALUES;
   constructor(mailchannels: MailChannelsClient);
   /**
    * Enrolls the customer to receive event notifications via webhooks.
@@ -1345,7 +1348,7 @@ declare class Webhooks {
    */
   resendBatch(batchId: number): Promise<WebhooksResendBatchResponse>;
 }
-interface SubAccount {
+export interface SubAccount {
   /**
    * The name of the company associated with the sub-account.
    */
@@ -1359,10 +1362,10 @@ interface SubAccount {
    */
   handle: string;
 }
-type SubAccountsCreateResponse = DataResponse<SubAccount>;
+export type SubAccountsCreateResponse = DataResponse<SubAccount>;
 /** @deprecated Use `SubAccount` instead. */
-type SubAccountsAccount = SubAccount;
-interface SubAccountsListOptions {
+export type SubAccountsAccount = SubAccount;
+export interface SubAccountsListOptions {
   /**
    * Possible values are `1` to `1000`.
    * @default 1000
@@ -1374,8 +1377,8 @@ interface SubAccountsListOptions {
    */
   offset?: number;
 }
-type SubAccountsListResponse = DataResponse<SubAccount[]>;
-interface SubAccountsApiKey {
+export type SubAccountsListResponse = DataResponse<SubAccount[]>;
+export interface SubAccountsApiKey {
   /**
    * The API key ID for the sub-account.
    */
@@ -1385,8 +1388,8 @@ interface SubAccountsApiKey {
    */
   key: string;
 }
-type SubAccountsApiKeysCreateResponse = DataResponse<SubAccountsApiKey>;
-interface SubAccountsApiKeysListOptions {
+export type SubAccountsApiKeysCreateResponse = DataResponse<SubAccountsApiKey>;
+export interface SubAccountsApiKeysListOptions {
   /**
    * The maximum number of API keys included in the response. Possible values are `1` to `1000`.
    * @default 100
@@ -1398,14 +1401,14 @@ interface SubAccountsApiKeysListOptions {
    */
   offset?: number;
 }
-type SubAccountsApiKeysListResponse = DataResponse<SubAccountsApiKey[]>;
+export type SubAccountsApiKeysListResponse = DataResponse<SubAccountsApiKey[]>;
 /** @deprecated Use `SubAccountsApiKeysCreateResponse` instead. */
-type SubAccountsCreateApiKeyResponse = SubAccountsApiKeysCreateResponse;
+export type SubAccountsCreateApiKeyResponse = SubAccountsApiKeysCreateResponse;
 /** @deprecated Use `SubAccountsApiKeysListOptions` instead. */
-type SubAccountsListApiKeyOptions = SubAccountsApiKeysListOptions;
+export type SubAccountsListApiKeyOptions = SubAccountsApiKeysListOptions;
 /** @deprecated Use `SubAccountsApiKeysListResponse` instead. */
-type SubAccountsListApiKeyResponse = SubAccountsApiKeysListResponse;
-interface SubAccountsSmtpPassword {
+export type SubAccountsListApiKeyResponse = SubAccountsApiKeysListResponse;
+export interface SubAccountsSmtpPassword {
   /**
    * Whether the SMTP password is enabled.
    */
@@ -1419,20 +1422,20 @@ interface SubAccountsSmtpPassword {
    */
   smtpPassword: string;
 }
-type SubAccountsSmtpPasswordsCreateResponse = DataResponse<SubAccountsSmtpPassword>;
-type SubAccountsSmtpPasswordsListResponse = DataResponse<SubAccountsSmtpPassword[]>;
+export type SubAccountsSmtpPasswordsCreateResponse = DataResponse<SubAccountsSmtpPassword>;
+export type SubAccountsSmtpPasswordsListResponse = DataResponse<SubAccountsSmtpPassword[]>;
 /** @deprecated Use `SubAccountsSmtpPasswordsCreateResponse` instead. */
-type SubAccountsCreateSmtpPasswordResponse = SubAccountsSmtpPasswordsCreateResponse;
+export type SubAccountsCreateSmtpPasswordResponse = SubAccountsSmtpPasswordsCreateResponse;
 /** @deprecated Use `SubAccountsSmtpPasswordsListResponse` instead. */
-type SubAccountsListSmtpPasswordResponse = SubAccountsSmtpPasswordsListResponse;
-interface SubAccountsLimit {
+export type SubAccountsListSmtpPasswordResponse = SubAccountsSmtpPasswordsListResponse;
+export interface SubAccountsLimit {
   sends: number;
 }
-interface SubAccountsLimitsSetOptions extends SubAccountsLimit {}
-type SubAccountsLimitsGetResponse = DataResponse<SubAccountsLimit>;
+export interface SubAccountsLimitsSetOptions extends SubAccountsLimit {}
+export type SubAccountsLimitsGetResponse = DataResponse<SubAccountsLimit>;
 /** @deprecated Use `SubAccountsLimitsGetResponse` instead. */
-type SubAccountsLimitResponse = SubAccountsLimitsGetResponse;
-interface SubAccountsUsage {
+export type SubAccountsLimitResponse = SubAccountsLimitsGetResponse;
+export interface SubAccountsUsage {
   /**
    * The end date of the current billing period (ISO 8601 format).
    * @example "2025-04-11"
@@ -1455,8 +1458,8 @@ interface SubAccountsUsage {
    */
   monthlyLimit: number;
 }
-type SubAccountsUsageResponse = DataResponse<SubAccountsUsage>;
-interface MetricsEngagement {
+export type SubAccountsUsageResponse = DataResponse<SubAccountsUsage>;
+export interface MetricsEngagement {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
    */
@@ -1517,8 +1520,8 @@ interface MetricsEngagement {
    */
   uniqueOpenTrackingDelivered?: number;
 }
-type MetricsEngagementResponse = DataResponse<MetricsEngagement>;
-interface MetricsPerformance {
+export type MetricsEngagementResponse = DataResponse<MetricsEngagement>;
+export interface MetricsPerformance {
   /**
    * Count of messages hard-bounced during the specified time range.
    */
@@ -1553,8 +1556,8 @@ interface MetricsPerformance {
    */
   startTime: string;
 }
-type MetricsPerformanceResponse = DataResponse<MetricsPerformance>;
-interface MetricsRecipientBehaviour {
+export type MetricsPerformanceResponse = DataResponse<MetricsPerformance>;
+export interface MetricsRecipientBehaviour {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
    */
@@ -1579,8 +1582,8 @@ interface MetricsRecipientBehaviour {
    */
   unsubscribed: number;
 }
-type MetricsRecipientBehaviourResponse = DataResponse<MetricsRecipientBehaviour>;
-interface MetricsVolume {
+export type MetricsRecipientBehaviourResponse = DataResponse<MetricsRecipientBehaviour>;
+export interface MetricsVolume {
   /**
    * A series of metrics aggregations bucketed by time interval (e.g. hour, day).
    */
@@ -1610,8 +1613,8 @@ interface MetricsVolume {
    */
   startTime: string;
 }
-type MetricsVolumeResponse = DataResponse<MetricsVolume>;
-type MetricsUsageResponse = DataResponse<{
+export type MetricsVolumeResponse = DataResponse<MetricsVolume>;
+export type MetricsUsageResponse = DataResponse<{
   /**
    * The end date of the current billing period (ISO 8601 format).
    * @example "2025-04-11"
@@ -1634,8 +1637,8 @@ type MetricsUsageResponse = DataResponse<{
    */
   monthlyLimit: number;
 }>;
-type MetricsSendersType = "sub-accounts" | "campaigns";
-interface MetricsSendersOptions {
+export type MetricsSendersType = "sub-accounts" | "campaigns";
+export interface MetricsSendersOptions {
   /**
    * The beginning of the time range for retrieving top senders metrics (inclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` or a `Date` object. Defaults to one month ago if not provided.
    * @example "2025-11-02T03:13:35.761763554Z"
@@ -1662,7 +1665,7 @@ interface MetricsSendersOptions {
    */
   sortOrder?: "asc" | "desc";
 }
-interface MetricsSenders {
+export interface MetricsSenders {
   endTime: string;
   limit: number;
   offset: number;
@@ -1682,8 +1685,8 @@ interface MetricsSenders {
    */
   total: number;
 }
-type MetricsSendersResponse = DataResponse<MetricsSenders>;
-interface MetricsBucket {
+export type MetricsSendersResponse = DataResponse<MetricsSenders>;
+export interface MetricsBucket {
   /**
    * The number of events or occurrences aggregated within this time period.
    */
@@ -1693,7 +1696,7 @@ interface MetricsBucket {
    */
   periodStart: string;
 }
-interface MetricsOptions {
+export interface MetricsOptions {
   /**
    * The beginning of the time range for retrieving message metrics (inclusive). Formats: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` or a `Date` object. Defaults to one month ago if not provided.
    * @example "2025-05-26"
@@ -1714,8 +1717,8 @@ interface MetricsOptions {
    */
   interval?: "hour" | "day" | "week" | "month";
 }
-type SuppressionsTypes = "transactional" | "non-transactional";
-interface SuppressionsCreateEntry {
+export type SuppressionsTypes = "transactional" | "non-transactional";
+export interface SuppressionsCreateEntry {
   /**
    * Must be less than `1024` characters.
    */
@@ -1730,7 +1733,7 @@ interface SuppressionsCreateEntry {
    */
   types?: SuppressionsTypes[];
 }
-interface SuppressionsCreateOptions {
+export 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
@@ -1742,8 +1745,8 @@ interface SuppressionsCreateOptions {
    */
   entries: SuppressionsCreateEntry[];
 }
-type SuppressionsSource = "api" | "unsubscribe_link" | "list_unsubscribe" | "hard_bounce" | "spam_complaint" | "all";
-interface SuppressionsListOptions {
+export type SuppressionsSource = "api" | "unsubscribe_link" | "list_unsubscribe" | "hard_bounce" | "spam_complaint";
+export 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.
    */
@@ -1751,7 +1754,7 @@ interface SuppressionsListOptions {
   /**
    * The source of the suppression entries to filter by. If not provided, suppression entries from all sources will be returned.
    */
-  source?: Exclude<SuppressionsSource, "all">;
+  source?: SuppressionsSource;
   /**
    * The date and/or time before which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` or a `Date` object.
    */
@@ -1771,7 +1774,7 @@ interface SuppressionsListOptions {
    */
   offset?: number;
 }
-interface SuppressionsListEntry {
+export interface SuppressionsListEntry {
   createdAt: string;
   notes?: string;
   /**
@@ -1782,7 +1785,7 @@ interface SuppressionsListEntry {
   source: SuppressionsSource;
   types: SuppressionsTypes[];
 }
-type SuppressionsListResponse = DataResponse<SuppressionsListEntry[]>;
+export type SuppressionsListResponse = DataResponse<SuppressionsListEntry[]>;
 declare class SubAccountsApiKeys {
   private mailchannels;
   constructor(mailchannels: MailChannelsClient);
@@ -1889,7 +1892,7 @@ declare class SubAccountsLimits {
    */
   delete(handle: string): Promise<SuccessResponse>;
 }
-declare class SubAccounts {
+export declare class SubAccounts {
   protected mailchannels: MailChannelsClient;
   private static readonly COMPANY_PATTERN;
   private static readonly HANDLE_PATTERN;
@@ -1977,7 +1980,7 @@ declare class SubAccounts {
   /** @deprecated Use `limits.delete` instead. */
   deleteLimit(...args: Parameters<SubAccountsLimits["delete"]>): Promise<SuccessResponse>;
 }
-declare class Metrics {
+export declare class Metrics {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
   /**
@@ -2041,8 +2044,10 @@ declare class Metrics {
    */
   senders(type: MetricsSendersType, options?: MetricsSendersOptions): Promise<MetricsSendersResponse>;
 }
-declare class Suppressions {
+export declare class Suppressions {
   protected mailchannels: MailChannelsClient;
+  private static readonly SOURCE_VALUES;
+  private static readonly DELETE_SOURCE_VALUES;
   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.
@@ -2072,7 +2077,7 @@ declare class Suppressions {
    * const { success, error } = await mailchannels.suppressions.delete('name@example.com', 'api');
    * ```
    */
-  delete(recipient: string, source?: SuppressionsSource): Promise<SuccessResponse>;
+  delete(recipient: string, source?: SuppressionsSource | "all"): 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`.
    * @param options - Options to filter and customize the suppression entries retrieval.
@@ -2085,11 +2090,11 @@ declare class Suppressions {
   list(options?: SuppressionsListOptions): Promise<SuppressionsListResponse>;
 }
 type AttachmentOptions = Omit<EmailsSendAttachment, "content">;
-declare class Attachment {
+export declare class Attachment {
   static fromBytes(data: ArrayBuffer | Uint8Array, options: AttachmentOptions): EmailsSendAttachment;
   static fromBlob(blob: Blob, options: AttachmentOptions): Promise<EmailsSendAttachment>;
 }
-declare class MailChannels extends MailChannelsClient {
+export declare class MailChannels extends MailChannelsClient {
   readonly emails: Emails;
   readonly domains: Domains;
   readonly webhooks: Webhooks;
@@ -2097,5 +2102,4 @@ declare class MailChannels extends MailChannelsClient {
   readonly metrics: Metrics;
   readonly suppressions: Suppressions;
   constructor(key: string, options?: MailChannelsClientOptions);
-}
-export { Attachment, DataResponse, Domains, DomainsCheckOptions, DomainsCheckResponse, DomainsCheckVerdict, DomainsCustomTrackingCreateResponse, DomainsCustomTrackingDnsSetupRequired, DomainsCustomTrackingDomain, DomainsCustomTrackingListOptions, DomainsCustomTrackingListResponse, DomainsCustomTrackingScope, DomainsCustomTrackingUpdateOptions, DomainsCustomTrackingUpdateResponse, DomainsCustomTrackingWithDnsSetupRequired, DomainsDkimCreateOptions, DomainsDkimCreateResponse, DomainsDkimKey, DomainsDkimKeyStatus, DomainsDkimListOptions, DomainsDkimListResponse, DomainsDkimRotateOptions, DomainsDkimRotateResponse, DomainsDkimUpdateStatusOptions, Emails, EmailsQueueResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendContent, EmailsSendDkim, EmailsSendOptions, EmailsSendPersonalization, EmailsSendRecipient, EmailsSendRecipientInput, EmailsSendResponse, EmailsSendTemplate, EmailsSendTemplateType, EmailsSendTemplateValue, EmailsSendTracking, ErrorResponse, ErrorType, MailChannels, MailChannelsClient, MailChannelsClientOptions, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, SubAccount, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsApiKeysCreateResponse, SubAccountsApiKeysListOptions, SubAccountsApiKeysListResponse, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsLimitsGetResponse, SubAccountsLimitsSetOptions, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsSmtpPasswordsCreateResponse, SubAccountsSmtpPasswordsListResponse, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateEntry, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksResendBatch, WebhooksResendBatchResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions, WebhooksVerifyResponse };
+}

package/dist/_chunks/mailchannels.mjs

@@ -3,7 +3,7 @@ import { subtle } from "node:crypto";
 import { Buffer } from "node:buffer";
 import mime from "mime";
 var name = "mailchannels-sdk";
-var version = "1.5.1";
+var version = "1.6.0";
 var MailChannelsClient = class MailChannelsClient {
 	static DEFAULT_BASE_URL = "https://api.mailchannels.net";
 	static DEFAULT_TIMEOUT = 12e4;
@@ -80,6 +80,10 @@ const STATUS_ERROR_TYPE_MAP = {
 	[429]: "rate_limit_error",
 	[500]: "internal_server_error"
 };
+const STATUS_DEFAULT_TEXT_MAP = {
+	[400]: "Bad request.",
+	[401]: "Invalid API key."
+};
 const createError = (message, statusCode = null, type, response = null) => {
 	return {
 		message,
@@ -89,11 +93,12 @@ const createError = (message, statusCode = null, type, response = null) => {
 	};
 };
 const getStatusError = (response, errors = {}) => {
-	const statusText = errors[response.status] || "Unknown error.";
+	const statusText = errors[response.status] || STATUS_DEFAULT_TEXT_MAP[response.status] || "Unknown error.";
+	const contentType = response.headers?.get("content-type")?.toLowerCase();
 	const payload = response._data ?? response.data;
 	let details;
 	let errorResponse = null;
-	if (typeof payload === "string") details = payload;
+	if (typeof payload === "string" && !contentType?.includes("text/html")) details = payload;
 	else if (typeof payload === "object" && payload !== null) {
 		if (typeof payload.message === "string") details = payload.message;
 		else if (Array.isArray(payload.errors) && payload.errors.length) details = payload.errors.join(", ");
@@ -109,8 +114,14 @@ const createValidationError = (message) => {
 };
 const validatePagination = (pagination = {}) => {
 	const { limit, offset, max } = pagination;
-	if (typeof limit === "number" && (limit < 1 || max && limit > max)) return createValidationError("The limit value " + (max ? `must be between 1 and ${max}.` : "is invalid. Only positive values are allowed."));
-	if (typeof offset === "number" && offset < 0) return createValidationError("Offset must be greater than or equal to 0.");
+	if (limit !== void 0) {
+		if (!Number.isInteger(limit)) return createValidationError("The limit value must be an integer.");
+		if (limit < 1 || max != null && limit > max) return createValidationError("The limit value " + (max != null ? `must be between 1 and ${max}.` : "is invalid. Only positive values are allowed."));
+	}
+	if (offset !== void 0) {
+		if (!Number.isInteger(offset)) return createValidationError("The offset value must be an integer.");
+		if (offset < 0) return createValidationError("The offset value must be greater than or equal to 0.");
+	}
 	return null;
 };
 const CUSTOM_TRACKING_NAME_PATTERN = /^[a-z0-9-]+$/;
@@ -393,7 +404,6 @@ var Emails = class {
 			body: payload,
 			onResponseError: async ({ response }) => {
 				error = getStatusError(response, {
-					[400]: "Bad Request.",
 					[403]: "User does not have access to this feature.",
 					[413]: "The total message size should not exceed 30MB. This includes the message itself, headers, and the combined size of any attachments."
 				});
@@ -454,8 +464,17 @@ const mapDkimKey = (key) => ({
 	status: key.status,
 	statusModifiedAt: key.status_modified_at
 });
-var DomainsDkim = class {
+const quoteValues = (values) => {
+	return Array.from(values).map((value) => `'${value}'`).join(", ");
+};
+var DomainsDkim = class DomainsDkim {
 	mailchannels;
+	static UPDATE_STATUS_VALUES = /* @__PURE__ */ new Set([
+		"retired",
+		"revoked",
+		"rotated"
+	]);
+	static STATUS_VALUES = /* @__PURE__ */ new Set(["active", ...DomainsDkim.UPDATE_STATUS_VALUES]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -483,10 +502,7 @@ var DomainsDkim = class {
 		const response = await this.mailchannels.post(`/tx/v1/domains/${encodeURIComponent(domain)}/dkim-keys`, {
 			body: payload,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[409]: "Key pair already created for domain, and selector."
-				});
+				error = getStatusError(response, { [409]: "Key pair already created for domain, and selector." });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to create DKIM key.");
@@ -517,6 +533,13 @@ var DomainsDkim = class {
 				error
 			};
 		}
+		if (options?.status !== void 0 && !DomainsDkim.STATUS_VALUES.has(options.status)) {
+			error = createValidationError(`Status must be one of ${quoteValues(DomainsDkim.STATUS_VALUES)}.`);
+			return {
+				data: null,
+				error
+			};
+		}
 		error = validatePagination({
 			...options,
 			max: 100
@@ -535,7 +558,7 @@ var DomainsDkim = class {
 		const response = await this.mailchannels.get(`/tx/v1/domains/${encodeURIComponent(domain)}/dkim-keys`, {
 			query: payload,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch DKIM keys.");
@@ -566,14 +589,18 @@ var DomainsDkim = class {
 				error
 			};
 		}
+		if (options?.status !== void 0 && !DomainsDkim.UPDATE_STATUS_VALUES.has(options.status)) {
+			error = createValidationError(`Status must be one of ${quoteValues(DomainsDkim.UPDATE_STATUS_VALUES)}.`);
+			return {
+				success: false,
+				error
+			};
+		}
 		const payload = { status: options.status };
 		await this.mailchannels.patch(`/tx/v1/domains/${encodeURIComponent(domain)}/dkim-keys/${encodeURIComponent(options.selector)}`, {
 			body: payload,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[404]: "Specified key pair not found, or no active key for rotation. This may also occur if the DKIM domain or selector path parameter is missing."
-				});
+				error = getStatusError(response, { [404]: "Specified key pair not found, or no active key for rotation. This may also occur if the DKIM domain or selector path parameter is missing." });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to update status of DKIM key.");
@@ -611,7 +638,6 @@ var DomainsDkim = class {
 			body: payload,
 			onResponseError: async ({ response }) => {
 				error = getStatusError(response, {
-					[400]: "Bad Request.",
 					[404]: "Specified key pair not found.",
 					[409]: "Key pair already created for domain, and provided new key selector."
 				});
@@ -656,7 +682,7 @@ var DomainsCustomTracking = class DomainsCustomTracking {
 		const response = await this.mailchannels.get("/tx/v1/custom-tracking-domains", {
 			query: options,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch custom tracking domains.");
@@ -714,7 +740,6 @@ var DomainsCustomTracking = class DomainsCustomTracking {
 			},
 			onResponseError: async ({ response }) => {
 				error = getStatusError(response, {
-					[400]: "Invalid request body.",
 					[403]: "No permission to register this domain.",
 					[409]: "A domain with the same name already exists, or the hostname and scope combination is already registered.",
 					[422]: "DNS verification incomplete. Either the TXT ownership record has not propagated yet or the hostname CNAME does not point to the required target."
@@ -764,7 +789,7 @@ var DomainsCustomTracking = class DomainsCustomTracking {
 			};
 		}
 		if (!scope || !DomainsCustomTracking.SCOPE_VALUES.has(scope)) {
-			error = createValidationError("Scope must be one of 'click', 'open', or 'unsubscribe'.");
+			error = createValidationError(`Scope must be one of ${quoteValues(DomainsCustomTracking.SCOPE_VALUES)}.`);
 			return {
 				data: null,
 				error
@@ -796,7 +821,6 @@ var DomainsCustomTracking = class DomainsCustomTracking {
 			},
 			onResponseError: async ({ response }) => {
 				error = getStatusError(response, {
-					[400]: "Bad Request.",
 					[403]: "No permission to update this domain.",
 					[404]: `Custom tracking domain for hostname '${hostname}' and scope '${scope}' not found.`,
 					[409]: "Name already used by another domain.",
@@ -910,10 +934,7 @@ var Domains = class {
 		const response = await this.mailchannels.post("/tx/v1/check-domain", {
 			body: payload,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[403]: "User does not have access to this feature."
-				});
+				error = getStatusError(response, { [403]: "User does not have access to this feature." });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to check domain.");
@@ -1044,6 +1065,14 @@ const parseDateInputs = (options) => {
 };
 var Webhooks = class Webhooks {
 	mailchannels;
+	static STATUS_VALUES = /* @__PURE__ */ new Set([
+		"1xx",
+		"2xx",
+		"3xx",
+		"4xx",
+		"5xx",
+		"no_response"
+	]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -1110,10 +1139,7 @@ var Webhooks = class Webhooks {
 		const response = await this.mailchannels.get("/tx/v1/webhook/public-key", {
 			query: { id },
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[404]: `The key '${id}' is not found.`
-				});
+				error = getStatusError(response, { [404]: `The key '${id}' is not found.` });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to get signing key.");
@@ -1143,10 +1169,7 @@ var Webhooks = class Webhooks {
 		const response = await this.mailchannels.post("/tx/v1/webhook/validate", {
 			body: { request_id: requestId },
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[404]: "No webhooks found for the account."
-				});
+				error = getStatusError(response, { [404]: "No webhooks found for the account." });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to validate webhooks.");
@@ -1221,14 +1244,27 @@ var Webhooks = class Webhooks {
 			data: null,
 			error
 		};
-		if (options?.statuses && options.statuses.length > 6) return {
-			data: null,
-			error: createValidationError("A maximum of 6 status filters can be provided.")
-		};
-		if (options?.statuses && new Set(options.statuses).size !== options.statuses.length) return {
-			data: null,
-			error: createValidationError("Status filters must be unique.")
-		};
+		if (options?.statuses !== void 0) {
+			if (!Array.isArray(options.statuses)) return {
+				data: null,
+				error: createValidationError("Status filters must be an array.")
+			};
+			if (options.statuses.length > 6) return {
+				data: null,
+				error: createValidationError("A maximum of 6 status filters can be provided.")
+			};
+			if (new Set(options.statuses).size !== options.statuses.length) return {
+				data: null,
+				error: createValidationError("Status filters must be unique.")
+			};
+			if (!options.statuses.every((status) => Webhooks.STATUS_VALUES.has(status))) {
+				const validValues = quoteValues(Webhooks.STATUS_VALUES);
+				return {
+					data: null,
+					error: createValidationError(`Invalid status filter provided. Valid values are: ${validValues}.`)
+				};
+			}
+		}
 		const { dates, error: dateError } = parseDateInputs({
 			createdAfter: options?.createdAfter,
 			createdBefore: options?.createdBefore
@@ -1254,13 +1290,13 @@ var Webhooks = class Webhooks {
 			query: {
 				created_after: dates.createdAfter,
 				created_before: dates.createdBefore,
-				statuses: options?.statuses,
+				statuses: options?.statuses?.join(","),
 				webhook: options?.webhook,
 				limit: options?.limit,
 				offset: options?.offset
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch webhook batches.");
@@ -1288,7 +1324,7 @@ var Webhooks = class Webhooks {
 		let error = null;
 		const response = await this.mailchannels.post(`/tx/v1/webhook-batch/${encodeURIComponent(batchId)}/resend`, { onResponseError: async ({ response }) => {
 			error = getStatusError(response, {
-				[400]: "Bad Request. The batch ID is invalid.",
+				[400]: "The batch ID is invalid.",
 				[404]: `The batch '${batchId}' is not found for the customer.`
 			});
 		} }).catch((e) => {
@@ -1537,10 +1573,7 @@ var SubAccountsLimits = class {
 		await this.mailchannels.put(`/tx/v1/sub-account/${encodeURIComponent(handle)}/limit`, {
 			body: options,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, {
-					[400]: "Bad Request.",
-					[404]: `Sub-account with handle '${handle}' not found.`
-				});
+				error = getStatusError(response, { [404]: `Sub-account with handle '${handle}' not found.` });
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to set sub-account limit.");
@@ -1807,7 +1840,7 @@ var Metrics = class {
 				interval: options?.interval
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch engagement metrics.");
@@ -1861,7 +1894,7 @@ var Metrics = class {
 				interval: options?.interval
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch performance metrics.");
@@ -1907,7 +1940,7 @@ var Metrics = class {
 				interval: options?.interval
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch recipient behaviour metrics.");
@@ -1949,7 +1982,7 @@ var Metrics = class {
 				interval: options?.interval
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch volume metrics.");
@@ -2024,7 +2057,7 @@ var Metrics = class {
 				sort_order: options?.sortOrder
 			},
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch senders metrics.");
@@ -2047,8 +2080,16 @@ var Metrics = class {
 		};
 	}
 };
-var Suppressions = class {
+var Suppressions = class Suppressions {
 	mailchannels;
+	static SOURCE_VALUES = /* @__PURE__ */ new Set([
+		"api",
+		"unsubscribe_link",
+		"list_unsubscribe",
+		"hard_bounce",
+		"spam_complaint"
+	]);
+	static DELETE_SOURCE_VALUES = /* @__PURE__ */ new Set([...Suppressions.SOURCE_VALUES, "all"]);
 	constructor(mailchannels) {
 		this.mailchannels = mailchannels;
 	}
@@ -2075,7 +2116,6 @@ var Suppressions = class {
 			body: payload,
 			onResponseError: async ({ response }) => {
 				error = getStatusError(response, {
-					[400]: "Bad Request.",
 					[409]: "Conflict. One or more suppression entries in the request already exist and cannot be created again.",
 					[413]: "Payload too large. The request exceeds the maximum allowed total of 1000 suppression entries for the parent account and/or its sub-accounts."
 				});
@@ -2090,10 +2130,17 @@ var Suppressions = class {
 	}
 	async delete(recipient, source) {
 		let error = null;
+		if (source !== void 0 && !Suppressions.DELETE_SOURCE_VALUES.has(source)) {
+			error = createValidationError(`Source must be one of ${quoteValues(Suppressions.DELETE_SOURCE_VALUES)}.`);
+			return {
+				success: false,
+				error
+			};
+		}
 		await this.mailchannels.delete(`/tx/v1/suppression-list/recipients/${encodeURIComponent(recipient)}`, {
 			query: { source },
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to delete suppression entry.");
@@ -2112,6 +2159,13 @@ var Suppressions = class {
 				error
 			};
 		}
+		if (options?.source !== void 0 && !Suppressions.SOURCE_VALUES.has(options.source)) {
+			error = createValidationError(`Source must be one of ${quoteValues(Suppressions.SOURCE_VALUES)}.`);
+			return {
+				data: null,
+				error
+			};
+		}
 		const { dates, error: dateError } = parseDateInputs({
 			createdBefore: options?.createdBefore,
 			createdAfter: options?.createdAfter
@@ -2139,7 +2193,7 @@ var Suppressions = class {
 		const response = await this.mailchannels.get("/tx/v1/suppression-list", {
 			query: payload,
 			onResponseError: async ({ response }) => {
-				error = getStatusError(response, { [400]: "Bad Request." });
+				error = getStatusError(response);
 			}
 		}).catch((e) => {
 			error ||= getResultError(e, "Failed to fetch suppression entries.");

package/dist/plugins/nodemailer/index.d.mts

@@ -1,9 +1,9 @@
 import { EmailsQueueResponse, EmailsSendOptions, EmailsSendResponse, MailChannelsClientOptions } from "../../_chunks/mailchannels.mjs";
-import { Transport as Transport$1 } from "nodemailer";
+import { Transport, TransportOptions, Transporter } from "nodemailer";
 import MimeNode from "nodemailer/lib/mime-node";
-type MailChannelsTransportSendOptions = Pick<EmailsSendOptions, "campaignId" | "tracking" | "transactional" | "unsubscribe">;
-type MailChannelsTransportSendMode = "sync" | "async";
-interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode = "async"> extends MailChannelsClientOptions {
+export type MailChannelsTransportSendOptions = Pick<EmailsSendOptions, "campaignId" | "tracking" | "transactional" | "unsubscribe">;
+export type MailChannelsTransportSendMode = "sync" | "async";
+export interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode = "async"> extends MailChannelsClientOptions {
   /**
    * The MailChannels Email API key.
    */
@@ -14,7 +14,7 @@ interface MailChannelsTransportOptions<T extends MailChannelsTransportSendMode =
    */
   sendMode?: T;
 }
-interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
+export interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
   messageId: string | null;
   accepted: string[];
   rejected: string[];
@@ -22,12 +22,14 @@ interface MailChannelsTransportInfo<T extends MailChannelsTransportSendMode> {
   response: (T extends "sync" ? EmailsSendResponse : EmailsQueueResponse) | null;
 }
 declare module "nodemailer" {
-  function createTransport<T>(transport: Transport<T> | TransportOptions, defaults?: TransportOptions): Transporter<T, TransportOptions>;
+  function createTransport<T>(transport: Transport<T> | TransportOptions, defaults?: TransportOptions): Transporter<T>;
+  interface SendMailOptions {
+    mailchannels?: MailChannelsTransportSendOptions;
+  }
 }
 declare module "nodemailer/lib/mailer" {
   interface Options {
     mailchannels?: MailChannelsTransportSendOptions;
   }
 }
-declare const mailchannelsTransport: <T extends MailChannelsTransportSendMode = "async">(options: MailChannelsTransportOptions<T>) => Transport$1<MailChannelsTransportInfo<T>>;
-export { MailChannelsTransportInfo, MailChannelsTransportOptions, MailChannelsTransportSendMode, MailChannelsTransportSendOptions, mailchannelsTransport };
+export declare const mailchannelsTransport: <T extends MailChannelsTransportSendMode = "async">(options: MailChannelsTransportOptions<T>) => Transport<MailChannelsTransportInfo<T>>;

package/dist/plugins/nodemailer/index.mjs

@@ -5,9 +5,10 @@ const parseAddress = (address) => {
 	if (!address) return "";
 	if (Array.isArray(address)) return parseAddress(address[0]);
 	if (typeof address === "string") return address;
+	if (!address.address) return "";
 	return {
 		email: address.address,
-		name: address.name || void 0
+		name: address.name
 	};
 };
 const parseAddresses = (addresses) => {
@@ -41,7 +42,7 @@ const parseDkim = (dkim) => {
 	if ("keys" in dkim) throw new Error("Multiple DKIM signatures are not supported");
 	let privateKey;
 	if (typeof dkim.privateKey === "string") privateKey = dkim.privateKey;
-	else if (dkim.privateKey?.key && dkim.privateKey?.passphrase) try {
+	else if (dkim.privateKey && "key" in dkim.privateKey && "passphrase" in dkim.privateKey) try {
 		privateKey = createPrivateKey({
 			key: dkim.privateKey.key,
 			passphrase: dkim.privateKey.passphrase
@@ -62,7 +63,8 @@ const parseDkim = (dkim) => {
 const parseHeaders = (headers) => {
 	if (!headers) return;
 	if (Array.isArray(headers)) return headers.reduce((acc, { key, value }) => {
-		acc[key] = value;
+		if (value == void 0) return acc;
+		acc[key] = value.toString();
 		return acc;
 	}, {});
 	return Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, Array.isArray(value) ? value.join(",") : value && typeof value === "object" && "value" in value ? String(value.value) : String(value)]));
@@ -94,7 +96,10 @@ const mailchannelsTransport = (options) => {
 				messageId: null,
 				accepted: [],
 				rejected: [],
-				envelope: mail.message.getEnvelope(),
+				envelope: mail.message?.getEnvelope() ?? {
+					from: false,
+					to: []
+				},
 				response: null
 			};
 			mail.normalize(async (err, data) => {

package/dist/simulator/index.d.mts

@@ -1,4 +1,4 @@
-declare const createSimulator: (options?: {
+export declare const createSimulator: (options?: {
   host?: string;
   port?: number;
   silent?: boolean;
@@ -16,5 +16,4 @@ declare const createSimulator: (options?: {
     host?: string;
     port?: number;
   }): Promise<string>;
-};
-export { createSimulator };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Node.js SDK to integrate MailChannels Email API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -52,19 +52,18 @@
   "devDependencies": {
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/markdown-it": "^14.2.0",
-    "@types/node": "^26.2.0",
-    "@types/nodemailer": "^8.0.1",
-    "@vitest/coverage-v8": "^4.1.11",
+    "@types/node": "^26.5.0",
+    "@vitest/coverage-v8": "^5.0.0",
     "changelogen": "^0.6.2",
-    "nodemailer": "^9.0.5",
-    "obuild": "^0.4.38",
-    "oxlint": "^1.79.0",
+    "nodemailer": "^10.0.1",
+    "obuild": "^0.4.39",
+    "oxlint": "^1.82.0",
     "scule": "^1.3.0",
     "typescript": "^6.0.3",
-    "vitepress": "^2.0.0-alpha.19",
+    "vitepress": "^2.0.0-alpha.20",
     "vitepress-plugin-group-icons": "^1.7.6",
     "vitepress-plugin-llms": "^1.13.5",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.0"
   },
   "engines": {
     "node": ">=20"
@@ -72,7 +71,7 @@
   "scripts": {
     "build": "obuild",
     "parity:fixtures": "node scripts/generate-parity-fixtures.ts",
-    "release": "pnpm lint && pnpm test && pnpm build && changelogen --bump",
+    "release": "pnpm lint && pnpm test && pnpm build && changelogen --bump && node scripts/update-examples-sdk-version.ts",
     "cli": "pnpx jiti src/cli/index.ts",
     "simulate": "pnpx jiti src/cli/index.ts simulate",
     "lint": "oxlint",