groundmail 0.30.0 → 0.32.0
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.
package/dist/authjs.d.ts
CHANGED
package/dist/better-auth.d.ts
CHANGED
package/dist/clerk.d.ts
CHANGED
|
@@ -973,9 +973,48 @@ type Domain = {
|
|
|
973
973
|
inbound_spam_threshold?: number | null;
|
|
974
974
|
/** `flag` keeps spam with `spam_status: 'spam'`; `drop` discards it. */
|
|
975
975
|
inbound_spam_action?: 'flag' | 'drop';
|
|
976
|
+
/** Daily blocklist check of this domain and its main domain. */
|
|
977
|
+
blocklists?: DomainBlocklists;
|
|
976
978
|
/** The tenant that owns this domain (external id). Absent for an account-wide domain. */
|
|
977
979
|
tenant?: string | null;
|
|
978
980
|
};
|
|
981
|
+
type DomainBlocklistStatus = 'clear' | 'listed' | 'unknown';
|
|
982
|
+
type DomainBlocklistListing = {
|
|
983
|
+
/** `Spamhaus DBL`, `SURBL` or `URIBL`. */
|
|
984
|
+
list: string;
|
|
985
|
+
/** `spamhaus-dbl`, `surbl` or `uribl`. */
|
|
986
|
+
list_id: string;
|
|
987
|
+
/** The listed name: the domain itself or its main domain. */
|
|
988
|
+
name: string;
|
|
989
|
+
/** What the list says it is listed for, for example `spam domain`. */
|
|
990
|
+
reason: string;
|
|
991
|
+
/** When our check first found it listed (ISO 8601). */
|
|
992
|
+
listed_since: string;
|
|
993
|
+
/** Where to look the name up and request removal. */
|
|
994
|
+
info_url: string;
|
|
995
|
+
};
|
|
996
|
+
/**
|
|
997
|
+
* Every day Groundmail checks a verified domain and its main domain (mail.example.com
|
|
998
|
+
* and example.com) on Spamhaus DBL, SURBL and URIBL and emails the account owners when
|
|
999
|
+
* either is added or removed. A listing never pauses sending.
|
|
1000
|
+
*/
|
|
1001
|
+
type DomainBlocklists = {
|
|
1002
|
+
/** `unknown` before the first check, for a domain that is not verified, or when no list answered. */
|
|
1003
|
+
status: DomainBlocklistStatus | string;
|
|
1004
|
+
/** When the last check ran (ISO 8601); null until the first check. */
|
|
1005
|
+
checked_at: string | null;
|
|
1006
|
+
/** The names checked: one when the domain is a main domain. */
|
|
1007
|
+
names: string[];
|
|
1008
|
+
main_domain: string;
|
|
1009
|
+
/** Current listings, main domain first. */
|
|
1010
|
+
listings: DomainBlocklistListing[];
|
|
1011
|
+
/** Recent removals, newest first (up to 5). */
|
|
1012
|
+
removed: Array<DomainBlocklistListing & {
|
|
1013
|
+
removed_at: string;
|
|
1014
|
+
}>;
|
|
1015
|
+
/** Lists that did not answer the last check. */
|
|
1016
|
+
unanswered_lists: string[];
|
|
1017
|
+
};
|
|
979
1018
|
type DnsRecord = {
|
|
980
1019
|
type: string;
|
|
981
1020
|
host: string;
|
|
@@ -1143,17 +1182,10 @@ type ApiErrorBody = {
|
|
|
1143
1182
|
message?: string;
|
|
1144
1183
|
};
|
|
1145
1184
|
/** Providers the importer reads from (Beta). */
|
|
1146
|
-
type MigrationProvider = 'sendgrid' | 'postmark' | 'mailgun';
|
|
1185
|
+
type MigrationProvider = 'sendgrid' | 'postmark' | 'mailgun' | 'resend' | 'ses';
|
|
1147
1186
|
type MigrationResource = 'domains' | 'webhooks' | 'templates' | 'suppressions';
|
|
1148
1187
|
type MigrationItemStatus = 'imported' | 'would_import' | 'needs_attention' | 'skipped' | 'failed';
|
|
1149
|
-
type
|
|
1150
|
-
provider: MigrationProvider;
|
|
1151
|
-
/** SendGrid API key, Postmark server token or Mailgun private key. Used for the import only; never stored. */
|
|
1152
|
-
api_key: string;
|
|
1153
|
-
/** Postmark only: the account token, needed to import sending domains. */
|
|
1154
|
-
account_api_key?: string;
|
|
1155
|
-
/** SendGrid and Mailgun: `eu` for EU-region accounts. */
|
|
1156
|
-
region?: 'us' | 'eu';
|
|
1188
|
+
type MigrationRunParams = {
|
|
1157
1189
|
/** What to import; all four by default. */
|
|
1158
1190
|
resources?: MigrationResource[];
|
|
1159
1191
|
/** Preview without writing anything. */
|
|
@@ -1161,6 +1193,33 @@ type CreateMigrationParams = {
|
|
|
1161
1193
|
/** `next_cursor` from the previous response, to continue. */
|
|
1162
1194
|
cursor?: string;
|
|
1163
1195
|
};
|
|
1196
|
+
/** SendGrid, Postmark, Mailgun and Resend: one API key. */
|
|
1197
|
+
type ApiKeyMigrationParams = MigrationRunParams & {
|
|
1198
|
+
provider: Exclude<MigrationProvider, 'ses'>;
|
|
1199
|
+
/**
|
|
1200
|
+
* SendGrid API key, Postmark server token, Mailgun private key, or a Resend key with
|
|
1201
|
+
* Full access. Used for the import only; never stored.
|
|
1202
|
+
*/
|
|
1203
|
+
api_key: string;
|
|
1204
|
+
/** Postmark only: the account token, needed to import sending domains. */
|
|
1205
|
+
account_api_key?: string;
|
|
1206
|
+
/** SendGrid and Mailgun: `eu` for EU-region accounts. */
|
|
1207
|
+
region?: 'us' | 'eu';
|
|
1208
|
+
};
|
|
1209
|
+
/**
|
|
1210
|
+
* Amazon SES: an access key for an IAM user or role with the read-only import
|
|
1211
|
+
* policy, and one region. Used for the import only; never stored.
|
|
1212
|
+
*/
|
|
1213
|
+
type SesMigrationParams = MigrationRunParams & {
|
|
1214
|
+
provider: 'ses';
|
|
1215
|
+
aws_access_key_id: string;
|
|
1216
|
+
aws_secret_access_key: string;
|
|
1217
|
+
/** Temporary credentials (SSO, an assumed role) only. */
|
|
1218
|
+
aws_session_token?: string;
|
|
1219
|
+
/** e.g. `us-east-1`. Run the import again for each other region you send from. */
|
|
1220
|
+
aws_region: string;
|
|
1221
|
+
};
|
|
1222
|
+
type CreateMigrationParams = ApiKeyMigrationParams | SesMigrationParams;
|
|
1164
1223
|
/**
|
|
1165
1224
|
* Running totals. Suppressions also count by kind: `bounce`, `complaint`,
|
|
1166
1225
|
* `unsubscribe`, `manual`, and `product_opt_out` (opt-outs that were never
|
|
@@ -1695,8 +1754,9 @@ declare class KeysResource {
|
|
|
1695
1754
|
/** Combine the reports of one import's requests: every item, the latest totals. */
|
|
1696
1755
|
declare function mergeMigrations(previous: Migration | null, next: Migration): Migration;
|
|
1697
1756
|
/**
|
|
1698
|
-
* Import templates, suppressions, domains and webhooks from SendGrid, Postmark
|
|
1699
|
-
* or
|
|
1757
|
+
* Import templates, suppressions, domains and webhooks from SendGrid, Postmark,
|
|
1758
|
+
* Mailgun, Resend or Amazon SES (Beta). The provider key (SES: access key and
|
|
1759
|
+
* secret) is sent with each request and never stored.
|
|
1700
1760
|
*/
|
|
1701
1761
|
declare class MigrationsResource {
|
|
1702
1762
|
private readonly client;
|
|
@@ -1946,7 +2006,7 @@ declare class Groundmail {
|
|
|
1946
2006
|
readonly templates: TemplatesResource;
|
|
1947
2007
|
/** Your platform's customers, each with its own domains, suppressions, stats and limits. */
|
|
1948
2008
|
readonly tenants: TenantsResource;
|
|
1949
|
-
/** Import from SendGrid, Postmark or
|
|
2009
|
+
/** Import from SendGrid, Postmark, Mailgun, Resend or Amazon SES (Beta). */
|
|
1950
2010
|
readonly migrations: MigrationsResource;
|
|
1951
2011
|
/** DMARC monitoring per domain: report address, sources, pass rates and readiness. */
|
|
1952
2012
|
readonly dmarc: DmarcResource;
|
|
@@ -1987,4 +2047,4 @@ declare function normalizeAccessToken(value: GroundmailAccessToken | null | unde
|
|
|
1987
2047
|
expiresAt: number | null;
|
|
1988
2048
|
};
|
|
1989
2049
|
|
|
1990
|
-
export { type
|
|
2050
|
+
export { type DmarcSourceStatus as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryOptOut as C, type DnsRecord as D, type CreateDomainParams as E, type CreateDomainResult as F, Groundmail as G, type CreateMigrationParams as H, type CreateSuppressionParams as I, type CreateTemplateParams as J, type CreateTenantParams as K, type CreateWebhookParams as L, DEFAULT_API_BASE_URL as M, type DailyRampLimitErrorDetails as N, type DeleteTenantResult as O, type DeliverabilityBucket as P, type DeliverabilityDomainInsight as Q, type DeliverabilityInsightsResult as R, type SendEmailResult as S, type DeliverabilityMailServerRelay as T, type DeliverabilityWindow as U, type DmarcDailyPoint as V, type DmarcMonitoring as W, type DmarcMonitoringDisabled as X, type DmarcReadiness as Y, type DmarcReadinessVerdict as Z, type DmarcSource as _, type ApiErrorCode as a, type MigrationTotals as a$, type DmarcStatus as a0, type DnsProviderName as a1, type Domain as a2, type DomainBimiAnalysis as a3, type DomainBlocklistListing as a4, type DomainBlocklistStatus as a5, type DomainBlocklists as a6, type DomainDetailResult as a7, type DomainDmarcAnalysis as a8, type DomainDnsAnalysis as a9, type ListCategoryOptOutsResult as aA, type ListDomainsParams as aB, type ListDomainsResult as aC, type ListEmailsParams as aD, type ListEmailsResult as aE, type ListReceivedEmailsParams as aF, type ListReceivedEmailsResult as aG, type ListSuppressionsParams as aH, type ListSuppressionsResult as aI, type ListTemplatesParams as aJ, type ListTemplatesResult as aK, type ListTenantDomainsResult as aL, type ListTenantsParams as aM, type ListTenantsResult as aN, type ListTestInboxEmailsParams as aO, type ListTestInboxEmailsResult as aP, type MailServerSigningStatus as aQ, type MailStream as aR, type Migration as aS, type MigrationDnsChange as aT, type MigrationDnsPlan as aU, type MigrationDomainItem as aV, type MigrationItemStatus as aW, type MigrationProvider as aX, type MigrationResource as aY, type MigrationSummary as aZ, type MigrationTemplateItem as a_, type DomainStatus as aa, type DomainTlsMode as ab, type DomainTrackingDns as ac, type DomainTrackingStatus as ad, type EmailDelivery as ae, type EmailListItem as af, type EmailWebhookEventPayload as ag, type EmailWebhookEventType as ah, type EnableDmarcParams as ai, type EnableDmarcResult as aj, type EnrollmentSkip as ak, type EventRecord as al, type GroundmailAccessToken as am, type GroundmailOptions as an, type GroundmailTokenOptions as ao, type GroundmailTokenProvider as ap, type HeldBackErrorDetails as aq, type HeldBackReason as ar, type HeldBackRecipient as as, type InReplyToEmail as at, type ListApiKeysParams as au, type ListApiKeysResult as av, type ListAutomationRunsParams as aw, type ListAutomationRunsResult as ax, type ListAutomationsResult as ay, type ListCategoryOptOutsParams as az, type ApiKey as b, type MigrationWebhookItem as b0, type ReceivedEmail as b1, type ReceivedEmailAttachment as b2, type ReceivedEmailAttachmentMeta as b3, type RemoteApplyDnsCredentials as b4, type RemoveCategoryOptOutOptions as b5, type RunMigrationOptions as b6, type SendEmailParams as b7, type SesMigrationParams as b8, type StreamDeliverability as b9, type TriggerEventParams as bA, type TriggerEventResult as bB, type TwilioIntegrationResponse as bC, type TwilioIntegrationStatus as bD, type UpdateAutomationParams as bE, type UpdateDomainParams as bF, type UpdateEmailParams as bG, type UpdateTemplateParams as bH, type UpdateTenantParams as bI, type UpdateWebhookParams as bJ, type ValidateEmailResult as bK, type ValidationReason as bL, type ValidationVerdict as bM, type VerifyDomainResult as bN, type WaitForTestEmailParams as bO, type WebhookEmailTag as bP, type WebhookEndpoint as bQ, type WebhookEndpointWithSecret as bR, type WebhookEventType as bS, mergeMigrations as bT, normalizeAccessToken as bU, type SuppressedErrorDetails as ba, type Suppression as bb, TEST_INBOX_WAIT_DEFAULT_MS as bc, TEST_INBOX_WAIT_MAX_SECONDS as bd, type Template as be, type TemplateFormat as bf, type TemplateLintWarning as bg, type TemplateStarter as bh, type TemplateStatus as bi, type TemplateVersion as bj, type Tenant as bk, type TenantPauseSource as bl, type TenantRamp as bm, type TenantStats as bn, type TenantStatsResult as bo, type TenantStatus as bp, type TenantStreamPolicy as bq, type TestEmailWebhookParams as br, type TestEmailWebhookResult as bs, type TestInbox as bt, type TestInboxAddressOptions as bu, type TestInboxEmail as bv, type TestInboxEmailDetail as bw, type TestInboxHeader as bx, TestInboxResource as by, type TestInboxUsage as bz, type ApiKeyMigrationParams as c, type ApiKeyScope as d, type ApplyDnsParams as e, type ApplyDnsRecordResult as f, type ApplyDnsResult as g, type Asset as h, type Automation as i, type AutomationResult as j, type AutomationRun as k, type AutomationRunResponse as l, type AutomationRunStatus as m, type AutomationRunStep as n, type AutomationRunStepStatus as o, type AutomationStatus as p, type AutomationStep as q, type AutomationTrigger as r, type BounceType as s, type CategoryOptOutCategory as t, type CategoryUnsubscribedErrorDetails as u, type ConnectTwilioParams as v, type ContactWebhookEventPayload as w, type CreateApiKeyParams as x, type CreateApiKeyResult as y, type CreateAutomationParams as z };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { A as ApiErrorBody, D as DnsRecord } from './client-
|
|
2
|
-
export { a as ApiErrorCode, b as ApiKey, c as
|
|
1
|
+
import { A as ApiErrorBody, D as DnsRecord } from './client-C6Cu0xLT.js';
|
|
2
|
+
export { a as ApiErrorCode, b as ApiKey, c as ApiKeyMigrationParams, d as ApiKeyScope, e as ApplyDnsParams, f as ApplyDnsRecordResult, g as ApplyDnsResult, h as Asset, i as Automation, j as AutomationResult, k as AutomationRun, l as AutomationRunResponse, m as AutomationRunStatus, n as AutomationRunStep, o as AutomationRunStepStatus, p as AutomationStatus, q as AutomationStep, r as AutomationTrigger, B as BatchSendEmailResult, s as BounceType, C as CategoryOptOut, t as CategoryOptOutCategory, u as CategoryUnsubscribedErrorDetails, v as ConnectTwilioParams, w as ContactWebhookEventPayload, x as CreateApiKeyParams, y as CreateApiKeyResult, z as CreateAutomationParams, E as CreateDomainParams, F as CreateDomainResult, H as CreateMigrationParams, I as CreateSuppressionParams, J as CreateTemplateParams, K as CreateTenantParams, L as CreateWebhookParams, M as DEFAULT_API_BASE_URL, N as DailyRampLimitErrorDetails, O as DeleteTenantResult, P as DeliverabilityBucket, Q as DeliverabilityDomainInsight, R as DeliverabilityInsightsResult, T as DeliverabilityMailServerRelay, U as DeliverabilityWindow, V as DmarcDailyPoint, W as DmarcMonitoring, X as DmarcMonitoringDisabled, Y as DmarcReadiness, Z as DmarcReadinessVerdict, _ as DmarcSource, $ as DmarcSourceStatus, a0 as DmarcStatus, a1 as DnsProviderName, a2 as Domain, a3 as DomainBimiAnalysis, a4 as DomainBlocklistListing, a5 as DomainBlocklistStatus, a6 as DomainBlocklists, a7 as DomainDetailResult, a8 as DomainDmarcAnalysis, a9 as DomainDnsAnalysis, aa as DomainStatus, ab as DomainTlsMode, ac as DomainTrackingDns, ad as DomainTrackingStatus, ae as EmailDelivery, af as EmailListItem, ag as EmailWebhookEventPayload, ah as EmailWebhookEventType, ai as EnableDmarcParams, aj as EnableDmarcResult, ak as EnrollmentSkip, al as EventRecord, G as Groundmail, am as GroundmailAccessToken, an as GroundmailOptions, ao as GroundmailTokenOptions, ap as GroundmailTokenProvider, aq as HeldBackErrorDetails, ar as HeldBackReason, as as HeldBackRecipient, at as InReplyToEmail, au as ListApiKeysParams, av as ListApiKeysResult, aw as ListAutomationRunsParams, ax as ListAutomationRunsResult, ay as ListAutomationsResult, az as ListCategoryOptOutsParams, aA as ListCategoryOptOutsResult, aB as ListDomainsParams, aC as ListDomainsResult, aD as ListEmailsParams, aE as ListEmailsResult, aF as ListReceivedEmailsParams, aG as ListReceivedEmailsResult, aH as ListSuppressionsParams, aI as ListSuppressionsResult, aJ as ListTemplatesParams, aK as ListTemplatesResult, aL as ListTenantDomainsResult, aM as ListTenantsParams, aN as ListTenantsResult, aO as ListTestInboxEmailsParams, aP as ListTestInboxEmailsResult, aQ as MailServerSigningStatus, aR as MailStream, aS as Migration, aT as MigrationDnsChange, aU as MigrationDnsPlan, aV as MigrationDomainItem, aW as MigrationItemStatus, aX as MigrationProvider, aY as MigrationResource, aZ as MigrationSummary, a_ as MigrationTemplateItem, a$ as MigrationTotals, b0 as MigrationWebhookItem, b1 as ReceivedEmail, b2 as ReceivedEmailAttachment, b3 as ReceivedEmailAttachmentMeta, b4 as RemoteApplyDnsCredentials, b5 as RemoveCategoryOptOutOptions, b6 as RunMigrationOptions, b7 as SendEmailParams, S as SendEmailResult, b8 as SesMigrationParams, b9 as StreamDeliverability, ba as SuppressedErrorDetails, bb as Suppression, bc as TEST_INBOX_WAIT_DEFAULT_MS, bd as TEST_INBOX_WAIT_MAX_SECONDS, be as Template, bf as TemplateFormat, bg as TemplateLintWarning, bh as TemplateStarter, bi as TemplateStatus, bj as TemplateVersion, bk as Tenant, bl as TenantPauseSource, bm as TenantRamp, bn as TenantStats, bo as TenantStatsResult, bp as TenantStatus, bq as TenantStreamPolicy, br as TestEmailWebhookParams, bs as TestEmailWebhookResult, bt as TestInbox, bu as TestInboxAddressOptions, bv as TestInboxEmail, bw as TestInboxEmailDetail, bx as TestInboxHeader, by as TestInboxResource, bz as TestInboxUsage, bA as TriggerEventParams, bB as TriggerEventResult, bC as TwilioIntegrationResponse, bD as TwilioIntegrationStatus, bE as UpdateAutomationParams, bF as UpdateDomainParams, bG as UpdateEmailParams, bH as UpdateTemplateParams, bI as UpdateTenantParams, bJ as UpdateWebhookParams, bK as ValidateEmailResult, bL as ValidationReason, bM as ValidationVerdict, bN as VerifyDomainResult, bO as WaitForTestEmailParams, bP as WebhookEmailTag, bQ as WebhookEndpoint, bR as WebhookEndpointWithSecret, bS as WebhookEventType, bT as mergeMigrations, bU as normalizeAccessToken } from './client-C6Cu0xLT.js';
|
|
3
3
|
|
|
4
4
|
type GroundmailErrorOptions = {
|
|
5
5
|
code?: string;
|
package/dist/payload.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "groundmail",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.32.0",
|
|
4
4
|
"description": "Groundmail transactional email API client",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -89,7 +89,7 @@
|
|
|
89
89
|
"prepublishOnly": "npm run build && npm run build:nodemailer-bridge"
|
|
90
90
|
},
|
|
91
91
|
"dependencies": {
|
|
92
|
-
"groundmail-nodemailer": "0.15.
|
|
92
|
+
"groundmail-nodemailer": "0.15.21"
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
95
|
"@types/nodemailer": "^8.0.1",
|