mailchannels-sdk 0.4.4 → 0.4.6

package/README.md

@@ -33,13 +33,13 @@ This library provides a simple way to interact with the [MailChannels API](https
 
 - Send transactional emails
 - Check DKIM, SPF & Domain Lockdown
+- Configure DKIM keys
 - Webhook notifications
 - Manage sub-accounts
 - Retrieve metrics
-- Manage suppressions
-- Manage inbound domains
-- Manage account lists
-- Manage recipient lists
+- Handle suppressions
+- Configure inbound domains
+- Manage account and recipient lists
 
 ## <a name="requirements">📏 Requirements</a>
 

package/dist/mailchannels.d.mts

@@ -1,5 +1,5 @@
-import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Metrics, b as Suppressions, D as Domains, L as Lists, U as Users, c as Service } from './shared/mailchannels-sdk.CiU7QtsS.mjs';
-export { ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, aq as UsersCreateOptions, ar as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.CiU7QtsS.mjs';
+import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Metrics, b as Suppressions, D as Domains, L as Lists, U as Users, c as Service } from './shared/mailchannels-sdk.DgBM4Ujq.mjs';
+export { ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, aq as UsersCreateOptions, ar as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.DgBM4Ujq.mjs';
 import 'ofetch';
 
 declare class MailChannels extends MailChannelsClient {

package/dist/mailchannels.d.ts

@@ -1,5 +1,5 @@
-import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Metrics, b as Suppressions, D as Domains, L as Lists, U as Users, c as Service } from './shared/mailchannels-sdk.CiU7QtsS.js';
-export { ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, aq as UsersCreateOptions, ar as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.CiU7QtsS.js';
+import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Metrics, b as Suppressions, D as Domains, L as Lists, U as Users, c as Service } from './shared/mailchannels-sdk.DgBM4Ujq.js';
+export { ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, aq as UsersCreateOptions, ar as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.DgBM4Ujq.js';
 import 'ofetch';
 
 declare class MailChannels extends MailChannelsClient {

package/dist/modules.d.mts

@@ -1,2 +1,2 @@
-export { D as Domains, ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, E as Emails, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, L as Lists, a as Metrics, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, c as Service, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, b as Suppressions, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, U as Users, aq as UsersCreateOptions, ar as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.CiU7QtsS.mjs';
+export { D as Domains, ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, E as Emails, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, L as Lists, a as Metrics, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, c as Service, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, b as Suppressions, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, U as Users, aq as UsersCreateOptions, ar as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.DgBM4Ujq.mjs';
 import 'ofetch';

package/dist/modules.d.ts

@@ -1,2 +1,2 @@
-export { D as Domains, ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, E as Emails, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, L as Lists, a as Metrics, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, c as Service, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, b as Suppressions, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, U as Users, aq as UsersCreateOptions, ar as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.CiU7QtsS.js';
+export { D as Domains, ai as DomainsBulkCreateLoginLinkResult, aj as DomainsBulkCreateLoginLinks, ak as DomainsBulkCreateLoginLinksResponse, a9 as DomainsBulkProvisionOptions, ab as DomainsBulkProvisionResponse, ae as DomainsCreateLoginLinkResponse, a7 as DomainsData, ag as DomainsDownstreamAddress, af as DomainsListDownstreamAddressesOptions, ah as DomainsListDownstreamAddressesResponse, ac as DomainsListOptions, ad as DomainsListResponse, a8 as DomainsProvisionOptions, aa as DomainsProvisionResponse, E as Emails, j as EmailsCheckDomainDkim, k as EmailsCheckDomainOptions, m as EmailsCheckDomainResponse, l as EmailsCheckDomainVerdict, n as EmailsCreateDkimKeyOptions, p as EmailsCreateDkimKeyResponse, o as EmailsDkimKey, q as EmailsGetDkimKeysOptions, r as EmailsGetDkimKeysResponse, e as EmailsSendAttachment, h as EmailsSendOptions, g as EmailsSendOptionsBase, d as EmailsSendRecipient, i as EmailsSendResponse, f as EmailsSendTracking, s as EmailsUpdateDkimKeyOptions, ap as ListEntriesResponse, an as ListEntry, am as ListEntryOptions, ao as ListEntryResponse, al as ListNames, L as Lists, a as Metrics, P as MetricsBucket, R as MetricsEngagement, T as MetricsEngagementResponse, Q as MetricsOptions, V as MetricsPerformance, X as MetricsPerformanceResponse, Y as MetricsRecipientBehaviour, Z as MetricsRecipientBehaviourResponse, a0 as MetricsUsageResponse, _ as MetricsVolume, $ as MetricsVolumeResponse, O as Optional, c as Service, at as ServiceReportOptions, as as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, G as SubAccountsCreateSmtpPasswordResponse, I as SubAccountsLimit, J as SubAccountsLimitResponse, C as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, H as SubAccountsListSmtpPasswordResponse, F as SubAccountsSmtpPassword, K as SubAccountsUsage, N as SubAccountsUsageResponse, au as SuccessResponse, b as Suppressions, a2 as SuppressionsCreateOptions, a5 as SuppressionsListEntry, a4 as SuppressionsListOptions, a6 as SuppressionsListResponse, a3 as SuppressionsSource, a1 as SuppressionsTypes, U as Users, aq as UsersCreateOptions, ar as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.DgBM4Ujq.js';
 import 'ofetch';

package/dist/modules.mjs

@@ -103,6 +103,7 @@ class Emails {
         dkim_selector: dkim?.selector || void 0,
         dynamic_template_data: options.mustaches
       }],
+      headers: options.headers,
       reply_to: parseRecipient(options.replyTo),
       from: parsedFrom,
       subject: options.subject,
@@ -160,12 +161,12 @@ class Emails {
    */
   async checkDomain(options) {
     const { dkim, domain, senderId } = options;
-    const dkimOptions = Array.isArray(dkim) ? dkim : [dkim];
+    const dkimOptions = dkim ? Array.isArray(dkim) ? dkim : [dkim] : void 0;
     const data = { results: null, error: null };
     const payload = {
-      dkim_settings: dkimOptions.map(({ domain: domain2, privateKey, selector }) => ({
+      dkim_settings: dkimOptions?.map(({ domain: domain2, privateKey, selector }) => ({
         dkim_domain: domain2,
-        dkim_private_key: stripPemHeaders(privateKey),
+        dkim_private_key: privateKey ? stripPemHeaders(privateKey) : void 0,
         dkim_selector: selector
       })),
       domain,
@@ -182,13 +183,15 @@ class Emails {
     }).catch(() => null);
     if (!response) return data;
     data.results = {
-      dkim: response.check_results.dkim.map(({ dkim_domain, dkim_selector, reason, verdict }) => ({
-        domain: dkim_domain,
-        selector: dkim_selector,
-        reason,
-        verdict
+      dkim: response.check_results.dkim.map((dkimResults) => ({
+        domain: dkimResults.dkim_domain,
+        keyStatus: dkimResults.dkim_key_status,
+        selector: dkimResults.dkim_selector,
+        reason: dkimResults.reason,
+        verdict: dkimResults.verdict
       })),
       domainLockdown: response.check_results.domain_lockdown,
+      senderDomain: response.check_results.sender_domain,
       spf: response.check_results.spf,
       references: response.references
     };
@@ -1252,7 +1255,7 @@ class Domains {
   }
   /**
    * Provision a single domain to use MailChannels Inbound.
-   * @param options - The domain data to provision.
+   * @param options - The provision options and domain data.
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
@@ -1285,7 +1288,7 @@ class Domains {
   /**
    * Provision up to 1000 domains to use MailChannels Inbound.
    * @param options - The options to provision the domains.
-   * @param domains - The list of domains to provision.
+   * @param domains - A list of domain data to provision.
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')

package/dist/shared/{mailchannels-sdk.CiU7QtsS.d.mts → mailchannels-sdk.DgBM4Ujq.d.mts}

@@ -129,6 +129,15 @@ interface EmailsSendOptionsBase {
    * '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
@@ -187,13 +196,13 @@ interface EmailsSendOptionsBase {
 type EmailsSendOptions = EmailsSendOptionsBase & (
   | {
     /**
-     * The HTML content of the email
+     * 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)
+     * The plain text content of the email (optional when html is provided).
      * @example
      * 'Hello World'
      */
@@ -201,13 +210,13 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
   }
   | {
     /**
-     * The HTML content of the email (optional when text is provided)
+     * 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
+     * The plain text content of the email.
      * @example
      * 'Hello World'
      */
@@ -217,7 +226,7 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
 
 interface EmailsSendResponse {
   /**
-   * Indicates if the email was successfully sent
+   * Indicates if the email was successfully sent.
    */
   success: boolean;
   data: {
@@ -251,74 +260,6 @@ interface EmailsSendResponse {
   error: string | null;
 }
 
-interface EmailsCheckDomainDkim {
-  /**
-   * Domain used for DKIM signing.
-   */
-  domain: string;
-  /**
-   * DKIM private key encoded in Base64.
-   */
-  privateKey: string;
-  /**
-   * DKIM selector in the domain DNS records.
-   */
-  selector: string;
-}
-
-interface EmailsCheckDomainOptions {
-  /**
-   * Up to 10 DKIM checks are allowed.
-   */
-  dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
-  /**
-   * Domain used for sending emails.
-   */
-  domain: string;
-  /**
-   * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
-   */
-  senderId: string;
-}
-
-type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-
-interface EmailsCheckDomainResponse {
-  /**
-   * The results of the domain checks.
-   */
-  results: {
-    dkim: {
-      domain: string;
-      selector: string;
-      /**
-       * A human-readable explanation of DKIM check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    }[];
-    domainLockdown: {
-      /**
-       * A human-readable explanation of Domain Lockdown check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    };
-    spf: {
-      /**
-       * A human-readable explanation of SPF check.
-       */
-      reason?: string;
-      verdict: EmailsCheckDomainVerdict;
-    };
-    references?: string[];
-  } | null;
-  /**
-   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
-   */
-  error: string | null;
-}
-
 interface EmailsCreateDkimKeyOptions {
   /**
    * Algorithm used for the new key pair Currently, only RSA is supported.
@@ -384,6 +325,107 @@ interface EmailsCreateDkimKeyResponse {
   error: string | null;
 }
 
+interface EmailsCheckDomainDkim {
+  /**
+   * Domain used for DKIM signing.
+   */
+  domain?: string;
+  /**
+   * DKIM private key encoded in Base64.
+   */
+  privateKey?: string;
+  /**
+   * DKIM selector in the domain DNS records.
+   */
+  selector?: string;
+}
+
+interface EmailsCheckDomainOptions {
+  /**
+   * 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:
+   * - If `domain`, `selector`, and `privateKey` are all present, verify using the provided domain, selector, and key.
+   * - If `domain` and `selector` are present, use the stored private key for the given domain and selector.
+   * - If only `domain` is present, use all stored keys for the given domain.
+   * - If none are present, use all stored keys for the `domain` provided in the domain field of the request.
+   * - If `privateKey` is present, `selector` must be present.
+   * - 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";
+
+interface EmailsCheckDomainResponse {
+  /**
+   * The results of the domain checks.
+   */
+  results: {
+    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[];
+  } | null;
+  /**
+   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
+   */
+  error: string | null;
+}
+
 interface EmailsGetDkimKeysOptions {
   /**
    * Selector to filter keys by. Must be a maximum of 63 characters.
@@ -426,7 +468,7 @@ interface EmailsUpdateDkimKeyOptions {
    */
   selector: string;
   /**
-   * New status of the DKIM key pair
+   * 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.
    */
@@ -523,7 +565,7 @@ interface WebhooksSigningKeyResponse {
 
 interface WebhooksValidateResponse {
   /**
-   * Indicates whether all webhook validations passed
+   * Indicates whether all webhook validations passed.
    */
   allPassed: boolean;
   /**
@@ -531,11 +573,11 @@ interface WebhooksValidateResponse {
    */
   results: {
     /**
-     * Indicates whether the webhook responded with a 2xx HTTP status code
+     * Indicates whether the webhook responded with a 2xx HTTP status code.
      */
     result: "passed" | "failed";
     /**
-     * The webhook that was validated
+     * The webhook that was validated.
      */
     webhook: string;
     /**
@@ -547,7 +589,7 @@ interface WebhooksValidateResponse {
        */
       body?: string;
       /**
-       * HTTP status code returned by the webhook
+       * HTTP status code returned by the webhook.
        */
       status: number;
     } | null;
@@ -1144,11 +1186,11 @@ interface SuppressionsListOptions {
    */
   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`
+   * 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`
+   * The date and/or time after which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`.
    */
   createdAfter?: string;
   /**
@@ -1298,7 +1340,7 @@ interface DomainsData {
     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
+   * 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;
   /**
@@ -1321,6 +1363,9 @@ interface DomainsProvisionOptions {
 type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
 
 interface DomainsProvisionResponse {
+  /**
+   * The provisioned domain data.
+   */
   data: DomainsData | null;
   error: string | null;
 }
@@ -1334,6 +1379,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were successfully provisioned or updated.
      */
     successes: {
+      /**
+       * The provisioned domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1342,6 +1390,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were not successfully provisioned.
      */
     errors: {
+      /**
+       * The failed to provision domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1356,7 +1407,7 @@ interface DomainsListOptions {
    */
   domains?: string[];
   /**
-   * The maximum number of domains included in the response. Possible values are 1 to 5000
+   * The maximum number of domains included in the response. Possible values are 1 to 5000.
    * @default 10
    */
   limit?: number;
@@ -1369,7 +1420,7 @@ interface DomainsListOptions {
 
 interface DomainsListResponse {
   /**
-   * A list of domains
+   * A list of domains.
    */
   domains: DomainsData[];
   /**
@@ -1455,7 +1506,7 @@ declare class Domains {
     constructor(mailchannels: MailChannelsClient);
     /**
      * Provision a single domain to use MailChannels Inbound.
-     * @param options - The domain data to provision.
+     * @param options - The provision options and domain data.
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
@@ -1469,7 +1520,7 @@ declare class Domains {
     /**
      * Provision up to 1000 domains to use MailChannels Inbound.
      * @param options - The options to provision the domains.
-     * @param domains - The list of domains to provision.
+     * @param domains - A list of domain data to provision.
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
@@ -1651,7 +1702,7 @@ declare class Lists {
 
 interface UsersCreateOptions {
   /**
-   * Flag to indicate if the user is a domain admin or a regular user
+   * Flag to indicate if the user is a domain admin or a regular user.
    * @default false
    */
   admin?: boolean;
@@ -1664,7 +1715,7 @@ interface UsersCreateOptions {
    */
   filter?: boolean | "compute";
   /**
-   * safelist and blocklist entries to be added
+   * safelist and blocklist entries to be added.
    */
   listEntries?: {
     blocklist?: string[];
@@ -1770,7 +1821,7 @@ interface ServiceReportOptions {
    */
   messageContent: string;
   /**
-   * The SMTP envelope information
+   * The SMTP envelope information.
    */
   smtpEnvelopeInformation?: {
     ehlo: string;

package/dist/shared/{mailchannels-sdk.CiU7QtsS.d.ts → mailchannels-sdk.DgBM4Ujq.d.ts}

@@ -129,6 +129,15 @@ interface EmailsSendOptionsBase {
    * '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
@@ -187,13 +196,13 @@ interface EmailsSendOptionsBase {
 type EmailsSendOptions = EmailsSendOptionsBase & (
   | {
     /**
-     * The HTML content of the email
+     * 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)
+     * The plain text content of the email (optional when html is provided).
      * @example
      * 'Hello World'
      */
@@ -201,13 +210,13 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
   }
   | {
     /**
-     * The HTML content of the email (optional when text is provided)
+     * 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
+     * The plain text content of the email.
      * @example
      * 'Hello World'
      */
@@ -217,7 +226,7 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
 
 interface EmailsSendResponse {
   /**
-   * Indicates if the email was successfully sent
+   * Indicates if the email was successfully sent.
    */
   success: boolean;
   data: {
@@ -251,74 +260,6 @@ interface EmailsSendResponse {
   error: string | null;
 }
 
-interface EmailsCheckDomainDkim {
-  /**
-   * Domain used for DKIM signing.
-   */
-  domain: string;
-  /**
-   * DKIM private key encoded in Base64.
-   */
-  privateKey: string;
-  /**
-   * DKIM selector in the domain DNS records.
-   */
-  selector: string;
-}
-
-interface EmailsCheckDomainOptions {
-  /**
-   * Up to 10 DKIM checks are allowed.
-   */
-  dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
-  /**
-   * Domain used for sending emails.
-   */
-  domain: string;
-  /**
-   * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
-   */
-  senderId: string;
-}
-
-type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
-
-interface EmailsCheckDomainResponse {
-  /**
-   * The results of the domain checks.
-   */
-  results: {
-    dkim: {
-      domain: string;
-      selector: string;
-      /**
-       * A human-readable explanation of DKIM check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    }[];
-    domainLockdown: {
-      /**
-       * A human-readable explanation of Domain Lockdown check.
-       */
-      reason?: string;
-      verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
-    };
-    spf: {
-      /**
-       * A human-readable explanation of SPF check.
-       */
-      reason?: string;
-      verdict: EmailsCheckDomainVerdict;
-    };
-    references?: string[];
-  } | null;
-  /**
-   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
-   */
-  error: string | null;
-}
-
 interface EmailsCreateDkimKeyOptions {
   /**
    * Algorithm used for the new key pair Currently, only RSA is supported.
@@ -384,6 +325,107 @@ interface EmailsCreateDkimKeyResponse {
   error: string | null;
 }
 
+interface EmailsCheckDomainDkim {
+  /**
+   * Domain used for DKIM signing.
+   */
+  domain?: string;
+  /**
+   * DKIM private key encoded in Base64.
+   */
+  privateKey?: string;
+  /**
+   * DKIM selector in the domain DNS records.
+   */
+  selector?: string;
+}
+
+interface EmailsCheckDomainOptions {
+  /**
+   * 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:
+   * - If `domain`, `selector`, and `privateKey` are all present, verify using the provided domain, selector, and key.
+   * - If `domain` and `selector` are present, use the stored private key for the given domain and selector.
+   * - If only `domain` is present, use all stored keys for the given domain.
+   * - If none are present, use all stored keys for the `domain` provided in the domain field of the request.
+   * - If `privateKey` is present, `selector` must be present.
+   * - 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";
+
+interface EmailsCheckDomainResponse {
+  /**
+   * The results of the domain checks.
+   */
+  results: {
+    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[];
+  } | null;
+  /**
+   * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
+   */
+  error: string | null;
+}
+
 interface EmailsGetDkimKeysOptions {
   /**
    * Selector to filter keys by. Must be a maximum of 63 characters.
@@ -426,7 +468,7 @@ interface EmailsUpdateDkimKeyOptions {
    */
   selector: string;
   /**
-   * New status of the DKIM key pair
+   * 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.
    */
@@ -523,7 +565,7 @@ interface WebhooksSigningKeyResponse {
 
 interface WebhooksValidateResponse {
   /**
-   * Indicates whether all webhook validations passed
+   * Indicates whether all webhook validations passed.
    */
   allPassed: boolean;
   /**
@@ -531,11 +573,11 @@ interface WebhooksValidateResponse {
    */
   results: {
     /**
-     * Indicates whether the webhook responded with a 2xx HTTP status code
+     * Indicates whether the webhook responded with a 2xx HTTP status code.
      */
     result: "passed" | "failed";
     /**
-     * The webhook that was validated
+     * The webhook that was validated.
      */
     webhook: string;
     /**
@@ -547,7 +589,7 @@ interface WebhooksValidateResponse {
        */
       body?: string;
       /**
-       * HTTP status code returned by the webhook
+       * HTTP status code returned by the webhook.
        */
       status: number;
     } | null;
@@ -1144,11 +1186,11 @@ interface SuppressionsListOptions {
    */
   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`
+   * 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`
+   * The date and/or time after which the suppression entries were created. Format: `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ`.
    */
   createdAfter?: string;
   /**
@@ -1298,7 +1340,7 @@ interface DomainsData {
     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
+   * 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;
   /**
@@ -1321,6 +1363,9 @@ interface DomainsProvisionOptions {
 type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
 
 interface DomainsProvisionResponse {
+  /**
+   * The provisioned domain data.
+   */
   data: DomainsData | null;
   error: string | null;
 }
@@ -1334,6 +1379,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were successfully provisioned or updated.
      */
     successes: {
+      /**
+       * The provisioned domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1342,6 +1390,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were not successfully provisioned.
      */
     errors: {
+      /**
+       * The failed to provision domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1356,7 +1407,7 @@ interface DomainsListOptions {
    */
   domains?: string[];
   /**
-   * The maximum number of domains included in the response. Possible values are 1 to 5000
+   * The maximum number of domains included in the response. Possible values are 1 to 5000.
    * @default 10
    */
   limit?: number;
@@ -1369,7 +1420,7 @@ interface DomainsListOptions {
 
 interface DomainsListResponse {
   /**
-   * A list of domains
+   * A list of domains.
    */
   domains: DomainsData[];
   /**
@@ -1455,7 +1506,7 @@ declare class Domains {
     constructor(mailchannels: MailChannelsClient);
     /**
      * Provision a single domain to use MailChannels Inbound.
-     * @param options - The domain data to provision.
+     * @param options - The provision options and domain data.
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
@@ -1469,7 +1520,7 @@ declare class Domains {
     /**
      * Provision up to 1000 domains to use MailChannels Inbound.
      * @param options - The options to provision the domains.
-     * @param domains - The list of domains to provision.
+     * @param domains - A list of domain data to provision.
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
@@ -1651,7 +1702,7 @@ declare class Lists {
 
 interface UsersCreateOptions {
   /**
-   * Flag to indicate if the user is a domain admin or a regular user
+   * Flag to indicate if the user is a domain admin or a regular user.
    * @default false
    */
   admin?: boolean;
@@ -1664,7 +1715,7 @@ interface UsersCreateOptions {
    */
   filter?: boolean | "compute";
   /**
-   * safelist and blocklist entries to be added
+   * safelist and blocklist entries to be added.
    */
   listEntries?: {
     blocklist?: string[];
@@ -1770,7 +1821,7 @@ interface ServiceReportOptions {
    */
   messageContent: string;
   /**
-   * The SMTP envelope information
+   * The SMTP envelope information.
    */
   smtpEnvelopeInformation?: {
     ehlo: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -43,24 +43,24 @@
   "devDependencies": {
     "@eslint/compat": "^1.4.0",
     "@stylistic/eslint-plugin": "^5.4.0",
-    "@types/node": "^24.5.2",
-    "@typescript-eslint/eslint-plugin": "^8.44.1",
-    "@typescript-eslint/parser": "^8.44.1",
+    "@types/node": "^24.8.1",
+    "@typescript-eslint/eslint-plugin": "^8.46.1",
+    "@typescript-eslint/parser": "^8.46.1",
     "@vitest/coverage-v8": "^3.2.4",
     "changelogen": "^0.6.2",
-    "eslint": "^9.36.0",
+    "eslint": "^9.37.0",
     "eslint-plugin-import-x": "^4.16.1",
-    "jiti": "^2.6.0",
+    "jiti": "^2.6.1",
     "scule": "^1.3.0",
-    "typescript": "^5.9.2",
+    "typescript": "^5.9.3",
     "unbuild": "^3.6.1",
     "vitepress": "^1.6.4",
-    "vitepress-plugin-group-icons": "^1.6.3",
+    "vitepress-plugin-group-icons": "^1.6.4",
     "vitest": "^3.2.4"
   },
   "scripts": {
     "build": "unbuild",
-    "release": "npm run lint && npm run test && pnpm build && changelogen --release && git push --follow-tags",
+    "release": "pnpm lint && pnpm test && pnpm build && changelogen --release && git push --follow-tags",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "test": "vitest run --reporter=verbose --coverage",