mailchannels-sdk 0.4.5 → 0.4.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
- 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';
2
- 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';
1
+ 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.B048hZT4.mjs';
2
+ export { aj as DomainsBulkCreateLoginLinkResult, ak as DomainsBulkCreateLoginLinks, al as DomainsBulkCreateLoginLinksResponse, aa as DomainsBulkProvisionOptions, ac as DomainsBulkProvisionResponse, af as DomainsCreateLoginLinkResponse, a8 as DomainsData, ah as DomainsDownstreamAddress, ag as DomainsListDownstreamAddressesOptions, ai as DomainsListDownstreamAddressesResponse, ad as DomainsListOptions, ae as DomainsListResponse, a9 as DomainsProvisionOptions, ab 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, aq as ListEntriesResponse, ao as ListEntry, an as ListEntryOptions, ap as ListEntryResponse, am as ListNames, Q as MetricsBucket, T as MetricsEngagement, V as MetricsEngagementResponse, R as MetricsOptions, X as MetricsPerformance, Y as MetricsPerformanceResponse, Z as MetricsRecipientBehaviour, _ as MetricsRecipientBehaviourResponse, a1 as MetricsUsageResponse, $ as MetricsVolume, a0 as MetricsVolumeResponse, O as Optional, au as ServiceReportOptions, at as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, H as SubAccountsCreateSmtpPasswordResponse, J as SubAccountsLimit, K as SubAccountsLimitResponse, C as SubAccountsListApiKeyOptions, F as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, I as SubAccountsListSmtpPasswordResponse, G as SubAccountsSmtpPassword, N as SubAccountsUsage, P as SubAccountsUsageResponse, av as SuccessResponse, a3 as SuppressionsCreateOptions, a6 as SuppressionsListEntry, a5 as SuppressionsListOptions, a7 as SuppressionsListResponse, a4 as SuppressionsSource, a2 as SuppressionsTypes, ar as UsersCreateOptions, as as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.B048hZT4.mjs';
3
3
  import 'ofetch';
4
4
 
5
5
  declare class MailChannels extends MailChannelsClient {
@@ -1,5 +1,5 @@
1
- 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';
2
- 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';
1
+ 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.B048hZT4.js';
2
+ export { aj as DomainsBulkCreateLoginLinkResult, ak as DomainsBulkCreateLoginLinks, al as DomainsBulkCreateLoginLinksResponse, aa as DomainsBulkProvisionOptions, ac as DomainsBulkProvisionResponse, af as DomainsCreateLoginLinkResponse, a8 as DomainsData, ah as DomainsDownstreamAddress, ag as DomainsListDownstreamAddressesOptions, ai as DomainsListDownstreamAddressesResponse, ad as DomainsListOptions, ae as DomainsListResponse, a9 as DomainsProvisionOptions, ab 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, aq as ListEntriesResponse, ao as ListEntry, an as ListEntryOptions, ap as ListEntryResponse, am as ListNames, Q as MetricsBucket, T as MetricsEngagement, V as MetricsEngagementResponse, R as MetricsOptions, X as MetricsPerformance, Y as MetricsPerformanceResponse, Z as MetricsRecipientBehaviour, _ as MetricsRecipientBehaviourResponse, a1 as MetricsUsageResponse, $ as MetricsVolume, a0 as MetricsVolumeResponse, O as Optional, au as ServiceReportOptions, at as ServiceSubscriptionsResponse, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, H as SubAccountsCreateSmtpPasswordResponse, J as SubAccountsLimit, K as SubAccountsLimitResponse, C as SubAccountsListApiKeyOptions, F as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, I as SubAccountsListSmtpPasswordResponse, G as SubAccountsSmtpPassword, N as SubAccountsUsage, P as SubAccountsUsageResponse, av as SuccessResponse, a3 as SuppressionsCreateOptions, a6 as SuppressionsListEntry, a5 as SuppressionsListOptions, a7 as SuppressionsListResponse, a4 as SuppressionsSource, a2 as SuppressionsTypes, ar as UsersCreateOptions, as as UsersCreateResponse, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.B048hZT4.js';
3
3
  import 'ofetch';
4
4
 
5
5
  declare class MailChannels extends MailChannelsClient {
@@ -1,2 +1,2 @@
1
- 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';
1
+ export { D as Domains, aj as DomainsBulkCreateLoginLinkResult, ak as DomainsBulkCreateLoginLinks, al as DomainsBulkCreateLoginLinksResponse, aa as DomainsBulkProvisionOptions, ac as DomainsBulkProvisionResponse, af as DomainsCreateLoginLinkResponse, a8 as DomainsData, ah as DomainsDownstreamAddress, ag as DomainsListDownstreamAddressesOptions, ai as DomainsListDownstreamAddressesResponse, ad as DomainsListOptions, ae as DomainsListResponse, a9 as DomainsProvisionOptions, ab 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, aq as ListEntriesResponse, ao as ListEntry, an as ListEntryOptions, ap as ListEntryResponse, am as ListNames, L as Lists, a as Metrics, Q as MetricsBucket, T as MetricsEngagement, V as MetricsEngagementResponse, R as MetricsOptions, X as MetricsPerformance, Y as MetricsPerformanceResponse, Z as MetricsRecipientBehaviour, _ as MetricsRecipientBehaviourResponse, a1 as MetricsUsageResponse, $ as MetricsVolume, a0 as MetricsVolumeResponse, O as Optional, c as Service, au as ServiceReportOptions, at as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, H as SubAccountsCreateSmtpPasswordResponse, J as SubAccountsLimit, K as SubAccountsLimitResponse, C as SubAccountsListApiKeyOptions, F as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, I as SubAccountsListSmtpPasswordResponse, G as SubAccountsSmtpPassword, N as SubAccountsUsage, P as SubAccountsUsageResponse, av as SuccessResponse, b as Suppressions, a3 as SuppressionsCreateOptions, a6 as SuppressionsListEntry, a5 as SuppressionsListOptions, a7 as SuppressionsListResponse, a4 as SuppressionsSource, a2 as SuppressionsTypes, U as Users, ar as UsersCreateOptions, as as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.B048hZT4.mjs';
2
2
  import 'ofetch';
package/dist/modules.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- 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';
1
+ export { D as Domains, aj as DomainsBulkCreateLoginLinkResult, ak as DomainsBulkCreateLoginLinks, al as DomainsBulkCreateLoginLinksResponse, aa as DomainsBulkProvisionOptions, ac as DomainsBulkProvisionResponse, af as DomainsCreateLoginLinkResponse, a8 as DomainsData, ah as DomainsDownstreamAddress, ag as DomainsListDownstreamAddressesOptions, ai as DomainsListDownstreamAddressesResponse, ad as DomainsListOptions, ae as DomainsListResponse, a9 as DomainsProvisionOptions, ab 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, aq as ListEntriesResponse, ao as ListEntry, an as ListEntryOptions, ap as ListEntryResponse, am as ListNames, L as Lists, a as Metrics, Q as MetricsBucket, T as MetricsEngagement, V as MetricsEngagementResponse, R as MetricsOptions, X as MetricsPerformance, Y as MetricsPerformanceResponse, Z as MetricsRecipientBehaviour, _ as MetricsRecipientBehaviourResponse, a1 as MetricsUsageResponse, $ as MetricsVolume, a0 as MetricsVolumeResponse, O as Optional, c as Service, au as ServiceReportOptions, at as ServiceSubscriptionsResponse, S as SubAccounts, w as SubAccountsAccount, A as SubAccountsApiKey, B as SubAccountsCreateApiKeyResponse, x as SubAccountsCreateResponse, H as SubAccountsCreateSmtpPasswordResponse, J as SubAccountsLimit, K as SubAccountsLimitResponse, C as SubAccountsListApiKeyOptions, F as SubAccountsListApiKeyResponse, y as SubAccountsListOptions, z as SubAccountsListResponse, I as SubAccountsListSmtpPasswordResponse, G as SubAccountsSmtpPassword, N as SubAccountsUsage, P as SubAccountsUsageResponse, av as SuccessResponse, b as Suppressions, a3 as SuppressionsCreateOptions, a6 as SuppressionsListEntry, a5 as SuppressionsListOptions, a7 as SuppressionsListResponse, a4 as SuppressionsSource, a2 as SuppressionsTypes, U as Users, ar as UsersCreateOptions, as as UsersCreateResponse, W as Webhooks, t as WebhooksListResponse, u as WebhooksSigningKeyResponse, v as WebhooksValidateResponse } from './shared/mailchannels-sdk.B048hZT4.js';
2
2
  import 'ofetch';
package/dist/modules.mjs CHANGED
@@ -103,6 +103,7 @@ class Emails {
103
103
  dkim_selector: dkim?.selector || void 0,
104
104
  dynamic_template_data: options.mustaches
105
105
  }],
106
+ headers: options.headers,
106
107
  reply_to: parseRecipient(options.replyTo),
107
108
  from: parsedFrom,
108
109
  subject: options.subject,
@@ -124,7 +125,7 @@ class Emails {
124
125
  data.error = getStatusError(response2, {
125
126
  [ErrorCode.BadRequest]: "Bad Request.",
126
127
  [ErrorCode.Forbidden]: "User does not have access to this feature.",
127
- [ErrorCode.PayloadTooLarge]: "The total message size should not exceed 20MB. This includes the message itself, headers, and the combined size of any attachments."
128
+ [ErrorCode.PayloadTooLarge]: "The total message size should not exceed 30MB. This includes the message itself, headers, and the combined size of any attachments."
128
129
  });
129
130
  }
130
131
  }).catch(() => null);
@@ -160,12 +161,12 @@ class Emails {
160
161
  */
161
162
  async checkDomain(options) {
162
163
  const { dkim, domain, senderId } = options;
163
- const dkimOptions = Array.isArray(dkim) ? dkim : [dkim];
164
+ const dkimOptions = dkim ? Array.isArray(dkim) ? dkim : [dkim] : void 0;
164
165
  const data = { results: null, error: null };
165
166
  const payload = {
166
- dkim_settings: dkimOptions.map(({ domain: domain2, privateKey, selector }) => ({
167
+ dkim_settings: dkimOptions?.map(({ domain: domain2, privateKey, selector }) => ({
167
168
  dkim_domain: domain2,
168
- dkim_private_key: stripPemHeaders(privateKey),
169
+ dkim_private_key: privateKey ? stripPemHeaders(privateKey) : void 0,
169
170
  dkim_selector: selector
170
171
  })),
171
172
  domain,
@@ -182,13 +183,15 @@ class Emails {
182
183
  }).catch(() => null);
183
184
  if (!response) return data;
184
185
  data.results = {
185
- dkim: response.check_results.dkim.map(({ dkim_domain, dkim_selector, reason, verdict }) => ({
186
- domain: dkim_domain,
187
- selector: dkim_selector,
188
- reason,
189
- verdict
186
+ dkim: response.check_results.dkim.map((dkimResults) => ({
187
+ domain: dkimResults.dkim_domain,
188
+ keyStatus: dkimResults.dkim_key_status,
189
+ selector: dkimResults.dkim_selector,
190
+ reason: dkimResults.reason,
191
+ verdict: dkimResults.verdict
190
192
  })),
191
193
  domainLockdown: response.check_results.domain_lockdown,
194
+ senderDomain: response.check_results.sender_domain,
192
195
  spf: response.check_results.spf,
193
196
  references: response.references
194
197
  };
@@ -674,18 +677,27 @@ class SubAccounts {
674
677
  /**
675
678
  * Retrieves details of all API keys associated with the specified sub-account. For security reasons, the full API key is not returned; only the key ID and a partially redacted version are provided.
676
679
  * @param handle - Handle of the sub-account to retrieve the API key for.
680
+ * @param options - The options to filter the list of API keys.
677
681
  * @example
678
682
  * ```ts
679
683
  * const mailchannels = new MailChannels('your-api-key')
680
684
  * const { keys } = await mailchannels.subAccounts.listApiKeys('validhandle123')
681
685
  * ```
682
686
  */
683
- async listApiKeys(handle) {
687
+ async listApiKeys(handle, options) {
684
688
  const data = { keys: [], error: null };
685
689
  if (!handle) {
686
690
  data.error = "No handle provided.";
687
691
  return data;
688
692
  }
693
+ if (typeof options?.limit === "number" && (options.limit < 1 || options.limit > 1e3)) {
694
+ data.error = "The limit value is invalid. Possible limit values are 1 to 1000.";
695
+ return data;
696
+ }
697
+ if (typeof options?.offset === "number" && options.offset < 0) {
698
+ data.error = "Offset must be greater than or equal to 0.";
699
+ return data;
700
+ }
689
701
  const response = await this.mailchannels.get(`/tx/v1/sub-account/${handle}/api-key`, {
690
702
  onResponseError: async ({ response: response2 }) => {
691
703
  data.error = getStatusError(response2, {
@@ -129,6 +129,15 @@ interface EmailsSendOptionsBase {
129
129
  * 'Name <email@example.com>'
130
130
  */
131
131
  from: EmailsSendRecipient | string;
132
+ /**
133
+ * An object containing key-value pairs, where both keys (header names) and values must be strings. These pairs represent custom headers to be substituted.
134
+ *
135
+ * Please note the following restrictions and behavior:
136
+ * - **Reserved headers**: The following headers cannot be modified: `Authentication-Results`, `BCC`, `CC`, `Content-Transfer-Encoding`, `Content-Type`, `DKIM-Signature`, `From`, `Message-ID`, `Received`, `Reply-To`, `Subject`, `To`.
137
+ * - **Header precedence**: If a header is defined in both the personalizations object and the root headers, the value from personalizations will be used.
138
+ * - **Case sensitivity**: Headers are treated as case-insensitive. If multiple headers differ only by case, only one will be used, with no guarantee of which one.
139
+ */
140
+ headers?: Record<string, string>;
132
141
  /**
133
142
  * The recipient of the email. Can be an array of email addresses or an array of objects with `email` and `name` properties or a single email address string or an object with `email` and `name` properties.
134
143
  * @example
@@ -251,74 +260,6 @@ interface EmailsSendResponse {
251
260
  error: string | null;
252
261
  }
253
262
 
254
- interface EmailsCheckDomainDkim {
255
- /**
256
- * Domain used for DKIM signing.
257
- */
258
- domain: string;
259
- /**
260
- * DKIM private key encoded in Base64.
261
- */
262
- privateKey: string;
263
- /**
264
- * DKIM selector in the domain DNS records.
265
- */
266
- selector: string;
267
- }
268
-
269
- interface EmailsCheckDomainOptions {
270
- /**
271
- * Up to 10 DKIM checks are allowed.
272
- */
273
- dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
274
- /**
275
- * Domain used for sending emails.
276
- */
277
- domain: string;
278
- /**
279
- * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
280
- */
281
- senderId: string;
282
- }
283
-
284
- type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
285
-
286
- interface EmailsCheckDomainResponse {
287
- /**
288
- * The results of the domain checks.
289
- */
290
- results: {
291
- dkim: {
292
- domain: string;
293
- selector: string;
294
- /**
295
- * A human-readable explanation of DKIM check.
296
- */
297
- reason?: string;
298
- verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
299
- }[];
300
- domainLockdown: {
301
- /**
302
- * A human-readable explanation of Domain Lockdown check.
303
- */
304
- reason?: string;
305
- verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
306
- };
307
- spf: {
308
- /**
309
- * A human-readable explanation of SPF check.
310
- */
311
- reason?: string;
312
- verdict: EmailsCheckDomainVerdict;
313
- };
314
- references?: string[];
315
- } | null;
316
- /**
317
- * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
318
- */
319
- error: string | null;
320
- }
321
-
322
263
  interface EmailsCreateDkimKeyOptions {
323
264
  /**
324
265
  * Algorithm used for the new key pair Currently, only RSA is supported.
@@ -384,6 +325,107 @@ interface EmailsCreateDkimKeyResponse {
384
325
  error: string | null;
385
326
  }
386
327
 
328
+ interface EmailsCheckDomainDkim {
329
+ /**
330
+ * Domain used for DKIM signing.
331
+ */
332
+ domain?: string;
333
+ /**
334
+ * DKIM private key encoded in Base64.
335
+ */
336
+ privateKey?: string;
337
+ /**
338
+ * DKIM selector in the domain DNS records.
339
+ */
340
+ selector?: string;
341
+ }
342
+
343
+ interface EmailsCheckDomainOptions {
344
+ /**
345
+ * Each item may include DKIM `domain`, `selector` and `privateKey`. Up to 10 items are allowed. The absence or presence of these fields affects how DKIM settings are validated:
346
+ * - If `domain`, `selector`, and `privateKey` are all present, verify using the provided domain, selector, and key.
347
+ * - If `domain` and `selector` are present, use the stored private key for the given domain and selector.
348
+ * - If only `domain` is present, use all stored keys for the given domain.
349
+ * - If none are present, use all stored keys for the `domain` provided in the domain field of the request.
350
+ * - If `privateKey` is present, `selector` must be present.
351
+ * - If `selector` is present and `domain` is not, the domain will be taken from the domain field of the request.
352
+ */
353
+ dkim?: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
354
+ /**
355
+ * Domain used for sending emails. If `dkim` settings are not provided, or `dkim` settings are provided with no `domain`, the stored dkim settings for this domain will be used.
356
+ */
357
+ domain: string;
358
+ /**
359
+ * Used exclusively for [Domain Lockdown](https://support.mailchannels.com/hc/en-us/articles/16918954360845-Secure-your-domain-name-against-spoofing-with-Domain-Lockdown) verification. If you're not using senderid to associate your domain with your account, you can disregard this field. The corresponding value is included in the `X-MailChannels-SenderId` header of emails sent via MailChannels.
360
+ */
361
+ senderId?: string;
362
+ }
363
+
364
+ type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
365
+
366
+ interface EmailsCheckDomainResponse {
367
+ /**
368
+ * The results of the domain checks.
369
+ */
370
+ results: {
371
+ dkim: {
372
+ domain: string;
373
+ /**
374
+ * The human readable status of the DKIM key used for verification.
375
+ */
376
+ keyStatus?: EmailsDkimKey["status"] | "provided";
377
+ selector: string;
378
+ /**
379
+ * A human-readable explanation of DKIM check.
380
+ */
381
+ reason?: string;
382
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
383
+ }[];
384
+ domainLockdown: {
385
+ /**
386
+ * A human-readable explanation of Domain Lockdown check.
387
+ */
388
+ reason?: string;
389
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
390
+ };
391
+ /**
392
+ * These results are here to help avoid [SDNF](https://support.mailchannels.com/hc/en-us/articles/203155500-550-5-2-1-SDNF-Sender-Domain-Not-Found) (Sender Domain Not Found) blocks. For messages not to get blocked by SDNF, we require either an MX or A record to exist for the sender domain.
393
+ */
394
+ senderDomain: {
395
+ a: {
396
+ /**
397
+ * A human-readable explanation of A record check.
398
+ */
399
+ reason?: string;
400
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
401
+ };
402
+ mx: {
403
+ /**
404
+ * A human-readable explanation of MX record check.
405
+ */
406
+ reason?: string;
407
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
408
+ };
409
+ /**
410
+ * Overall verdict. Passed if either A or MX record check passed.
411
+ */
412
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
413
+ };
414
+ spf: {
415
+ /**
416
+ * A human-readable explanation of SPF check.
417
+ */
418
+ reason?: string;
419
+ verdict: EmailsCheckDomainVerdict;
420
+ };
421
+ references?: string[];
422
+ } | null;
423
+ /**
424
+ * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
425
+ */
426
+ error: string | null;
427
+ }
428
+
387
429
  interface EmailsGetDkimKeysOptions {
388
430
  /**
389
431
  * Selector to filter keys by. Must be a maximum of 63 characters.
@@ -662,6 +704,19 @@ interface SubAccountsCreateApiKeyResponse {
662
704
  error: string | null;
663
705
  }
664
706
 
707
+ interface SubAccountsListApiKeyOptions {
708
+ /**
709
+ * The maximum number of API keys included in the response. Possible values are `1` to `1000`.
710
+ * @default 100
711
+ */
712
+ limit?: number;
713
+ /**
714
+ * Offset into the list of API keys to return.
715
+ * @default 0
716
+ */
717
+ offset?: number;
718
+ }
719
+
665
720
  interface SubAccountsListApiKeyResponse {
666
721
  keys: SubAccountsApiKey[];
667
722
  error: string | null;
@@ -791,13 +846,14 @@ declare class SubAccounts {
791
846
  /**
792
847
  * Retrieves details of all API keys associated with the specified sub-account. For security reasons, the full API key is not returned; only the key ID and a partially redacted version are provided.
793
848
  * @param handle - Handle of the sub-account to retrieve the API key for.
849
+ * @param options - The options to filter the list of API keys.
794
850
  * @example
795
851
  * ```ts
796
852
  * const mailchannels = new MailChannels('your-api-key')
797
853
  * const { keys } = await mailchannels.subAccounts.listApiKeys('validhandle123')
798
854
  * ```
799
855
  */
800
- listApiKeys(handle: string): Promise<SubAccountsListApiKeyResponse>;
856
+ listApiKeys(handle: string, options?: SubAccountsListApiKeyOptions): Promise<SubAccountsListApiKeyResponse>;
801
857
  /**
802
858
  * Deletes the API key identified by its ID for the specified sub-account.
803
859
  * @param handle - Handle of the sub-account for which the API key should be deleted.
@@ -1830,4 +1886,4 @@ declare class Service {
1830
1886
  }
1831
1887
 
1832
1888
  export { Domains as D, Emails as E, Lists as L, MailChannelsClient as M, SubAccounts as S, Users as U, Webhooks as W, Metrics as a, Suppressions as b, Service as c };
1833
- export type { MetricsVolumeResponse as $, SubAccountsApiKey as A, SubAccountsCreateApiKeyResponse as B, SubAccountsListApiKeyResponse as C, SubAccountsSmtpPassword as F, SubAccountsCreateSmtpPasswordResponse as G, SubAccountsListSmtpPasswordResponse as H, SubAccountsLimit as I, SubAccountsLimitResponse as J, SubAccountsUsage as K, SubAccountsUsageResponse as N, Optional as O, MetricsBucket as P, MetricsOptions as Q, MetricsEngagement as R, MetricsEngagementResponse as T, MetricsPerformance as V, MetricsPerformanceResponse as X, MetricsRecipientBehaviour as Y, MetricsRecipientBehaviourResponse as Z, MetricsVolume as _, MetricsUsageResponse as a0, SuppressionsTypes as a1, SuppressionsCreateOptions as a2, SuppressionsSource as a3, SuppressionsListOptions as a4, SuppressionsListEntry as a5, SuppressionsListResponse as a6, DomainsData as a7, DomainsProvisionOptions as a8, DomainsBulkProvisionOptions as a9, DomainsProvisionResponse as aa, DomainsBulkProvisionResponse as ab, DomainsListOptions as ac, DomainsListResponse as ad, DomainsCreateLoginLinkResponse as ae, DomainsListDownstreamAddressesOptions as af, DomainsDownstreamAddress as ag, DomainsListDownstreamAddressesResponse as ah, DomainsBulkCreateLoginLinkResult as ai, DomainsBulkCreateLoginLinks as aj, DomainsBulkCreateLoginLinksResponse as ak, ListNames as al, ListEntryOptions as am, ListEntry as an, ListEntryResponse as ao, ListEntriesResponse as ap, UsersCreateOptions as aq, UsersCreateResponse as ar, ServiceSubscriptionsResponse as as, ServiceReportOptions as at, SuccessResponse as au, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, EmailsCreateDkimKeyOptions as n, EmailsDkimKey as o, EmailsCreateDkimKeyResponse as p, EmailsGetDkimKeysOptions as q, EmailsGetDkimKeysResponse as r, EmailsUpdateDkimKeyOptions as s, WebhooksListResponse as t, WebhooksSigningKeyResponse as u, WebhooksValidateResponse as v, SubAccountsAccount as w, SubAccountsCreateResponse as x, SubAccountsListOptions as y, SubAccountsListResponse as z };
1889
+ export type { MetricsVolume as $, SubAccountsApiKey as A, SubAccountsCreateApiKeyResponse as B, SubAccountsListApiKeyOptions as C, SubAccountsListApiKeyResponse as F, SubAccountsSmtpPassword as G, SubAccountsCreateSmtpPasswordResponse as H, SubAccountsListSmtpPasswordResponse as I, SubAccountsLimit as J, SubAccountsLimitResponse as K, SubAccountsUsage as N, Optional as O, SubAccountsUsageResponse as P, MetricsBucket as Q, MetricsOptions as R, MetricsEngagement as T, MetricsEngagementResponse as V, MetricsPerformance as X, MetricsPerformanceResponse as Y, MetricsRecipientBehaviour as Z, MetricsRecipientBehaviourResponse as _, MetricsVolumeResponse as a0, MetricsUsageResponse as a1, SuppressionsTypes as a2, SuppressionsCreateOptions as a3, SuppressionsSource as a4, SuppressionsListOptions as a5, SuppressionsListEntry as a6, SuppressionsListResponse as a7, DomainsData as a8, DomainsProvisionOptions as a9, DomainsBulkProvisionOptions as aa, DomainsProvisionResponse as ab, DomainsBulkProvisionResponse as ac, DomainsListOptions as ad, DomainsListResponse as ae, DomainsCreateLoginLinkResponse as af, DomainsListDownstreamAddressesOptions as ag, DomainsDownstreamAddress as ah, DomainsListDownstreamAddressesResponse as ai, DomainsBulkCreateLoginLinkResult as aj, DomainsBulkCreateLoginLinks as ak, DomainsBulkCreateLoginLinksResponse as al, ListNames as am, ListEntryOptions as an, ListEntry as ao, ListEntryResponse as ap, ListEntriesResponse as aq, UsersCreateOptions as ar, UsersCreateResponse as as, ServiceSubscriptionsResponse as at, ServiceReportOptions as au, SuccessResponse as av, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, EmailsCreateDkimKeyOptions as n, EmailsDkimKey as o, EmailsCreateDkimKeyResponse as p, EmailsGetDkimKeysOptions as q, EmailsGetDkimKeysResponse as r, EmailsUpdateDkimKeyOptions as s, WebhooksListResponse as t, WebhooksSigningKeyResponse as u, WebhooksValidateResponse as v, SubAccountsAccount as w, SubAccountsCreateResponse as x, SubAccountsListOptions as y, SubAccountsListResponse as z };
@@ -129,6 +129,15 @@ interface EmailsSendOptionsBase {
129
129
  * 'Name <email@example.com>'
130
130
  */
131
131
  from: EmailsSendRecipient | string;
132
+ /**
133
+ * An object containing key-value pairs, where both keys (header names) and values must be strings. These pairs represent custom headers to be substituted.
134
+ *
135
+ * Please note the following restrictions and behavior:
136
+ * - **Reserved headers**: The following headers cannot be modified: `Authentication-Results`, `BCC`, `CC`, `Content-Transfer-Encoding`, `Content-Type`, `DKIM-Signature`, `From`, `Message-ID`, `Received`, `Reply-To`, `Subject`, `To`.
137
+ * - **Header precedence**: If a header is defined in both the personalizations object and the root headers, the value from personalizations will be used.
138
+ * - **Case sensitivity**: Headers are treated as case-insensitive. If multiple headers differ only by case, only one will be used, with no guarantee of which one.
139
+ */
140
+ headers?: Record<string, string>;
132
141
  /**
133
142
  * The recipient of the email. Can be an array of email addresses or an array of objects with `email` and `name` properties or a single email address string or an object with `email` and `name` properties.
134
143
  * @example
@@ -251,74 +260,6 @@ interface EmailsSendResponse {
251
260
  error: string | null;
252
261
  }
253
262
 
254
- interface EmailsCheckDomainDkim {
255
- /**
256
- * Domain used for DKIM signing.
257
- */
258
- domain: string;
259
- /**
260
- * DKIM private key encoded in Base64.
261
- */
262
- privateKey: string;
263
- /**
264
- * DKIM selector in the domain DNS records.
265
- */
266
- selector: string;
267
- }
268
-
269
- interface EmailsCheckDomainOptions {
270
- /**
271
- * Up to 10 DKIM checks are allowed.
272
- */
273
- dkim: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
274
- /**
275
- * Domain used for sending emails.
276
- */
277
- domain: string;
278
- /**
279
- * `X-MailChannels-Sender-Id` header value in emails via MailChannels.
280
- */
281
- senderId: string;
282
- }
283
-
284
- type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
285
-
286
- interface EmailsCheckDomainResponse {
287
- /**
288
- * The results of the domain checks.
289
- */
290
- results: {
291
- dkim: {
292
- domain: string;
293
- selector: string;
294
- /**
295
- * A human-readable explanation of DKIM check.
296
- */
297
- reason?: string;
298
- verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
299
- }[];
300
- domainLockdown: {
301
- /**
302
- * A human-readable explanation of Domain Lockdown check.
303
- */
304
- reason?: string;
305
- verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
306
- };
307
- spf: {
308
- /**
309
- * A human-readable explanation of SPF check.
310
- */
311
- reason?: string;
312
- verdict: EmailsCheckDomainVerdict;
313
- };
314
- references?: string[];
315
- } | null;
316
- /**
317
- * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
318
- */
319
- error: string | null;
320
- }
321
-
322
263
  interface EmailsCreateDkimKeyOptions {
323
264
  /**
324
265
  * Algorithm used for the new key pair Currently, only RSA is supported.
@@ -384,6 +325,107 @@ interface EmailsCreateDkimKeyResponse {
384
325
  error: string | null;
385
326
  }
386
327
 
328
+ interface EmailsCheckDomainDkim {
329
+ /**
330
+ * Domain used for DKIM signing.
331
+ */
332
+ domain?: string;
333
+ /**
334
+ * DKIM private key encoded in Base64.
335
+ */
336
+ privateKey?: string;
337
+ /**
338
+ * DKIM selector in the domain DNS records.
339
+ */
340
+ selector?: string;
341
+ }
342
+
343
+ interface EmailsCheckDomainOptions {
344
+ /**
345
+ * Each item may include DKIM `domain`, `selector` and `privateKey`. Up to 10 items are allowed. The absence or presence of these fields affects how DKIM settings are validated:
346
+ * - If `domain`, `selector`, and `privateKey` are all present, verify using the provided domain, selector, and key.
347
+ * - If `domain` and `selector` are present, use the stored private key for the given domain and selector.
348
+ * - If only `domain` is present, use all stored keys for the given domain.
349
+ * - If none are present, use all stored keys for the `domain` provided in the domain field of the request.
350
+ * - If `privateKey` is present, `selector` must be present.
351
+ * - If `selector` is present and `domain` is not, the domain will be taken from the domain field of the request.
352
+ */
353
+ dkim?: EmailsCheckDomainDkim[] | EmailsCheckDomainDkim;
354
+ /**
355
+ * Domain used for sending emails. If `dkim` settings are not provided, or `dkim` settings are provided with no `domain`, the stored dkim settings for this domain will be used.
356
+ */
357
+ domain: string;
358
+ /**
359
+ * Used exclusively for [Domain Lockdown](https://support.mailchannels.com/hc/en-us/articles/16918954360845-Secure-your-domain-name-against-spoofing-with-Domain-Lockdown) verification. If you're not using senderid to associate your domain with your account, you can disregard this field. The corresponding value is included in the `X-MailChannels-SenderId` header of emails sent via MailChannels.
360
+ */
361
+ senderId?: string;
362
+ }
363
+
364
+ type EmailsCheckDomainVerdict = "passed" | "failed" | "soft failed" | "temporary error" | "permanent error" | "neutral" | "none" | "unknown";
365
+
366
+ interface EmailsCheckDomainResponse {
367
+ /**
368
+ * The results of the domain checks.
369
+ */
370
+ results: {
371
+ dkim: {
372
+ domain: string;
373
+ /**
374
+ * The human readable status of the DKIM key used for verification.
375
+ */
376
+ keyStatus?: EmailsDkimKey["status"] | "provided";
377
+ selector: string;
378
+ /**
379
+ * A human-readable explanation of DKIM check.
380
+ */
381
+ reason?: string;
382
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
383
+ }[];
384
+ domainLockdown: {
385
+ /**
386
+ * A human-readable explanation of Domain Lockdown check.
387
+ */
388
+ reason?: string;
389
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
390
+ };
391
+ /**
392
+ * These results are here to help avoid [SDNF](https://support.mailchannels.com/hc/en-us/articles/203155500-550-5-2-1-SDNF-Sender-Domain-Not-Found) (Sender Domain Not Found) blocks. For messages not to get blocked by SDNF, we require either an MX or A record to exist for the sender domain.
393
+ */
394
+ senderDomain: {
395
+ a: {
396
+ /**
397
+ * A human-readable explanation of A record check.
398
+ */
399
+ reason?: string;
400
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
401
+ };
402
+ mx: {
403
+ /**
404
+ * A human-readable explanation of MX record check.
405
+ */
406
+ reason?: string;
407
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
408
+ };
409
+ /**
410
+ * Overall verdict. Passed if either A or MX record check passed.
411
+ */
412
+ verdict: Extract<EmailsCheckDomainVerdict, "passed" | "failed">;
413
+ };
414
+ spf: {
415
+ /**
416
+ * A human-readable explanation of SPF check.
417
+ */
418
+ reason?: string;
419
+ verdict: EmailsCheckDomainVerdict;
420
+ };
421
+ references?: string[];
422
+ } | null;
423
+ /**
424
+ * Link to SPF, Domain Lockdown or DKIM references, displayed if any verdict is not passed.
425
+ */
426
+ error: string | null;
427
+ }
428
+
387
429
  interface EmailsGetDkimKeysOptions {
388
430
  /**
389
431
  * Selector to filter keys by. Must be a maximum of 63 characters.
@@ -662,6 +704,19 @@ interface SubAccountsCreateApiKeyResponse {
662
704
  error: string | null;
663
705
  }
664
706
 
707
+ interface SubAccountsListApiKeyOptions {
708
+ /**
709
+ * The maximum number of API keys included in the response. Possible values are `1` to `1000`.
710
+ * @default 100
711
+ */
712
+ limit?: number;
713
+ /**
714
+ * Offset into the list of API keys to return.
715
+ * @default 0
716
+ */
717
+ offset?: number;
718
+ }
719
+
665
720
  interface SubAccountsListApiKeyResponse {
666
721
  keys: SubAccountsApiKey[];
667
722
  error: string | null;
@@ -791,13 +846,14 @@ declare class SubAccounts {
791
846
  /**
792
847
  * Retrieves details of all API keys associated with the specified sub-account. For security reasons, the full API key is not returned; only the key ID and a partially redacted version are provided.
793
848
  * @param handle - Handle of the sub-account to retrieve the API key for.
849
+ * @param options - The options to filter the list of API keys.
794
850
  * @example
795
851
  * ```ts
796
852
  * const mailchannels = new MailChannels('your-api-key')
797
853
  * const { keys } = await mailchannels.subAccounts.listApiKeys('validhandle123')
798
854
  * ```
799
855
  */
800
- listApiKeys(handle: string): Promise<SubAccountsListApiKeyResponse>;
856
+ listApiKeys(handle: string, options?: SubAccountsListApiKeyOptions): Promise<SubAccountsListApiKeyResponse>;
801
857
  /**
802
858
  * Deletes the API key identified by its ID for the specified sub-account.
803
859
  * @param handle - Handle of the sub-account for which the API key should be deleted.
@@ -1830,4 +1886,4 @@ declare class Service {
1830
1886
  }
1831
1887
 
1832
1888
  export { Domains as D, Emails as E, Lists as L, MailChannelsClient as M, SubAccounts as S, Users as U, Webhooks as W, Metrics as a, Suppressions as b, Service as c };
1833
- export type { MetricsVolumeResponse as $, SubAccountsApiKey as A, SubAccountsCreateApiKeyResponse as B, SubAccountsListApiKeyResponse as C, SubAccountsSmtpPassword as F, SubAccountsCreateSmtpPasswordResponse as G, SubAccountsListSmtpPasswordResponse as H, SubAccountsLimit as I, SubAccountsLimitResponse as J, SubAccountsUsage as K, SubAccountsUsageResponse as N, Optional as O, MetricsBucket as P, MetricsOptions as Q, MetricsEngagement as R, MetricsEngagementResponse as T, MetricsPerformance as V, MetricsPerformanceResponse as X, MetricsRecipientBehaviour as Y, MetricsRecipientBehaviourResponse as Z, MetricsVolume as _, MetricsUsageResponse as a0, SuppressionsTypes as a1, SuppressionsCreateOptions as a2, SuppressionsSource as a3, SuppressionsListOptions as a4, SuppressionsListEntry as a5, SuppressionsListResponse as a6, DomainsData as a7, DomainsProvisionOptions as a8, DomainsBulkProvisionOptions as a9, DomainsProvisionResponse as aa, DomainsBulkProvisionResponse as ab, DomainsListOptions as ac, DomainsListResponse as ad, DomainsCreateLoginLinkResponse as ae, DomainsListDownstreamAddressesOptions as af, DomainsDownstreamAddress as ag, DomainsListDownstreamAddressesResponse as ah, DomainsBulkCreateLoginLinkResult as ai, DomainsBulkCreateLoginLinks as aj, DomainsBulkCreateLoginLinksResponse as ak, ListNames as al, ListEntryOptions as am, ListEntry as an, ListEntryResponse as ao, ListEntriesResponse as ap, UsersCreateOptions as aq, UsersCreateResponse as ar, ServiceSubscriptionsResponse as as, ServiceReportOptions as at, SuccessResponse as au, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, EmailsCreateDkimKeyOptions as n, EmailsDkimKey as o, EmailsCreateDkimKeyResponse as p, EmailsGetDkimKeysOptions as q, EmailsGetDkimKeysResponse as r, EmailsUpdateDkimKeyOptions as s, WebhooksListResponse as t, WebhooksSigningKeyResponse as u, WebhooksValidateResponse as v, SubAccountsAccount as w, SubAccountsCreateResponse as x, SubAccountsListOptions as y, SubAccountsListResponse as z };
1889
+ export type { MetricsVolume as $, SubAccountsApiKey as A, SubAccountsCreateApiKeyResponse as B, SubAccountsListApiKeyOptions as C, SubAccountsListApiKeyResponse as F, SubAccountsSmtpPassword as G, SubAccountsCreateSmtpPasswordResponse as H, SubAccountsListSmtpPasswordResponse as I, SubAccountsLimit as J, SubAccountsLimitResponse as K, SubAccountsUsage as N, Optional as O, SubAccountsUsageResponse as P, MetricsBucket as Q, MetricsOptions as R, MetricsEngagement as T, MetricsEngagementResponse as V, MetricsPerformance as X, MetricsPerformanceResponse as Y, MetricsRecipientBehaviour as Z, MetricsRecipientBehaviourResponse as _, MetricsVolumeResponse as a0, MetricsUsageResponse as a1, SuppressionsTypes as a2, SuppressionsCreateOptions as a3, SuppressionsSource as a4, SuppressionsListOptions as a5, SuppressionsListEntry as a6, SuppressionsListResponse as a7, DomainsData as a8, DomainsProvisionOptions as a9, DomainsBulkProvisionOptions as aa, DomainsProvisionResponse as ab, DomainsBulkProvisionResponse as ac, DomainsListOptions as ad, DomainsListResponse as ae, DomainsCreateLoginLinkResponse as af, DomainsListDownstreamAddressesOptions as ag, DomainsDownstreamAddress as ah, DomainsListDownstreamAddressesResponse as ai, DomainsBulkCreateLoginLinkResult as aj, DomainsBulkCreateLoginLinks as ak, DomainsBulkCreateLoginLinksResponse as al, ListNames as am, ListEntryOptions as an, ListEntry as ao, ListEntryResponse as ap, ListEntriesResponse as aq, UsersCreateOptions as ar, UsersCreateResponse as as, ServiceSubscriptionsResponse as at, ServiceReportOptions as au, SuccessResponse as av, EmailsSendRecipient as d, EmailsSendAttachment as e, EmailsSendTracking as f, EmailsSendOptionsBase as g, EmailsSendOptions as h, EmailsSendResponse as i, EmailsCheckDomainDkim as j, EmailsCheckDomainOptions as k, EmailsCheckDomainVerdict as l, EmailsCheckDomainResponse as m, EmailsCreateDkimKeyOptions as n, EmailsDkimKey as o, EmailsCreateDkimKeyResponse as p, EmailsGetDkimKeysOptions as q, EmailsGetDkimKeysResponse as r, EmailsUpdateDkimKeyOptions as s, WebhooksListResponse as t, WebhooksSigningKeyResponse as u, WebhooksValidateResponse as v, SubAccountsAccount as w, SubAccountsCreateResponse as x, SubAccountsListOptions as y, SubAccountsListResponse as z };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mailchannels-sdk",
3
- "version": "0.4.5",
3
+ "version": "0.4.7",
4
4
  "description": "Node.js SDK to integrate MailChannels API into your JavaScript or TypeScript server-side applications.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -42,20 +42,22 @@
42
42
  },
43
43
  "devDependencies": {
44
44
  "@eslint/compat": "^1.4.0",
45
- "@stylistic/eslint-plugin": "^5.4.0",
46
- "@types/node": "^24.7.2",
47
- "@typescript-eslint/eslint-plugin": "^8.46.0",
48
- "@typescript-eslint/parser": "^8.46.0",
45
+ "@stylistic/eslint-plugin": "^5.5.0",
46
+ "@types/markdown-it": "^14.1.2",
47
+ "@types/node": "^24.8.1",
48
+ "@typescript-eslint/eslint-plugin": "^8.46.1",
49
+ "@typescript-eslint/parser": "^8.46.1",
49
50
  "@vitest/coverage-v8": "^3.2.4",
50
51
  "changelogen": "^0.6.2",
51
- "eslint": "^9.37.0",
52
+ "eslint": "^9.38.0",
52
53
  "eslint-plugin-import-x": "^4.16.1",
53
54
  "jiti": "^2.6.1",
54
55
  "scule": "^1.3.0",
55
56
  "typescript": "^5.9.3",
56
57
  "unbuild": "^3.6.1",
57
58
  "vitepress": "^1.6.4",
58
- "vitepress-plugin-group-icons": "^1.6.3",
59
+ "vitepress-plugin-group-icons": "^1.6.4",
60
+ "vitepress-plugin-llms": "^1.8.0",
59
61
  "vitest": "^3.2.4"
60
62
  },
61
63
  "scripts": {