groundmail 0.39.1 → 0.40.0

package/dist/authjs.d.ts

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

package/dist/authjs.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-H53CAVEH.js";
 
 // src/authjs.ts
 function escapeHtml(value) {

package/dist/better-auth.d.ts

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

package/dist/better-auth.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-H53CAVEH.js";
 
 // src/better-auth.ts
 function linkHtml(label, url) {

package/dist/{chunk-V4ZZRJ3Q.js → chunk-H53CAVEH.js}

@@ -1702,6 +1702,7 @@ var EmailsResource = class {
       payload.scheduled_at = scheduledAt instanceof Date ? scheduledAt.toISOString() : scheduledAt;
     }
     if (params.unsubscribe !== void 0) payload.unsubscribe = params.unsubscribe;
+    if (params.validation !== void 0) payload.validation = params.validation;
     if (params.category !== void 0) payload.category = params.category;
     if (params.tenant !== void 0) payload.tenant = params.tenant;
     return payload;

package/dist/clerk.d.ts

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

package/dist/clerk.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-H53CAVEH.js";
 
 // src/clerk.ts
 function resolveApiKey(options) {

package/dist/{client-CTQyEXww.d.ts → client-CtzyzXO3.d.ts}

@@ -76,6 +76,14 @@ type SendEmailParams = {
      * `newsletter_not_enabled`.
      */
     category?: 'transactional' | 'product' | 'newsletter';
+    /**
+     * Opt-in checks for this send. `block_bot_signups` holds back addresses that look
+     * like bots filled them into a form (reason `likely_bot_signup`). It's a pattern
+     * check and it can be wrong: use it for sign-up emails, not password resets.
+     */
+    validation?: {
+        block_bot_signups?: boolean;
+    };
     /**
      * Send as one of your tenants (its external id or Groundmail id). The send uses that
      * tenant's domains, suppression list, pause switch and daily limit. Omit to send from
@@ -90,8 +98,10 @@ type SendEmailParams = {
  * - `previously_bounced`: the address hard-bounced (mailbox does not exist) for a Groundmail
  *   sender in the last 90 days.
  * - `mailbox_not_found`: Groundmail validation already knows the mailbox does not exist.
+ * - `likely_bot_signup`: the address looks like a bot filled it into a form. Only when the
+ *   send sets `validation: { block_bot_signups: true }`.
  */
-type HeldBackReason = 'invalid_address' | 'no_mail_server' | 'previously_bounced' | 'mailbox_not_found';
+type HeldBackReason = 'invalid_address' | 'no_mail_server' | 'previously_bounced' | 'mailbox_not_found' | 'likely_bot_signup';
 type HeldBackRecipient = {
     email: string;
     reason: HeldBackReason | (string & {});
@@ -112,10 +122,10 @@ type HeldBackErrorDetails = {
 type ValidationVerdict = 'valid' | 'risky' | 'invalid';
 /**
  * - invalid: `syntax`, `no_mail_server`, `mailbox_not_found`, `previously_bounced`
- * - risky: `disposable`, `catch_all`, `possible_typo`
+ * - risky: `disposable`, `catch_all`, `possible_typo`, `likely_bot_signup`
  * - informational (does not change the verdict): `role`
  */
-type ValidationReason = 'syntax' | 'no_mail_server' | 'mailbox_not_found' | 'previously_bounced' | 'disposable' | 'catch_all' | 'possible_typo' | 'role';
+type ValidationReason = 'syntax' | 'no_mail_server' | 'mailbox_not_found' | 'previously_bounced' | 'disposable' | 'catch_all' | 'possible_typo' | 'likely_bot_signup' | 'role';
 /** `POST /validate` result. */
 type ValidateEmailResult = {
     /** The address as checked: trimmed and lowercased. */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiErrorBody, D as DnsRecord } from './client-CTQyEXww.js';
-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 AutomationBranchQuestion, k as AutomationBranchStep, l as AutomationInlineEmail, m as AutomationResult, n as AutomationRun, o as AutomationRunResponse, p as AutomationRunStatus, q as AutomationRunStep, r as AutomationRunStepStatus, s as AutomationSendEmailStep, t as AutomationStatus, u as AutomationStep, v as AutomationTemplateEmail, w as AutomationTrigger, B as Batch, x as BatchSendEmailResult, y as BounceType, z as Brand, C as BrandLogo, E as BrandSettings, F as CancelBatchResult, H as CategoryOptOut, I as CategoryOptOutCategory, J as CategoryUnsubscribedErrorDetails, K as ConnectTwilioParams, L as ContactWebhookEventPayload, M as CreateApiKeyParams, N as CreateApiKeyResult, O as CreateAutomationParams, P as CreateDomainParams, Q as CreateDomainResult, R as CreateMigrationParams, T as CreateSenderParams, U as CreateSuppressionParams, V as CreateTemplateParams, W as CreateTenantParams, X as CreateWebhookParams, Y as DEFAULT_API_BASE_URL, Z as DailyRampLimitErrorDetails, _ as DeleteTenantResult, $ as DeliverabilityBucket, a0 as DeliverabilityDomainInsight, a1 as DeliverabilityInsightsResult, a2 as DeliverabilityMailServerRelay, a3 as DeliverabilityWindow, a4 as DmarcDailyPoint, a5 as DmarcMonitoring, a6 as DmarcMonitoringDisabled, a7 as DmarcReadiness, a8 as DmarcReadinessVerdict, a9 as DmarcSource, aa as DmarcSourceStatus, ab as DmarcStatus, ac as DnsProviderName, ad as Domain, ae as DomainBimiAnalysis, af as DomainBlocklistListing, ag as DomainBlocklistStatus, ah as DomainBlocklists, ai as DomainDetailResult, aj as DomainDmarcAnalysis, ak as DomainDnsAnalysis, al as DomainStatus, am as DomainTlsMode, an as DomainTrackingDns, ao as DomainTrackingStatus, ap as EmailDelivery, aq as EmailListItem, ar as EmailWebhookEventPayload, as as EmailWebhookEventType, at as EnableDmarcParams, au as EnableDmarcResult, av as EnrollmentSkip, aw as EventRecord, G as Groundmail, ax as GroundmailAccessToken, ay as GroundmailOptions, az as GroundmailTokenOptions, aA as GroundmailTokenProvider, aB as HeldBackErrorDetails, aC as HeldBackReason, aD as HeldBackRecipient, aE as InReplyToEmail, aF as ListApiKeysParams, aG as ListApiKeysResult, aH as ListAutomationRunsParams, aI as ListAutomationRunsResult, aJ as ListAutomationsResult, aK as ListCategoryOptOutsParams, aL as ListCategoryOptOutsResult, aM as ListDomainsParams, aN as ListDomainsResult, aO as ListEmailsParams, aP as ListEmailsResult, aQ as ListReceivedEmailsParams, aR as ListReceivedEmailsResult, aS as ListSendersResult, aT as ListSuppressionsParams, aU as ListSuppressionsResult, aV as ListTemplatesParams, aW as ListTemplatesResult, aX as ListTenantDomainsResult, aY as ListTenantsParams, aZ as ListTenantsResult, a_ as ListTestInboxEmailsParams, a$ as ListTestInboxEmailsResult, b0 as ListWebhookDeliveriesParams, b1 as ListWebhookDeliveriesResult, b2 as MailServerSigningStatus, b3 as MailStream, b4 as Migration, b5 as MigrationDnsChange, b6 as MigrationDnsPlan, b7 as MigrationDomainItem, b8 as MigrationItemStatus, b9 as MigrationProvider, ba as MigrationResource, bb as MigrationSummary, bc as MigrationTemplateItem, bd as MigrationTotals, be as MigrationWebhookItem, bf as ReceivedEmail, bg as ReceivedEmailAttachment, bh as ReceivedEmailAttachmentMeta, bi as RemoteApplyDnsCredentials, bj as RemoveCategoryOptOutOptions, bk as RunMigrationOptions, bl as SendEmailParams, S as SendEmailResult, bm as Sender, bn as SesMigrationParams, bo as StreamDeliverability, bp as SuppressedErrorDetails, bq as Suppression, br as TEST_INBOX_WAIT_DEFAULT_MS, bs as TEST_INBOX_WAIT_MAX_SECONDS, bt as Template, bu as TemplateFormat, bv as TemplateLintWarning, bw as TemplateStarter, bx as TemplateStatus, by as TemplateVersion, bz as Tenant, bA as TenantPauseSource, bB as TenantRamp, bC as TenantStats, bD as TenantStatsResult, bE as TenantStatus, bF as TenantStreamPolicy, bG as TestEmailWebhookParams, bH as TestEmailWebhookResult, bI as TestInbox, bJ as TestInboxAddressOptions, bK as TestInboxEmail, bL as TestInboxEmailDetail, bM as TestInboxHeader, bN as TestInboxResource, bO as TestInboxUsage, bP as TriggerEventParams, bQ as TriggerEventResult, bR as TwilioIntegrationResponse, bS as TwilioIntegrationStatus, bT as UpdateAutomationParams, bU as UpdateBrandParams, bV as UpdateDomainParams, bW as UpdateEmailParams, bX as UpdateSenderParams, bY as UpdateTemplateParams, bZ as UpdateTenantParams, b_ as UpdateWebhookParams, b$ as ValidateEmailResult, c0 as ValidationReason, c1 as ValidationVerdict, c2 as VerifyDomainResult, c3 as WaitForTestEmailParams, c4 as WebhookDelivery, c5 as WebhookDeliveryAttempt, c6 as WebhookDeliveryDetail, c7 as WebhookDeliveryStatus, c8 as WebhookEmailTag, c9 as WebhookEndpoint, ca as WebhookEndpointHealth, cb as WebhookEndpointWithSecret, cc as WebhookEventType, cd as mergeMigrations, ce as normalizeAccessToken } from './client-CTQyEXww.js';
+import { A as ApiErrorBody, D as DnsRecord } from './client-CtzyzXO3.js';
+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 AutomationBranchQuestion, k as AutomationBranchStep, l as AutomationInlineEmail, m as AutomationResult, n as AutomationRun, o as AutomationRunResponse, p as AutomationRunStatus, q as AutomationRunStep, r as AutomationRunStepStatus, s as AutomationSendEmailStep, t as AutomationStatus, u as AutomationStep, v as AutomationTemplateEmail, w as AutomationTrigger, B as Batch, x as BatchSendEmailResult, y as BounceType, z as Brand, C as BrandLogo, E as BrandSettings, F as CancelBatchResult, H as CategoryOptOut, I as CategoryOptOutCategory, J as CategoryUnsubscribedErrorDetails, K as ConnectTwilioParams, L as ContactWebhookEventPayload, M as CreateApiKeyParams, N as CreateApiKeyResult, O as CreateAutomationParams, P as CreateDomainParams, Q as CreateDomainResult, R as CreateMigrationParams, T as CreateSenderParams, U as CreateSuppressionParams, V as CreateTemplateParams, W as CreateTenantParams, X as CreateWebhookParams, Y as DEFAULT_API_BASE_URL, Z as DailyRampLimitErrorDetails, _ as DeleteTenantResult, $ as DeliverabilityBucket, a0 as DeliverabilityDomainInsight, a1 as DeliverabilityInsightsResult, a2 as DeliverabilityMailServerRelay, a3 as DeliverabilityWindow, a4 as DmarcDailyPoint, a5 as DmarcMonitoring, a6 as DmarcMonitoringDisabled, a7 as DmarcReadiness, a8 as DmarcReadinessVerdict, a9 as DmarcSource, aa as DmarcSourceStatus, ab as DmarcStatus, ac as DnsProviderName, ad as Domain, ae as DomainBimiAnalysis, af as DomainBlocklistListing, ag as DomainBlocklistStatus, ah as DomainBlocklists, ai as DomainDetailResult, aj as DomainDmarcAnalysis, ak as DomainDnsAnalysis, al as DomainStatus, am as DomainTlsMode, an as DomainTrackingDns, ao as DomainTrackingStatus, ap as EmailDelivery, aq as EmailListItem, ar as EmailWebhookEventPayload, as as EmailWebhookEventType, at as EnableDmarcParams, au as EnableDmarcResult, av as EnrollmentSkip, aw as EventRecord, G as Groundmail, ax as GroundmailAccessToken, ay as GroundmailOptions, az as GroundmailTokenOptions, aA as GroundmailTokenProvider, aB as HeldBackErrorDetails, aC as HeldBackReason, aD as HeldBackRecipient, aE as InReplyToEmail, aF as ListApiKeysParams, aG as ListApiKeysResult, aH as ListAutomationRunsParams, aI as ListAutomationRunsResult, aJ as ListAutomationsResult, aK as ListCategoryOptOutsParams, aL as ListCategoryOptOutsResult, aM as ListDomainsParams, aN as ListDomainsResult, aO as ListEmailsParams, aP as ListEmailsResult, aQ as ListReceivedEmailsParams, aR as ListReceivedEmailsResult, aS as ListSendersResult, aT as ListSuppressionsParams, aU as ListSuppressionsResult, aV as ListTemplatesParams, aW as ListTemplatesResult, aX as ListTenantDomainsResult, aY as ListTenantsParams, aZ as ListTenantsResult, a_ as ListTestInboxEmailsParams, a$ as ListTestInboxEmailsResult, b0 as ListWebhookDeliveriesParams, b1 as ListWebhookDeliveriesResult, b2 as MailServerSigningStatus, b3 as MailStream, b4 as Migration, b5 as MigrationDnsChange, b6 as MigrationDnsPlan, b7 as MigrationDomainItem, b8 as MigrationItemStatus, b9 as MigrationProvider, ba as MigrationResource, bb as MigrationSummary, bc as MigrationTemplateItem, bd as MigrationTotals, be as MigrationWebhookItem, bf as ReceivedEmail, bg as ReceivedEmailAttachment, bh as ReceivedEmailAttachmentMeta, bi as RemoteApplyDnsCredentials, bj as RemoveCategoryOptOutOptions, bk as RunMigrationOptions, bl as SendEmailParams, S as SendEmailResult, bm as Sender, bn as SesMigrationParams, bo as StreamDeliverability, bp as SuppressedErrorDetails, bq as Suppression, br as TEST_INBOX_WAIT_DEFAULT_MS, bs as TEST_INBOX_WAIT_MAX_SECONDS, bt as Template, bu as TemplateFormat, bv as TemplateLintWarning, bw as TemplateStarter, bx as TemplateStatus, by as TemplateVersion, bz as Tenant, bA as TenantPauseSource, bB as TenantRamp, bC as TenantStats, bD as TenantStatsResult, bE as TenantStatus, bF as TenantStreamPolicy, bG as TestEmailWebhookParams, bH as TestEmailWebhookResult, bI as TestInbox, bJ as TestInboxAddressOptions, bK as TestInboxEmail, bL as TestInboxEmailDetail, bM as TestInboxHeader, bN as TestInboxResource, bO as TestInboxUsage, bP as TriggerEventParams, bQ as TriggerEventResult, bR as TwilioIntegrationResponse, bS as TwilioIntegrationStatus, bT as UpdateAutomationParams, bU as UpdateBrandParams, bV as UpdateDomainParams, bW as UpdateEmailParams, bX as UpdateSenderParams, bY as UpdateTemplateParams, bZ as UpdateTenantParams, b_ as UpdateWebhookParams, b$ as ValidateEmailResult, c0 as ValidationReason, c1 as ValidationVerdict, c2 as VerifyDomainResult, c3 as WaitForTestEmailParams, c4 as WebhookDelivery, c5 as WebhookDeliveryAttempt, c6 as WebhookDeliveryDetail, c7 as WebhookDeliveryStatus, c8 as WebhookEmailTag, c9 as WebhookEndpoint, ca as WebhookEndpointHealth, cb as WebhookEndpointWithSecret, cc as WebhookEventType, cd as mergeMigrations, ce as normalizeAccessToken } from './client-CtzyzXO3.js';
 
 type GroundmailErrorOptions = {
     code?: string;

package/dist/index.js

@@ -12,7 +12,7 @@ import {
   normalizeAccessToken,
   signWebhookPayload,
   verifyWebhookSignature
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-H53CAVEH.js";
 
 // src/simulator.ts
 var SIMULATOR_DOMAIN = "simulator.groundmail.dev";

package/dist/payload.d.ts

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

package/dist/payload.js

@@ -1,7 +1,7 @@
 import {
   DEFAULT_API_BASE_URL,
   Groundmail
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-H53CAVEH.js";
 
 // src/payload.ts
 function resolveApiKey(args) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail",
-  "version": "0.39.1",
+  "version": "0.40.0",
   "description": "Groundmail transactional email API client",
   "license": "MIT",
   "type": "module",