@messagebird/sdk 0.7.6 → 0.8.1

package/dist/index.d.mts

@@ -269,6 +269,194 @@ interface PaginatedPromise<T> extends Promise<CursorPage<T>>, AsyncIterable<T> {
 }
 //#endregion
 //#region src/generated/types.gen.d.ts
+/**
+ * Payload of the whatsapp.sent event.
+ */
+type EventWhatsAppSentData = EventWhatsAppBase;
+/**
+ * Structured key/value label attached to a message. Surfaces in list filters, the event log, and webhook payloads. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID). For arbitrary per-send context that does not need to be filterable, use `metadata`.
+ * Tag count and per-tag size are capped to keep per-send tag payloads small — see the send request for the array maximum. Tag names are unique within a send; supplying the same name twice is rejected.
+ *
+ */
+type Tag = {
+  /**
+   * Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
+   *
+   */
+  name: string;
+  /**
+   * Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
+   *
+   */
+  value: string;
+};
+/**
+ * Sender or recipient of a WhatsApp message — a phone number, a business-scoped user ID, or both.
+ */
+type WhatsAppAddress = {
+  /**
+   * Phone number in E.164 format, when known.
+   */
+  phone_number?: string;
+  /**
+   * Business-scoped user ID — Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
+   *
+   */
+  bsuid?: string;
+};
+type WorkspaceId = string;
+type WhatsAppMessageId = string;
+/**
+ * Identity fields shared by every WhatsApp lifecycle event payload.
+ */
+type EventWhatsAppBase = {
+  /**
+   * ID of the WhatsApp message.
+   */
+  whatsapp_id: WhatsAppMessageId;
+  /**
+   * ID of the workspace.
+   */
+  workspace_id: WorkspaceId;
+  /**
+   * Whether the message was sent by the business (`outbound`) or received from the contact (`inbound`).
+   */
+  direction: "outbound" | "inbound";
+  /**
+   * Sender of the message. On outbound messages, the business number it was sent from.
+   */
+  from: WhatsAppAddress;
+  /**
+   * Recipient of the message. On outbound messages, the WhatsApp contact.
+   */
+  to: WhatsAppAddress;
+  /**
+   * Tags provided on the send request, echoed on every event for the message. Null when the message carried no tags.
+   *
+   */
+  tags: Array<Tag> | null;
+  /**
+   * The metadata object provided on the send request, echoed on every event for the message. Null when the message carried no metadata.
+   *
+   */
+  metadata: {
+    [key: string]: unknown;
+  } | null;
+};
+/**
+ * Bird handed the message to Meta for delivery.
+ */
+type EventWhatsAppSent = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.sent";
+  /**
+   * Time Bird handed the message to Meta for delivery.
+   */
+  timestamp: string;
+  data: EventWhatsAppSentData;
+};
+/**
+ * Payload of the whatsapp.read event.
+ */
+type EventWhatsAppReadData = EventWhatsAppBase;
+/**
+ * The recipient read the message.
+ */
+type EventWhatsAppRead = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.read";
+  /**
+   * Time the recipient read the message.
+   */
+  timestamp: string;
+  data: EventWhatsAppReadData;
+};
+/**
+ * Bird-stable failure reason, uniform whether the failure happened internally or was reported by the WhatsApp network. `insufficient_balance` — the workspace could not afford the send. `price_not_found` — no price was configured for this destination/template combination. `internal_error` — an unexpected Bird-side failure. `undeliverable` — the recipient could not be reached (e.g. not on WhatsApp, number invalid). `service_window_expired` — the 24-hour customer care window has closed and a free-form message cannot be sent; send a template instead. `rate_limited` — the send was throttled.
+ *
+ */
+type WhatsAppErrorCode = string;
+/**
+ * Failure detail for a message that could not be delivered. Null when there is no failure.
+ */
+type WhatsAppError = {
+  code: WhatsAppErrorCode;
+  /**
+   * Human-readable explanation of the failure.
+   */
+  readonly description: string;
+  /**
+   * Raw error code from the WhatsApp Cloud API, when available, for low-level debugging.
+   */
+  readonly meta_error_code?: string | null;
+  /**
+   * When the failure occurred.
+   */
+  readonly occurred_at: string;
+} | null;
+/**
+ * Payload of the whatsapp.failed event.
+ */
+type EventWhatsAppFailedData = EventWhatsAppBase & {
+  /**
+   * Why the message terminally failed.
+   */
+  error: WhatsAppError;
+};
+/**
+ * The message terminally failed and will not be delivered.
+ */
+type EventWhatsAppFailed = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.failed";
+  /**
+   * Time the failure was recorded.
+   */
+  timestamp: string;
+  data: EventWhatsAppFailedData;
+};
+/**
+ * Payload of the whatsapp.delivered event.
+ */
+type EventWhatsAppDeliveredData = EventWhatsAppBase;
+/**
+ * The message was delivered to the recipient's device.
+ */
+type EventWhatsAppDelivered = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.delivered";
+  /**
+   * Time the message was delivered to the recipient's device.
+   */
+  timestamp: string;
+  data: EventWhatsAppDeliveredData;
+};
+/**
+ * Payload of the whatsapp.accepted event.
+ */
+type EventWhatsAppAcceptedData = EventWhatsAppBase;
+/**
+ * Bird accepted and charged the send request.
+ */
+type EventWhatsAppAccepted = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.accepted";
+  /**
+   * Time Bird accepted and charged the send request.
+   */
+  timestamp: string;
+  data: EventWhatsAppAcceptedData;
+};
 /**
  * Payload of the sms.undelivered event.
  */
@@ -301,24 +489,6 @@ type SmsError = {
    */
   occurred_at: string;
 } | null;
-/**
- * Structured key/value label attached to a message. Surfaces in list filters, the event log, and webhook payloads. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID). For arbitrary per-send context that does not need to be filterable, use `metadata`.
- * Tag count and per-tag size are capped to keep per-send tag payloads small — see the send request for the array maximum. Tag names are unique within a send; supplying the same name twice is rejected.
- *
- */
-type Tag = {
-  /**
-   * Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
-   *
-   */
-  name: string;
-  /**
-   * Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
-   *
-   */
-  value: string;
-};
-type WorkspaceId = string;
 type SmsMessageId = string;
 /**
  * Identity fields shared by every SMS lifecycle event payload.
@@ -1388,7 +1558,17 @@ type WebhookEvent = ({
   type: "sms.sent";
 } & EventSmsSent) | ({
   type: "sms.undelivered";
-} & EventSmsUndelivered);
+} & EventSmsUndelivered) | ({
+  type: "whatsapp.accepted";
+} & EventWhatsAppAccepted) | ({
+  type: "whatsapp.delivered";
+} & EventWhatsAppDelivered) | ({
+  type: "whatsapp.failed";
+} & EventWhatsAppFailed) | ({
+  type: "whatsapp.read";
+} & EventWhatsAppRead) | ({
+  type: "whatsapp.sent";
+} & EventWhatsAppSent);
 type Timestamps = {
   readonly created_at: string;
   readonly updated_at: string;
@@ -1406,6 +1586,283 @@ type EmailAddress = {
    */
   name?: string;
 };
+/**
+ * Partial update. `settings` changes apply immediately. Changes to `return_path`, `tracking`, or `dkim` on a verified capability are staged: the current configuration keeps serving until the new one's DNS records verify, then the change is promoted automatically and the old records are marked `deprecated`. The staged value is visible under `capabilities.*.pending` and can be replaced by submitting another change.
+ *
+ */
+type DomainUpdate = {
+  settings?: DomainSettings;
+  return_path?: DomainReturnPathConfig & unknown;
+  /**
+   * Set or change the tracking name part, or remove tracking by passing null. Removal requires `click_tracking` and `open_tracking` to be disabled first, and returns `409` otherwise. After removal, links in previously sent email keep resolving while the tracking records are reported as `deprecated`.
+   *
+   */
+  tracking?: DomainTrackingConfig | null;
+  dkim?: DomainDkimConfig & unknown;
+  inbound?: DomainInboundConfig & unknown;
+};
+/**
+ * Inbound (receiving) configuration. Enable inbound to receive email addressed to this domain: Bird returns MX records to publish, and once they verify, mail to any local-part at this domain is delivered as an inbound message and the `email.received` webhook fires. The capability is enabled on the domain's own registration, so use a dedicated subdomain (e.g. `inbound.acme.com`), never your apex — apex MX would capture your corporate mail.
+ *
+ */
+type DomainInboundConfig = {
+  /**
+   * Set `true` to enable receiving on this domain, `false` to disable it. Disabling tears receiving down and removes the MX records from `dns_records`; this is immediate in the normal case, and if a step needs retrying the capability clears as soon as teardown finishes.
+   *
+   */
+  enabled: boolean;
+};
+/**
+ * DKIM signing configuration.
+ */
+type DomainDkimConfig = {
+  /**
+   * How the DKIM public key is published in your DNS.
+   * - `txt` — you publish the DKIM public key as a TXT record. Key
+   * rotation requires updating the record.
+   * - `delegated` — preview, currently unavailable; supplying it returns
+   * `422`. When available, you publish a single CNAME and Bird hosts
+   * and rotates the key with no further DNS changes on your side.
+   *
+   */
+  mode?: "txt" | "delegated";
+};
+/**
+ * Tracking domain configuration for branded open and click tracking URLs. Provide only the name part; Bird adds the sending domain automatically. Defaults to `links` when omitted at creation. Tracked links are served over HTTPS once the tracking record verifies.
+ *
+ */
+type DomainTrackingConfig = {
+  /**
+   * Name part to use for branded open and click tracking URLs. For example, `links` on `mail.acme.com` becomes `links.mail.acme.com`.
+   *
+   */
+  name: string;
+};
+/**
+ * Return-path (bounce) domain configuration. The return-path domain receives bounce and complaint notifications for mail sent from this domain and is what mailbox providers check for SPF. Provide only the name part; Bird adds the sending domain automatically.
+ *
+ */
+type DomainReturnPathConfig = {
+  /**
+   * Name part to use for the return-path domain. For example, `send` on `mail.acme.com` becomes `send.mail.acme.com`. Defaults to `send` when omitted at creation.
+   *
+   */
+  name: string;
+};
+/**
+ * Per-domain behavior toggles. Changes apply immediately to new sends.
+ *
+ */
+type DomainSettings = {
+  /**
+   * Rewrite links in HTML email through your tracking domain to record clicks. You can enable this before your tracking domain has verified — it begins working once verification completes. A tracking domain must be configured; enabling it without one returns `409`.
+   *
+   */
+  click_tracking?: boolean;
+  /**
+   * Insert a tracking pixel in HTML email to record opens. You can enable this before your tracking domain has verified — it begins working once verification completes. A tracking domain must be configured; enabling it without one returns `409`.
+   *
+   */
+  open_tracking?: boolean;
+};
+type DomainCreate = {
+  /**
+   * The domain you will send from — the domain of your `from` addresses. Use a dedicated subdomain (e.g. `mail.acme.com`) rather than your registered domain so sending reputation stays separate from other services on the domain.
+   *
+   */
+  domain: string;
+  return_path?: DomainReturnPathConfig;
+  tracking?: DomainTrackingConfig;
+  dkim?: DomainDkimConfig;
+  settings?: DomainSettings;
+};
+type DnsRecord = {
+  type: "TXT" | "CNAME" | "MX";
+  /**
+   * The record name — the part you enter in your DNS provider's "Name" or "Host" field, relative to the DNS zone the record belongs in (your registered domain). For a sending domain `mail.acme.com` the DKIM record name is `bird1._domainkey.mail`, entered in the `acme.com` zone. `@` for records at the zone apex.
+   *
+   */
+  name: string;
+  /**
+   * The fully qualified hostname for this record (e.g. `bird1._domainkey.mail.acme.com`).
+   *
+   */
+  host: string;
+  value: string;
+  /**
+   * What this record is for.
+   * - `dkim` — signs outbound mail and proves domain ownership. - `return_path` — return-path (bounce) CNAME for sending. - `tracking` — branded open/click tracking CNAME (optional). - `dmarc` — advisory DMARC policy record. - `inbound_mx` — MX record routing mail to Bird for receiving. Always
+   * present wherever inbound is available, as a regional reference,
+   * regardless of whether receiving is enabled; publishing it does not
+   * enable receiving on its own — see `DomainUpdate.inbound`.
+   *
+   */
+  purpose: "dkim" | "return_path" | "tracking" | "inbound_mx" | "dmarc";
+  /**
+   * Lifecycle state of this record.
+   * - `active` — the record backs the domain's current configuration. - `pending` — the record belongs to a staged configuration change;
+   * publish it to complete the change.
+   * - `deprecated` — the record belonged to a previous configuration.
+   * Keep it in DNS until `safe_to_remove` is `true`; in-flight mail and
+   * previously sent tracked links may still resolve through it.
+   *
+   */
+  readonly state: "active" | "pending" | "deprecated";
+  /**
+   * Whether this record can be skipped. Optional records enable extra functionality (e.g. tracking) but are not required for sending.
+   *
+   */
+  readonly optional: boolean;
+  /**
+   * Verification status of this record's most recent DNS check.
+   * - `pending` — the record has not verified yet; publish it (or correct it)
+   * and it will verify on the next check.
+   * - `verified` — the most recent check matched the expected value. - `warning` — the record verified before and a recent check no longer
+   * matched, but it is still within the grace period. Sending is not yet
+   * affected; fix the record before the grace period ends to avoid it
+   * being blocked.
+   * - `failed` — the record verified before but later checks kept failing
+   * past the grace period; the configuration has regressed and needs
+   * attention.
+   *
+   */
+  readonly status: "pending" | "verified" | "warning" | "failed";
+  /**
+   * Human-readable detail for a failed check on this record — what was found in DNS and why it did not match. Null when the record is verified or not yet checked.
+   *
+   */
+  readonly error?: string | null;
+  /**
+   * Only set on `deprecated` records: `true` once the record is no longer referenced by in-flight mail or live tracked links and can be deleted from your DNS. Null on `active` and `pending` records.
+   *
+   */
+  readonly safe_to_remove?: boolean | null;
+};
+/**
+ * A staged configuration change awaiting DNS verification. The currently active configuration keeps serving until the staged one verifies, at which point it is promoted automatically. Submitting another change for the same capability replaces the staged value.
+ *
+ */
+type DomainCapabilityPending = {
+  /**
+   * Hostname the capability will use once the staged change verifies.
+   */
+  readonly domain: string;
+  /**
+   * Verification status of the staged change. `pending` — waiting for the DNS records to be detected. `failed` — the records resolved with wrong values; correct them or submit a different change. `temporary_failure` — DNS lookup failed transiently and will be retried.
+   *
+   */
+  readonly status: "pending" | "failed" | "temporary_failure";
+};
+type DomainCapability = {
+  /**
+   * Capability verification status.
+   * - `pending` — verification has not run, or is currently running. - `verified` — all DNS records for this capability resolved with the
+   * expected values.
+   * - `warning` — a record for this capability verified before and a recent
+   * check no longer matches, but it is still within the grace period.
+   * Sending is not yet affected; fix it before the grace period ends.
+   * - `failed` — DNS records resolved but at least one value is wrong.
+   * Update your DNS to recover.
+   * - `temporary_failure` — DNS lookup failed transiently. Verification is
+   * queued for retry; don't change DNS records yet.
+   * - `not_configured` — the capability is not set up on this domain
+   * (e.g. no tracking domain configured).
+   *
+   */
+  readonly status: "pending" | "verified" | "warning" | "failed" | "temporary_failure" | "not_configured";
+  /**
+   * Hostname this capability is configured with — the return-path domain, the tracking domain, or the domain where the DMARC policy was found. Null when not applicable or not configured.
+   *
+   */
+  readonly domain?: string | null;
+  pending?: DomainCapabilityPending;
+  /**
+   * Machine-readable reason code for a failed capability status. Only set when `status` is `failed`. Use this to display a specific message to users rather than a generic failure message.
+   * - `tracking_domain_in_use` — the link tracking subdomain is already claimed
+   * by another organization.
+   *
+   */
+  readonly reason?: string | null;
+};
+type DomainCapabilities = {
+  sending: DomainCapability & unknown;
+  return_path: DomainCapability & unknown;
+  dmarc: DomainCapability & unknown;
+  tracking: DomainCapability & unknown;
+  inbound?: DomainCapability & unknown;
+};
+/**
+ * Active DKIM signing configuration for the domain.
+ */
+type DomainDkim = {
+  /**
+   * How the DKIM public key is published in your DNS. `txt` — you publish the key as a TXT record. `delegated` — you publish a single CNAME and Bird hosts and rotates the key.
+   *
+   */
+  readonly mode: "txt" | "delegated";
+  /**
+   * DKIM selector used to sign mail from this domain.
+   */
+  readonly selector: string;
+  /**
+   * RSA key size in bits.
+   */
+  readonly key_size: number;
+};
+type Domain = {
+  readonly id: DomainId;
+  readonly workspace_id: WorkspaceId;
+  /**
+   * The sending domain name. Set at creation and immutable.
+   */
+  readonly domain: string;
+  /**
+   * The DNS provider hosting this domain's nameservers, so you know which provider's dashboard to manage the required DNS records in. Returns "other" when the provider has not been detected or is not recognized.
+   *
+   */
+  readonly vendor: "other" | "cloudflare" | "route53" | "godaddy" | "namecheap" | "google" | "azure" | "digitalocean" | "squarespace";
+  /**
+   * Domain ownership verification, proven by the DKIM record. Readiness to send or track is reported separately per capability under `capabilities.*.status`.
+   * - `pending` — the DKIM record has not been published yet. - `verified` — the DKIM record is in place; ownership is confirmed. - `failed` — a DKIM record exists but does not match the expected
+   * value (for example a stale record from an earlier setup), or a
+   * previously verified record was removed. Correct the record to
+   * recover.
+   * - `temporary_failure` — DNS resolution failed transiently (timeout,
+   * unreachable nameserver). Verification is queued for retry on a 72h
+   * cadence; customer should not edit DNS records before the retry runs.
+   * - `rejected` — the domain was refused for policy reasons and cannot be
+   * used for sending. Contact support if you believe this is an error.
+   *
+   */
+  readonly status: "pending" | "verified" | "failed" | "temporary_failure" | "rejected";
+  settings: DomainSettings;
+  readonly dkim: DomainDkim;
+  capabilities: DomainCapabilities;
+  /**
+   * The domain's DNS records and their individual verification state, returned in full on both the list and single-domain responses. This is the complete set to publish across DKIM, return-path, DMARC, tracking, and inbound; records for a staged change carry `state: pending`. Inbound MX records are always included as a regional reference, even while receiving is off (`capabilities.inbound.status` is `not_configured`) — their presence alone does not mean receiving is enabled (see `DomainUpdate.inbound`).
+   *
+   */
+  readonly dns_records: Array<DnsRecord>;
+  /**
+   * When Bird last checked this domain's DNS records, whether or not the outcome changed. Updated on every verification — your manual refresh and the periodic automatic re-checks alike. Null if the domain has never been checked.
+   *
+   */
+  readonly last_checked_at?: string | null;
+  /**
+   * When the domain's ownership was confirmed — the moment `status` became `verified` via the DKIM record. Unchanged by later re-checks while it stays verified. Null if the domain has never been verified.
+   *
+   */
+  readonly verified_at?: string | null;
+  /**
+   * When the domain was added.
+   */
+  readonly created_at: string;
+  /**
+   * When the domain's configuration was last changed (such as a settings or return-path change). Verification re-checks do not change this; see `last_checked_at` and `verified_at` for verification timing.
+   *
+   */
+  readonly updated_at: string;
+};
 type WhatsAppTemplateList = {
   /**
    * The templates available to your workspace.
@@ -1508,29 +1965,6 @@ type WhatsAppEventList = {
    */
   data: Array<WhatsAppEvent>;
 };
-/**
- * Bird-stable failure reason, uniform whether the failure happened internally or was reported by the WhatsApp network. `insufficient_balance` — the workspace could not afford the send. `price_not_found` — no price was configured for this destination/template combination. `internal_error` — an unexpected Bird-side failure. `undeliverable` — the recipient could not be reached (e.g. not on WhatsApp, number invalid). `service_window_expired` — the 24-hour customer care window has closed and a free-form message cannot be sent; send a template instead. `rate_limited` — the send was throttled.
- *
- */
-type WhatsAppErrorCode = string;
-/**
- * Failure detail for a message that could not be delivered. Null when there is no failure.
- */
-type WhatsAppError = {
-  code: WhatsAppErrorCode;
-  /**
-   * Human-readable explanation of the failure.
-   */
-  readonly description: string;
-  /**
-   * Raw error code from the WhatsApp Cloud API, when available, for low-level debugging.
-   */
-  readonly meta_error_code?: string | null;
-  /**
-   * When the failure occurred.
-   */
-  readonly occurred_at: string;
-} | null;
 type WhatsAppEventId = string;
 type WhatsAppEvent = {
   /**
@@ -1549,7 +1983,7 @@ type WhatsAppEvent = {
   /**
    * Failure detail. Present on `whatsapp.failed` events; null otherwise.
    */
-  error: WhatsAppError;
+  error?: WhatsAppError;
 };
 type SendWhatsAppMessageRequest = {
   /**
@@ -1664,7 +2098,6 @@ type WhatsAppMessageBusiness = {
    */
   readonly phone_number_id?: string;
 };
-type WhatsAppMessageId = string;
 type WhatsAppMessage = {
   /**
    * Message ID.
@@ -3087,6 +3520,42 @@ type ListWhatsAppMessageEventsData = {
   };
   url: "/v1/whatsapp/messages/{message_id}/events";
 };
+type ListDomainsData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Substring match against the domain name (case-insensitive).
+     */
+    name?: string;
+    /**
+     * Field to sort by.
+     */
+    sort?: "created_at" | "name";
+    /**
+     * Sort direction. Defaults to `desc` (newest/largest first).
+     *
+     */
+    order?: "asc" | "desc";
+    /**
+     * Maximum number of items to return per page.
+     */
+    limit?: number;
+    /**
+     * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
+     */
+    starting_after?: string;
+    /**
+     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     */
+    ending_before?: string;
+    /**
+     * When true, the response includes a `total` field with the total number of items matching the request's filters across all pages.
+     */
+    include_total?: boolean;
+  };
+  url: "/v1/email/domains";
+};
 //#endregion
 //#region src/generated/core/auth.gen.d.ts
 type AuthToken = string | undefined;
@@ -3653,6 +4122,76 @@ declare class AudiencesResource extends Resource {
   removeContact(audienceId: string, contactId: string, options?: RequestOptions): APIPromise<void>;
 }
 //#endregion
+//#region src/resources/domains.d.ts
+/** Body for `bird.domains.create`. */
+type DomainCreateParams = DomainCreate;
+/**
+ * Body for `bird.domains.update` — a partial patch. Omit a field to leave it
+ * unchanged; send `tracking: null` to remove the tracking domain (both tracking
+ * toggles must be off first, else the API returns 409).
+ */
+type DomainUpdateParams = DomainUpdate;
+/** Filters and cursor params for `bird.domains.list`. */
+type DomainListQuery = NonNullable<ListDomainsData["query"]>;
+declare class DomainsResource extends Resource {
+  /**
+   * Register a sending domain. Returns it in `pending` with the `dns_records`
+   * to publish at your DNS provider; call `verify` once they are in place.
+   *
+   * @example Register a sending domain
+   * const domain = await bird.domains.create({ domain: "mail.acme.com" });
+   * console.log(domain.id, domain.status); // "dom_…", "pending"
+   */
+  create(params: DomainCreateParams, options?: RequestOptions): APIPromise<Domain>;
+  /**
+   * List the workspace's sending domains, newest first. `await` resolves the
+   * first page; `for await` walks every domain across pages.
+   *
+   * @example
+   * for await (const domain of bird.domains.list()) {
+   *   console.log(domain.id, domain.status);
+   * }
+   */
+  list(query?: DomainListQuery, options?: RequestOptions): PaginatedPromise<Domain>;
+  /**
+   * Fetch a single sending domain by id, with its DNS records and their
+   * per-record verification state.
+   *
+   * @example
+   * const domain = await bird.domains.get("dom_01krdgeqcxet5s7t44vh8rt9mg");
+   */
+  get(domainId: string, options?: RequestOptions): APIPromise<Domain>;
+  /**
+   * Update a sending domain. Only the fields you send change; `settings` apply
+   * immediately, while `return_path`/`tracking`/`dkim` changes are staged until
+   * their new DNS records verify.
+   *
+   * @example
+   * await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   settings: { click_tracking: true, open_tracking: true },
+   *   tracking: { name: "links" },
+   * });
+   */
+  update(domainId: string, params: DomainUpdateParams, options?: RequestOptions): APIPromise<Domain>;
+  /**
+   * Delete a sending domain. Mail already accepted still sends; you can no
+   * longer send new mail from it.
+   *
+   * @example
+   * await bird.domains.delete("dom_01krdgeqcxet5s7t44vh8rt9mg");
+   */
+  delete(domainId: string, options?: RequestOptions): APIPromise<void>;
+  /**
+   * Trigger a fresh DNS check and return the refreshed domain with per-record
+   * results. Safe to repeat while waiting for DNS to propagate.
+   *
+   * @example
+   * const domain = await bird.domains.verify("dom_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(domain.status); // "verified" once DNS is in place
+   */
+  verify(domainId: string, options?: RequestOptions): APIPromise<Domain>;
+}
+//#endregion
 //#region src/resources/contactProperties.d.ts
 /** Body for `bird.contactProperties.create`. */
 type ContactPropertyCreateParams = ContactPropertyCreateRequest;
@@ -4128,6 +4667,8 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly audiences: AudiencesResource;
   /** Contact properties — `bird.contactProperties.create(...)`, `.list(...)`, `.archive(...)`, … */
   readonly contactProperties: ContactPropertiesResource;
+  /** Sending domains — `bird.domains.create(...)`, `.list(...)`, `.verify(...)`, … */
+  readonly domains: DomainsResource;
   /** Webhooks — `bird.webhooks.unwrap(payload, headers)` verifies an inbound delivery. */
   readonly webhooks: WebhooksResource;
   constructor(options: O);
@@ -4195,9 +4736,14 @@ declare const WebhookEventType: {
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
   readonly SmsUndelivered: "sms.undelivered";
+  readonly WhatsappAccepted: "whatsapp.accepted";
+  readonly WhatsappDelivered: "whatsapp.delivered";
+  readonly WhatsappFailed: "whatsapp.failed";
+  readonly WhatsappRead: "whatsapp.read";
+  readonly WhatsappSent: "whatsapp.sent";
 };
 /** A known webhook event type value. */
 type WebhookEventTypeValue = (typeof WebhookEventType)[keyof typeof WebhookEventType];
 //#endregion
-export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceContactsQuery, type AudienceCreateParams, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type CursorPage, type EmailChannelDefaults, type EmailListQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type ErrorDetail, type ErrorNextAction, type PaginatedPromise, type RequestOptions, type SafeResult, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, type UnmetGate, type Verification, type VerificationCheckParams, type VerificationCheckResult, type VerificationCreateParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, type WhatsAppEventList, type WhatsAppMessage, type WhatsAppTemplate, type WhatsAppTemplateList, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
+export { type APIPromise, type Audience, type AudienceAddContactsParams, type AudienceContactsQuery, type AudienceCreateParams, type AudienceListQuery, type AudienceMember, type AudienceRemoveContactsParams, type AudienceUpdateParams, BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, type BirdClientOptions, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, type BirdRequest, type BirdResponse, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, type BirdWebhookEvent, BirdWebhookVerificationError, type Contact, type ContactBatchParams, type ContactCreateParams, type ContactListQuery, type ContactProperty, type ContactPropertyCreateParams, type ContactPropertyListQuery, type ContactPropertyUpdateParams, type ContactUpdateParams, type ContactUpsertResult, type CursorPage, type DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, type EmailListQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type ErrorDetail, type ErrorNextAction, type PaginatedPromise, type RequestOptions, type SafeResult, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, type UnmetGate, type Verification, type VerificationCheckParams, type VerificationCheckResult, type VerificationCreateParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, type WhatsAppEventList, type WhatsAppMessage, type WhatsAppTemplate, type WhatsAppTemplateList, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.d.mts.map