groundmail 0.22.0 → 0.23.0

package/dist/authjs.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-XU99yezY.js';
+import { G as Groundmail } from './client-CTG4zTKw.js';
 
 /** Subset of Auth.js theme used for the default magic-link email. */
 type AuthjsTheme = {

package/dist/better-auth.d.ts

@@ -1,4 +1,4 @@
-import { S as SendEmailResult, G as Groundmail } from './client-XU99yezY.js';
+import { S as SendEmailResult, G as Groundmail } from './client-CTG4zTKw.js';
 
 type BetterAuthEmailUser = {
     email: string;

package/dist/clerk.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail, S as SendEmailResult } from './client-XU99yezY.js';
+import { G as Groundmail, S as SendEmailResult } from './client-CTG4zTKw.js';
 
 /**
  * Subset of Clerk `email.created` webhook `data` used for delivery.

package/dist/{client-XU99yezY.d.ts → client-CTG4zTKw.d.ts}

@@ -389,6 +389,11 @@ type CreateSmtpCredentialResult = SmtpCredential & {
     password: string;
 };
 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';
+/** A tag on a webhook payload: the email's tags as sent, as `{ name, value }` pairs. */
+type WebhookEmailTag = {
+    name: string;
+    value: string;
+};
 /** Outbound `email.*` webhook payload (everything except `email.received`). */
 type EmailWebhookEventPayload = {
     type: Exclude<EmailWebhookEventType, 'email.received'>;
@@ -402,6 +407,11 @@ type EmailWebhookEventPayload = {
         bounce_reason?: string | null;
         /** Set on `email.bounced` and `email.failed` when the email bounced: `hard` or `block`. */
         bounce_type?: BounceType | null;
+        /**
+         * The email's tags as sent (`[]` when it had none), so you can match an event
+         * to your own records without storing the email id first.
+         */
+        tags?: WebhookEmailTag[];
         /** `true` on simulated events (test keys, simulator addresses, `POST /emails/test`). Absent on real mail. */
         test?: true;
         /** The tenant's external id, when the email was sent as a tenant. */
@@ -427,6 +437,13 @@ type ContactWebhookEventPayload = {
         suppression_id?: string | null;
         category_opt_out_id?: string | null;
         email_id?: string | null;
+        /**
+         * The tenant's external id when the unsubscribed email was sent as a tenant.
+         * The opt-out or suppression then applies to that tenant only.
+         */
+        tenant?: string;
+        /** The unsubscribed email's tags as sent; present when `email_id` is. */
+        tags?: WebhookEmailTag[];
     };
 };
 /** `details` on `POST /emails` 422 when recipients opted out of a category. */
@@ -1683,4 +1700,4 @@ declare class Groundmail {
     request<T>(path: string, init: RequestInit): Promise<T>;
 }
 
-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 WebhookEndpoint as bo, type WebhookEndpointWithSecret as bp, type WebhookEventType as bq, mergeMigrations as br, 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 };
+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

@@ -1,5 +1,5 @@
-import { A as ApiErrorBody, D as DnsRecord } from './client-XU99yezY.js';
-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 WebhookEndpoint, bp as WebhookEndpointWithSecret, bq as WebhookEventType, br as mergeMigrations } from './client-XU99yezY.js';
+import { A as ApiErrorBody, D as DnsRecord } from './client-CTG4zTKw.js';
+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';
 
 type GroundmailErrorOptions = {
     code?: string;

package/dist/payload.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-XU99yezY.js';
+import { G as Groundmail } from './client-CTG4zTKw.js';
 
 /**
  * Minimal Payload `SendEmailOptions` / address shapes used by this adapter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Groundmail transactional email API client",
   "license": "MIT",
   "type": "module",
@@ -89,7 +89,7 @@
     "prepublishOnly": "npm run build && npm run build:nodemailer-bridge"
   },
   "dependencies": {
-    "groundmail-nodemailer": "0.15.8"
+    "groundmail-nodemailer": "0.15.9"
   },
   "devDependencies": {
     "@types/nodemailer": "^8.0.1",