groundmail 0.30.0 → 0.31.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
|
@@ -1143,17 +1143,10 @@ type ApiErrorBody = {
|
|
|
1143
1143
|
message?: string;
|
|
1144
1144
|
};
|
|
1145
1145
|
/** Providers the importer reads from (Beta). */
|
|
1146
|
-
type MigrationProvider = 'sendgrid' | 'postmark' | 'mailgun';
|
|
1146
|
+
type MigrationProvider = 'sendgrid' | 'postmark' | 'mailgun' | 'resend' | 'ses';
|
|
1147
1147
|
type MigrationResource = 'domains' | 'webhooks' | 'templates' | 'suppressions';
|
|
1148
1148
|
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';
|
|
1149
|
+
type MigrationRunParams = {
|
|
1157
1150
|
/** What to import; all four by default. */
|
|
1158
1151
|
resources?: MigrationResource[];
|
|
1159
1152
|
/** Preview without writing anything. */
|
|
@@ -1161,6 +1154,33 @@ type CreateMigrationParams = {
|
|
|
1161
1154
|
/** `next_cursor` from the previous response, to continue. */
|
|
1162
1155
|
cursor?: string;
|
|
1163
1156
|
};
|
|
1157
|
+
/** SendGrid, Postmark, Mailgun and Resend: one API key. */
|
|
1158
|
+
type ApiKeyMigrationParams = MigrationRunParams & {
|
|
1159
|
+
provider: Exclude<MigrationProvider, 'ses'>;
|
|
1160
|
+
/**
|
|
1161
|
+
* SendGrid API key, Postmark server token, Mailgun private key, or a Resend key with
|
|
1162
|
+
* Full access. Used for the import only; never stored.
|
|
1163
|
+
*/
|
|
1164
|
+
api_key: string;
|
|
1165
|
+
/** Postmark only: the account token, needed to import sending domains. */
|
|
1166
|
+
account_api_key?: string;
|
|
1167
|
+
/** SendGrid and Mailgun: `eu` for EU-region accounts. */
|
|
1168
|
+
region?: 'us' | 'eu';
|
|
1169
|
+
};
|
|
1170
|
+
/**
|
|
1171
|
+
* Amazon SES: an access key for an IAM user or role with the read-only import
|
|
1172
|
+
* policy, and one region. Used for the import only; never stored.
|
|
1173
|
+
*/
|
|
1174
|
+
type SesMigrationParams = MigrationRunParams & {
|
|
1175
|
+
provider: 'ses';
|
|
1176
|
+
aws_access_key_id: string;
|
|
1177
|
+
aws_secret_access_key: string;
|
|
1178
|
+
/** Temporary credentials (SSO, an assumed role) only. */
|
|
1179
|
+
aws_session_token?: string;
|
|
1180
|
+
/** e.g. `us-east-1`. Run the import again for each other region you send from. */
|
|
1181
|
+
aws_region: string;
|
|
1182
|
+
};
|
|
1183
|
+
type CreateMigrationParams = ApiKeyMigrationParams | SesMigrationParams;
|
|
1164
1184
|
/**
|
|
1165
1185
|
* Running totals. Suppressions also count by kind: `bounce`, `complaint`,
|
|
1166
1186
|
* `unsubscribe`, `manual`, and `product_opt_out` (opt-outs that were never
|
|
@@ -1695,8 +1715,9 @@ declare class KeysResource {
|
|
|
1695
1715
|
/** Combine the reports of one import's requests: every item, the latest totals. */
|
|
1696
1716
|
declare function mergeMigrations(previous: Migration | null, next: Migration): Migration;
|
|
1697
1717
|
/**
|
|
1698
|
-
* Import templates, suppressions, domains and webhooks from SendGrid, Postmark
|
|
1699
|
-
* or
|
|
1718
|
+
* Import templates, suppressions, domains and webhooks from SendGrid, Postmark,
|
|
1719
|
+
* Mailgun, Resend or Amazon SES (Beta). The provider key (SES: access key and
|
|
1720
|
+
* secret) is sent with each request and never stored.
|
|
1700
1721
|
*/
|
|
1701
1722
|
declare class MigrationsResource {
|
|
1702
1723
|
private readonly client;
|
|
@@ -1946,7 +1967,7 @@ declare class Groundmail {
|
|
|
1946
1967
|
readonly templates: TemplatesResource;
|
|
1947
1968
|
/** Your platform's customers, each with its own domains, suppressions, stats and limits. */
|
|
1948
1969
|
readonly tenants: TenantsResource;
|
|
1949
|
-
/** Import from SendGrid, Postmark or
|
|
1970
|
+
/** Import from SendGrid, Postmark, Mailgun, Resend or Amazon SES (Beta). */
|
|
1950
1971
|
readonly migrations: MigrationsResource;
|
|
1951
1972
|
/** DMARC monitoring per domain: report address, sources, pass rates and readiness. */
|
|
1952
1973
|
readonly dmarc: DmarcResource;
|
|
@@ -1987,4 +2008,4 @@ declare function normalizeAccessToken(value: GroundmailAccessToken | null | unde
|
|
|
1987
2008
|
expiresAt: number | null;
|
|
1988
2009
|
};
|
|
1989
2010
|
|
|
1990
|
-
export { type
|
|
2011
|
+
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 ReceivedEmailAttachment as a$, type DmarcStatus as a0, type DnsProviderName as a1, type Domain as a2, type DomainBimiAnalysis as a3, type DomainDetailResult as a4, type DomainDmarcAnalysis as a5, type DomainDnsAnalysis as a6, type DomainStatus as a7, type DomainTlsMode as a8, type DomainTrackingDns as a9, type ListEmailsParams as aA, type ListEmailsResult as aB, type ListReceivedEmailsParams as aC, type ListReceivedEmailsResult as aD, type ListSuppressionsParams as aE, type ListSuppressionsResult as aF, type ListTemplatesParams as aG, type ListTemplatesResult as aH, type ListTenantDomainsResult as aI, type ListTenantsParams as aJ, type ListTenantsResult as aK, type ListTestInboxEmailsParams as aL, type ListTestInboxEmailsResult as aM, type MailServerSigningStatus as aN, type MailStream as aO, type Migration as aP, type MigrationDnsChange as aQ, type MigrationDnsPlan as aR, type MigrationDomainItem as aS, type MigrationItemStatus as aT, type MigrationProvider as aU, type MigrationResource as aV, type MigrationSummary as aW, type MigrationTemplateItem as aX, type MigrationTotals as aY, type MigrationWebhookItem as aZ, type ReceivedEmail as a_, type DomainTrackingStatus as aa, type EmailDelivery as ab, type EmailListItem as ac, type EmailWebhookEventPayload as ad, type EmailWebhookEventType as ae, type EnableDmarcParams as af, type EnableDmarcResult as ag, type EnrollmentSkip as ah, type EventRecord as ai, type GroundmailAccessToken as aj, type GroundmailOptions as ak, type GroundmailTokenOptions as al, type GroundmailTokenProvider as am, type HeldBackErrorDetails as an, type HeldBackReason as ao, type HeldBackRecipient as ap, type InReplyToEmail as aq, type ListApiKeysParams as ar, type ListApiKeysResult as as, type ListAutomationRunsParams as at, type ListAutomationRunsResult as au, type ListAutomationsResult as av, type ListCategoryOptOutsParams as aw, type ListCategoryOptOutsResult as ax, type ListDomainsParams as ay, type ListDomainsResult as az, type ApiKey as b, type ReceivedEmailAttachmentMeta as b0, type RemoteApplyDnsCredentials as b1, type RemoveCategoryOptOutOptions as b2, type RunMigrationOptions as b3, type SendEmailParams as b4, type SesMigrationParams as b5, type StreamDeliverability as b6, type SuppressedErrorDetails as b7, type Suppression as b8, TEST_INBOX_WAIT_DEFAULT_MS as b9, type TwilioIntegrationStatus as bA, type UpdateAutomationParams as bB, type UpdateDomainParams as bC, type UpdateEmailParams as bD, type UpdateTemplateParams as bE, type UpdateTenantParams as bF, type UpdateWebhookParams as bG, type ValidateEmailResult as bH, type ValidationReason as bI, type ValidationVerdict as bJ, type VerifyDomainResult as bK, type WaitForTestEmailParams as bL, type WebhookEmailTag as bM, type WebhookEndpoint as bN, type WebhookEndpointWithSecret as bO, type WebhookEventType as bP, mergeMigrations as bQ, normalizeAccessToken as bR, TEST_INBOX_WAIT_MAX_SECONDS as ba, type Template as bb, type TemplateFormat as bc, type TemplateLintWarning as bd, type TemplateStarter as be, type TemplateStatus as bf, type TemplateVersion as bg, type Tenant as bh, type TenantPauseSource as bi, type TenantRamp as bj, type TenantStats as bk, type TenantStatsResult as bl, type TenantStatus as bm, type TenantStreamPolicy as bn, type TestEmailWebhookParams as bo, type TestEmailWebhookResult as bp, type TestInbox as bq, type TestInboxAddressOptions as br, type TestInboxEmail as bs, type TestInboxEmailDetail as bt, type TestInboxHeader as bu, TestInboxResource as bv, type TestInboxUsage as bw, type TriggerEventParams as bx, type TriggerEventResult as by, type TwilioIntegrationResponse 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-CKFcXIXY.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 DomainDetailResult, a5 as DomainDmarcAnalysis, a6 as DomainDnsAnalysis, a7 as DomainStatus, a8 as DomainTlsMode, a9 as DomainTrackingDns, aa as DomainTrackingStatus, ab as EmailDelivery, ac as EmailListItem, ad as EmailWebhookEventPayload, ae as EmailWebhookEventType, af as EnableDmarcParams, ag as EnableDmarcResult, ah as EnrollmentSkip, ai as EventRecord, G as Groundmail, aj as GroundmailAccessToken, ak as GroundmailOptions, al as GroundmailTokenOptions, am as GroundmailTokenProvider, an as HeldBackErrorDetails, ao as HeldBackReason, ap as HeldBackRecipient, aq as InReplyToEmail, ar as ListApiKeysParams, as as ListApiKeysResult, at as ListAutomationRunsParams, au as ListAutomationRunsResult, av as ListAutomationsResult, aw as ListCategoryOptOutsParams, ax as ListCategoryOptOutsResult, ay as ListDomainsParams, az as ListDomainsResult, aA as ListEmailsParams, aB as ListEmailsResult, aC as ListReceivedEmailsParams, aD as ListReceivedEmailsResult, aE as ListSuppressionsParams, aF as ListSuppressionsResult, aG as ListTemplatesParams, aH as ListTemplatesResult, aI as ListTenantDomainsResult, aJ as ListTenantsParams, aK as ListTenantsResult, aL as ListTestInboxEmailsParams, aM as ListTestInboxEmailsResult, aN as MailServerSigningStatus, aO as MailStream, aP as Migration, aQ as MigrationDnsChange, aR as MigrationDnsPlan, aS as MigrationDomainItem, aT as MigrationItemStatus, aU as MigrationProvider, aV as MigrationResource, aW as MigrationSummary, aX as MigrationTemplateItem, aY as MigrationTotals, aZ as MigrationWebhookItem, a_ as ReceivedEmail, a$ as ReceivedEmailAttachment, b0 as ReceivedEmailAttachmentMeta, b1 as RemoteApplyDnsCredentials, b2 as RemoveCategoryOptOutOptions, b3 as RunMigrationOptions, b4 as SendEmailParams, S as SendEmailResult, b5 as SesMigrationParams, b6 as StreamDeliverability, b7 as SuppressedErrorDetails, b8 as Suppression, b9 as TEST_INBOX_WAIT_DEFAULT_MS, ba as TEST_INBOX_WAIT_MAX_SECONDS, bb as Template, bc as TemplateFormat, bd as TemplateLintWarning, be as TemplateStarter, bf as TemplateStatus, bg as TemplateVersion, bh as Tenant, bi as TenantPauseSource, bj as TenantRamp, bk as TenantStats, bl as TenantStatsResult, bm as TenantStatus, bn as TenantStreamPolicy, bo as TestEmailWebhookParams, bp as TestEmailWebhookResult, bq as TestInbox, br as TestInboxAddressOptions, bs as TestInboxEmail, bt as TestInboxEmailDetail, bu as TestInboxHeader, bv as TestInboxResource, bw as TestInboxUsage, bx as TriggerEventParams, by as TriggerEventResult, bz as TwilioIntegrationResponse, bA as TwilioIntegrationStatus, bB as UpdateAutomationParams, bC as UpdateDomainParams, bD as UpdateEmailParams, bE as UpdateTemplateParams, bF as UpdateTenantParams, bG as UpdateWebhookParams, bH as ValidateEmailResult, bI as ValidationReason, bJ as ValidationVerdict, bK as VerifyDomainResult, bL as WaitForTestEmailParams, bM as WebhookEmailTag, bN as WebhookEndpoint, bO as WebhookEndpointWithSecret, bP as WebhookEventType, bQ as mergeMigrations, bR as normalizeAccessToken } from './client-CKFcXIXY.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.31.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.20"
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
95
|
"@types/nodemailer": "^8.0.1",
|