mailchannels-sdk 0.4.2 → 0.4.4

package/README.md

@@ -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.ug4M5nbx.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.ug4M5nbx.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.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 '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.ug4M5nbx.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.ug4M5nbx.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.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 '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.ug4M5nbx.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.CiU7QtsS.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.ug4M5nbx.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.CiU7QtsS.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;
   }
   /**

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

@@ -113,7 +113,7 @@ interface EmailsSendOptionsBase {
     /**
      * DKIM private key encoded in Base64.
      */
-    privateKey: string;
+    privateKey?: string;
     /**
      * DKIM selector in the domain DNS records.
      */
@@ -220,10 +220,34 @@ interface EmailsSendResponse {
    * 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;
 }
 
@@ -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',

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

@@ -113,7 +113,7 @@ interface EmailsSendOptionsBase {
     /**
      * DKIM private key encoded in Base64.
      */
-    privateKey: string;
+    privateKey?: string;
     /**
      * DKIM selector in the domain DNS records.
      */
@@ -220,10 +220,34 @@ interface EmailsSendResponse {
    * 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;
 }
 
@@ -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',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -41,16 +41,16 @@
     "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.5.2",
+    "@typescript-eslint/eslint-plugin": "^8.44.1",
+    "@typescript-eslint/parser": "^8.44.1",
     "@vitest/coverage-v8": "^3.2.4",
     "changelogen": "^0.6.2",
-    "eslint": "^9.35.0",
+    "eslint": "^9.36.0",
     "eslint-plugin-import-x": "^4.16.1",
-    "jiti": "^2.5.1",
+    "jiti": "^2.6.0",
     "scule": "^1.3.0",
     "typescript": "^5.9.2",
     "unbuild": "^3.6.1",