groundmail 0.39.1 → 0.41.0

package/dist/authjs.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-CTQyEXww.js';
+import { G as Groundmail } from './client-B_H1iNa7.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-65NWGUZM.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-B_H1iNa7.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-65NWGUZM.js";
 
 // src/better-auth.ts
 function linkHtml(label, url) {

package/dist/{chunk-V4ZZRJ3Q.js → chunk-65NWGUZM.js}

@@ -48,6 +48,69 @@ var GroundmailError = class _GroundmailError extends Error {
   }
 };
 
+// src/burrowguard.ts
+var BurrowGuardSitesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list() {
+    return this.client.request("/burrowguard/sites", { method: "GET" });
+  }
+  async get(id) {
+    return this.client.request(`/burrowguard/sites/${encodeURIComponent(id)}`, { method: "GET" });
+  }
+  /** The response holds the secret, once. */
+  async create(params) {
+    return this.client.request("/burrowguard/sites", { method: "POST", body: JSON.stringify(params) });
+  }
+  async update(id, params) {
+    return this.client.request(`/burrowguard/sites/${encodeURIComponent(id)}`, { method: "PATCH", body: JSON.stringify(params) });
+  }
+  /** A new secret, returned once. The old one stops working at once. */
+  async rollSecret(id) {
+    return this.client.request(`/burrowguard/sites/${encodeURIComponent(id)}/secret`, { method: "POST" });
+  }
+  async remove(id) {
+    await this.client.request(`/burrowguard/sites/${encodeURIComponent(id)}`, { method: "DELETE" });
+  }
+};
+var BurrowGuardChecksResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async list(params = {}) {
+    const query = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+      if (value !== void 0) query.set(key, String(value));
+    }
+    const suffix = query.size ? `?${query}` : "";
+    return this.client.request(`/burrowguard/checks${suffix}`, { method: "GET" });
+  }
+};
+var BurrowGuardResource = class {
+  constructor(client) {
+    this.client = client;
+    this.sites = new BurrowGuardSitesResource(client);
+    this.checks = new BurrowGuardChecksResource(client);
+  }
+  /**
+   * Check a form submission from your server. If we can't be reached this returns
+   * `success: true` with `limited: true`, so a sign-up never fails because of us. A wrong
+   * secret still throws: that's a broken install to fix.
+   */
+  async verify(params) {
+    try {
+      return await this.client.request("/burrowguard/verify", {
+        method: "POST",
+        body: JSON.stringify({ token: params.token ?? null, email: params.email })
+      });
+    } catch (error) {
+      if (error instanceof GroundmailError && error.status >= 400 && error.status < 500) throw error;
+      return { success: true, reason: null, limited: true };
+    }
+  }
+};
+
 // src/dns/spf.ts
 function mergeSpfInclude(existing, includeHost) {
   const include = `include:${includeHost.replace(/^include:/i, "")}`;
@@ -1702,6 +1765,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;
@@ -2219,6 +2283,7 @@ var _Groundmail = class _Groundmail {
     this.suppressions = new SuppressionsResource(this);
     this.templates = new TemplatesResource(this);
     this.senders = new SendersResource(this);
+    this.burrowguard = new BurrowGuardResource(this);
     this.brand = new BrandResource(this);
     this.tenants = new TenantsResource(this);
     this.migrations = new MigrationsResource(this);
@@ -2316,6 +2381,7 @@ function jwtExpiry(token) {
 
 export {
   GroundmailError,
+  BurrowGuardResource,
   mergeSpfInclude,
   applyDnsRecords,
   mergeMigrations,

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-B_H1iNa7.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-65NWGUZM.js";
 
 // src/clerk.ts
 function resolveApiKey(options) {

package/dist/{client-CTQyEXww.d.ts → client-B_H1iNa7.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. */
@@ -1878,6 +1888,128 @@ declare class BatchesResource {
     cancel(batchId: string): Promise<CancelBatchResult>;
 }
 
+type BurrowGuardReason = 'no_token' | 'invalid_token' | 'expired_token' | 'token_used' | 'email_mismatch' | 'invalid_format' | 'no_mail_server' | 'disposable' | 'bounce_history' | 'bot_dot_stuffed_gmail' | 'bot_gibberish' | 'free_webmail' | 'scripted_browser' | 'too_fast' | 'abusive_ip' | 'tor' | 'data_center_ip';
+type BurrowGuardVerifyParams = {
+    /** The `burrowguard-token` field from the form. Empty when the script didn't run. Leave out on a site with `email_checks_only`. */
+    token?: string | null;
+    /** The address from the same form. */
+    email: string;
+};
+type BurrowGuardVerifyResult = {
+    /** True: accept the sign-up. */
+    success: boolean;
+    /**
+     * Why not, for your logs. Never show it to the visitor. `no_token` means the script didn't
+     * run and the email checks passed: accept it, or your form breaks for those visitors.
+     */
+    reason: BurrowGuardReason | null;
+    /** Set when nothing was checked: over the monthly limit, rate limited, or we couldn't be reached. */
+    limited?: true;
+};
+type BurrowGuardSite = {
+    id: string;
+    name: string;
+    /** Public: goes in your page. */
+    site_key: string;
+    allowed_hostnames: string[];
+    block_free_webmail: boolean;
+    allow_data_center_ips: boolean;
+    /** No script or token: verify takes the email and runs the address checks only. */
+    email_checks_only: boolean;
+    last_check_at: string | null;
+    created_at: string;
+};
+type BurrowGuardSiteWithSecret = BurrowGuardSite & {
+    /** `gm_bg_…`. Returned once. Keep it on your server. */
+    secret: string;
+};
+type CreateBurrowGuardSiteParams = {
+    name: string;
+    /** Hostnames the form runs on. Keep `localhost` while you build. Optional with `email_checks_only`. */
+    allowed_hostnames?: string[];
+    /** For B2B forms: turn away Gmail, Outlook and other personal addresses. */
+    block_free_webmail?: boolean;
+    /** Let through visitors on hosting and cloud networks. */
+    allow_data_center_ips?: boolean;
+    /** Already using a captcha? No script or box: one server call checks the address. */
+    email_checks_only?: boolean;
+};
+type UpdateBurrowGuardSiteParams = Partial<CreateBurrowGuardSiteParams>;
+type BurrowGuardCheck = {
+    id: string;
+    site_id: string;
+    created_at: string;
+    /** The address is never stored: its domain and a one-way hash only. */
+    email_domain: string | null;
+    result: 'passed' | 'blocked' | 'no_token';
+    reason: BurrowGuardReason | null;
+    reason_label: string | null;
+    ip: string | null;
+    user_agent: string | null;
+};
+type ListBurrowGuardChecksParams = {
+    /** A site's id. */
+    site?: string;
+    result?: 'passed' | 'blocked' | 'no_token';
+    range?: '24h' | '7d' | '30d';
+    limit?: number;
+    cursor?: string;
+};
+type ListBurrowGuardChecksResult = {
+    data: BurrowGuardCheck[];
+    has_more: boolean;
+    next_cursor: string | null;
+    stats: {
+        checked: number;
+        passed: number;
+        blocked: number;
+        no_token: number;
+        top_reason: BurrowGuardReason | null;
+    };
+    usage: {
+        month: string;
+        used: number;
+        limit: number;
+        limited: boolean;
+    };
+};
+declare class BurrowGuardSitesResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(): Promise<{
+        data: BurrowGuardSite[];
+    }>;
+    get(id: string): Promise<BurrowGuardSite>;
+    /** The response holds the secret, once. */
+    create(params: CreateBurrowGuardSiteParams): Promise<BurrowGuardSiteWithSecret>;
+    update(id: string, params: UpdateBurrowGuardSiteParams): Promise<BurrowGuardSite>;
+    /** A new secret, returned once. The old one stops working at once. */
+    rollSecret(id: string): Promise<BurrowGuardSiteWithSecret>;
+    remove(id: string): Promise<void>;
+}
+declare class BurrowGuardChecksResource {
+    private readonly client;
+    constructor(client: Groundmail);
+    list(params?: ListBurrowGuardChecksParams): Promise<ListBurrowGuardChecksResult>;
+}
+/**
+ * BurrowGuard: a free bot and bad-address blocker for sign-up and contact forms.
+ * `sites` and `checks` take an API key. `verify` takes the site secret instead:
+ * `new Groundmail(process.env.GROUNDMAIL_BURROWGUARD_SECRET).burrowguard.verify({ token, email })`.
+ */
+declare class BurrowGuardResource {
+    private readonly client;
+    readonly sites: BurrowGuardSitesResource;
+    readonly checks: BurrowGuardChecksResource;
+    constructor(client: Groundmail);
+    /**
+     * Check a form submission from your server. If we can't be reached this returns
+     * `success: true` with `limited: true`, so a sign-up never fails because of us. A wrong
+     * secret still throws: that's a broken install to fix.
+     */
+    verify(params: BurrowGuardVerifyParams): Promise<BurrowGuardVerifyResult>;
+}
+
 /** Status of one sending source in the DMARC reports. `unknown`: an unrecognised server failing DMARC (possible spoofing). */
 type DmarcSourceStatus = 'passing' | 'failing' | 'unknown';
 type DmarcSource = {
@@ -2398,6 +2530,8 @@ declare class Groundmail {
     readonly dmarc: DmarcResource;
     /** Hosted test inbox: catch test mail from any provider and wait for it in your tests. */
     readonly testInbox: TestInboxResource;
+    /** BurrowGuard: keep bots and bad addresses out of your sign-up and contact forms. */
+    readonly burrowguard: BurrowGuardResource;
     private readonly apiKey;
     private readonly options;
     private readonly getToken;
@@ -2433,4 +2567,4 @@ declare function normalizeAccessToken(value: GroundmailAccessToken | null | unde
     expiresAt: number | null;
 };
 
-export { type DeliverabilityBucket as $, type ApiErrorBody as A, type Batch as B, type BrandLogo as C, type DnsRecord as D, type BrandSettings as E, type CancelBatchResult as F, Groundmail as G, type CategoryOptOut as H, type CategoryOptOutCategory as I, type CategoryUnsubscribedErrorDetails as J, type ConnectTwilioParams as K, type ContactWebhookEventPayload as L, type CreateApiKeyParams as M, type CreateApiKeyResult as N, type CreateAutomationParams as O, type CreateDomainParams as P, type CreateDomainResult as Q, type CreateMigrationParams as R, type SendEmailResult as S, type CreateSenderParams as T, type CreateSuppressionParams as U, type CreateTemplateParams as V, type CreateTenantParams as W, type CreateWebhookParams as X, DEFAULT_API_BASE_URL as Y, type DailyRampLimitErrorDetails as Z, type DeleteTenantResult as _, type ApiErrorCode as a, type ListTestInboxEmailsResult as a$, type DeliverabilityDomainInsight as a0, type DeliverabilityInsightsResult as a1, type DeliverabilityMailServerRelay as a2, type DeliverabilityWindow as a3, type DmarcDailyPoint as a4, type DmarcMonitoring as a5, type DmarcMonitoringDisabled as a6, type DmarcReadiness as a7, type DmarcReadinessVerdict as a8, type DmarcSource as a9, type GroundmailTokenProvider as aA, type HeldBackErrorDetails as aB, type HeldBackReason as aC, type HeldBackRecipient as aD, type InReplyToEmail as aE, type ListApiKeysParams as aF, type ListApiKeysResult as aG, type ListAutomationRunsParams as aH, type ListAutomationRunsResult as aI, type ListAutomationsResult as aJ, type ListCategoryOptOutsParams as aK, type ListCategoryOptOutsResult as aL, type ListDomainsParams as aM, type ListDomainsResult as aN, type ListEmailsParams as aO, type ListEmailsResult as aP, type ListReceivedEmailsParams as aQ, type ListReceivedEmailsResult as aR, type ListSendersResult as aS, type ListSuppressionsParams as aT, type ListSuppressionsResult as aU, type ListTemplatesParams as aV, type ListTemplatesResult as aW, type ListTenantDomainsResult as aX, type ListTenantsParams as aY, type ListTenantsResult as aZ, type ListTestInboxEmailsParams as a_, type DmarcSourceStatus as aa, type DmarcStatus as ab, type DnsProviderName as ac, type Domain as ad, type DomainBimiAnalysis as ae, type DomainBlocklistListing as af, type DomainBlocklistStatus as ag, type DomainBlocklists as ah, type DomainDetailResult as ai, type DomainDmarcAnalysis as aj, type DomainDnsAnalysis as ak, type DomainStatus as al, type DomainTlsMode as am, type DomainTrackingDns as an, type DomainTrackingStatus as ao, type EmailDelivery as ap, type EmailListItem as aq, type EmailWebhookEventPayload as ar, type EmailWebhookEventType as as, type EnableDmarcParams as at, type EnableDmarcResult as au, type EnrollmentSkip as av, type EventRecord as aw, type GroundmailAccessToken as ax, type GroundmailOptions as ay, type GroundmailTokenOptions as az, type ApiKey as b, type ValidateEmailResult as b$, type ListWebhookDeliveriesParams as b0, type ListWebhookDeliveriesResult as b1, type MailServerSigningStatus as b2, type MailStream as b3, type Migration as b4, type MigrationDnsChange as b5, type MigrationDnsPlan as b6, type MigrationDomainItem as b7, type MigrationItemStatus as b8, type MigrationProvider as b9, type TenantPauseSource as bA, type TenantRamp as bB, type TenantStats as bC, type TenantStatsResult as bD, type TenantStatus as bE, type TenantStreamPolicy as bF, type TestEmailWebhookParams as bG, type TestEmailWebhookResult as bH, type TestInbox as bI, type TestInboxAddressOptions as bJ, type TestInboxEmail as bK, type TestInboxEmailDetail as bL, type TestInboxHeader as bM, TestInboxResource as bN, type TestInboxUsage as bO, type TriggerEventParams as bP, type TriggerEventResult as bQ, type TwilioIntegrationResponse as bR, type TwilioIntegrationStatus as bS, type UpdateAutomationParams as bT, type UpdateBrandParams as bU, type UpdateDomainParams as bV, type UpdateEmailParams as bW, type UpdateSenderParams as bX, type UpdateTemplateParams as bY, type UpdateTenantParams as bZ, type UpdateWebhookParams as b_, type MigrationResource as ba, type MigrationSummary as bb, type MigrationTemplateItem as bc, type MigrationTotals as bd, type MigrationWebhookItem as be, type ReceivedEmail as bf, type ReceivedEmailAttachment as bg, type ReceivedEmailAttachmentMeta as bh, type RemoteApplyDnsCredentials as bi, type RemoveCategoryOptOutOptions as bj, type RunMigrationOptions as bk, type SendEmailParams as bl, type Sender as bm, type SesMigrationParams as bn, type StreamDeliverability as bo, type SuppressedErrorDetails as bp, type Suppression as bq, TEST_INBOX_WAIT_DEFAULT_MS as br, TEST_INBOX_WAIT_MAX_SECONDS as bs, type Template as bt, type TemplateFormat as bu, type TemplateLintWarning as bv, type TemplateStarter as bw, type TemplateStatus as bx, type TemplateVersion as by, type Tenant as bz, type ApiKeyMigrationParams as c, type ValidationReason as c0, type ValidationVerdict as c1, type VerifyDomainResult as c2, type WaitForTestEmailParams as c3, type WebhookDelivery as c4, type WebhookDeliveryAttempt as c5, type WebhookDeliveryDetail as c6, type WebhookDeliveryStatus as c7, type WebhookEmailTag as c8, type WebhookEndpoint as c9, type WebhookEndpointHealth as ca, type WebhookEndpointWithSecret as cb, type WebhookEventType as cc, mergeMigrations as cd, normalizeAccessToken as ce, 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 AutomationBranchQuestion as j, type AutomationBranchStep as k, type AutomationInlineEmail as l, type AutomationResult as m, type AutomationRun as n, type AutomationRunResponse as o, type AutomationRunStatus as p, type AutomationRunStep as q, type AutomationRunStepStatus as r, type AutomationSendEmailStep as s, type AutomationStatus as t, type AutomationStep as u, type AutomationTemplateEmail as v, type AutomationTrigger as w, type BatchSendEmailResult as x, type BounceType as y, type Brand as z };
+export { type CreateSenderParams as $, type ApiErrorBody as A, type Batch as B, type BrandLogo as C, type DnsRecord as D, type BrandSettings as E, type BurrowGuardCheck as F, Groundmail as G, type BurrowGuardReason as H, BurrowGuardResource as I, type BurrowGuardSite as J, type BurrowGuardSiteWithSecret as K, type BurrowGuardVerifyParams as L, type BurrowGuardVerifyResult as M, type CancelBatchResult as N, type CategoryOptOut as O, type CategoryOptOutCategory as P, type CategoryUnsubscribedErrorDetails as Q, type ConnectTwilioParams as R, type SendEmailResult as S, type ContactWebhookEventPayload as T, type CreateApiKeyParams as U, type CreateApiKeyResult as V, type CreateAutomationParams as W, type CreateBurrowGuardSiteParams as X, type CreateDomainParams as Y, type CreateDomainResult as Z, type CreateMigrationParams as _, type ApiErrorCode as a, type ListReceivedEmailsResult as a$, type CreateSuppressionParams as a0, type CreateTemplateParams as a1, type CreateTenantParams as a2, type CreateWebhookParams as a3, DEFAULT_API_BASE_URL as a4, type DailyRampLimitErrorDetails as a5, type DeleteTenantResult as a6, type DeliverabilityBucket as a7, type DeliverabilityDomainInsight as a8, type DeliverabilityInsightsResult as a9, type EmailWebhookEventType as aA, type EnableDmarcParams as aB, type EnableDmarcResult as aC, type EnrollmentSkip as aD, type EventRecord as aE, type GroundmailAccessToken as aF, type GroundmailOptions as aG, type GroundmailTokenOptions as aH, type GroundmailTokenProvider as aI, type HeldBackErrorDetails as aJ, type HeldBackReason as aK, type HeldBackRecipient as aL, type InReplyToEmail as aM, type ListApiKeysParams as aN, type ListApiKeysResult as aO, type ListAutomationRunsParams as aP, type ListAutomationRunsResult as aQ, type ListAutomationsResult as aR, type ListBurrowGuardChecksParams as aS, type ListBurrowGuardChecksResult as aT, type ListCategoryOptOutsParams as aU, type ListCategoryOptOutsResult as aV, type ListDomainsParams as aW, type ListDomainsResult as aX, type ListEmailsParams as aY, type ListEmailsResult as aZ, type ListReceivedEmailsParams as a_, type DeliverabilityMailServerRelay as aa, type DeliverabilityWindow as ab, type DmarcDailyPoint as ac, type DmarcMonitoring as ad, type DmarcMonitoringDisabled as ae, type DmarcReadiness as af, type DmarcReadinessVerdict as ag, type DmarcSource as ah, type DmarcSourceStatus as ai, type DmarcStatus as aj, type DnsProviderName as ak, type Domain as al, type DomainBimiAnalysis as am, type DomainBlocklistListing as an, type DomainBlocklistStatus as ao, type DomainBlocklists as ap, type DomainDetailResult as aq, type DomainDmarcAnalysis as ar, type DomainDnsAnalysis as as, type DomainStatus as at, type DomainTlsMode as au, type DomainTrackingDns as av, type DomainTrackingStatus as aw, type EmailDelivery as ax, type EmailListItem as ay, type EmailWebhookEventPayload as az, type ApiKey as b, type TwilioIntegrationResponse as b$, type ListSendersResult as b0, type ListSuppressionsParams as b1, type ListSuppressionsResult as b2, type ListTemplatesParams as b3, type ListTemplatesResult as b4, type ListTenantDomainsResult as b5, type ListTenantsParams as b6, type ListTenantsResult as b7, type ListTestInboxEmailsParams as b8, type ListTestInboxEmailsResult as b9, type Suppression as bA, TEST_INBOX_WAIT_DEFAULT_MS as bB, TEST_INBOX_WAIT_MAX_SECONDS as bC, type Template as bD, type TemplateFormat as bE, type TemplateLintWarning as bF, type TemplateStarter as bG, type TemplateStatus as bH, type TemplateVersion as bI, type Tenant as bJ, type TenantPauseSource as bK, type TenantRamp as bL, type TenantStats as bM, type TenantStatsResult as bN, type TenantStatus as bO, type TenantStreamPolicy as bP, type TestEmailWebhookParams as bQ, type TestEmailWebhookResult as bR, type TestInbox as bS, type TestInboxAddressOptions as bT, type TestInboxEmail as bU, type TestInboxEmailDetail as bV, type TestInboxHeader as bW, TestInboxResource as bX, type TestInboxUsage as bY, type TriggerEventParams as bZ, type TriggerEventResult as b_, type ListWebhookDeliveriesParams as ba, type ListWebhookDeliveriesResult as bb, type MailServerSigningStatus as bc, type MailStream as bd, type Migration as be, type MigrationDnsChange as bf, type MigrationDnsPlan as bg, type MigrationDomainItem as bh, type MigrationItemStatus as bi, type MigrationProvider as bj, type MigrationResource as bk, type MigrationSummary as bl, type MigrationTemplateItem as bm, type MigrationTotals as bn, type MigrationWebhookItem as bo, type ReceivedEmail as bp, type ReceivedEmailAttachment as bq, type ReceivedEmailAttachmentMeta as br, type RemoteApplyDnsCredentials as bs, type RemoveCategoryOptOutOptions as bt, type RunMigrationOptions as bu, type SendEmailParams as bv, type Sender as bw, type SesMigrationParams as bx, type StreamDeliverability as by, type SuppressedErrorDetails as bz, type ApiKeyMigrationParams as c, type TwilioIntegrationStatus as c0, type UpdateAutomationParams as c1, type UpdateBrandParams as c2, type UpdateBurrowGuardSiteParams as c3, type UpdateDomainParams as c4, type UpdateEmailParams as c5, type UpdateSenderParams as c6, type UpdateTemplateParams as c7, type UpdateTenantParams as c8, type UpdateWebhookParams as c9, type ValidateEmailResult as ca, type ValidationReason as cb, type ValidationVerdict as cc, type VerifyDomainResult as cd, type WaitForTestEmailParams as ce, type WebhookDelivery as cf, type WebhookDeliveryAttempt as cg, type WebhookDeliveryDetail as ch, type WebhookDeliveryStatus as ci, type WebhookEmailTag as cj, type WebhookEndpoint as ck, type WebhookEndpointHealth as cl, type WebhookEndpointWithSecret as cm, type WebhookEventType as cn, mergeMigrations as co, normalizeAccessToken as cp, 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 AutomationBranchQuestion as j, type AutomationBranchStep as k, type AutomationInlineEmail as l, type AutomationResult as m, type AutomationRun as n, type AutomationRunResponse as o, type AutomationRunStatus as p, type AutomationRunStep as q, type AutomationRunStepStatus as r, type AutomationSendEmailStep as s, type AutomationStatus as t, type AutomationStep as u, type AutomationTemplateEmail as v, type AutomationTrigger as w, type BatchSendEmailResult as x, type BounceType as y, type Brand as z };

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

package/dist/index.js

@@ -1,4 +1,5 @@
 import {
+  BurrowGuardResource,
   DEFAULT_API_BASE_URL,
   Groundmail,
   GroundmailError,
@@ -12,7 +13,7 @@ import {
   normalizeAccessToken,
   signWebhookPayload,
   verifyWebhookSignature
-} from "./chunk-V4ZZRJ3Q.js";
+} from "./chunk-65NWGUZM.js";
 
 // src/simulator.ts
 var SIMULATOR_DOMAIN = "simulator.groundmail.dev";
@@ -34,6 +35,7 @@ function isTestApiKey(key) {
   return Boolean(key?.startsWith(TEST_API_KEY_PREFIX));
 }
 export {
+  BurrowGuardResource,
   DEFAULT_API_BASE_URL,
   Groundmail,
   GroundmailError,

package/dist/payload.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-CTQyEXww.js';
+import { G as Groundmail } from './client-B_H1iNa7.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-65NWGUZM.js";
 
 // src/payload.ts
 function resolveApiKey(args) {

package/package.json

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