groundmail 0.17.0 → 0.19.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/README.md CHANGED
@@ -46,6 +46,49 @@ await tx.emails.send({
46
46
  Outcomes: `delivered`, `bounce`, `block`, `complaint`, `suppressed`, `delayed`. Details:
47
47
  https://docs.groundmail.dev/testing
48
48
 
49
+ ## Tenants
50
+
51
+ If you send email for your own customers, create one tenant per customer. Each tenant has its
52
+ own domains, suppression list, stats, pause switch and daily limit, so one customer's bounces
53
+ or complaints never affect the others. Tenants are included on the Scale and Dedicated plans.
54
+
55
+ ```ts
56
+ await tx.tenants.create({ external_id: 'cus_123', name: 'Acme', daily_limit: 5000 })
57
+ await tx.tenants.domains.assign('cus_123', 'mail.acme.com')
58
+
59
+ await tx.emails.send({
60
+ from: 'billing@mail.acme.com',
61
+ to: 'user@example.com',
62
+ subject: 'Your invoice',
63
+ html: '<p>Thanks!</p>',
64
+ tenant: 'cus_123',
65
+ })
66
+
67
+ const { stats } = await tx.tenants.stats('cus_123', { days: 7 })
68
+ await tx.tenants.pause('cus_123', 'Unpaid invoice')
69
+ await tx.tenants.resume('cus_123')
70
+ ```
71
+
72
+ `tenant` (your external id or the Groundmail id) also works on `emails.list`, `domains.create` and
73
+ `domains.list`, `suppressions`, `apiKeys.create` (a key limited to one tenant) and
74
+ `emails.testWebhook`. Webhook endpoints take `tenants: ['cus_123']` to receive only those
75
+ tenants' email events. Details: https://docs.groundmail.dev/tenants
76
+
77
+ ## DMARC monitoring
78
+
79
+ Free for every domain. Turn it on, publish the record it returns, and read sources, pass rates
80
+ and whether it's safe to enforce once the daily reports arrive:
81
+
82
+ ```ts
83
+ const { dmarc } = await tx.dmarc.enable('yourdomain.com') // or { apply: 'cloudflare' }
84
+ console.log(dmarc.dns.suggested_record) // your record with our report address in rua=
85
+
86
+ const report = await tx.dmarc.get('yourdomain.com')
87
+ if (report.dmarc.enabled) console.log(report.dmarc.readiness.label, report.dmarc.sources)
88
+ ```
89
+
90
+ Details: https://docs.groundmail.dev/dmarc
91
+
49
92
  ## Adapters
50
93
 
51
94
  Optional entry points (install peer deps as needed):
@@ -63,6 +106,7 @@ Optional entry points (install peer deps as needed):
63
106
  - Quickstart: https://docs.groundmail.dev/quickstart
64
107
  - Node / Nodemailer: https://docs.groundmail.dev/frameworks/node
65
108
  - Testing (test keys, simulator): https://docs.groundmail.dev/testing
109
+ - DMARC monitoring: https://docs.groundmail.dev/dmarc
66
110
  - API reference: https://docs.groundmail.dev/api/emails
67
111
  - Product: https://groundmail.dev
68
112
 
package/dist/authjs.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail } from './client-DLz4rpD9.js';
1
+ import { G as Groundmail } from './client-H0RF4KEK.js';
2
2
 
3
3
  /** Subset of Auth.js theme used for the default magic-link email. */
4
4
  type AuthjsTheme = {
package/dist/authjs.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  DEFAULT_API_BASE_URL,
3
3
  Groundmail
4
- } from "./chunk-MJKAVFFN.js";
4
+ } from "./chunk-2RKWN4OE.js";
5
5
 
6
6
  // src/authjs.ts
7
7
  function escapeHtml(value) {
@@ -1,4 +1,4 @@
1
- import { S as SendEmailResult, G as Groundmail } from './client-DLz4rpD9.js';
1
+ import { S as SendEmailResult, G as Groundmail } from './client-H0RF4KEK.js';
2
2
 
3
3
  type BetterAuthEmailUser = {
4
4
  email: string;
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  DEFAULT_API_BASE_URL,
3
3
  Groundmail
4
- } from "./chunk-MJKAVFFN.js";
4
+ } from "./chunk-2RKWN4OE.js";
5
5
 
6
6
  // src/better-auth.ts
7
7
  function linkHtml(label, url) {
@@ -895,6 +895,32 @@ var AutomationsResource = class {
895
895
  }
896
896
  };
897
897
 
898
+ // src/dmarc.ts
899
+ var DmarcResource = class {
900
+ constructor(client) {
901
+ this.client = client;
902
+ }
903
+ path(domain) {
904
+ return `/domains/${encodeURIComponent(domain)}/dmarc`;
905
+ }
906
+ /** Monitoring status and the last 30 days of reports. `domain` is the domain id or name. */
907
+ async get(domain) {
908
+ return this.client.request(this.path(domain), { method: "GET" });
909
+ }
910
+ /** Turn monitoring on. Returns the report address and the DMARC record to publish. */
911
+ async enable(domain, params = {}) {
912
+ return this.client.request(this.path(domain), { method: "POST", body: JSON.stringify(params) });
913
+ }
914
+ /** Turn the weekly digest email on or off. */
915
+ async update(domain, params) {
916
+ return this.client.request(this.path(domain), { method: "PATCH", body: JSON.stringify(params) });
917
+ }
918
+ /** Stop monitoring. Remove the address from your DMARC record's rua= tag too. */
919
+ async disable(domain) {
920
+ return this.client.request(this.path(domain), { method: "DELETE" });
921
+ }
922
+ };
923
+
898
924
  // src/domains.ts
899
925
  var DomainsResource = class {
900
926
  constructor(client) {
@@ -906,6 +932,7 @@ var DomainsResource = class {
906
932
  if (params.cursor) search.set("cursor", params.cursor);
907
933
  const inboundEnabled = params.inbound_enabled ?? params.inboundEnabled;
908
934
  if (inboundEnabled !== void 0) search.set("inbound_enabled", String(inboundEnabled));
935
+ if (params.tenant) search.set("tenant", params.tenant);
909
936
  const query = search.toString();
910
937
  return this.client.request(`/domains${query ? `?${query}` : ""}`, { method: "GET" });
911
938
  }
@@ -918,7 +945,8 @@ var DomainsResource = class {
918
945
  method: "POST",
919
946
  body: JSON.stringify({
920
947
  name: params.name,
921
- ...inboundEnabled !== void 0 ? { inbound_enabled: inboundEnabled } : {}
948
+ ...inboundEnabled !== void 0 ? { inbound_enabled: inboundEnabled } : {},
949
+ ...params.tenant ? { tenant: params.tenant } : {}
922
950
  })
923
951
  });
924
952
  }
@@ -1009,6 +1037,7 @@ var EmailsResource = class {
1009
1037
  if (params.limit != null) search.set("limit", String(params.limit));
1010
1038
  if (params.cursor) search.set("cursor", params.cursor);
1011
1039
  if (params.test != null) search.set("test", String(params.test));
1040
+ if (params.tenant) search.set("tenant", params.tenant);
1012
1041
  const query = search.toString();
1013
1042
  return this.client.request(`/emails${query ? `?${query}` : ""}`, {
1014
1043
  method: "GET"
@@ -1074,7 +1103,8 @@ var EmailsResource = class {
1074
1103
  ...params.email_id !== void 0 ? { email_id: params.email_id } : {},
1075
1104
  ...params.webhook_id !== void 0 ? { webhook_id: params.webhook_id } : {},
1076
1105
  ...params.sync !== void 0 ? { sync: params.sync } : {},
1077
- ...params.deliver !== void 0 ? { deliver: params.deliver } : {}
1106
+ ...params.deliver !== void 0 ? { deliver: params.deliver } : {},
1107
+ ...params.tenant !== void 0 ? { tenant: params.tenant } : {}
1078
1108
  })
1079
1109
  });
1080
1110
  }
@@ -1126,6 +1156,7 @@ var EmailsResource = class {
1126
1156
  }
1127
1157
  if (params.unsubscribe !== void 0) payload.unsubscribe = params.unsubscribe;
1128
1158
  if (params.category !== void 0) payload.category = params.category;
1159
+ if (params.tenant !== void 0) payload.tenant = params.tenant;
1129
1160
  return payload;
1130
1161
  }
1131
1162
  };
@@ -1196,7 +1227,8 @@ var KeysResource = class {
1196
1227
  ...params.scope && !params.scopes?.length ? { scope: params.scope } : {},
1197
1228
  ...params.scopes?.length ? { scopes: params.scopes } : {},
1198
1229
  ...params.allowedDomains?.length ? { allowed_domains: params.allowedDomains } : {},
1199
- ...params.test ? { test: true } : {}
1230
+ ...params.test ? { test: true } : {},
1231
+ ...params.tenant ? { tenant: params.tenant } : {}
1200
1232
  })
1201
1233
  });
1202
1234
  }
@@ -1275,6 +1307,7 @@ var SuppressionsResource = class {
1275
1307
  if (params.limit != null) search.set("limit", String(params.limit));
1276
1308
  if (params.cursor) search.set("cursor", params.cursor);
1277
1309
  if (params.email) search.set("email", params.email);
1310
+ if (params.tenant) search.set("tenant", params.tenant);
1278
1311
  const query = search.toString();
1279
1312
  return this.client.request(`/suppressions${query ? `?${query}` : ""}`, { method: "GET" });
1280
1313
  }
@@ -1284,10 +1317,15 @@ var SuppressionsResource = class {
1284
1317
  body: JSON.stringify(params)
1285
1318
  });
1286
1319
  }
1287
- /** Remove by suppression id or email address. */
1288
- async remove(idOrEmail) {
1289
- if (idOrEmail.includes("@")) {
1290
- return this.client.request(`/suppressions?email=${encodeURIComponent(idOrEmail)}`, {
1320
+ /**
1321
+ * Remove by suppression id or email address. Pass `tenant` to remove an address
1322
+ * from that tenant's own list (by email address).
1323
+ */
1324
+ async remove(idOrEmail, options = {}) {
1325
+ if (idOrEmail.includes("@") || options.tenant) {
1326
+ const search = new URLSearchParams({ email: idOrEmail });
1327
+ if (options.tenant) search.set("tenant", options.tenant);
1328
+ return this.client.request(`/suppressions?${search.toString()}`, {
1291
1329
  method: "DELETE"
1292
1330
  });
1293
1331
  }
@@ -1373,6 +1411,84 @@ var TemplatesResource = class {
1373
1411
  }
1374
1412
  };
1375
1413
 
1414
+ // src/tenants.ts
1415
+ var TenantsResource = class {
1416
+ constructor(client) {
1417
+ this.client = client;
1418
+ this.domains = new TenantDomainsResource(client);
1419
+ }
1420
+ async list(params = {}) {
1421
+ const search = new URLSearchParams();
1422
+ if (params.limit != null) search.set("limit", String(params.limit));
1423
+ if (params.cursor) search.set("cursor", params.cursor);
1424
+ if (params.status) search.set("status", params.status);
1425
+ const query = search.toString();
1426
+ return this.client.request(`/tenants${query ? `?${query}` : ""}`, { method: "GET" });
1427
+ }
1428
+ async create(params) {
1429
+ return this.client.request("/tenants", {
1430
+ method: "POST",
1431
+ body: JSON.stringify(params)
1432
+ });
1433
+ }
1434
+ async get(tenant) {
1435
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}`, { method: "GET" });
1436
+ }
1437
+ async update(tenant, params) {
1438
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}`, {
1439
+ method: "PATCH",
1440
+ body: JSON.stringify(params)
1441
+ });
1442
+ }
1443
+ /** Stop the tenant's new sends until you resume it. */
1444
+ async pause(tenant, reason) {
1445
+ return this.update(tenant, { status: "paused", ...reason ? { reason } : {} });
1446
+ }
1447
+ /**
1448
+ * Let a tenant you paused send again. A tenant Groundmail paused (`pause_source`
1449
+ * `automated` or `admin`) cannot be resumed this way: contact support.
1450
+ */
1451
+ async resume(tenant) {
1452
+ return this.update(tenant, { status: "active" });
1453
+ }
1454
+ /**
1455
+ * Delete a tenant and its suppression list. Its domains go back to the account,
1456
+ * its emails keep their history, and API keys limited to it stop working.
1457
+ */
1458
+ async delete(tenant) {
1459
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}`, { method: "DELETE" });
1460
+ }
1461
+ /** Email counts and rates over the last `days` (1–90, default 7), plus the tenant's ramp today. */
1462
+ async stats(tenant, params = {}) {
1463
+ const query = params.days != null ? `?days=${encodeURIComponent(String(params.days))}` : "";
1464
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}/stats${query}`, {
1465
+ method: "GET"
1466
+ });
1467
+ }
1468
+ };
1469
+ var TenantDomainsResource = class {
1470
+ constructor(client) {
1471
+ this.client = client;
1472
+ }
1473
+ async list(tenant) {
1474
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}/domains`, { method: "GET" });
1475
+ }
1476
+ /** Give an existing domain of the account (name or id) to the tenant. Only that tenant can then send from it. */
1477
+ async assign(tenant, domain) {
1478
+ return this.client.request(`/tenants/${encodeURIComponent(tenant)}/domains`, {
1479
+ method: "POST",
1480
+ body: JSON.stringify({ domain })
1481
+ });
1482
+ }
1483
+ /** Give the tenant's domain (name or id) back to the whole account. The domain itself stays. */
1484
+ async unassign(tenant, domain) {
1485
+ return this.client.request(
1486
+ `/tenants/${encodeURIComponent(tenant)}/domains/${encodeURIComponent(domain)}`,
1487
+ { method: "DELETE" }
1488
+ );
1489
+ }
1490
+ };
1491
+
1376
1492
  // src/webhooks/index.ts
1377
1493
  var WebhooksResource = class {
1378
1494
  constructor(client) {
@@ -1429,7 +1545,9 @@ var Groundmail = class {
1429
1545
  this.smtpCredentials = new SmtpCredentialsResource(this);
1430
1546
  this.suppressions = new SuppressionsResource(this);
1431
1547
  this.templates = new TemplatesResource(this);
1548
+ this.tenants = new TenantsResource(this);
1432
1549
  this.migrations = new MigrationsResource(this);
1550
+ this.dmarc = new DmarcResource(this);
1433
1551
  }
1434
1552
  /**
1435
1553
  * Check one address with Groundmail validation before you accept it (for
package/dist/clerk.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail, S as SendEmailResult } from './client-DLz4rpD9.js';
1
+ import { G as Groundmail, S as SendEmailResult } from './client-H0RF4KEK.js';
2
2
 
3
3
  /**
4
4
  * Subset of Clerk `email.created` webhook `data` used for delivery.
package/dist/clerk.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  DEFAULT_API_BASE_URL,
3
3
  Groundmail
4
- } from "./chunk-MJKAVFFN.js";
4
+ } from "./chunk-2RKWN4OE.js";
5
5
 
6
6
  // src/clerk.ts
7
7
  function resolveApiKey(options) {
@@ -1,6 +1,8 @@
1
1
  type ApiErrorCode = 'validation_error' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'plan_limit'
2
2
  /** 429: the send would go over a new account's daily ramp-up limit; see `details.resets_at`. */
3
- | 'daily_ramp_limit' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
3
+ | 'daily_ramp_limit'
4
+ /** 403: the request names a tenant, but tenants are not enabled for this account (Scale and Dedicated plans). */
5
+ | 'tenants_not_enabled' | 'domain_limit' | 'idempotency_conflict' | 'rate_limited' | 'upstream_error' | 'not_configured' | 'internal_error';
4
6
  type SendEmailParams = {
5
7
  from: string | {
6
8
  email: string;
@@ -59,6 +61,12 @@ type SendEmailParams = {
59
61
  * is not accepted: Groundmail is for transactional and product email.
60
62
  */
61
63
  category?: 'transactional' | 'product';
64
+ /**
65
+ * Send as one of your tenants (its external id or Groundmail id). The send uses that
66
+ * tenant's domains, suppression list, pause switch and daily limit. Omit to send from
67
+ * the account as a whole, or from a tenant's own domain to use that tenant automatically.
68
+ */
69
+ tenant?: string;
62
70
  };
63
71
  /**
64
72
  * Why Groundmail validation held a recipient back before sending:
@@ -167,6 +175,8 @@ type EmailListItem = {
167
175
  opened_at: string | null;
168
176
  /** First tracked-link click; requires click tracking on the sending domain. */
169
177
  clicked_at: string | null;
178
+ /** The tenant's external id. Present only when the email was sent as a tenant. */
179
+ tenant?: string | null;
170
180
  };
171
181
  type ReceivedEmailAttachmentMeta = {
172
182
  filename: string;
@@ -217,6 +227,8 @@ type ListEmailsParams = {
217
227
  cursor?: string;
218
228
  /** `true`: only test emails; `false`: only live ones. Omit for both. */
219
229
  test?: boolean;
230
+ /** Only this tenant's emails (external id or Groundmail id). */
231
+ tenant?: string;
220
232
  };
221
233
  type ListEmailsResult = {
222
234
  emails: EmailListItem[];
@@ -277,6 +289,8 @@ type ApiKey = {
277
289
  allowed_domains?: string[];
278
290
  /** A test key (`gm_test_…`): its sends are simulated and never delivered. */
279
291
  test?: boolean;
292
+ /** The tenant this key is limited to (external id). Absent or null for an account-wide key. */
293
+ tenant?: string | null;
280
294
  prefix: string;
281
295
  created_at: string;
282
296
  last_used_at: string | null;
@@ -302,6 +316,11 @@ type CreateApiKeyParams = {
302
316
  * never delivered. They get simulated events and webhooks and count toward nothing.
303
317
  */
304
318
  test?: boolean;
319
+ /**
320
+ * Limit the key to one tenant (external id or Groundmail id): it sends only as that
321
+ * tenant and sees only that tenant's emails, domains and suppressions.
322
+ */
323
+ tenant?: string;
305
324
  };
306
325
  type CreateApiKeyResult = {
307
326
  id: string;
@@ -311,6 +330,8 @@ type CreateApiKeyResult = {
311
330
  allowed_domains?: string[];
312
331
  /** A test key (`gm_test_…`). */
313
332
  test?: boolean;
333
+ /** The tenant this key is limited to (external id), when it is. */
334
+ tenant?: string;
314
335
  prefix: string;
315
336
  token: string;
316
337
  created_at: string;
@@ -357,6 +378,8 @@ type EmailWebhookEventPayload = {
357
378
  bounce_type?: BounceType | null;
358
379
  /** `true` on simulated events (test keys, simulator addresses, `POST /emails/test`). Absent on real mail. */
359
380
  test?: true;
381
+ /** The tenant's external id, when the email was sent as a tenant. */
382
+ tenant?: string;
360
383
  };
361
384
  };
362
385
  /** `contact.unsubscribed` webhook payload (`scope` distinguishes global vs category opt-out). */
@@ -387,10 +410,14 @@ type SuppressedErrorDetails = {
387
410
  };
388
411
  /**
389
412
  * `details` on a 429 `daily_ramp_limit`: the send would go over a new account's
390
- * daily ramp-up limit for its stream. Send the rest after `resets_at`.
413
+ * daily ramp-up limit for its stream, or over a tenant's own daily limit (then
414
+ * `tenant` is set). Send the rest after `resets_at`.
391
415
  */
392
416
  type DailyRampLimitErrorDetails = {
393
- stream: 'transactional' | 'product';
417
+ /** Set when a tenant's own daily limit or ramp refused the send: the tenant's external id. */
418
+ tenant?: string;
419
+ /** The stream whose limit was reached. Absent when a tenant's fixed `daily_limit` was reached. */
420
+ stream?: 'transactional' | 'product';
394
421
  /** Today's recipient limit for this stream. */
395
422
  daily_limit: number;
396
423
  /** Recipients already sent today on this stream. */
@@ -398,7 +425,7 @@ type DailyRampLimitErrorDetails = {
398
425
  /** Recipients (to + cc + bcc) in the refused send. */
399
426
  recipients: number;
400
427
  /** Ramp-up stage, 1-based; null with a fixed limit set by support. */
401
- ramp_stage: number | null;
428
+ ramp_stage?: number | null;
402
429
  /** The next 00:00 UTC, ISO 8601. */
403
430
  resets_at: string;
404
431
  };
@@ -412,6 +439,8 @@ type TestEmailWebhookParams = {
412
439
  sync?: boolean;
413
440
  /** When true (default), enqueue delivery to account webhooks. */
414
441
  deliver?: boolean;
442
+ /** Put this tenant (external id or Groundmail id) on the test payload, to test tenant-filtered webhooks. */
443
+ tenant?: string;
415
444
  };
416
445
  type WebhookTestDelivery = {
417
446
  endpoint_id: string;
@@ -563,17 +592,23 @@ type WebhookEndpoint = {
563
592
  url: string;
564
593
  events: string[];
565
594
  enabled: boolean;
595
+ /** Present only when the endpoint receives email events for some tenants only (their external ids). */
596
+ tenants?: string[];
566
597
  created_at: string;
567
598
  updated_at: string;
568
599
  };
569
600
  type CreateWebhookParams = {
570
601
  url: string;
571
602
  events?: WebhookEventType[];
603
+ /** Only these tenants' email events (external ids or Groundmail ids). Omit, `[]` or `null` for all. */
604
+ tenants?: string[] | null;
572
605
  };
573
606
  type UpdateWebhookParams = {
574
607
  url?: string;
575
608
  events?: WebhookEventType[];
576
609
  enabled?: boolean;
610
+ /** Only these tenants' email events. `[]` or `null` removes the filter. */
611
+ tenants?: string[] | null;
577
612
  };
578
613
  type WebhookEndpointWithSecret = {
579
614
  webhook: WebhookEndpoint;
@@ -584,6 +619,8 @@ type Suppression = {
584
619
  email: string;
585
620
  reason: string | null;
586
621
  source: string;
622
+ /** The tenant's external id, on an entry of a tenant's own list. */
623
+ tenant?: string;
587
624
  created_at: string;
588
625
  updated_at: string;
589
626
  };
@@ -591,6 +628,8 @@ type ListSuppressionsParams = {
591
628
  limit?: number;
592
629
  cursor?: string;
593
630
  email?: string;
631
+ /** List this tenant's own suppression list instead of the account's. */
632
+ tenant?: string;
594
633
  };
595
634
  type ListSuppressionsResult = {
596
635
  data: Suppression[];
@@ -600,6 +639,8 @@ type ListSuppressionsResult = {
600
639
  type CreateSuppressionParams = {
601
640
  email: string;
602
641
  reason?: string;
642
+ /** Add to this tenant's own list (external id or Groundmail id) instead of the account's. */
643
+ tenant?: string;
603
644
  };
604
645
  type TemplateStatus = 'draft' | 'published';
605
646
  type TemplateFormat = 'html' | 'blocks';
@@ -755,6 +796,8 @@ type Domain = {
755
796
  inbound_enabled: boolean;
756
797
  inbound_status: 'disabled' | 'pending' | 'active' | 'error' | string;
757
798
  inbound_error: string | null;
799
+ /** The tenant that owns this domain (external id). Absent for an account-wide domain. */
800
+ tenant?: string | null;
758
801
  };
759
802
  type DnsRecord = {
760
803
  type: string;
@@ -768,12 +811,16 @@ type CreateDomainParams = {
768
811
  name: string;
769
812
  inbound_enabled?: boolean;
770
813
  inboundEnabled?: boolean;
814
+ /** Give the new domain to this tenant (external id or Groundmail id). Only that tenant can send from it. */
815
+ tenant?: string;
771
816
  };
772
817
  type ListDomainsParams = {
773
818
  limit?: number;
774
819
  cursor?: string;
775
820
  inbound_enabled?: boolean;
776
821
  inboundEnabled?: boolean;
822
+ /** Only this tenant's domains. */
823
+ tenant?: string;
777
824
  };
778
825
  type ListDomainsResult = {
779
826
  domains: Domain[];
@@ -1039,6 +1086,117 @@ type RunMigrationOptions = {
1039
1086
  /** Waits for `retry_after_seconds` (tests can pass a no-op). */
1040
1087
  sleep?: (ms: number) => Promise<void>;
1041
1088
  };
1089
+ type TenantStatus = 'active' | 'paused';
1090
+ /** `all` (default) or `transactional_only` (product email is refused for this tenant). */
1091
+ type TenantStreamPolicy = 'all' | 'transactional_only';
1092
+ /** Who paused a tenant: you over the API, Groundmail support, or Groundmail's automatic checks. */
1093
+ type TenantPauseSource = 'api' | 'admin' | 'automated';
1094
+ /**
1095
+ * One of your customers, inside your Groundmail account. Each tenant has its own
1096
+ * domains, suppression list, stats, pause switch and daily limit.
1097
+ */
1098
+ type Tenant = {
1099
+ id: string;
1100
+ object: 'tenant';
1101
+ /** Your id for this customer. Unique in your account; cannot be changed. */
1102
+ external_id: string;
1103
+ name: string | null;
1104
+ status: TenantStatus;
1105
+ paused_reason: string | null;
1106
+ paused_at: string | null;
1107
+ pause_source: TenantPauseSource | null;
1108
+ /** Completes a bare `from` (`"billing"` → `billing@<domain>`) on sends that name this tenant. */
1109
+ default_from_domain: string | null;
1110
+ stream_policy: TenantStreamPolicy;
1111
+ /** Most recipients per UTC day for this tenant; null for no tenant limit. */
1112
+ daily_limit: number | null;
1113
+ metadata: Record<string, unknown> | null;
1114
+ created_at: string;
1115
+ updated_at: string;
1116
+ };
1117
+ type ListTenantsParams = {
1118
+ limit?: number;
1119
+ cursor?: string;
1120
+ status?: TenantStatus;
1121
+ };
1122
+ type ListTenantsResult = {
1123
+ data: Tenant[];
1124
+ has_more: boolean;
1125
+ next_cursor: string | null;
1126
+ };
1127
+ type CreateTenantParams = {
1128
+ /** Your id for this customer: 1–128 characters of `A-Z a-z 0-9 . _ : @ -`. */
1129
+ external_id: string;
1130
+ name?: string;
1131
+ default_from_domain?: string | null;
1132
+ stream_policy?: TenantStreamPolicy;
1133
+ daily_limit?: number | null;
1134
+ metadata?: Record<string, unknown> | null;
1135
+ };
1136
+ type UpdateTenantParams = {
1137
+ name?: string | null;
1138
+ default_from_domain?: string | null;
1139
+ stream_policy?: TenantStreamPolicy;
1140
+ daily_limit?: number | null;
1141
+ metadata?: Record<string, unknown> | null;
1142
+ /** `paused` stops this tenant's new sends; `active` resumes them. */
1143
+ status?: TenantStatus;
1144
+ /** Why you paused the tenant (with `status: 'paused'`). */
1145
+ reason?: string;
1146
+ };
1147
+ type DeleteTenantResult = {
1148
+ ok: boolean;
1149
+ id: string;
1150
+ external_id: string;
1151
+ deleted: true;
1152
+ };
1153
+ /** A tenant's email counts over the last `days`. Rates are 0–1. */
1154
+ type TenantStats = {
1155
+ object: 'tenant_stats';
1156
+ days: number;
1157
+ /** Start of the window, ISO 8601. */
1158
+ from: string;
1159
+ total: number;
1160
+ queued: number;
1161
+ scheduled: number;
1162
+ sent: number;
1163
+ delivered: number;
1164
+ bounced: number;
1165
+ complained: number;
1166
+ failed: number;
1167
+ suppressed: number;
1168
+ opened: number;
1169
+ clicked: number;
1170
+ bounce_rate: number;
1171
+ complaint_rate: number;
1172
+ };
1173
+ /** A tenant's sending ramp today. `active` is false when no ramp limit applies. */
1174
+ type TenantRamp = {
1175
+ object: 'tenant_ramp';
1176
+ active: boolean;
1177
+ /** 1-based stage; null when the ramp does not apply. */
1178
+ stage: number | null;
1179
+ daily_limit: {
1180
+ transactional: number | null;
1181
+ product: number | null;
1182
+ } | null;
1183
+ used_today: {
1184
+ transactional: number;
1185
+ product: number;
1186
+ };
1187
+ completed: boolean;
1188
+ /** The next 00:00 UTC, ISO 8601. */
1189
+ resets_at: string;
1190
+ };
1191
+ type TenantStatsResult = {
1192
+ /** The tenant's external id. */
1193
+ tenant: string;
1194
+ stats: TenantStats;
1195
+ ramp?: TenantRamp;
1196
+ };
1197
+ type ListTenantDomainsResult = {
1198
+ data: Domain[];
1199
+ };
1042
1200
 
1043
1201
  declare class AutomationsResource {
1044
1202
  private readonly client;
@@ -1064,6 +1222,121 @@ declare class AutomationsResource {
1064
1222
  retryRun(id: string): Promise<AutomationRunResponse>;
1065
1223
  }
1066
1224
 
1225
+ /** Status of one sending source in the DMARC reports. `unknown`: an unrecognised server failing DMARC (possible spoofing). */
1226
+ type DmarcSourceStatus = 'passing' | 'failing' | 'unknown';
1227
+ type DmarcSource = {
1228
+ /** Provider id (`google`, `microsoft`, `groundmail`, `sendgrid`…) or `unknown:<reverse DNS domain>`. */
1229
+ key: string;
1230
+ provider: string;
1231
+ name: string;
1232
+ status: DmarcSourceStatus;
1233
+ messages: number;
1234
+ dmarc_pass: number;
1235
+ /** 0–1. */
1236
+ pass_rate: number;
1237
+ spf_aligned_rate: number;
1238
+ dkim_aligned_rate: number;
1239
+ /** Up to five source IPs, busiest first. */
1240
+ ips: string[];
1241
+ ip_count: number;
1242
+ first_seen: string;
1243
+ last_seen: string;
1244
+ };
1245
+ type DmarcReadinessVerdict = 'no_data' | 'collecting' | 'fix_sources' | 'ready_quarantine' | 'ready_reject' | 'enforced';
1246
+ type DmarcReadiness = {
1247
+ verdict: DmarcReadinessVerdict;
1248
+ label: string;
1249
+ detail: string;
1250
+ days_of_data: number;
1251
+ blocking_sources: string[];
1252
+ };
1253
+ type DmarcDailyPoint = {
1254
+ date: string;
1255
+ messages: number;
1256
+ dmarc_pass: number;
1257
+ pass_rate: number;
1258
+ };
1259
+ type DmarcMonitoring = {
1260
+ domain: string;
1261
+ enabled: true;
1262
+ /** `waiting` until the first report arrives. */
1263
+ status: 'waiting' | 'receiving';
1264
+ /** Where receivers send the domain's reports. */
1265
+ report_address: string;
1266
+ /** The `rua=` value: `mailto:<report_address>`. */
1267
+ rua: string;
1268
+ dns: {
1269
+ host: string;
1270
+ record: string | null;
1271
+ rua_present: boolean;
1272
+ policy: string | null;
1273
+ /** The current record with our address added to rua=. Publish this. */
1274
+ suggested_record: string;
1275
+ };
1276
+ digest_enabled: boolean;
1277
+ created_at: string;
1278
+ last_report_at: string | null;
1279
+ window_days: number;
1280
+ summary: {
1281
+ messages: number;
1282
+ dmarc_pass: number;
1283
+ dmarc_fail: number;
1284
+ pass_rate: number;
1285
+ reports: number;
1286
+ reporters: string[];
1287
+ };
1288
+ sources: DmarcSource[];
1289
+ daily: DmarcDailyPoint[];
1290
+ readiness: DmarcReadiness;
1291
+ };
1292
+ type DmarcMonitoringDisabled = {
1293
+ domain: string;
1294
+ enabled: false;
1295
+ status: 'disabled';
1296
+ dns: {
1297
+ host: string;
1298
+ record: string | null;
1299
+ policy: string | null;
1300
+ };
1301
+ };
1302
+ type DmarcStatus = DmarcMonitoring | DmarcMonitoringDisabled;
1303
+ type EnableDmarcParams = {
1304
+ /** Also write the record through a DNS provider connected under Settings → Integrations. */
1305
+ apply?: 'cloudflare' | 'vercel' | 'godaddy';
1306
+ digest_enabled?: boolean;
1307
+ };
1308
+ type EnableDmarcResult = {
1309
+ dmarc: DmarcMonitoring;
1310
+ applied: {
1311
+ provider: string;
1312
+ results: unknown;
1313
+ } | null;
1314
+ apply_error?: string;
1315
+ };
1316
+ /** DMARC monitoring for a sending domain: reports, sources, pass rates and enforcement readiness. */
1317
+ declare class DmarcResource {
1318
+ private readonly client;
1319
+ constructor(client: Groundmail);
1320
+ private path;
1321
+ /** Monitoring status and the last 30 days of reports. `domain` is the domain id or name. */
1322
+ get(domain: string): Promise<{
1323
+ dmarc: DmarcStatus;
1324
+ }>;
1325
+ /** Turn monitoring on. Returns the report address and the DMARC record to publish. */
1326
+ enable(domain: string, params?: EnableDmarcParams): Promise<EnableDmarcResult>;
1327
+ /** Turn the weekly digest email on or off. */
1328
+ update(domain: string, params: {
1329
+ digest_enabled: boolean;
1330
+ }): Promise<{
1331
+ dmarc: DmarcStatus;
1332
+ }>;
1333
+ /** Stop monitoring. Remove the address from your DMARC record's rua= tag too. */
1334
+ disable(domain: string): Promise<{
1335
+ dmarc: DmarcStatus;
1336
+ disabled: boolean;
1337
+ }>;
1338
+ }
1339
+
1067
1340
  declare class DomainsResource {
1068
1341
  private readonly client;
1069
1342
  constructor(client: Groundmail);
@@ -1188,8 +1461,13 @@ declare class SuppressionsResource {
1188
1461
  create(params: CreateSuppressionParams): Promise<{
1189
1462
  suppression: Suppression;
1190
1463
  }>;
1191
- /** Remove by suppression id or email address. */
1192
- remove(idOrEmail: string): Promise<{
1464
+ /**
1465
+ * Remove by suppression id or email address. Pass `tenant` to remove an address
1466
+ * from that tenant's own list (by email address).
1467
+ */
1468
+ remove(idOrEmail: string, options?: {
1469
+ tenant?: string;
1470
+ }): Promise<{
1193
1471
  ok: boolean;
1194
1472
  }>;
1195
1473
  }
@@ -1238,6 +1516,61 @@ declare class TemplatesResource {
1238
1516
  }): Promise<unknown>;
1239
1517
  }
1240
1518
 
1519
+ /**
1520
+ * Tenants: one per customer of your platform, each with its own domains,
1521
+ * suppression list, stats, pause switch and daily limit. Every method takes the
1522
+ * tenant's external id (your id for the customer) or its Groundmail id.
1523
+ */
1524
+ declare class TenantsResource {
1525
+ private readonly client;
1526
+ /** The domains a tenant owns. */
1527
+ readonly domains: TenantDomainsResource;
1528
+ constructor(client: Groundmail);
1529
+ list(params?: ListTenantsParams): Promise<ListTenantsResult>;
1530
+ create(params: CreateTenantParams): Promise<{
1531
+ tenant: Tenant;
1532
+ }>;
1533
+ get(tenant: string): Promise<{
1534
+ tenant: Tenant;
1535
+ }>;
1536
+ update(tenant: string, params: UpdateTenantParams): Promise<{
1537
+ tenant: Tenant;
1538
+ }>;
1539
+ /** Stop the tenant's new sends until you resume it. */
1540
+ pause(tenant: string, reason?: string): Promise<{
1541
+ tenant: Tenant;
1542
+ }>;
1543
+ /**
1544
+ * Let a tenant you paused send again. A tenant Groundmail paused (`pause_source`
1545
+ * `automated` or `admin`) cannot be resumed this way: contact support.
1546
+ */
1547
+ resume(tenant: string): Promise<{
1548
+ tenant: Tenant;
1549
+ }>;
1550
+ /**
1551
+ * Delete a tenant and its suppression list. Its domains go back to the account,
1552
+ * its emails keep their history, and API keys limited to it stop working.
1553
+ */
1554
+ delete(tenant: string): Promise<DeleteTenantResult>;
1555
+ /** Email counts and rates over the last `days` (1–90, default 7), plus the tenant's ramp today. */
1556
+ stats(tenant: string, params?: {
1557
+ days?: number;
1558
+ }): Promise<TenantStatsResult>;
1559
+ }
1560
+ declare class TenantDomainsResource {
1561
+ private readonly client;
1562
+ constructor(client: Groundmail);
1563
+ list(tenant: string): Promise<ListTenantDomainsResult>;
1564
+ /** Give an existing domain of the account (name or id) to the tenant. Only that tenant can then send from it. */
1565
+ assign(tenant: string, domain: string): Promise<{
1566
+ domain: Domain;
1567
+ }>;
1568
+ /** Give the tenant's domain (name or id) back to the whole account. The domain itself stays. */
1569
+ unassign(tenant: string, domain: string): Promise<{
1570
+ domain: Domain;
1571
+ }>;
1572
+ }
1573
+
1241
1574
  declare class WebhooksResource {
1242
1575
  private readonly client;
1243
1576
  constructor(client: Groundmail);
@@ -1278,8 +1611,12 @@ declare class Groundmail {
1278
1611
  readonly smtpCredentials: SmtpCredentialsResource;
1279
1612
  readonly suppressions: SuppressionsResource;
1280
1613
  readonly templates: TemplatesResource;
1614
+ /** Your platform's customers, each with its own domains, suppressions, stats and limits. */
1615
+ readonly tenants: TenantsResource;
1281
1616
  /** Import from SendGrid, Postmark or Mailgun (Beta). */
1282
1617
  readonly migrations: MigrationsResource;
1618
+ /** DMARC monitoring per domain: report address, sources, pass rates and readiness. */
1619
+ readonly dmarc: DmarcResource;
1283
1620
  constructor(apiKey: string, options?: GroundmailOptions);
1284
1621
  /**
1285
1622
  * Check one address with Groundmail validation before you accept it (for
@@ -1294,4 +1631,4 @@ declare class Groundmail {
1294
1631
  request<T>(path: string, init: RequestInit): Promise<T>;
1295
1632
  }
1296
1633
 
1297
- export { type EmailWebhookEventPayload 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 CreateWebhookParams as H, DEFAULT_API_BASE_URL as I, type DailyRampLimitErrorDetails as J, type DeliverabilityBucket as K, type DeliverabilityDomainInsight as L, type DeliverabilityInsightsResult as M, type DeliverabilityMailServerRelay as N, type DeliverabilityWindow as O, type DnsProviderName as P, type Domain as Q, type DomainBimiAnalysis as R, type SendEmailResult as S, type DomainDetailResult as T, type DomainDmarcAnalysis as U, type DomainDnsAnalysis as V, type DomainStatus as W, type DomainTlsMode as X, type DomainTrackingDns as Y, type DomainTrackingStatus as Z, type EmailListItem as _, type ApiErrorCode as a, type WebhookEndpoint as a$, type EmailWebhookEventType as a0, type EnrollmentSkip as a1, type EventRecord as a2, type GroundmailOptions as a3, type HeldBackErrorDetails as a4, type HeldBackReason as a5, type HeldBackRecipient as a6, type ListApiKeysParams as a7, type ListApiKeysResult as a8, type ListAutomationRunsParams as a9, type ReceivedEmailAttachmentMeta as aA, type RemoteApplyDnsCredentials as aB, type RunMigrationOptions as aC, type SendEmailParams as aD, type SuppressedErrorDetails as aE, type Suppression as aF, type Template as aG, type TemplateFormat as aH, type TemplateLintWarning as aI, type TemplateStarter as aJ, type TemplateStatus as aK, type TemplateVersion as aL, type TestEmailWebhookParams as aM, type TestEmailWebhookResult as aN, type TriggerEventParams as aO, type TriggerEventResult as aP, type TwilioIntegrationResponse as aQ, type TwilioIntegrationStatus as aR, type UpdateAutomationParams as aS, type UpdateDomainParams as aT, type UpdateEmailParams as aU, type UpdateTemplateParams as aV, type UpdateWebhookParams as aW, type ValidateEmailResult as aX, type ValidationReason as aY, type ValidationVerdict as aZ, type VerifyDomainResult as a_, type ListAutomationRunsResult as aa, type ListAutomationsResult as ab, type ListDomainsParams as ac, type ListDomainsResult as ad, type ListEmailsParams as ae, type ListEmailsResult as af, type ListReceivedEmailsParams as ag, type ListReceivedEmailsResult as ah, type ListSuppressionsParams as ai, type ListSuppressionsResult as aj, type ListTemplatesParams as ak, type ListTemplatesResult as al, type MailServerSigningStatus as am, type Migration as an, type MigrationDnsChange as ao, type MigrationDnsPlan as ap, type MigrationDomainItem as aq, type MigrationItemStatus as ar, type MigrationProvider as as, type MigrationResource as at, type MigrationSummary as au, type MigrationTemplateItem as av, type MigrationTotals as aw, type MigrationWebhookItem as ax, type ReceivedEmail as ay, type ReceivedEmailAttachment as az, type ApiKey as b, type WebhookEndpointWithSecret as b0, type WebhookEventType as b1, mergeMigrations as b2, 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 };
1634
+ 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 Tenant 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 Migration as aC, type MigrationDnsChange as aD, type MigrationDnsPlan as aE, type MigrationDomainItem as aF, type MigrationItemStatus as aG, type MigrationProvider as aH, type MigrationResource as aI, type MigrationSummary as aJ, type MigrationTemplateItem as aK, type MigrationTotals as aL, type MigrationWebhookItem as aM, type ReceivedEmail as aN, type ReceivedEmailAttachment as aO, type ReceivedEmailAttachmentMeta as aP, type RemoteApplyDnsCredentials as aQ, type RunMigrationOptions as aR, type SendEmailParams as aS, type SuppressedErrorDetails as aT, type Suppression as aU, type Template as aV, type TemplateFormat as aW, type TemplateLintWarning as aX, type TemplateStarter as aY, type TemplateStatus as aZ, type TemplateVersion 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 TenantPauseSource as b0, type TenantRamp as b1, type TenantStats as b2, type TenantStatsResult as b3, type TenantStatus as b4, type TenantStreamPolicy as b5, type TestEmailWebhookParams as b6, type TestEmailWebhookResult as b7, type TriggerEventParams as b8, type TriggerEventResult as b9, type TwilioIntegrationResponse as ba, type TwilioIntegrationStatus as bb, type UpdateAutomationParams as bc, type UpdateDomainParams as bd, type UpdateEmailParams as be, type UpdateTemplateParams as bf, type UpdateTenantParams as bg, type UpdateWebhookParams as bh, type ValidateEmailResult as bi, type ValidationReason as bj, type ValidationVerdict as bk, type VerifyDomainResult as bl, type WebhookEndpoint as bm, type WebhookEndpointWithSecret as bn, type WebhookEventType as bo, mergeMigrations as bp, 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-DLz4rpD9.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 CreateWebhookParams, I as DEFAULT_API_BASE_URL, J as DailyRampLimitErrorDetails, K as DeliverabilityBucket, L as DeliverabilityDomainInsight, M as DeliverabilityInsightsResult, N as DeliverabilityMailServerRelay, O as DeliverabilityWindow, P as DnsProviderName, Q as Domain, R as DomainBimiAnalysis, T as DomainDetailResult, U as DomainDmarcAnalysis, V as DomainDnsAnalysis, W as DomainStatus, X as DomainTlsMode, Y as DomainTrackingDns, Z as DomainTrackingStatus, _ as EmailListItem, $ as EmailWebhookEventPayload, a0 as EmailWebhookEventType, a1 as EnrollmentSkip, a2 as EventRecord, G as Groundmail, a3 as GroundmailOptions, a4 as HeldBackErrorDetails, a5 as HeldBackReason, a6 as HeldBackRecipient, a7 as ListApiKeysParams, a8 as ListApiKeysResult, a9 as ListAutomationRunsParams, aa as ListAutomationRunsResult, ab as ListAutomationsResult, ac as ListDomainsParams, ad as ListDomainsResult, ae as ListEmailsParams, af as ListEmailsResult, ag as ListReceivedEmailsParams, ah as ListReceivedEmailsResult, ai as ListSuppressionsParams, aj as ListSuppressionsResult, ak as ListTemplatesParams, al as ListTemplatesResult, am as MailServerSigningStatus, an as Migration, ao as MigrationDnsChange, ap as MigrationDnsPlan, aq as MigrationDomainItem, ar as MigrationItemStatus, as as MigrationProvider, at as MigrationResource, au as MigrationSummary, av as MigrationTemplateItem, aw as MigrationTotals, ax as MigrationWebhookItem, ay as ReceivedEmail, az as ReceivedEmailAttachment, aA as ReceivedEmailAttachmentMeta, aB as RemoteApplyDnsCredentials, aC as RunMigrationOptions, aD as SendEmailParams, S as SendEmailResult, aE as SuppressedErrorDetails, aF as Suppression, aG as Template, aH as TemplateFormat, aI as TemplateLintWarning, aJ as TemplateStarter, aK as TemplateStatus, aL as TemplateVersion, aM as TestEmailWebhookParams, aN as TestEmailWebhookResult, aO as TriggerEventParams, aP as TriggerEventResult, aQ as TwilioIntegrationResponse, aR as TwilioIntegrationStatus, aS as UpdateAutomationParams, aT as UpdateDomainParams, aU as UpdateEmailParams, aV as UpdateTemplateParams, aW as UpdateWebhookParams, aX as ValidateEmailResult, aY as ValidationReason, aZ as ValidationVerdict, a_ as VerifyDomainResult, a$ as WebhookEndpoint, b0 as WebhookEndpointWithSecret, b1 as WebhookEventType, b2 as mergeMigrations } from './client-DLz4rpD9.js';
1
+ import { A as ApiErrorBody, D as DnsRecord } from './client-H0RF4KEK.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 Migration, aD as MigrationDnsChange, aE as MigrationDnsPlan, aF as MigrationDomainItem, aG as MigrationItemStatus, aH as MigrationProvider, aI as MigrationResource, aJ as MigrationSummary, aK as MigrationTemplateItem, aL as MigrationTotals, aM as MigrationWebhookItem, aN as ReceivedEmail, aO as ReceivedEmailAttachment, aP as ReceivedEmailAttachmentMeta, aQ as RemoteApplyDnsCredentials, aR as RunMigrationOptions, aS as SendEmailParams, S as SendEmailResult, aT as SuppressedErrorDetails, aU as Suppression, aV as Template, aW as TemplateFormat, aX as TemplateLintWarning, aY as TemplateStarter, aZ as TemplateStatus, a_ as TemplateVersion, a$ as Tenant, b0 as TenantPauseSource, b1 as TenantRamp, b2 as TenantStats, b3 as TenantStatsResult, b4 as TenantStatus, b5 as TenantStreamPolicy, b6 as TestEmailWebhookParams, b7 as TestEmailWebhookResult, b8 as TriggerEventParams, b9 as TriggerEventResult, ba as TwilioIntegrationResponse, bb as TwilioIntegrationStatus, bc as UpdateAutomationParams, bd as UpdateDomainParams, be as UpdateEmailParams, bf as UpdateTemplateParams, bg as UpdateTenantParams, bh as UpdateWebhookParams, bi as ValidateEmailResult, bj as ValidationReason, bk as ValidationVerdict, bl as VerifyDomainResult, bm as WebhookEndpoint, bn as WebhookEndpointWithSecret, bo as WebhookEventType, bp as mergeMigrations } from './client-H0RF4KEK.js';
3
3
 
4
4
  type GroundmailErrorOptions = {
5
5
  code?: string;
package/dist/index.js CHANGED
@@ -8,7 +8,7 @@ import {
8
8
  mergeSpfInclude,
9
9
  signWebhookPayload,
10
10
  verifyWebhookSignature
11
- } from "./chunk-MJKAVFFN.js";
11
+ } from "./chunk-2RKWN4OE.js";
12
12
 
13
13
  // src/simulator.ts
14
14
  var SIMULATOR_DOMAIN = "simulator.groundmail.dev";
package/dist/payload.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { G as Groundmail } from './client-DLz4rpD9.js';
1
+ import { G as Groundmail } from './client-H0RF4KEK.js';
2
2
 
3
3
  /**
4
4
  * Minimal Payload `SendEmailOptions` / address shapes used by this adapter.
package/dist/payload.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  DEFAULT_API_BASE_URL,
3
3
  Groundmail
4
- } from "./chunk-MJKAVFFN.js";
4
+ } from "./chunk-2RKWN4OE.js";
5
5
 
6
6
  // src/payload.ts
7
7
  function resolveApiKey(args) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "groundmail",
3
- "version": "0.17.0",
3
+ "version": "0.19.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.3"
92
+ "groundmail-nodemailer": "0.15.5"
93
93
  },
94
94
  "devDependencies": {
95
95
  "@types/nodemailer": "^8.0.1",