mailchannels-sdk 0.7.7 → 0.7.9

package/README.md

@@ -1,4 +1,4 @@
-![MailChannels Node.js SDK](/docs/public/images/presentation.png)
+![MailChannels Node.js SDK](./docs/public/images/presentation.png)
 
 # MailChannels Node.js SDK
 

package/dist/mailchannels.d.mts

@@ -510,6 +510,14 @@ type EmailsCheckDomainResponse = DataResponse<{
      * A human-readable explanation of SPF check.
      */
     reason?: string;
+    /**
+     * The SPF record that was used for the check.
+     */
+    spfRecord?: string;
+    /**
+     * Error message if the SPF record lookup failed.
+     */
+    spfRecordError?: string;
     verdict: EmailsCheckDomainVerdict;
   };
   references?: string[];
@@ -809,6 +817,37 @@ interface WebhooksBatch {
   webhook: string;
 }
 type WebhooksBatchesResponse = DataResponse<WebhooksBatch[]>;
+interface WebhooksResendBatch {
+  /**
+   * Unique identifier for the webhook batch.
+   */
+  batchId: number;
+  /**
+   * Customer handle associated with the webhook batch.
+   */
+  customerHandle: string;
+  /**
+   * Webhook URL to which events in the batch were posted.
+   */
+  webhook: string;
+  /**
+   * Timestamp of when the webhook batch was created.
+   */
+  createdAt: string;
+  /**
+   * Number of events in the webhook batch.
+   */
+  eventCount: number;
+  /**
+   * Duration of the webhook batch in milliseconds. `null` indicates that no response was returned from the webhook endpoint.
+   */
+  duration: number | null;
+  /**
+   * HTTP status code returned by the webhook endpoint. `null` indicates that no response was returned from the webhook endpoint.
+   */
+  statusCode: number | null;
+}
+type WebhooksResendBatchResponse = DataResponse<WebhooksResendBatch>;
 declare class Webhooks {
   protected mailchannels: MailChannelsClient;
   constructor(mailchannels: MailChannelsClient);
@@ -889,6 +928,16 @@ declare class Webhooks {
    * ```
    */
   batches(options?: WebhooksBatchesOptions): Promise<WebhooksBatchesResponse>;
+  /**
+   * Synchronously resends the webhook batch with the provided `batchId` for the customer. The result is returned in the response.
+   * @param batchId - The ID of the batch to resend.
+   * @example
+   * ```ts
+   * const mailchannels = new MailChannels('your-api-key')
+   * const { data, error } = await mailchannels.webhooks.resendBatch(123)
+   * ```
+   */
+  resendBatch(batchId: number): Promise<WebhooksResendBatchResponse>;
 }
 interface SubAccountsAccount {
   /**
@@ -2148,4 +2197,4 @@ declare class MailChannels extends MailChannelsClient {
   readonly service: Service;
   constructor(key: string, options?: MailChannelsClientOptions);
 }
-export { DataResponse, Domains, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, Emails, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendDkim, EmailsSendOptions, EmailsSendPersonalization, EmailsSendRecipient, EmailsSendRecipientInput, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, Lists, MailChannels, MailChannelsClient, type MailChannelsClientOptions, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Service, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, Users, UsersCreateOptions, UsersCreateResponse, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions };
+export { DataResponse, Domains, DomainsBulkCreateLoginLinks, DomainsBulkCreateLoginLinksResponse, DomainsBulkProvisionOptions, DomainsBulkProvisionResponse, DomainsCreateLoginLink, DomainsCreateLoginLinkResponse, DomainsData, DomainsDownstreamAddress, DomainsListDownstreamAddressesOptions, DomainsListDownstreamAddressesResponse, DomainsListOptions, DomainsListResponse, DomainsProvisionOptions, DomainsProvisionResponse, Emails, EmailsCheckDomainOptions, EmailsCheckDomainResponse, EmailsCheckDomainVerdict, EmailsCreateDkimKeyOptions, EmailsCreateDkimKeyResponse, EmailsDkimKey, EmailsDkimKeyStatus, EmailsGetDkimKeysOptions, EmailsGetDkimKeysResponse, EmailsRotateDkimKeyOptions, EmailsRotateDkimKeyResponse, EmailsSendAsyncResponse, EmailsSendAttachment, EmailsSendDkim, EmailsSendOptions, EmailsSendPersonalization, EmailsSendRecipient, EmailsSendRecipientInput, EmailsSendResponse, EmailsSendTracking, EmailsUpdateDkimKeyOptions, ErrorResponse, ListEntriesResponse, ListEntry, ListEntryOptions, ListEntryResponse, ListNames, Lists, MailChannels, MailChannelsClient, type MailChannelsClientOptions, Metrics, MetricsBucket, MetricsEngagement, MetricsEngagementResponse, MetricsOptions, MetricsPerformance, MetricsPerformanceResponse, MetricsRecipientBehaviour, MetricsRecipientBehaviourResponse, MetricsSenders, MetricsSendersOptions, MetricsSendersResponse, MetricsSendersType, MetricsUsageResponse, MetricsVolume, MetricsVolumeResponse, Service, ServiceReportOptions, ServiceSubscriptionsResponse, SubAccounts, SubAccountsAccount, SubAccountsApiKey, SubAccountsCreateApiKeyResponse, SubAccountsCreateResponse, SubAccountsCreateSmtpPasswordResponse, SubAccountsLimit, SubAccountsLimitResponse, SubAccountsListApiKeyOptions, SubAccountsListApiKeyResponse, SubAccountsListOptions, SubAccountsListResponse, SubAccountsListSmtpPasswordResponse, SubAccountsSmtpPassword, SubAccountsUsage, SubAccountsUsageResponse, SuccessResponse, Suppressions, SuppressionsCreateOptions, SuppressionsListEntry, SuppressionsListOptions, SuppressionsListResponse, SuppressionsSource, SuppressionsTypes, Users, UsersCreateOptions, UsersCreateResponse, WebhookEvent, WebhookEventClick, WebhookEventComplained, WebhookEventDelivered, WebhookEventDropped, WebhookEventHardBounced, WebhookEventOpen, WebhookEventProcessed, WebhookEventSoftBounced, WebhookEventTest, WebhookEventType, WebhookEventUnsubscribed, WebhookEvents, Webhooks, WebhooksBatch, WebhooksBatchResponseStatus, WebhooksBatchStatus, WebhooksBatchesOptions, WebhooksBatchesResponse, WebhooksListResponse, WebhooksResendBatch, WebhooksResendBatchResponse, WebhooksSigningKeyResponse, WebhooksValidateResponse, WebhooksVerifyOptions };

package/dist/mailchannels.mjs

@@ -842,6 +842,34 @@ var Webhooks = class Webhooks {
 			error: null
 		};
 	}
+	async resendBatch(batchId) {
+		let error = null;
+		const response = await this.mailchannels.post(`/tx/v1/webhook-batch/${batchId}/resend`, { onResponseError: async ({ response }) => {
+			error = getStatusError(response, {
+				[ErrorCode.BadRequest]: "Bad Request. The batch ID is invalid.",
+				[ErrorCode.NotFound]: `The batch '${batchId}' is not found for the customer.`
+			});
+		} }).catch((e) => {
+			error ||= getResultError(e, "Failed to resend webhook batch.");
+			return null;
+		});
+		if (!response) return {
+			data: null,
+			error
+		};
+		return {
+			data: clean({
+				batchId: response.batch_id,
+				customerHandle: response.customer_handle,
+				webhook: response.webhook,
+				createdAt: response.created_at,
+				eventCount: response.event_count,
+				duration: response.duration_in_ms,
+				statusCode: response.status_code
+			}),
+			error: null
+		};
+	}
 };
 var SubAccounts = class SubAccounts {
 	static COMPANY_PATTERN = /^.{3,128}$/;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailchannels-sdk",
-  "version": "0.7.7",
+  "version": "0.7.9",
   "description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
   "type": "module",
   "license": "MIT",
@@ -39,18 +39,18 @@
   "devDependencies": {
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/markdown-it": "^14.1.2",
-    "@types/node": "^25.5.2",
-    "@vitest/coverage-v8": "^4.1.3",
+    "@types/node": "^25.6.0",
+    "@vitest/coverage-v8": "^4.1.4",
     "changelogen": "^0.6.2",
     "jiti": "^2.6.1",
     "obuild": "^0.4.33",
-    "oxlint": "^1.59.0",
+    "oxlint": "^1.60.0",
     "scule": "^1.3.0",
     "typescript": "^6.0.2",
     "vitepress": "^2.0.0-alpha.17",
     "vitepress-plugin-group-icons": "^1.7.3",
     "vitepress-plugin-llms": "^1.12.0",
-    "vitest": "^4.1.3"
+    "vitest": "^4.1.4"
   },
   "scripts": {
     "build": "obuild",