mailchannels-sdk 0.6.0 → 0.7.0

package/README.md

@@ -43,8 +43,8 @@ This library provides a simple way to interact with the [MailChannels API](https
 
 ## <a name="requirements">📏 Requirements</a>
 
-- MailChannels account
-- Email API key
+- [Create a MailChannels account](https://www.mailchannels.com/pricing/#for_devs)
+- [Create an API key](https://console.mailchannels.net/settings/accountSettings#APIKeys)
 
 ## <a name="quick-setup">🏃 Quick setup</a>
 

package/dist/mailchannels.d.mts

@@ -12,18 +12,41 @@ declare class MailChannelsClient {
     patch<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
 }
 
+interface ErrorResponse {
+  message: string;
+  statusCode: number | null;
+}
+
 interface SuccessResponse {
   /**
    * Whether the operation was successful.
    */
   success: boolean;
-  error: string | null;
+  /**
+   * Error information if the operation failed.
+   */
+  error: ErrorResponse | null;
 }
 
-interface DataResponse<T> {
-  data: T | null;
-  error: string | null;
-}
+type DataResponse<T> = {
+  /**
+   * The response data.
+   */
+  data: T;
+  /**
+   * Error information if the operation failed.
+   */
+  error: null;
+} | {
+  /**
+   * The response data.
+   */
+  data: null;
+  /**
+   * Error information if the operation failed.
+   */
+  error: ErrorResponse;
+};
 
 interface EmailsSendRecipient {
   /**
@@ -229,41 +252,34 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
   }
 );
 
-interface EmailsSendResponse {
+type EmailsSendResponse = SuccessResponse & DataResponse<{
   /**
-   * Indicates if the email was successfully sent.
-   */
-  success: boolean;
-  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[];
-    /**
+  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?: {
-      /**
+  requestId?: string;
+  results?: {
+    /**
        * The index of the personalization in the request. Starts at 0.
        */
-      index?: number;
-      /**
+    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;
-      /**
+    messageId: string;
+    /**
        * A human-readable explanation of the status.
        */
-      reason?: string;
-      /**
+    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;
-}
+    status: "sent" | "failed";
+  }[];
+}>;
 
 interface EmailsCreateDkimKeyOptions {
   /**
@@ -1924,4 +1940,4 @@ declare class MailChannels extends MailChannelsClient {
 }
 
 export { Domains, Emails, Lists, MailChannels, MailChannelsClient, Metrics, Service, SubAccounts, Suppressions, Users, Webhooks };
-export type { DataResponse, DomainsBulkCreateLoginLinkResult, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, EmailsCheckDomainDkim, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendOptionsBase, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Optional, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, UsersCreateOptions, UsersCreateResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };
+export type { DataResponse, DomainsBulkCreateLoginLinkResult, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, EmailsCheckDomainDkim, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendOptionsBase, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Optional, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, UsersCreateOptions, UsersCreateResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };

package/dist/mailchannels.d.ts

@@ -12,18 +12,41 @@ declare class MailChannelsClient {
     patch<T>(path: string, options?: Omit<FetchOptions<"json">, "method">): Promise<T>;
 }
 
+interface ErrorResponse {
+  message: string;
+  statusCode: number | null;
+}
+
 interface SuccessResponse {
   /**
    * Whether the operation was successful.
    */
   success: boolean;
-  error: string | null;
+  /**
+   * Error information if the operation failed.
+   */
+  error: ErrorResponse | null;
 }
 
-interface DataResponse<T> {
-  data: T | null;
-  error: string | null;
-}
+type DataResponse<T> = {
+  /**
+   * The response data.
+   */
+  data: T;
+  /**
+   * Error information if the operation failed.
+   */
+  error: null;
+} | {
+  /**
+   * The response data.
+   */
+  data: null;
+  /**
+   * Error information if the operation failed.
+   */
+  error: ErrorResponse;
+};
 
 interface EmailsSendRecipient {
   /**
@@ -229,41 +252,34 @@ type EmailsSendOptions = EmailsSendOptionsBase & (
   }
 );
 
-interface EmailsSendResponse {
+type EmailsSendResponse = SuccessResponse & DataResponse<{
   /**
-   * Indicates if the email was successfully sent.
-   */
-  success: boolean;
-  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[];
-    /**
+  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?: {
-      /**
+  requestId?: string;
+  results?: {
+    /**
        * The index of the personalization in the request. Starts at 0.
        */
-      index?: number;
-      /**
+    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;
-      /**
+    messageId: string;
+    /**
        * A human-readable explanation of the status.
        */
-      reason?: string;
-      /**
+    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;
-}
+    status: "sent" | "failed";
+  }[];
+}>;
 
 interface EmailsCreateDkimKeyOptions {
   /**
@@ -1924,4 +1940,4 @@ declare class MailChannels extends MailChannelsClient {
 }
 
 export { Domains, Emails, Lists, MailChannels, MailChannelsClient, Metrics, Service, SubAccounts, Suppressions, Users, Webhooks };
-export type { DataResponse, DomainsBulkCreateLoginLinkResult, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, EmailsCheckDomainDkim, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendOptionsBase, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Optional, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, UsersCreateOptions, UsersCreateResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };
+export type { DataResponse, DomainsBulkCreateLoginLinkResult, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, EmailsCheckDomainDkim, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAttachment, EmailsSendOptions, EmailsSendOptionsBase, EmailsSendRecipient, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Optional, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, UsersCreateOptions, UsersCreateResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse };