mailchannels-sdk 0.4.3 → 0.4.5

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>
 
@@ -70,6 +70,9 @@ pnpm add mailchannels-sdk
 
 Already implemented features are marked with a checkmark. Please open an issue if you find any bugs or missing features.
 
+> [!IMPORTANT]
+> Links below point to the official MailChannels API documentation, options and responses may differ slightly when using this SDK. Please refer to the [documentation](https://mailchannels.yizack.com) for the correct usage of each feature.
+
 ### [Email API](https://docs.mailchannels.net/email-api/api-reference/email-api)
 
 - 📧 Emails

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.DQwR3U6M.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.DQwR3U6M.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.LKYcN74O.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.LKYcN74O.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.DQwR3U6M.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.DQwR3U6M.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.LKYcN74O.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.LKYcN74O.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.DQwR3U6M.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.LKYcN74O.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.DQwR3U6M.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.LKYcN74O.js';
 import 'ofetch';

package/dist/modules.mjs

@@ -62,7 +62,7 @@ class Emails {
    * @example
    * ```ts
    * const mailchannels = new MailChannels('your-api-key')
-   * const { success } = await mailchannels.emails.send({
+   * const { success, data } = await mailchannels.emails.send({
    *   to: 'to@example.com',
    *   from: 'from@example.com',
    *   subject: 'Test',
@@ -72,7 +72,7 @@ class Emails {
    */
   async send(options, dryRun = false) {
     const { cc, bcc, from, to, html, text, mustaches, dkim } = options;
-    const data = { success: false, error: null };
+    const data = { success: false, data: null, error: null };
     const parsedFrom = parseRecipient(from);
     if (!parsedFrom || !parsedFrom.email) {
       data.error = "No sender provided. Use the `from` option to specify a sender";
@@ -128,7 +128,17 @@ class Emails {
         });
       }
     }).catch(() => null);
-    data.data = response?.data;
+    if (!response) return data;
+    data.data = {
+      rendered: response.data,
+      requestId: response.request_id,
+      results: response.results?.map((result) => ({
+        index: result.index,
+        messageId: result.message_id,
+        reason: result.reason,
+        status: result.status
+      }))
+    };
     return data;
   }
   /**
@@ -1242,7 +1252,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')
@@ -1275,7 +1285,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.DQwR3U6M.d.mts → mailchannels-sdk.LKYcN74O.d.mts}

@@ -187,13 +187,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 +201,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,13 +217,37 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
 
 interface EmailsSendResponse {
   /**
-   * Indicates if the email was successfully sent
+   * Indicates if the email was successfully sent.
    */
   success: boolean;
-  /**
-   * Fully rendered message if `dryRun` was set to `true`
-   */
-  data?: string[];
+  data: {
+    /**
+     * Fully rendered message if `dryRun` was set to `true`. A string representation of a rendered message, one per personalization in the request.
+     */
+    rendered?: string[];
+    /**
+     * The Request ID is a unique identifier generated by the service to track the HTTP request. It will also be included in all webhooks for reference.
+     */
+    requestId?: string;
+    results?: {
+      /**
+       * The index of the personalization in the request. Starts at 0.
+       */
+      index?: number;
+      /**
+       * The Message ID is a unique identifier generated by the service. Each personalization has a distinct Message ID, which is also used in the `Message-Id` header and included in webhooks.
+       */
+      messageId: string;
+      /**
+       * A human-readable explanation of the status.
+       */
+      reason?: string;
+      /**
+       * The status of the message. Note that 'sent' is a temporary status; the final status will be provided through webhooks, if configured.
+       */
+      status: "sent" | "failed";
+    }[];
+  } | null;
   error: string | null;
 }
 
@@ -402,7 +426,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.
    */
@@ -419,7 +443,7 @@ declare class Emails {
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
-     * const { success } = await mailchannels.emails.send({
+     * const { success, data } = await mailchannels.emails.send({
      *   to: 'to@example.com',
      *   from: 'from@example.com',
      *   subject: 'Test',
@@ -499,7 +523,7 @@ interface WebhooksSigningKeyResponse {
 
 interface WebhooksValidateResponse {
   /**
-   * Indicates whether all webhook validations passed
+   * Indicates whether all webhook validations passed.
    */
   allPassed: boolean;
   /**
@@ -507,11 +531,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;
     /**
@@ -523,7 +547,7 @@ interface WebhooksValidateResponse {
        */
       body?: string;
       /**
-       * HTTP status code returned by the webhook
+       * HTTP status code returned by the webhook.
        */
       status: number;
     } | null;
@@ -1120,11 +1144,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;
   /**
@@ -1274,7 +1298,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;
   /**
@@ -1297,6 +1321,9 @@ interface DomainsProvisionOptions {
 type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
 
 interface DomainsProvisionResponse {
+  /**
+   * The provisioned domain data.
+   */
   data: DomainsData | null;
   error: string | null;
 }
@@ -1310,6 +1337,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were successfully provisioned or updated.
      */
     successes: {
+      /**
+       * The provisioned domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1318,6 +1348,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were not successfully provisioned.
      */
     errors: {
+      /**
+       * The failed to provision domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1332,7 +1365,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;
@@ -1345,7 +1378,7 @@ interface DomainsListOptions {
 
 interface DomainsListResponse {
   /**
-   * A list of domains
+   * A list of domains.
    */
   domains: DomainsData[];
   /**
@@ -1431,7 +1464,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')
@@ -1445,7 +1478,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')
@@ -1627,7 +1660,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;
@@ -1640,7 +1673,7 @@ interface UsersCreateOptions {
    */
   filter?: boolean | "compute";
   /**
-   * safelist and blocklist entries to be added
+   * safelist and blocklist entries to be added.
    */
   listEntries?: {
     blocklist?: string[];
@@ -1746,7 +1779,7 @@ interface ServiceReportOptions {
    */
   messageContent: string;
   /**
-   * The SMTP envelope information
+   * The SMTP envelope information.
    */
   smtpEnvelopeInformation?: {
     ehlo: string;

package/dist/shared/{mailchannels-sdk.DQwR3U6M.d.ts → mailchannels-sdk.LKYcN74O.d.ts}

@@ -187,13 +187,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 +201,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,13 +217,37 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
 
 interface EmailsSendResponse {
   /**
-   * Indicates if the email was successfully sent
+   * Indicates if the email was successfully sent.
    */
   success: boolean;
-  /**
-   * Fully rendered message if `dryRun` was set to `true`
-   */
-  data?: string[];
+  data: {
+    /**
+     * Fully rendered message if `dryRun` was set to `true`. A string representation of a rendered message, one per personalization in the request.
+     */
+    rendered?: string[];
+    /**
+     * The Request ID is a unique identifier generated by the service to track the HTTP request. It will also be included in all webhooks for reference.
+     */
+    requestId?: string;
+    results?: {
+      /**
+       * The index of the personalization in the request. Starts at 0.
+       */
+      index?: number;
+      /**
+       * The Message ID is a unique identifier generated by the service. Each personalization has a distinct Message ID, which is also used in the `Message-Id` header and included in webhooks.
+       */
+      messageId: string;
+      /**
+       * A human-readable explanation of the status.
+       */
+      reason?: string;
+      /**
+       * The status of the message. Note that 'sent' is a temporary status; the final status will be provided through webhooks, if configured.
+       */
+      status: "sent" | "failed";
+    }[];
+  } | null;
   error: string | null;
 }
 
@@ -402,7 +426,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.
    */
@@ -419,7 +443,7 @@ declare class Emails {
      * @example
      * ```ts
      * const mailchannels = new MailChannels('your-api-key')
-     * const { success } = await mailchannels.emails.send({
+     * const { success, data } = await mailchannels.emails.send({
      *   to: 'to@example.com',
      *   from: 'from@example.com',
      *   subject: 'Test',
@@ -499,7 +523,7 @@ interface WebhooksSigningKeyResponse {
 
 interface WebhooksValidateResponse {
   /**
-   * Indicates whether all webhook validations passed
+   * Indicates whether all webhook validations passed.
    */
   allPassed: boolean;
   /**
@@ -507,11 +531,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;
     /**
@@ -523,7 +547,7 @@ interface WebhooksValidateResponse {
        */
       body?: string;
       /**
-       * HTTP status code returned by the webhook
+       * HTTP status code returned by the webhook.
        */
       status: number;
     } | null;
@@ -1120,11 +1144,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;
   /**
@@ -1274,7 +1298,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;
   /**
@@ -1297,6 +1321,9 @@ interface DomainsProvisionOptions {
 type DomainsBulkProvisionOptions = DomainsProvisionOptions & Pick<DomainsData, "subscriptionHandle">;
 
 interface DomainsProvisionResponse {
+  /**
+   * The provisioned domain data.
+   */
   data: DomainsData | null;
   error: string | null;
 }
@@ -1310,6 +1337,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were successfully provisioned or updated.
      */
     successes: {
+      /**
+       * The provisioned domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1318,6 +1348,9 @@ interface DomainsBulkProvisionResponse {
      * Domains that were not successfully provisioned.
      */
     errors: {
+      /**
+       * The failed to provision domain data.
+       */
       domain: DomainsData;
       code: number;
       comment?: string;
@@ -1332,7 +1365,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;
@@ -1345,7 +1378,7 @@ interface DomainsListOptions {
 
 interface DomainsListResponse {
   /**
-   * A list of domains
+   * A list of domains.
    */
   domains: DomainsData[];
   /**
@@ -1431,7 +1464,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')
@@ -1445,7 +1478,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')
@@ -1627,7 +1660,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;
@@ -1640,7 +1673,7 @@ interface UsersCreateOptions {
    */
   filter?: boolean | "compute";
   /**
-   * safelist and blocklist entries to be added
+   * safelist and blocklist entries to be added.
    */
   listEntries?: {
     blocklist?: string[];
@@ -1746,7 +1779,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.3",
+  "version": "0.4.5",
   "description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -41,18 +41,18 @@
     "ofetch": "^1.4.1"
   },
   "devDependencies": {
-    "@eslint/compat": "^1.3.2",
-    "@stylistic/eslint-plugin": "^5.3.1",
-    "@types/node": "^24.5.1",
-    "@typescript-eslint/eslint-plugin": "^8.44.0",
-    "@typescript-eslint/parser": "^8.44.0",
+    "@eslint/compat": "^1.4.0",
+    "@stylistic/eslint-plugin": "^5.4.0",
+    "@types/node": "^24.7.2",
+    "@typescript-eslint/eslint-plugin": "^8.46.0",
+    "@typescript-eslint/parser": "^8.46.0",
     "@vitest/coverage-v8": "^3.2.4",
     "changelogen": "^0.6.2",
-    "eslint": "^9.35.0",
+    "eslint": "^9.37.0",
     "eslint-plugin-import-x": "^4.16.1",
-    "jiti": "^2.5.1",
+    "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",
@@ -60,7 +60,7 @@
   },
   "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",