groundmail 0.21.0 → 0.23.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 +1 -1
- package/dist/authjs.js +1 -1
- package/dist/better-auth.d.ts +1 -1
- package/dist/better-auth.js +1 -1
- package/dist/{chunk-2RKWN4OE.js → chunk-QBGTN2WD.js} +1 -0
- package/dist/clerk.d.ts +1 -1
- package/dist/clerk.js +1 -1
- package/dist/{client-DmLWvBuY.d.ts → client-CTG4zTKw.d.ts} +46 -4
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/payload.d.ts +1 -1
- package/dist/payload.js +1 -1
- package/package.json +2 -2
package/dist/authjs.d.ts
CHANGED
package/dist/authjs.js
CHANGED
package/dist/better-auth.d.ts
CHANGED
package/dist/better-auth.js
CHANGED
|
@@ -1038,6 +1038,7 @@ var EmailsResource = class {
|
|
|
1038
1038
|
if (params.cursor) search.set("cursor", params.cursor);
|
|
1039
1039
|
if (params.test != null) search.set("test", String(params.test));
|
|
1040
1040
|
if (params.tenant) search.set("tenant", params.tenant);
|
|
1041
|
+
if (params.stream) search.set("stream", params.stream);
|
|
1041
1042
|
const query = search.toString();
|
|
1042
1043
|
return this.client.request(`/emails${query ? `?${query}` : ""}`, {
|
|
1043
1044
|
method: "GET"
|
package/dist/clerk.d.ts
CHANGED
package/dist/clerk.js
CHANGED
|
@@ -2,7 +2,9 @@ type ApiErrorCode = 'validation_error' | 'unauthorized' | 'forbidden' | 'not_fou
|
|
|
2
2
|
/** 429: the send would go over a new account's daily ramp-up limit; see `details.resets_at`. */
|
|
3
3
|
| 'daily_ramp_limit'
|
|
4
4
|
/** 403: the request names a tenant, but tenants are not enabled for this account (Scale and Dedicated plans). */
|
|
5
|
-
| 'tenants_not_enabled'
|
|
5
|
+
| 'tenants_not_enabled'
|
|
6
|
+
/** 403: the send uses `category: 'newsletter'`, but newsletter sending isn't enabled on this account (approved accounts only). */
|
|
7
|
+
| 'newsletter_not_enabled' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
|
|
6
8
|
type SendEmailParams = {
|
|
7
9
|
from: string | {
|
|
8
10
|
email: string;
|
|
@@ -58,9 +60,11 @@ type SendEmailParams = {
|
|
|
58
60
|
/**
|
|
59
61
|
* Optional category override. `product` (onboarding, lifecycle, notifications)
|
|
60
62
|
* honours category opt-outs and is sent from a separate IP pool. `newsletter`
|
|
61
|
-
* is
|
|
63
|
+
* (opt-in newsletters) is accepted only for approved accounts, is sent from its
|
|
64
|
+
* own IPs, always carries one-click unsubscribe, and otherwise fails with 403
|
|
65
|
+
* `newsletter_not_enabled`.
|
|
62
66
|
*/
|
|
63
|
-
category?: 'transactional' | 'product';
|
|
67
|
+
category?: 'transactional' | 'product' | 'newsletter';
|
|
64
68
|
/**
|
|
65
69
|
* Send as one of your tenants (its external id or Groundmail id). The send uses that
|
|
66
70
|
* tenant's domains, suppression list, pause switch and daily limit. Omit to send from
|
|
@@ -164,6 +168,8 @@ type EmailListItem = {
|
|
|
164
168
|
* simulator addresses. Its status and events are simulated.
|
|
165
169
|
*/
|
|
166
170
|
test: boolean;
|
|
171
|
+
/** Mail stream it went out on (each sends from its own IPs). */
|
|
172
|
+
stream?: MailStream;
|
|
167
173
|
tags: unknown;
|
|
168
174
|
scheduled_at: string | null;
|
|
169
175
|
cancelled_at: string | null;
|
|
@@ -232,6 +238,8 @@ type ListEmailsParams = {
|
|
|
232
238
|
test?: boolean;
|
|
233
239
|
/** Only this tenant's emails (external id or Groundmail id). */
|
|
234
240
|
tenant?: string;
|
|
241
|
+
/** Only emails sent on this mail stream. */
|
|
242
|
+
stream?: MailStream;
|
|
235
243
|
};
|
|
236
244
|
type ListEmailsResult = {
|
|
237
245
|
emails: EmailListItem[];
|
|
@@ -280,6 +288,21 @@ type DeliverabilityInsightsResult = {
|
|
|
280
288
|
count: number;
|
|
281
289
|
}>;
|
|
282
290
|
notes: string[];
|
|
291
|
+
/** Sent, bounced and complained per mail stream over the last 24 hours, for streams with activity. */
|
|
292
|
+
by_stream_24h?: StreamDeliverability[];
|
|
293
|
+
};
|
|
294
|
+
/**
|
|
295
|
+
* The mail stream an email goes out on, from its `category`. Each stream sends from
|
|
296
|
+
* its own IPs. `newsletter` is for approved accounts only.
|
|
297
|
+
*/
|
|
298
|
+
type MailStream = 'transactional' | 'product' | 'newsletter';
|
|
299
|
+
type StreamDeliverability = {
|
|
300
|
+
stream: MailStream;
|
|
301
|
+
sent: number;
|
|
302
|
+
bounced: number;
|
|
303
|
+
complained: number;
|
|
304
|
+
bounce_rate: number;
|
|
305
|
+
complaint_rate: number;
|
|
283
306
|
};
|
|
284
307
|
type ApiKeyScope = 'full' | 'sending';
|
|
285
308
|
type ApiKey = {
|
|
@@ -366,6 +389,11 @@ type CreateSmtpCredentialResult = SmtpCredential & {
|
|
|
366
389
|
password: string;
|
|
367
390
|
};
|
|
368
391
|
type WebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.held' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled' | 'contact.unsubscribed' | 'automation.started' | 'automation.step_completed' | 'automation.completed' | 'automation.failed';
|
|
392
|
+
/** A tag on a webhook payload: the email's tags as sent, as `{ name, value }` pairs. */
|
|
393
|
+
type WebhookEmailTag = {
|
|
394
|
+
name: string;
|
|
395
|
+
value: string;
|
|
396
|
+
};
|
|
369
397
|
/** Outbound `email.*` webhook payload (everything except `email.received`). */
|
|
370
398
|
type EmailWebhookEventPayload = {
|
|
371
399
|
type: Exclude<EmailWebhookEventType, 'email.received'>;
|
|
@@ -379,10 +407,17 @@ type EmailWebhookEventPayload = {
|
|
|
379
407
|
bounce_reason?: string | null;
|
|
380
408
|
/** Set on `email.bounced` and `email.failed` when the email bounced: `hard` or `block`. */
|
|
381
409
|
bounce_type?: BounceType | null;
|
|
410
|
+
/**
|
|
411
|
+
* The email's tags as sent (`[]` when it had none), so you can match an event
|
|
412
|
+
* to your own records without storing the email id first.
|
|
413
|
+
*/
|
|
414
|
+
tags?: WebhookEmailTag[];
|
|
382
415
|
/** `true` on simulated events (test keys, simulator addresses, `POST /emails/test`). Absent on real mail. */
|
|
383
416
|
test?: true;
|
|
384
417
|
/** The tenant's external id, when the email was sent as a tenant. */
|
|
385
418
|
tenant?: string;
|
|
419
|
+
/** The mail stream the email went out on. */
|
|
420
|
+
stream?: MailStream;
|
|
386
421
|
/** On `email.held`: why the email was held before sending. */
|
|
387
422
|
held_reason?: string;
|
|
388
423
|
/** On `email.held` when content scanning held it: the score. */
|
|
@@ -402,6 +437,13 @@ type ContactWebhookEventPayload = {
|
|
|
402
437
|
suppression_id?: string | null;
|
|
403
438
|
category_opt_out_id?: string | null;
|
|
404
439
|
email_id?: string | null;
|
|
440
|
+
/**
|
|
441
|
+
* The tenant's external id when the unsubscribed email was sent as a tenant.
|
|
442
|
+
* The opt-out or suppression then applies to that tenant only.
|
|
443
|
+
*/
|
|
444
|
+
tenant?: string;
|
|
445
|
+
/** The unsubscribed email's tags as sent; present when `email_id` is. */
|
|
446
|
+
tags?: WebhookEmailTag[];
|
|
405
447
|
};
|
|
406
448
|
};
|
|
407
449
|
/** `details` on `POST /emails` 422 when recipients opted out of a category. */
|
|
@@ -1658,4 +1700,4 @@ declare class Groundmail {
|
|
|
1658
1700
|
request<T>(path: string, init: RequestInit): Promise<T>;
|
|
1659
1701
|
}
|
|
1660
1702
|
|
|
1661
|
-
export { type Domain as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryUnsubscribedErrorDetails as C, type DnsRecord as D, type CreateSuppressionParams as E, type CreateTemplateParams as F, Groundmail as G, type CreateTenantParams as H, type CreateWebhookParams as I, DEFAULT_API_BASE_URL as J, type DailyRampLimitErrorDetails as K, type DeleteTenantResult as L, type DeliverabilityBucket as M, type DeliverabilityDomainInsight as N, type DeliverabilityInsightsResult as O, type DeliverabilityMailServerRelay as P, type DeliverabilityWindow as Q, type DmarcDailyPoint as R, type SendEmailResult as S, type DmarcMonitoring as T, type DmarcMonitoringDisabled as U, type DmarcReadiness as V, type DmarcReadinessVerdict as W, type DmarcSource as X, type DmarcSourceStatus as Y, type DmarcStatus as Z, type DnsProviderName as _, type ApiErrorCode as a, type
|
|
1703
|
+
export { type Domain as $, type ApiErrorBody as A, type BatchSendEmailResult as B, type CategoryUnsubscribedErrorDetails as C, type DnsRecord as D, type CreateSuppressionParams as E, type CreateTemplateParams as F, Groundmail as G, type CreateTenantParams as H, type CreateWebhookParams as I, DEFAULT_API_BASE_URL as J, type DailyRampLimitErrorDetails as K, type DeleteTenantResult as L, type DeliverabilityBucket as M, type DeliverabilityDomainInsight as N, type DeliverabilityInsightsResult as O, type DeliverabilityMailServerRelay as P, type DeliverabilityWindow as Q, type DmarcDailyPoint as R, type SendEmailResult as S, type DmarcMonitoring as T, type DmarcMonitoringDisabled as U, type DmarcReadiness as V, type DmarcReadinessVerdict as W, type DmarcSource as X, type DmarcSourceStatus as Y, type DmarcStatus as Z, type DnsProviderName as _, type ApiErrorCode as a, type TemplateStatus as a$, type DomainBimiAnalysis as a0, type DomainDetailResult as a1, type DomainDmarcAnalysis as a2, type DomainDnsAnalysis as a3, type DomainStatus as a4, type DomainTlsMode as a5, type DomainTrackingDns as a6, type DomainTrackingStatus as a7, type EmailListItem as a8, type EmailWebhookEventPayload as a9, type ListTenantsResult as aA, type MailServerSigningStatus as aB, type MailStream as aC, type Migration as aD, type MigrationDnsChange as aE, type MigrationDnsPlan as aF, type MigrationDomainItem as aG, type MigrationItemStatus as aH, type MigrationProvider as aI, type MigrationResource as aJ, type MigrationSummary as aK, type MigrationTemplateItem as aL, type MigrationTotals as aM, type MigrationWebhookItem as aN, type ReceivedEmail as aO, type ReceivedEmailAttachment as aP, type ReceivedEmailAttachmentMeta as aQ, type RemoteApplyDnsCredentials as aR, type RunMigrationOptions as aS, type SendEmailParams as aT, type StreamDeliverability as aU, type SuppressedErrorDetails as aV, type Suppression as aW, type Template as aX, type TemplateFormat as aY, type TemplateLintWarning as aZ, type TemplateStarter as a_, type EmailWebhookEventType as aa, type EnableDmarcParams as ab, type EnableDmarcResult as ac, type EnrollmentSkip as ad, type EventRecord as ae, type GroundmailOptions as af, type HeldBackErrorDetails as ag, type HeldBackReason as ah, type HeldBackRecipient as ai, type ListApiKeysParams as aj, type ListApiKeysResult as ak, type ListAutomationRunsParams as al, type ListAutomationRunsResult as am, type ListAutomationsResult as an, type ListDomainsParams as ao, type ListDomainsResult as ap, type ListEmailsParams as aq, type ListEmailsResult as ar, type ListReceivedEmailsParams as as, type ListReceivedEmailsResult as at, type ListSuppressionsParams as au, type ListSuppressionsResult as av, type ListTemplatesParams as aw, type ListTemplatesResult as ax, type ListTenantDomainsResult as ay, type ListTenantsParams as az, type ApiKey as b, type TemplateVersion as b0, type Tenant as b1, type TenantPauseSource as b2, type TenantRamp as b3, type TenantStats as b4, type TenantStatsResult as b5, type TenantStatus as b6, type TenantStreamPolicy as b7, type TestEmailWebhookParams as b8, type TestEmailWebhookResult 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 WebhookEmailTag as bo, type WebhookEndpoint as bp, type WebhookEndpointWithSecret as bq, type WebhookEventType as br, mergeMigrations as bs, type ApiKeyScope as c, type ApplyDnsParams as d, type ApplyDnsRecordResult as e, type ApplyDnsResult as f, type Asset as g, type Automation as h, type AutomationResult as i, type AutomationRun as j, type AutomationRunResponse as k, type AutomationRunStatus as l, type AutomationRunStep as m, type AutomationRunStepStatus as n, type AutomationStatus as o, type AutomationStep as p, type AutomationTrigger as q, type BounceType as r, type ConnectTwilioParams as s, type ContactWebhookEventPayload as t, type CreateApiKeyParams as u, type CreateApiKeyResult as v, type CreateAutomationParams as w, type CreateDomainParams as x, type CreateDomainResult as y, type CreateMigrationParams 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 ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryUnsubscribedErrorDetails, s as ConnectTwilioParams, t as ContactWebhookEventPayload, u as CreateApiKeyParams, v as CreateApiKeyResult, w as CreateAutomationParams, x as CreateDomainParams, y as CreateDomainResult, z as CreateMigrationParams, E as CreateSuppressionParams, F as CreateTemplateParams, H as CreateTenantParams, I as CreateWebhookParams, J as DEFAULT_API_BASE_URL, K as DailyRampLimitErrorDetails, L as DeleteTenantResult, M as DeliverabilityBucket, N as DeliverabilityDomainInsight, O as DeliverabilityInsightsResult, P as DeliverabilityMailServerRelay, Q as DeliverabilityWindow, R as DmarcDailyPoint, T as DmarcMonitoring, U as DmarcMonitoringDisabled, V as DmarcReadiness, W as DmarcReadinessVerdict, X as DmarcSource, Y as DmarcSourceStatus, Z as DmarcStatus, _ as DnsProviderName, $ as Domain, a0 as DomainBimiAnalysis, a1 as DomainDetailResult, a2 as DomainDmarcAnalysis, a3 as DomainDnsAnalysis, a4 as DomainStatus, a5 as DomainTlsMode, a6 as DomainTrackingDns, a7 as DomainTrackingStatus, a8 as EmailListItem, a9 as EmailWebhookEventPayload, aa as EmailWebhookEventType, ab as EnableDmarcParams, ac as EnableDmarcResult, ad as EnrollmentSkip, ae as EventRecord, G as Groundmail, af as GroundmailOptions, ag as HeldBackErrorDetails, ah as HeldBackReason, ai as HeldBackRecipient, aj as ListApiKeysParams, ak as ListApiKeysResult, al as ListAutomationRunsParams, am as ListAutomationRunsResult, an as ListAutomationsResult, ao as ListDomainsParams, ap as ListDomainsResult, aq as ListEmailsParams, ar as ListEmailsResult, as as ListReceivedEmailsParams, at as ListReceivedEmailsResult, au as ListSuppressionsParams, av as ListSuppressionsResult, aw as ListTemplatesParams, ax as ListTemplatesResult, ay as ListTenantDomainsResult, az as ListTenantsParams, aA as ListTenantsResult, aB as MailServerSigningStatus, aC as
|
|
1
|
+
import { A as ApiErrorBody, D as DnsRecord } from './client-CTG4zTKw.js';
|
|
2
|
+
export { a as ApiErrorCode, b as ApiKey, c as ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryUnsubscribedErrorDetails, s as ConnectTwilioParams, t as ContactWebhookEventPayload, u as CreateApiKeyParams, v as CreateApiKeyResult, w as CreateAutomationParams, x as CreateDomainParams, y as CreateDomainResult, z as CreateMigrationParams, E as CreateSuppressionParams, F as CreateTemplateParams, H as CreateTenantParams, I as CreateWebhookParams, J as DEFAULT_API_BASE_URL, K as DailyRampLimitErrorDetails, L as DeleteTenantResult, M as DeliverabilityBucket, N as DeliverabilityDomainInsight, O as DeliverabilityInsightsResult, P as DeliverabilityMailServerRelay, Q as DeliverabilityWindow, R as DmarcDailyPoint, T as DmarcMonitoring, U as DmarcMonitoringDisabled, V as DmarcReadiness, W as DmarcReadinessVerdict, X as DmarcSource, Y as DmarcSourceStatus, Z as DmarcStatus, _ as DnsProviderName, $ as Domain, a0 as DomainBimiAnalysis, a1 as DomainDetailResult, a2 as DomainDmarcAnalysis, a3 as DomainDnsAnalysis, a4 as DomainStatus, a5 as DomainTlsMode, a6 as DomainTrackingDns, a7 as DomainTrackingStatus, a8 as EmailListItem, a9 as EmailWebhookEventPayload, aa as EmailWebhookEventType, ab as EnableDmarcParams, ac as EnableDmarcResult, ad as EnrollmentSkip, ae as EventRecord, G as Groundmail, af as GroundmailOptions, ag as HeldBackErrorDetails, ah as HeldBackReason, ai as HeldBackRecipient, aj as ListApiKeysParams, ak as ListApiKeysResult, al as ListAutomationRunsParams, am as ListAutomationRunsResult, an as ListAutomationsResult, ao as ListDomainsParams, ap as ListDomainsResult, aq as ListEmailsParams, ar as ListEmailsResult, as as ListReceivedEmailsParams, at as ListReceivedEmailsResult, au as ListSuppressionsParams, av as ListSuppressionsResult, aw as ListTemplatesParams, ax as ListTemplatesResult, ay as ListTenantDomainsResult, az as ListTenantsParams, aA as ListTenantsResult, aB as MailServerSigningStatus, aC as MailStream, aD as Migration, aE as MigrationDnsChange, aF as MigrationDnsPlan, aG as MigrationDomainItem, aH as MigrationItemStatus, aI as MigrationProvider, aJ as MigrationResource, aK as MigrationSummary, aL as MigrationTemplateItem, aM as MigrationTotals, aN as MigrationWebhookItem, aO as ReceivedEmail, aP as ReceivedEmailAttachment, aQ as ReceivedEmailAttachmentMeta, aR as RemoteApplyDnsCredentials, aS as RunMigrationOptions, aT as SendEmailParams, S as SendEmailResult, aU as StreamDeliverability, aV as SuppressedErrorDetails, aW as Suppression, aX as Template, aY as TemplateFormat, aZ as TemplateLintWarning, a_ as TemplateStarter, a$ as TemplateStatus, b0 as TemplateVersion, b1 as Tenant, b2 as TenantPauseSource, b3 as TenantRamp, b4 as TenantStats, b5 as TenantStatsResult, b6 as TenantStatus, b7 as TenantStreamPolicy, b8 as TestEmailWebhookParams, b9 as TestEmailWebhookResult, 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 WebhookEmailTag, bp as WebhookEndpoint, bq as WebhookEndpointWithSecret, br as WebhookEventType, bs as mergeMigrations } from './client-CTG4zTKw.js';
|
|
3
3
|
|
|
4
4
|
type GroundmailErrorOptions = {
|
|
5
5
|
code?: string;
|
package/dist/index.js
CHANGED
package/dist/payload.d.ts
CHANGED
package/dist/payload.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "groundmail",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.23.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.9"
|
|
93
93
|
},
|
|
94
94
|
"devDependencies": {
|
|
95
95
|
"@types/nodemailer": "^8.0.1",
|