@messagebird/sdk 0.12.2 → 0.14.0

package/dist/index.d.mts

@@ -80,7 +80,7 @@ interface ErrorDetail {
   /** What is wrong with this field. */
   message: string;
 }
-/** One recovery step: an operation to call to resolve the error (ADR-0073). */
+/** One recovery step: an operation to call to resolve the error. */
 interface ErrorNextAction {
   /** operationId of the follow-up operation that resolves this error. */
   operation: string;
@@ -118,9 +118,9 @@ interface BirdAPIErrorFields {
   param?: string;
   /** Verbatim code from a downstream system (SMTP reply, payment decline). */
   vendorCode?: string;
-  /** Human recovery line for this error, when a recovery is known (ADR-0073). */
+  /** Human recovery line for this error, when a recovery is known. */
   remediation?: string;
-  /** Operations that resolve this error, in the order to try them (ADR-0073). */
+  /** Operations that resolve this error, in the order to try them. */
   next?: ErrorNextAction[];
   /** Verification requirements blocking this action, when it is blocked pending verification. */
   unmetGates?: UnmetGate[];
@@ -180,7 +180,7 @@ declare class BirdInternalError extends BirdAPIError {
 declare class BirdNotImplementedError extends BirdAPIError {
   constructor(fields: BirdAPIErrorFields);
 }
-/** 421 — request reached the wrong region (ADR-0036). */
+/** 421 — request reached the wrong region. */
 declare class BirdMisdirectedError extends BirdAPIError {
   constructor(fields: BirdAPIErrorFields);
 }
@@ -223,7 +223,7 @@ interface RequestOptions {
  * failure `error` is a `BirdError` you can `instanceof`-narrow, and `data`/
  * `response` are `null` — the metadata you need (status, request id) is on the
  * error itself. A caller-initiated abort is not a Bird failure and still throws
- * (the native `AbortError`, ADR-0042 §1).
+ * (the native `AbortError`).
  */
 type SafeResult<T> = {
   data: T;
@@ -531,7 +531,11 @@ type EventVoiceCallInitiated = {
   data: EventVoiceCallInitiatedData;
 };
 /**
- * Call status. v1 records are always terminal and carry one of answered, no_answer, failed, rejected, or unknown. The remaining values are declared ahead of planned features so their arrival is not a breaking contract change: busy and canceled arrive with inbound (DID) termination — today both outcomes are folded into failed — and ringing and in_progress with a live-calls surface.
+ * Call status.
+ *
+ * A call that has ended carries answered, no_answer, failed, rejected, or unknown. A call that is still up carries ringing before it is picked up and in_progress once it is; both are what the `status` filter on the call list selects on to show calls happening right now.
+ *
+ * busy and canceled are declared ahead of the feature that produces them, so their arrival is not a breaking contract change: they come with inbound termination, and today both outcomes are folded into failed.
  *
  */
 type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
@@ -691,7 +695,7 @@ type EventVerifyVerificationCreated = {
   data: EventVerifyVerificationCreatedData;
 };
 /**
- * Why a passcode send did not deliver. Open enum — new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error. v1 emits `carrier_rejected` (SMS), `hard_bounce` (email), `undelivered` (a generic terminal delivery failure), and `channel_unavailable` (the channel could not be used and the verification failed over).
+ * Why a passcode send did not deliver. Open enum — new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error. Emitted reasons are `carrier_rejected` (SMS), `hard_bounce` (email, permanent bounce), `soft_bounce` (email, transient bounce such as a full mailbox), `undelivered` (a generic delivery failure), and `channel_unavailable` (the channel could not be used and the verification failed over).
  */
 type VerificationAttemptFailureReason = string;
 /**
@@ -2072,20 +2076,6 @@ type Timestamps = {
   readonly created_at: string;
   readonly updated_at: string;
 };
-type ListEnvelope = {
-  /**
-   * Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.
-   */
-  next_cursor: string | null;
-  /**
-   * Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.
-   */
-  prev_cursor: string | null;
-  /**
-   * Refresh anchor. Pass back as `ending_before` later to fetch items that have appeared since this response. Non-null whenever `data` is non-empty; null only on an empty page. Distinct from `prev_cursor`.
-   */
-  refresh_cursor: string | null;
-};
 /**
  * The labels available in a mailbox.
  */
@@ -2156,12 +2146,13 @@ type EmailMailboxComposeRequest = {
   metadata?: {
     [key: string]: unknown;
   };
-  /**
-   * Content classification — controls suppression policy. `marketing` blocks on all suppression reasons; `transactional` allows delivery through complaint and unsubscribe suppressions. Default: transactional.
-   *
-   */
-  category?: "marketing" | "transactional";
+  category?: EmailMessageCategory;
 };
+/**
+ * Content classification. Controls suppression policy: `marketing` blocks on all suppression reasons; `transactional` allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail.
+ *
+ */
+type EmailMessageCategory = "marketing" | "transactional";
 /**
  * File attached to an email send. The attachment bytes are passed as base64-encoded `content` directly in the request body (required). The `path` field (provide a URL and Bird fetches the attachment for you) is a preview feature and currently unavailable. Requests are rejected with 422 if `content` is missing — `path` alone does not satisfy the schema. When `path` becomes generally available, the schema will be relaxed so that exactly one of `content` or `path` is required.
  * Inline images for `<img src="cid:..."/>` references in the HTML body use the `content_id` field together with `content`.
@@ -2243,11 +2234,12 @@ type EmailThreadMessageReplyRequest = {
   metadata?: {
     [key: string]: unknown;
   };
+  category?: EmailMessageCategory;
   /**
-   * Content classification — controls suppression policy. `marketing` blocks on all suppression reasons; `transactional` allows delivery through complaint and unsubscribe suppressions. Default: transactional.
+   * File attachments to include with the reply. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata endures on the message's `attachment_manifest`; the bytes are downloadable for 30 days.
    *
    */
-  category?: "marketing" | "transactional";
+  attachments?: Array<EmailAttachment>;
 };
 /**
  * The attachments on a conversation message.
@@ -2306,9 +2298,6 @@ type EmailLabelsUpdate = {
    */
   remove?: Array<string>;
 };
-type EmailThreadMessageList = {
-  data: Array<EmailThreadMessage>;
-} & ListEnvelope;
 /**
  * Link to the message's entry in the received-message or sent-message log, which carries delivery analytics such as per-recipient events. Log entries expire 30 days after the message occurred.
  *
@@ -2462,9 +2451,6 @@ type EmailThreadUpdateRequest = {
    */
   contact_id?: ContactId | null;
 };
-type EmailThreadList = {
-  data: Array<EmailThread>;
-} & ListEnvelope;
 /**
  * Matched search fragments for a thread, one array per field the query matched, with the matched terms wrapped in `**`. A field is present only when the query matched it, so the keys that are present tell you which fields produced the hit. Returned only on thread search results.
  *
@@ -2560,9 +2546,6 @@ type ReceiveRuleCreate = {
    */
   note?: string;
 };
-type ReceiveRuleList = {
-  data: Array<ReceiveRule>;
-} & ListEnvelope;
 type ReceiveRuleId = string;
 /**
  * An allow or block entry on a mailbox, evaluated when inbound mail arrives. Matching is against the message's envelope sender; domain entries also match subdomains. A given entry can be allow or block, never both.
@@ -2941,9 +2924,6 @@ type MailboxCreate = {
     [key: string]: unknown;
   };
 };
-type MailboxList = {
-  data: Array<Mailbox>;
-} & ListEnvelope;
 type InboundAddressId = string;
 /**
  * The principal that owns the mailbox. Always the workspace.
@@ -3042,14 +3022,26 @@ type Mailbox = {
  */
 type DomainUpdate = {
   settings?: DomainSettings;
-  return_path?: DomainReturnPathConfig & unknown;
+  /**
+   * Change the return-path name part. Cannot be removed — the return-path is required for sending.
+   *
+   */
+  return_path?: DomainReturnPathConfig;
   /**
    * 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;
+  /**
+   * Change how the DKIM key is published. The current key keeps signing until the new configuration verifies, so mail is never sent unsigned during the transition.
+   *
+   */
+  dkim?: DomainDkimConfig;
+  /**
+   * Enable or disable receiving on this domain. Enabling claims the domain for inbound and moves `capabilities.inbound.status` from `not_configured` to `pending`, then `verified` once the MX records resolve to Bird. The MX records to publish are always present under `dns_records` (`purpose: inbound_mx`) as a regional reference, so their presence does not mean receiving is on — a domain still needs enabling whenever `capabilities.inbound.status` is `not_configured`. Enabling requires the domain's DKIM to be verified first (ownership proof): a fresh enable on a domain whose DKIM is not verified returns `422` `E05019` and claims nothing. A domain already receiving inbound for another organization returns `422` `E05018`.
+   *
+   */
+  inbound?: DomainInboundConfig;
 };
 /**
  * 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.
@@ -3239,11 +3231,31 @@ type DomainCapability = {
   readonly reason?: string | null;
 };
 type DomainCapabilities = {
-  sending: DomainCapability & unknown;
-  return_path: DomainCapability & unknown;
-  dmarc: DomainCapability & unknown;
-  tracking: DomainCapability & unknown;
-  inbound?: DomainCapability & unknown;
+  /**
+   * Overall authorization to send from this domain. Verified when the DKIM record, the return-path CNAME, and a DMARC policy are all in place. Required for live sends.
+   *
+   */
+  sending: DomainCapability;
+  /**
+   * Return-path (bounce) CNAME verification. The return-path domain receives bounce and complaint notifications and is what mailbox providers check for SPF — no separate SPF record is needed.
+   *
+   */
+  return_path: DomainCapability;
+  /**
+   * DMARC policy check. Satisfied by any valid DMARC record covering the sending domain — on the domain itself or on its registered (organizational) domain; `domain` reports where the policy was found. A minimal policy of `p=none` is sufficient.
+   *
+   */
+  dmarc: DomainCapability;
+  /**
+   * Branded open/click tracking domain. `not_configured` until a tracking domain is set. Tracked links are served over HTTPS once the CNAME verifies.
+   *
+   */
+  tracking: DomainCapability;
+  /**
+   * Inbound mail receiving. `not_configured` until receiving is enabled on this domain (see `DomainUpdate.inbound`), then `pending` while the published MX records are checked, and `verified` once they resolve to Bird. The MX records to publish are always listed under `dns_records` (`purpose: inbound_mx`) as a regional reference, even while this is `not_configured` — enabling is what actually starts delivery.
+   *
+   */
+  inbound?: DomainCapability;
 };
 /**
  * Active DKIM signing configuration for the domain.
@@ -3321,7 +3333,10 @@ type Domain = {
  * Per-broadcast breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByBroadcastResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Broadcast breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no broadcast messages were active in the period.
    */
@@ -3409,7 +3424,10 @@ type EmailStatsPeriod = {
  * Per-complaint-type breakdown for the requested period, ranked by `complained` descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByComplaintTypeResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Complaint-type breakdown rows, ranked by `complained` descending. Empty when no complaints occurred in the period.
    */
@@ -3438,7 +3456,10 @@ type EmailComplaintTypeStatsPoint = {
  * Per-SMTP-code bounce breakdown for the requested period, ranked by the `sort` metric (default `bounced`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByBounceCodeResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Bounce-code breakdown rows, ranked by the `sort` metric (default `bounced`) descending. Empty when no bounces occurred in the period.
    */
@@ -3499,7 +3520,10 @@ type EmailBounceCodeStatsPoint = {
  * Per-client engagement breakdown for the requested period, grouped by the requested `group_by` facet, ranked by the `sort` metric (default `unique_opens`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByClientResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Client breakdown rows, ranked by the `sort` metric (default `unique_opens`) descending. Empty when no opens or clicks with a detected client occurred in the period.
    */
@@ -3565,7 +3589,10 @@ type EmailClientStatsPoint = {
  * Per-location engagement breakdown for the requested period, grouped at the requested `group_by` granularity, ranked by the `sort` metric (default `unique_opens`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByLocationResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Location breakdown rows, ranked by the `sort` metric (default `unique_opens`) descending. Empty when no opens or clicks with a resolved location occurred in the period.
    */
@@ -3604,7 +3631,10 @@ type EmailEngagementSortMetric = "opens" | "opens_non_prefetched" | "unique_open
  * Per-template breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByTemplateResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Template breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no templated messages were active in the period.
    */
@@ -3636,7 +3666,10 @@ type EmailTemplateStatsPoint = {
  * Per-recipient-domain breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByRecipientDomainResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Recipient-domain breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no eligible activity occurred in the period.
    */
@@ -3667,7 +3700,10 @@ type EmailRecipientDomainStatsPoint = {
  * Per-(mailbox provider, provider region) breakdown for the requested period, ranked by the `sort` metric (default `delivered`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByMailboxProviderRegionResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Provider-region breakdown rows, ranked by the `sort` metric (default `delivered`) descending. Empty when no deliveries occurred in the period.
    */
@@ -3754,7 +3790,10 @@ type EmailMailboxProviderRegionStatsPoint = {
  * Per-mailbox-provider breakdown for the requested period, ranked by the `sort` metric (default `delivered`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByMailboxProviderResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Mailbox-provider breakdown rows, ranked by the `sort` metric (default `delivered`) descending. Empty when no eligible activity occurred in the period.
    */
@@ -3791,7 +3830,10 @@ type EmailMailboxProviderSortMetric = "delivered" | "bounced" | "complained" | "
  * Per-category breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsByCategoryResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Category breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no sends occurred in the period.
    */
@@ -3822,7 +3864,10 @@ type EmailCategoryStatsPoint = {
  * Per-sending-domain breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsBySendingDomainResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Sending-domain breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no eligible activity occurred in the period.
    */
@@ -3853,7 +3898,10 @@ type EmailSendingDomainStatsPoint = {
  * Per-sending-IP breakdown for the requested period, ranked by the `sort` metric (default `delivered`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsBySendingIpResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Sending-IP breakdown rows, ranked by the `sort` metric (default `delivered`) descending. Empty when no per-IP-attributable activity (delivery, bounce, deferral, or late bounce) occurred in the period.
    */
@@ -3948,7 +3996,10 @@ type EmailSendingIpStatsPoint = {
  *
  */
 type EmailStatsSummary = {
-  period: EmailStatsSummaryPeriod & unknown;
+  /**
+   * The window the response covers (echoed back from the request, day or hour grain), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsSummaryPeriod;
   /**
    * Distinct email messages accepted, counted at the message level (one per accepted send regardless of recipient count) and summed per bucket across the period. This counts messages, not recipients, so it is not comparable to `delivery.accepted`, which counts recipients (a single message to 500 recipients is 1 here and up to 500 there).
    */
@@ -4013,7 +4064,10 @@ type EmailStatsComparisonDelta = {
  *
  */
 type EmailStatsComparison = {
-  period: EmailStatsSummaryPeriod & unknown;
+  /**
+   * The preceding window these comparison figures cover, the equal-length window ending immediately before the requested start (the prior day for day windows, the prior hour for hour windows). For a request covering 2026-05-01 to 2026-05-31, this is 2026-03-31 to 2026-04-30, both inclusive.
+   */
+  period: EmailStatsSummaryPeriod;
   /**
    * Distinct email messages accepted in the preceding period, counted at the message level.
    */
@@ -4046,7 +4100,10 @@ type EmailStatsSummaryPeriod = {
  * Per-tag breakdown for the requested period, ranked by the `sort` metric (default `processed`) descending and capped at the requested `limit` (default 50, max 200).
  */
 type EmailStatsTagsResponse = {
-  period: EmailStatsPeriod & unknown;
+  /**
+   * The date range the response covers (echoed back from the request), plus `data_as_of`, the freshness boundary the data is current to.
+   */
+  period: EmailStatsPeriod;
   /**
    * Tag breakdown rows, ranked by the `sort` metric (default `processed`) descending. Empty when no tagged sends occurred in the period.
    */
@@ -4108,123 +4165,6 @@ type EmailStatsPoint = {
   readonly engagement: EmailEngagementStats;
   readonly latency: EmailLatencyStats;
 };
-type WhatsAppTemplateList = {
-  /**
-   * The templates available to your workspace.
-   */
-  data: Array<WhatsAppTemplate>;
-};
-type WhatsAppTemplateButton = {
-  /**
-   * The button's behavior type.
-   */
-  readonly type: string;
-  /**
-   * How the recipient receives the one-time passcode. Present on authentication-template OTP buttons.
-   */
-  readonly otp_type?: string;
-  /**
-   * The button's label text.
-   */
-  readonly text: string;
-  /**
-   * The URL the button opens, with any variable placeholder shown inline. Present on link buttons.
-   */
-  readonly url?: string;
-  /**
-   * Example values for this button's variables, in placeholder order. Present when the button URL has variables.
-   */
-  readonly example_parameters?: Array<WhatsAppTemplateExampleParameter>;
-};
-/**
- * The kind of value a template parameter accepts. `text` (the only kind today) is a plain string substituted into the placeholder. Open enum: more kinds may be added over time.
- *
- */
-type WhatsAppTemplateParameterType = string;
-type WhatsAppTemplateExampleParameter = {
-  /**
-   * The kind of value this parameter accepts.
-   */
-  readonly type: WhatsAppTemplateParameterType;
-  /**
-   * An example value for a text parameter. Present when `type` is `text`.
-   */
-  readonly text?: string;
-  /**
-   * The named placeholder this example fills, for templates that use named parameters. Absent for system templates, which use positional parameters.
-   */
-  readonly name?: string;
-};
-type WhatsAppTemplateComponent = {
-  /**
-   * The content block's type within the template.
-   */
-  readonly type: string;
-  /**
-   * The block's text content, with any variable placeholders shown inline. Present when the block carries text.
-   */
-  readonly text?: string;
-  /**
-   * Example values for this block's variables, in placeholder order (one per `{{n}}`). Use them to see what a filled message looks like. Present when the block has variables.
-   */
-  readonly example_parameters?: Array<WhatsAppTemplateExampleParameter>;
-  /**
-   * The buttons attached to this block. Present when the block carries buttons.
-   */
-  readonly buttons?: Array<WhatsAppTemplateButton>;
-};
-/**
- * A message template's review and health status. `approved` (passed review and sendable), `pending` (review in progress), and `rejected` (failed review) are review outcomes. The rest reflect a template's ongoing health after approval: `paused` and `disabled` mean sending from it is suspended, `in_appeal` means a review decision is under appeal, `pending_deletion` means the template is queued for removal, and `limit_exceeded` means it has exceeded a usage limit. Every template in Bird's catalogue is currently `approved`. Open enum: new statuses may be added over time, so treat any unrecognized value as a future status rather than an error.
- *
- */
-type WhatsAppTemplateStatus = string;
-/**
- * Meta's content classification for a template. `authentication` templates deliver one-time passcodes, `utility` templates deliver transaction-triggered updates (receipts, order status), and `marketing` templates carry promotional content. The category drives which sender number Bird selects and how the send is priced. Open enum: Meta may add new categories over time, so treat any unrecognized value as a future category rather than an error.
- *
- */
-type WhatsAppTemplateCategory = string;
-/**
- * Language code of the template variant (for example `en` or `pt_BR`).
- */
-type WhatsAppLanguage = string;
-/**
- * Whether the template is a built-in Bird template (`system`) or one your workspace authored (`workspace`).
- */
-type TemplateScope = "system" | "workspace";
-/**
- * A WhatsApp template's name — the stable handle used to reference the template when sending. Lowercase letters, numbers, and underscores.
- *
- */
-type WhatsAppTemplateName = string;
-type WhatsAppTemplateId = string;
-type WhatsAppTemplate = {
-  /**
-   * Stable Bird identifier for the template.
-   */
-  readonly id: WhatsAppTemplateId;
-  /**
-   * The template's stable handle. Pass it as the template reference when sending.
-   */
-  readonly name: WhatsAppTemplateName;
-  /**
-   * Optional description of the template's purpose. Null when unset.
-   */
-  readonly description?: string | null;
-  scope: TemplateScope;
-  readonly language: WhatsAppLanguage;
-  /**
-   * Content classification applied to messages sent from this template.
-   */
-  readonly category: WhatsAppTemplateCategory;
-  /**
-   * The template's review and health status.
-   */
-  readonly status: WhatsAppTemplateStatus;
-  /**
-   * The content blocks that make up the template, in display order.
-   */
-  readonly components: Array<WhatsAppTemplateComponent>;
-};
 type WhatsAppEventList = {
   /**
    * Timeline events for this WhatsApp message, in chronological order. The timeline is bounded and returned in full; this list is not paginated.
@@ -4275,6 +4215,11 @@ type WhatsAppMessageSendRequest = {
     [key: string]: unknown;
   };
 };
+/**
+ * The kind of value a template parameter accepts. `text` (the only kind today) is a plain string substituted into the placeholder. Open enum: more kinds may be added over time.
+ *
+ */
+type WhatsAppTemplateParameterType = string;
 type WhatsAppMessageTemplateComponentParameter = {
   /**
    * The kind of value this parameter carries. `text` is the only kind today.
@@ -4301,6 +4246,15 @@ type WhatsAppMessageTemplateComponent = {
    */
   parameters?: Array<WhatsAppMessageTemplateComponentParameter>;
 };
+/**
+ * Language code of the template variant (for example `en` or `pt_BR`).
+ */
+type WhatsAppLanguage = string;
+/**
+ * A WhatsApp template's name — the stable handle used to reference the template when sending. Lowercase letters, numbers, and underscores.
+ *
+ */
+type WhatsAppTemplateName = string;
 type WhatsAppTemplateSend = {
   /**
    * The template to send, by its name (for example `bird_otp`).
@@ -4317,11 +4271,30 @@ type WhatsAppTemplateSend = {
    */
   components?: Array<WhatsAppMessageTemplateComponent>;
 };
+/**
+ * ISO 4217 three-letter currency code.
+ */
+type CurrencyCode = string;
+type Money = {
+  /**
+   * Decimal amount as a string, in major currency units.
+   */
+  amount: string;
+  /**
+   * ISO 4217 currency code.
+   */
+  currency_code: CurrencyCode;
+};
 /**
  * Delivery status. `accepted` (the initial status of an outbound send) means Bird accepted the request and it is queued for sending. `sent` means it was handed to the WhatsApp network. `delivered` is confirmed delivery to the recipient's device. `failed` is a terminal permanent failure. `rejected` means the recipient is on the workspace's suppression list; the message was not sent and not charged. There is no `read` status: a read receipt is reported as `read_at` and a `whatsapp.read` event, not a status value. The remaining values are reserved and not returned today: `scheduled` (queued to send at a future time), `canceled` (a scheduled message canceled before sending), and `received` (an inbound message, `direction: inbound`, sent to you by a contact).
  *
  */
 type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "failed" | "rejected" | "canceled" | "received";
+/**
+ * Meta's content classification for a template. `authentication` templates deliver one-time passcodes, `utility` templates deliver transaction-triggered updates (receipts, order status), and `marketing` templates carry promotional content. The category drives which sender number Bird selects and how the send is priced. Open enum: Meta may add new categories over time, so treat any unrecognized value as a future category rather than an error.
+ *
+ */
+type WhatsAppTemplateCategory = string;
 /**
  * The template a message was sent from. On reads `name`, `language`, `category`, and `components` are always present; `components` is an empty array for an authentication template (the filled-in values, for example a verification code, are never returned).
  *
@@ -4388,6 +4361,7 @@ type WhatsAppMessage = {
    * When the message was read by the recipient. Null until then.
    */
   readonly read_at?: string | null;
+  cost?: Money | null;
   /**
    * Structured `{name, value}` filter labels applied to this message.
    */
@@ -4485,6 +4459,10 @@ type VerificationOptions = {
    */
   channels?: Array<VerificationChannel>;
 };
+/**
+ * Bucket grain for a stats trend series.
+ */
+type StatsTrendGrain = "daily" | "hourly";
 type SmsTemplateList = {
   /**
    * The templates available to your workspace. The catalogue is small and returned in full; this list is not paginated.
@@ -4520,6 +4498,10 @@ type TemplateVariable = {
  * Content classification. Tells Bird and carriers why you're sending; per-country compliance rules (opt-out policy, quiet hours) key on it as they roll out.
  */
 type SmsMessageCategory = "transactional" | "marketing" | "authentication" | "service";
+/**
+ * Whether the template is a built-in Bird template (`system`) or one your workspace authored (`workspace`).
+ */
+type TemplateScope = "system" | "workspace";
 /**
  * A template's send-by handle — the stable reference used in place of the template id when sending. Lowercase letters, numbers, hyphens, and underscores; starts and ends with a letter or number.
  *
@@ -4624,10 +4606,6 @@ type SmsCostBreakdown = {
    */
   carrier_surcharge: string;
 };
-/**
- * ISO 4217 three-letter currency code.
- */
-type CurrencyCode = string;
 /**
  * Cost of the message. Null until the message has been priced; the cost is populated as the message is processed, not at the moment it is accepted.
  */
@@ -4776,7 +4754,7 @@ type SmsMessageSendRequest = unknown & {
    */
   to: string;
   /**
-   * Sender to send from: an E.164 number (`+15557654321`), an alphanumeric sender ID (1-11 letters, digits, or spaces, for example `MyBrand`), or a short code (5-6 digits). A numeric sender must be a number your workspace owns; an alphanumeric sender is accepted where the destination country permits one. Required on a free-text send: omitting it returns a `422` `SMSNoEligibleSender`. Not accepted alongside `template`, which selects its sender automatically.
+   * Sender to send from: an E.164 number (`+15557654321`), an alphanumeric sender ID (1-11 letters, digits, spaces, dashes, or underscores, at least one of them a letter, for example `MyBrand`), or a short code (5-6 digits). A numeric sender must be a number your workspace owns; an alphanumeric sender is accepted where the destination country permits one. Required on a free-text send: omitting it returns a `422` `SMSNoEligibleSender`. Not accepted alongside `template`, which selects its sender automatically.
    *
    */
   from?: string;
@@ -4859,6 +4837,10 @@ type SmsMessageSendRequest = unknown & {
    */
   track_clicks?: boolean;
 };
+/**
+ * Whether a message was sent from the workspace (`outbound`) or received by it (`inbound`).
+ */
+type MessageDirection = "outbound" | "inbound";
 type AudienceContactsRemoveRequest = {
   /**
    * Contacts to remove from the audience. Removing a contact that is not a member has no effect; duplicate IDs in the list are collapsed. If any ID does not exist in the workspace, the whole request fails with a validation error and no memberships are removed.
@@ -4971,15 +4953,16 @@ type ContactPropertyCreateRequest = {
    * The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
    */
   key: string;
-  /**
-   * The value type every contact must use for this property. Cannot be changed after creation.
-   */
-  type: "string" | "number" | "boolean";
+  type: ContactPropertyType;
   /**
    * Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null for no fallback; a value of another type returns a validation error.
    */
   fallback_value?: unknown;
 };
+/**
+ * The value type every contact must use for a property. Cannot be changed after creation.
+ */
+type ContactPropertyType = "string" | "number" | "boolean";
 type ContactPropertyId = string;
 type ContactProperty = {
   /**
@@ -4990,10 +4973,7 @@ type ContactProperty = {
    * The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
    */
   key: string;
-  /**
-   * The value type every contact must use for this property. Cannot be changed after creation.
-   */
-  type: "string" | "number" | "boolean";
+  type: ContactPropertyType;
   /**
    * Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null when no fallback is set.
    */
@@ -5146,17 +5126,31 @@ type EmailMessageBatchItem = {
  *
  */
 type EmailMessageBatchRequest = Array<EmailMessageSendRequest>;
+/**
+ * A language tag in BCP-47 form, for example `en` or `pt-BR`.
+ */
+type LanguageTag = string;
+/**
+ * A template's slug: its permanent, workspace-unique handle and API address. Lowercase letters, numbers, hyphens, and underscores. Fixed at creation, so anything that references it never breaks; the display name is the label to change freely.
+ *
+ */
+type TemplateSlug = string;
 type EmailTemplateSend = unknown & {
   /**
    * The template to send, by its id.
    */
   id?: EmailTemplateId;
   /**
-   * The template to send, by its name handle — a workspace template (for example `welcome-email`) or a built-in `system` template (for example `bird_welcome`).
+   * The template to send, by its slug handle. A workspace template (for example `welcome-email`) or a built-in `system` template (for example `bird_welcome`).
    */
-  name?: TemplateName;
+  slug?: TemplateSlug;
+  /**
+   * Which of the template's languages to send. Omit it to send the template's default language. When the template does not carry the language you ask for, its own `on_missing_language` setting decides whether the closest available language is sent instead or the send is rejected.
+   *
+   */
+  language?: LanguageTag;
   /**
-   * Values for the template's variables, keyed by variable name. A token with no matching value renders empty. Cap: 16 KB serialized.
+   * Values for the template's variables, keyed by variable name. A token with no matching value renders empty. Send everything the template's `variables` lists rather than only what you expect the chosen language to use: languages need not reference the same variables, and a value no language uses is ignored. Cap: 16 KB serialized.
    *
    */
   parameters?: {
@@ -5241,11 +5235,7 @@ type EmailMessageSendRequest = {
    *
    */
   ip_pool_id?: string;
-  /**
-   * Content classification — independent of which endpoint you use. Controls suppression policy: `marketing` blocks on all suppression reasons (use for marketing content); `transactional` allows delivery through complaint and unsubscribe suppressions (use for receipts, password resets, and similar operational messages). Default: marketing.
-   *
-   */
-  category?: "marketing" | "transactional";
+  category?: EmailMessageCategory;
   /**
    * Preview feature — threaded replies. Currently unavailable; supplying this field returns `422 UnsupportedEmailFeature`. When generally available, sets In-Reply-To and References headers automatically.
    */
@@ -5349,11 +5339,7 @@ type EmailMessage = {
    * Message subject line.
    */
   subject: string;
-  /**
-   * Content classification. Controls suppression policy — `marketing` blocks on all suppression reasons; `transactional` allows delivery through complaint and unsubscribe suppressions.
-   *
-   */
-  category: "marketing" | "transactional";
+  category: EmailMessageCategory;
   /**
    * Reply-To addresses, if set on the send. Empty/null when no Reply-To was provided.
    */
@@ -5458,52 +5444,255 @@ type EmailMessage = {
    */
   readonly scheduled_at?: string | null;
 };
-type ListEmailMessagesData = {
-  body?: never;
-  path?: never;
-  query?: {
-    /**
-     * 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;
-    /**
-     * Return only resources created at or after this timestamp (inclusive lower bound). Combine with `created_before` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
-     */
-    created_after?: string;
-    /**
-     * Return only resources created strictly before this timestamp (exclusive upper bound). Combine with `created_after` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
-     */
-    created_before?: string;
-    /**
-     * Filter by aggregate delivery status.
-     */
-    status?: "scheduled" | "accepted" | "processed" | "deferred" | "delivered" | "partial_failure" | "bounced" | "complained" | "rejected" | "canceled";
-    /**
-     * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (e.g. `category:welcome`). Repeat the parameter to AND-combine several tag filters.
-     *
-     */
-    tag?: Array<string>;
-    /**
-     * Filter by category.
-     */
-    category?: "marketing" | "transactional";
-    /**
-     * Filter by recipient address. Exact match against any `to`/`cc`/`bcc` recipient on the message; normalised to lowercase before comparison.
-     *
-     */
-    to?: string;
-    /**
-     * Filter by sender address. Exact match against the message `from` field; normalised to lowercase before comparison.
-     *
-     */
+/**
+ * The members present on a presence channel.
+ */
+type RealtimeChannelMembers = {
+  members: Array<RealtimeChannelMember>;
+};
+/**
+ * An app-defined member id — the identity of your application's end user ("member"), assigned when your auth server authorizes them. Never a Bird user. Max 128 characters, restricted to URL-safe characters because member ids appear directly in API request paths. Broader than a channel name — allows `+ : @ . _ -` etc. for real identifiers (phone numbers, emails, `member:42`), but excludes `/ ? # %` and whitespace.
+ */
+type RealtimeMemberId = string;
+/**
+ * A member present on a presence channel.
+ */
+type RealtimeChannelMember = {
+  member_id: RealtimeMemberId;
+};
+type RealtimeChannelInfo = RealtimeChannelCounts & {
+  /**
+   * Whether at least one client is subscribed.
+   */
+  occupied: boolean;
+};
+/**
+ * Per-channel counts, present only when requested via `include` and applicable.
+ */
+type RealtimeChannelCounts = {
+  /**
+   * Distinct members (presence channels only; requires include=member_count).
+   */
+  member_count?: number;
+  /**
+   * Connections currently subscribed to this channel (requires include=connection_count and the app's connection-counting flag). Channel-scoped — distinct from the app-wide peak connections metric.
+   */
+  connection_count?: number;
+};
+/**
+ * The app's occupied channels. The Realtime service does not paginate this listing, so all occupied channels are returned in one response.
+ */
+type RealtimeChannelsList = {
+  /**
+   * The occupied channels, sorted by name.
+   */
+  data: Array<RealtimeChannelListItem>;
+};
+/**
+ * A Realtime channel name. Only letters, digits, and _ - = @ , . ; Prefix with `private-` or `presence-` for authenticated channels.
+ */
+type RealtimeChannelName = string;
+type RealtimeChannelListItem = RealtimeChannelCounts & {
+  name: RealtimeChannelName;
+};
+/**
+ * The result of a Realtime batch publish. The events were accepted for delivery; delivery to connected clients is asynchronous.
+ *
+ */
+type RealtimeBatchPublishResult = {
+  /**
+   * Per-event channel attributes at publish time, present only when at least one event asked for them via `include`. Positional: one item per event, in request order.
+   */
+  readonly data?: Array<RealtimeBatchPublishResultItem>;
+};
+type RealtimeBatchPublishResultItem = RealtimeChannelCounts & {
+  channel: RealtimeChannelName;
+};
+/**
+ * A batch of events, each delivered to a single channel, in one request.
+ */
+type RealtimeBatchPublish = {
+  /**
+   * Up to 10 events per batch.
+   */
+  events: Array<RealtimeBatchEvent>;
+};
+/**
+ * A per-channel attribute to include in the response. `member_count` is presence-channels only; `connection_count` requires the app's connection-counting flag.
+ */
+type RealtimeChannelInclude = "member_count" | "connection_count";
+/**
+ * Exclude this connection from delivery, to avoid echoing a change back to the client that triggered it. The value is the client's connection id, assigned when its connection is established.
+ */
+type RealtimeExcludeConnectionId = string;
+/**
+ * Arbitrary JSON payload delivered as the event data — an object, array, or scalar. Cap: 10 KB serialized.
+ */
+type RealtimeEventData = unknown;
+/**
+ * The event name clients bind to. Application event names are free-form; the `bird:` and `bird_internal:` prefixes are reserved for the protocol and rejected.
+ */
+type RealtimeEventName = string;
+/**
+ * One item of a batch publish — a single event to a single channel.
+ */
+type RealtimeBatchEvent = {
+  event: RealtimeEventName;
+  channel: RealtimeChannelName;
+  data?: RealtimeEventData;
+  exclude_connection_id?: RealtimeExcludeConnectionId;
+  /**
+   * Attributes of this event's channel to return alongside the publish (same semantics and validation errors as on the channel endpoints). Requesting attributes counts as one additional message toward usage.
+   */
+  include?: Array<RealtimeChannelInclude>;
+};
+/**
+ * The result of a Realtime publish. The event was accepted and fanned out to the requested channels; delivery to connected clients is asynchronous.
+ *
+ */
+type RealtimePublishResult = {
+  /**
+   * Per-channel attributes at publish time, present only when the request asked for them via `include`; one item per distinct target channel, sorted by name.
+   */
+  readonly data?: Array<RealtimeChannelListItem>;
+};
+/**
+ * A Realtime publish: delivers one event to one or more channels of the app. Listing several channels fans the event out to all of them (broadcast) in a single call.
+ *
+ */
+type RealtimePublish = {
+  event: RealtimeEventName;
+  /**
+   * The channels to deliver the event to (up to 100 per call). Prefix with `private-` or `presence-` for authenticated channels.
+   *
+   */
+  channels: Array<RealtimeChannelName>;
+  data?: RealtimeEventData;
+  exclude_connection_id?: RealtimeExcludeConnectionId;
+  /**
+   * Per-channel attributes to return alongside the publish, reflecting each channel's state at publish time (same semantics and validation errors as on the channel endpoints: `member_count` is presence-channels only, `connection_count` requires the app's connection-counting flag). Requesting attributes counts as one additional message toward usage.
+   */
+  include?: Array<RealtimeChannelInclude>;
+};
+type RealtimeAppId = string;
+type ListRealtimeAppChannelsData = {
+  body?: never;
+  headers: {
+    /**
+     * Workspace context. Required for session auth; derived from API key otherwise.
+     */
+    "X-Workspace-Id"?: string;
+    /**
+     * The Realtime app key. With X-Realtime-Secret it authenticates the request to the Realtime edge. Both come from the app's credentials (shown once at creation) and must belong to the calling workspace.
+     *
+     */
+    "X-Realtime-Key": string;
+    /**
+     * The Realtime app secret, paired with X-Realtime-Key. Sent over TLS and used only to sign the request to the edge — never stored. Rotate it by rotating the app key.
+     *
+     */
+    "X-Realtime-Secret": string;
+  };
+  path: {
+    /**
+     * Realtime app ID
+     */
+    realtime_app_id: RealtimeAppId;
+  };
+  query?: {
+    /**
+     * Only channels whose name starts with this prefix (e.g. "presence-").
+     */
+    prefix?: string;
+    /**
+     * Per-channel attributes to include. Repeatable. Requesting `member_count` without a presence-channel `prefix`, or `connection_count` when the app's connection-counting flag is off, returns a validation error (400).
+     */
+    include?: Array<RealtimeChannelInclude>;
+  };
+  url: "/v1/realtime/apps/{realtime_app_id}/channels";
+};
+type GetRealtimeAppChannelData = {
+  body?: never;
+  headers: {
+    /**
+     * Workspace context. Required for session auth; derived from API key otherwise.
+     */
+    "X-Workspace-Id"?: string;
+    /**
+     * The Realtime app key. With X-Realtime-Secret it authenticates the request to the Realtime edge. Both come from the app's credentials (shown once at creation) and must belong to the calling workspace.
+     *
+     */
+    "X-Realtime-Key": string;
+    /**
+     * The Realtime app secret, paired with X-Realtime-Key. Sent over TLS and used only to sign the request to the edge — never stored. Rotate it by rotating the app key.
+     *
+     */
+    "X-Realtime-Secret": string;
+  };
+  path: {
+    /**
+     * Realtime app ID
+     */
+    realtime_app_id: RealtimeAppId;
+    /**
+     * Channel name
+     */
+    channel_name: RealtimeChannelName;
+  };
+  query?: {
+    /**
+     * Attributes to include. Repeatable. Requesting `member_count` for a non-presence channel, or `connection_count` when the app's connection-counting flag is off, returns a validation error (400).
+     */
+    include?: Array<RealtimeChannelInclude>;
+  };
+  url: "/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}";
+};
+type ListEmailMessagesData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * 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;
+    /**
+     * Return only resources created at or after this timestamp (inclusive lower bound). Combine with `created_before` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
+     */
+    created_after?: string;
+    /**
+     * Return only resources created strictly before this timestamp (exclusive upper bound). Combine with `created_after` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
+     */
+    created_before?: string;
+    /**
+     * Filter by aggregate delivery status.
+     */
+    status?: EmailMessageStatus;
+    /**
+     * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (e.g. `category:welcome`). Repeat the parameter to AND-combine several tag filters.
+     *
+     */
+    tag?: Array<string>;
+    /**
+     * Filter by category.
+     */
+    category?: EmailMessageCategory;
+    /**
+     * Filter by recipient address. Exact match against any `to`/`cc`/`bcc` recipient on the message; normalised to lowercase before comparison.
+     *
+     */
+    to?: string;
+    /**
+     * Filter by sender address. Exact match against the message `from` field; normalised to lowercase before comparison.
+     *
+     */
     from?: string;
   };
   url: "/v1/email/messages";
@@ -5560,6 +5749,53 @@ type CreateContactData = {
   query?: never;
   url: "/v1/contacts";
 };
+type CreateContactBatchData = {
+  body: ContactUpsertRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/contacts/batch";
+};
+type UpdateContactData = {
+  body: ContactUpdateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the contact to update (`con_`-prefixed).
+     */
+    contact_id: ContactId;
+  };
+  query?: never;
+  url: "/v1/contacts/{contact_id}";
+};
 type ListContactPropertiesData = {
   body?: never;
   path?: never;
@@ -5579,6 +5815,53 @@ type ListContactPropertiesData = {
   };
   url: "/v1/contact-properties";
 };
+type CreateContactPropertyData = {
+  body: ContactPropertyCreateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/contact-properties";
+};
+type UpdateContactPropertyData = {
+  body: ContactPropertyUpdateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the contact property to update (`prp_`-prefixed).
+     */
+    property_id: ContactPropertyId;
+  };
+  query?: never;
+  url: "/v1/contact-properties/{property_id}";
+};
 type ListAudiencesData = {
   body?: never;
   path?: never;
@@ -5602,6 +5885,53 @@ type ListAudiencesData = {
   };
   url: "/v1/audiences";
 };
+type CreateAudienceData = {
+  body: AudienceCreateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/audiences";
+};
+type UpdateAudienceData = {
+  body: AudienceUpdateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the audience to update (`adn_`-prefixed).
+     */
+    audience_id: AudienceId;
+  };
+  query?: never;
+  url: "/v1/audiences/{audience_id}";
+};
 type ListAudienceContactsData = {
   body?: never;
   path: {
@@ -5630,6 +5960,58 @@ type ListAudienceContactsData = {
   };
   url: "/v1/audiences/{audience_id}/contacts";
 };
+type AssignAudienceContactsData = {
+  body: AudienceContactsAddRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the audience to add contacts to (`adn_`-prefixed).
+     */
+    audience_id: AudienceId;
+  };
+  query?: never;
+  url: "/v1/audiences/{audience_id}/contacts";
+};
+type UnassignAudienceContactsData = {
+  body: AudienceContactsRemoveRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * ID of the audience to remove contacts from (`adn_`-prefixed).
+     */
+    audience_id: AudienceId;
+  };
+  query?: never;
+  url: "/v1/audiences/{audience_id}/contacts/remove";
+};
 type ListSmsMessagesData = {
   body?: never;
   path?: never;
@@ -5657,7 +6039,7 @@ type ListSmsMessagesData = {
     /**
      * Filter by direction. Omit for both.
      */
-    direction?: "outbound" | "inbound";
+    direction?: MessageDirection;
     /**
      * Keep only messages whose current `status` matches; repeat the parameter to match any of several. One of `scheduled`, `accepted`, `sent`, `delivered`, `undelivered`, `failed`, `rejected`, `canceled`, `expired`, or `received`.
      *
@@ -5671,7 +6053,7 @@ type ListSmsMessagesData = {
     /**
      * Filter by category.
      */
-    category?: "transactional" | "marketing" | "authentication" | "service";
+    category?: SmsMessageCategory;
     /**
      * Filter by recipient phone number (E.164 exact match).
      */
@@ -5696,11 +6078,11 @@ type ListSmsTemplatesData = {
      * Keep only templates of this scope: `system` for Bird's built-in templates, `workspace` for templates authored in your workspace. Omit for all. Workspace-authored SMS templates are not available yet, so `workspace` currently matches nothing.
      *
      */
-    scope?: "system" | "workspace";
+    scope?: TemplateScope;
     /**
      * Keep only templates whose `category` matches. Omit for all categories.
      */
-    category?: "transactional" | "marketing" | "authentication" | "service";
+    category?: SmsMessageCategory;
     /**
      * Keep only templates available in this language, as a BCP-47 tag. Matches the template's `available_languages` entries exactly, with no fallback.
      *
@@ -5709,6 +6091,56 @@ type ListSmsTemplatesData = {
   };
   url: "/v1/sms/templates";
 };
+type CreateVerificationData = {
+  body: VerificationCreateRequest;
+  headers?: {
+    /**
+     * Workspace context. Required for session auth; derived from API key otherwise.
+     */
+    "X-Workspace-Id"?: string;
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/verify/verifications";
+};
+type CreateVerificationCheckData = {
+  body: VerificationCheckRequest;
+  headers?: {
+    /**
+     * Workspace context. Required for session auth; derived from API key otherwise.
+     */
+    "X-Workspace-Id"?: string;
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/verify/verifications/check";
+};
 type ListWhatsAppMessagesData = {
   body?: never;
   path?: never;
@@ -5906,7 +6338,7 @@ type GetEmailStatsByTagData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/tags";
 };
@@ -6004,7 +6436,7 @@ type GetEmailStatsBySendingIpData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/sending-ips";
 };
@@ -6046,7 +6478,7 @@ type GetEmailStatsBySendingDomainData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/sending-domains";
 };
@@ -6084,7 +6516,7 @@ type GetEmailStatsByCategoryData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/categories";
 };
@@ -6126,7 +6558,7 @@ type GetEmailStatsByMailboxProviderData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/mailbox-providers";
 };
@@ -6168,7 +6600,7 @@ type GetEmailStatsByMailboxProviderRegionData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/mailbox-provider-regions";
 };
@@ -6210,7 +6642,7 @@ type GetEmailStatsByRecipientDomainData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/recipient-domains";
 };
@@ -6252,7 +6684,7 @@ type GetEmailStatsByTemplateData = {
     /**
      * Bucket grain for the `trend` series. Has no effect unless `include_trend=true`.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/templates";
 };
@@ -6431,7 +6863,7 @@ type GetEmailStatsByBroadcastData = {
     /**
      * Bucket grain for the `trend` series. Has no effect on this breakdown, where `include_trend` is not available.
      */
-    trend_grain?: "daily" | "hourly";
+    trend_grain?: StatsTrendGrain;
   };
   url: "/v1/email/stats/broadcasts";
 };
@@ -6459,17 +6891,64 @@ type ListDomainsData = {
     /**
      * 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;
+    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";
+};
+type CreateDomainData = {
+  body: DomainCreate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/email/domains";
+};
+type UpdateDomainData = {
+  body: DomainUpdate;
+  headers?: {
     /**
-     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
      */
-    ending_before?: string;
+    "Idempotency-Key"?: string;
+  };
+  path: {
     /**
-     * When true, the response includes a `total` field with the total number of items matching the request's filters across all pages.
+     * Domain ID.
      */
-    include_total?: boolean;
+    domain_id: DomainId;
   };
-  url: "/v1/email/domains";
+  query?: never;
+  url: "/v1/email/domains/{domain_id}";
 };
 type ListMailboxesData = {
   body?: never;
@@ -6510,6 +6989,58 @@ type ListMailboxesData = {
   };
   url: "/v1/email/mailboxes";
 };
+type CreateMailboxData = {
+  body: MailboxCreate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/email/mailboxes";
+};
+type UpdateMailboxData = {
+  body: MailboxUpdate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * Mailbox ID.
+     */
+    mailbox_id: MailboxId;
+  };
+  query?: {
+    /**
+     * Required as `true` when lowering `retention_tier`, acknowledging that remembered messages older than the new horizon are deleted.
+     */
+    confirm?: boolean;
+  };
+  url: "/v1/email/mailboxes/{mailbox_id}";
+};
 type GetMailboxStatsData = {
   body?: never;
   path: {
@@ -6570,6 +7101,32 @@ type ListMailboxReceiveRulesData = {
   };
   url: "/v1/email/mailboxes/{mailbox_id}/receive-rules";
 };
+type CreateMailboxReceiveRuleData = {
+  body: ReceiveRuleCreate;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * Mailbox ID.
+     */
+    mailbox_id: MailboxId;
+  };
+  query?: never;
+  url: "/v1/email/mailboxes/{mailbox_id}/receive-rules";
+};
 type ListEmailThreadsData = {
   body?: never;
   path?: never;
@@ -6621,6 +7178,63 @@ type ListEmailThreadsData = {
   };
   url: "/v1/email/threads";
 };
+type DeleteEmailThreadData = {
+  body?: never;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * Thread ID.
+     */
+    thread_id: ThreadId;
+  };
+  query?: {
+    /**
+     * Permanently delete the conversation and its messages immediately instead of moving them to the trash.
+     */
+    permanent?: boolean;
+  };
+  url: "/v1/email/threads/{thread_id}";
+};
+type UpdateEmailThreadData = {
+  body: EmailThreadUpdateRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * Thread ID.
+     */
+    thread_id: ThreadId;
+  };
+  query?: never;
+  url: "/v1/email/threads/{thread_id}";
+};
 type ListEmailThreadMessagesData = {
   body?: never;
   path: {
@@ -6633,7 +7247,7 @@ type ListEmailThreadMessagesData = {
     /**
      * Filter to received (`inbound`) or sent (`outbound`) messages.
      */
-    direction?: "inbound" | "outbound";
+    direction?: MessageDirection;
     /**
      * Filter to messages carrying this label. `trash` lists trashed messages; any other label — `archive`, `spam`, `blocked`, `unread`, or a custom label — lists its non-trashed carriers. When omitted, received messages in the inbox and all sent messages are returned.
      *
@@ -6658,6 +7272,36 @@ type ListEmailThreadMessagesData = {
   };
   url: "/v1/email/threads/{thread_id}/messages";
 };
+type ReplyEmailThreadMessageData = {
+  body: EmailThreadMessageReplyRequest;
+  headers?: {
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004) — the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005) — the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path: {
+    /**
+     * Thread ID.
+     */
+    thread_id: ThreadId;
+    /**
+     * Message ID (`rem_` for a received message, `em_` for a sent one).
+     */
+    message_id: string;
+  };
+  query?: never;
+  url: "/v1/email/threads/{thread_id}/messages/{message_id}/reply";
+};
 //#endregion
 //#region src/generated/core/auth.gen.d.ts
 type AuthToken = string | undefined;
@@ -6991,6 +7635,37 @@ declare abstract class Resource {
   protected paginated<T>(method: string, options: RequestOptions | undefined, invoke: (ctx: CallContext, cursor: string | undefined) => Promise<FetchOutcome<CursorPage<T>>>): PaginatedPromise<T>;
 }
 //#endregion
+//#region src/resources/email.gen.d.ts
+type EmailListQuery$1 = NonNullable<ListEmailMessagesData["query"]>;
+declare class EmailResourceBase extends Resource {
+  /**
+   * Fetch one email message by id — aggregate delivery status and per-state recipient counts. The message body (html, text) is not returned. Per-recipient delivery statuses and the event log are separate sub-resources: GET /v1/email/messages/{message_id}/recipients and GET /v1/email/messages/{message_id}/events.
+   *
+   * @example
+   * const msg = await bird.email.get("em_abc123");
+   * msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
+   * msg.delivered_count;
+   * msg.bounced_count;
+   */
+  get(messageId: string, options?: RequestOptions): APIPromise<EmailMessage>;
+  /**
+   * List sent email messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by creation time with the half-open range created_after (inclusive) / created_before (exclusive) — e.g. for a single UTC day set created_after to that day at 00:00:00Z and created_before to the next day at 00:00:00Z.
+   *
+   * @example
+   * for await (const message of bird.email.list({ status: "bounced" })) {
+   *   console.log(message.id);
+   * }
+   */
+  list(query?: EmailListQuery$1, options?: RequestOptions): PaginatedPromise<EmailMessage>;
+  /**
+   * Cancel a scheduled email before it sends. Only works while the message is still scheduled (status `scheduled`); once it starts sending — or was already canceled — the call returns a conflict error. Canceling does not return consumed scheduled-send quota.
+   *
+   * @example
+   * await bird.email.cancel("em_abc123");
+   */
+  cancel(messageId: string, options?: RequestOptions): APIPromise<void>;
+}
+//#endregion
 //#region src/resources/emailStats.gen.d.ts
 type EmailStatsSummaryQuery = NonNullable<GetEmailStatsSummaryData["query"]>;
 type EmailStatsDailyQuery = NonNullable<GetEmailStatsDailyData["query"]>;
@@ -7210,7 +7885,7 @@ type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type DefaultedKeys<D> = D extends object ? Extract<keyof D, keyof EmailSendParams> : never;
 /** `send` params with defaulted fields made optional. */
 type EmailSend<D> = PartialBy<EmailSendParams, DefaultedKeys<D>>;
-declare class EmailResource<D extends EmailChannelDefaults | undefined = undefined> extends Resource {
+declare class EmailResource<D extends EmailChannelDefaults | undefined = undefined> extends EmailResourceBase {
   #private;
   /** Email statistics — `bird.email.stats.summary(...)`, `.daily(...)`, `.byTag(...)`, … */
   readonly stats: EmailStatsResource;
@@ -7302,202 +7977,156 @@ declare class EmailResource<D extends EmailChannelDefaults | undefined = undefin
    * for (const item of batch.data) console.log(item.id, item.status);
    */
   sendBatch(params: EmailSendBatchParams, options?: RequestOptions): APIPromise<EmailSendBatchResult>;
-  /**
-   * Fetch a message with aggregate delivery status.
-   *
-   * @example
-   * const msg = await bird.email.get("em_abc123");
-   * msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
-   * msg.delivered_count;
-   * msg.bounced_count;
-   */
-  get(messageId: string, options?: RequestOptions): APIPromise<EmailMessage>;
-  /**
-   * Cancel a message scheduled with `scheduled_at` before it sends. Only a
-   * message that is still scheduled can be canceled; one that already started
-   * sending — or was previously canceled — rejects with a conflict error.
-   * Canceling does not return consumed scheduled-send quota.
-   *
-   * @example
-   * await bird.email.cancel("em_abc123");
-   */
-  cancel(messageId: string, options?: RequestOptions): APIPromise<void>;
-  /**
-   * List messages, newest first. `await` resolves the first page; `for await`
-   * walks every message across all pages.
-   *
-   * @example Iterate every message, or take one page
-   * for await (const message of bird.email.list({ status: "bounced" })) {
-   *   console.log(message.id);
-   * }
-   * const page = await bird.email.list({ limit: 50 }); // page.data, page.next_cursor
-   */
-  list(query?: EmailListQuery, options?: RequestOptions): PaginatedPromise<EmailMessage>;
 }
 //#endregion
-//#region src/resources/audiences.d.ts
-/** Body for `bird.audiences.create`. */
-type AudienceCreateParams = AudienceCreateRequest;
-/** Body for `bird.audiences.update` — a partial patch. */
-type AudienceUpdateParams = AudienceUpdateRequest;
-/** Body for `bird.audiences.addContacts`. */
-type AudienceAddContactsParams = AudienceContactsAddRequest;
-/** Body for `bird.audiences.removeContacts`. */
-type AudienceRemoveContactsParams = AudienceContactsRemoveRequest;
-/** Filters and cursor params for `bird.audiences.list`. */
+//#region src/resources/audiences.gen.d.ts
 type AudienceListQuery = NonNullable<ListAudiencesData["query"]>;
-/** Cursor params for `bird.audiences.listContacts`. */
-type AudienceContactsQuery = NonNullable<ListAudienceContactsData["query"]>;
+type AudienceCreateParams = NonNullable<CreateAudienceData["body"]>;
+type AudienceUpdateParams = NonNullable<UpdateAudienceData["body"]>;
+type AudienceListContactsQuery = NonNullable<ListAudienceContactsData["query"]>;
+type AudienceAddContactsParams = NonNullable<AssignAudienceContactsData["body"]>;
+type AudienceRemoveContactsParams = NonNullable<UnassignAudienceContactsData["body"]>;
 declare class AudiencesResource extends Resource {
   /**
-   * Create an audience.
-   *
-   * @example Create an audience
-   * const audience = await bird.audiences.create({ name: "Newsletter subscribers" });
-   * console.log(audience.id); // "aud_…"
-   */
-  create(params: AudienceCreateParams, options?: RequestOptions): APIPromise<Audience>;
-  /**
-   * List the workspace's audiences, newest first. `await` resolves the first
-   * page; `for await` walks every audience across pages.
+   * List the workspace's audiences as a cursor page, newest first. Filter by name substring with `q`.
    *
-   * @example
+   * @example Iterate every audience, or take one page
    * for await (const audience of bird.audiences.list()) {
    *   console.log(audience.id, audience.name);
    * }
    */
   list(query?: AudienceListQuery, options?: RequestOptions): PaginatedPromise<Audience>;
   /**
-   * Fetch a single audience by id.
+   * Get a single audience by ID: name, description, and type. Members are listed separately with `audiences.list_contacts`.
    *
-   * @example
-   * const audience = await bird.audiences.get("aud_01krdgeqcxet5s7t44vh8rt9mg");
+   * @example Fetch an audience by id
+   * const audience = await bird.audiences.get("adn_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(audience.name);
    */
   get(audienceId: string, options?: RequestOptions): APIPromise<Audience>;
   /**
-   * Update an audience. Only the fields you send change.
+   * Create an audience in the workspace. New audiences start empty; add contacts with `audiences.add_contacts` or `contacts.batch`. Only static audiences can be created today.
    *
-   * @example
-   * await bird.audiences.update("aud_01krdgeqcxet5s7t44vh8rt9mg", { name: "Renamed" });
+   * @example Create an audience
+   * const audience = await bird.audiences.create({ name: "Newsletter subscribers" });
+   * console.log(audience.id); // "adn_…"
    */
-  update(audienceId: string, params: AudienceUpdateParams, options?: RequestOptions): APIPromise<Audience>;
+  create(params: AudienceCreateParams, options?: RequestOptions): APIPromise<Audience>;
   /**
-   * Delete an audience. Its contacts are unaffected.
+   * Update an audience's name or description. Omitted fields are unchanged; a null description clears it.
    *
-   * @example
-   * await bird.audiences.delete("aud_01krdgeqcxet5s7t44vh8rt9mg");
+   * @example Rename an audience
+   * await bird.audiences.update("adn_01krdgeqcxet5s7t44vh8rt9mg", { name: "Renamed" });
+   */
+  update(audienceId: string, params?: AudienceUpdateParams, options?: RequestOptions): APIPromise<Audience>;
+  /**
+   * Delete an audience and its memberships; contacts themselves are not deleted. Fails while a broadcast targeting the audience is scheduled, accepted, sending, or canceling.
+   *
+   * @example Delete an audience by id
+   * await bird.audiences.delete("adn_01krdgeqcxet5s7t44vh8rt9mg");
    */
   delete(audienceId: string, options?: RequestOptions): APIPromise<void>;
   /**
-   * List the contacts in an audience, newest first. `await` resolves the first
-   * page; `for await` walks every member across pages.
+   * List the contacts in a static audience by ID, as a cursor page ordered by when each contact joined (most recent first). Each entry pairs the contact with its join time.
    *
-   * @example
-   * for await (const member of bird.audiences.listContacts("aud_01krdgeqcxet5s7t44vh8rt9mg")) {
+   * @example Iterate an audience's members
+   * for await (const member of bird.audiences.listContacts("adn_01krdgeqcxet5s7t44vh8rt9mg")) {
    *   console.log(member.contact.id, member.joined_at);
    * }
    */
-  listContacts(audienceId: string, query?: AudienceContactsQuery, options?: RequestOptions): PaginatedPromise<AudienceMember>;
+  listContacts(audienceId: string, query?: AudienceListContactsQuery, options?: RequestOptions): PaginatedPromise<AudienceMember>;
   /**
-   * Add contacts to an audience by id.
+   * Add up to 1,000 existing contacts to a static audience by ID. Fails entirely if any contact ID does not exist.
    *
-   * @example
-   * await bird.audiences.addContacts("aud_01krdgeqcxet5s7t44vh8rt9mg", {
-   *   contact_ids: ["con_1", "con_2"],
+   * @example Add contacts to an audience
+   * await bird.audiences.addContacts("adn_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   contact_ids: ["con_01krdgeqcxet5s7t44vh8rt9mg"],
    * });
    */
   addContacts(audienceId: string, params: AudienceAddContactsParams, options?: RequestOptions): APIPromise<void>;
   /**
-   * Remove a set of contacts from an audience.
+   * Remove up to 1,000 contacts from a static audience by ID. Fails entirely if any contact ID does not exist; contacts are not deleted.
    *
-   * @example
-   * await bird.audiences.removeContacts("aud_01krdgeqcxet5s7t44vh8rt9mg", {
-   *   contact_ids: ["con_1", "con_2"],
+   * @example Remove contacts from an audience
+   * await bird.audiences.removeContacts("adn_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   contact_ids: ["con_01krdgeqcxet5s7t44vh8rt9mg"],
    * });
    */
   removeContacts(audienceId: string, params: AudienceRemoveContactsParams, options?: RequestOptions): APIPromise<void>;
   /**
-   * Remove a single contact from an audience.
+   * Remove one contact's membership from an audience. The contact itself is not deleted and stays a member of any other audiences.
    *
-   * @example
-   * await bird.audiences.removeContact("aud_01krdgeqcxet5s7t44vh8rt9mg", "con_1");
-   */
-  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"
+   * @example Remove one contact's membership
+   * await bird.audiences.removeContact(
+   *   "adn_01krdgeqcxet5s7t44vh8rt9mg",
+   *   "con_01krdgeqcxet5s7t44vh8rt9mg",
+   * );
    */
-  create(params: DomainCreateParams, options?: RequestOptions): APIPromise<Domain>;
+  removeContact(audienceId: string, contactId: string, options?: RequestOptions): APIPromise<void>;
+}
+//#endregion
+//#region src/resources/domains.gen.d.ts
+type DomainListQuery = NonNullable<ListDomainsData["query"]>;
+type DomainCreateParams = NonNullable<CreateDomainData["body"]>;
+type DomainUpdateParams = NonNullable<UpdateDomainData["body"]>;
+declare class DomainsResource extends Resource {
   /**
-   * List the workspace's sending domains, newest first. `await` resolves the
-   * first page; `for await` walks every domain across pages.
+   * List the workspace's sending domains with their verification status, as a cursor page.
    *
-   * @example
+   * @example Iterate every sending domain
    * 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.
+   * Fetch one sending domain: verification status and the DNS records with their individual verification states.
    *
-   * @example
+   * @example Fetch a sending domain by id
    * const domain = await bird.domains.get("dom_01krdgeqcxet5s7t44vh8rt9mg");
+   * console.log(domain.domain);
    */
   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.
+   * Register a new sending domain and get the DNS records to publish. Flow: call this, publish the returned DNS records at your DNS provider, then call email_domains_verify (repeat until status is verified — DNS propagation can take minutes to hours).
    *
-   * @example
+   * @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>;
+  /**
+   * Trigger a DNS verification check for a sending domain and return the refreshed domain with per-record results. Safe to repeat while waiting for DNS propagation.
+   *
+   * @example Re-run the DNS verification check
+   * 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>;
+  /**
+   * Update a sending domain's tracking and inbound configuration. Tracking: toggle click_tracking and open_tracking (applied immediately to new sends), and set, change, or remove the tracking domain (the name part only — Bird appends the sending domain). Enabling either toggle with no tracking domain configured returns 409; removing the tracking domain while either toggle is still on also returns 409. Tracking-domain changes on a verified domain are staged behind DNS verification, so the current config keeps serving until the new records verify. Inbound receiving: set inbound.enabled to start or stop receiving mail for the domain. Enabling requires the domain's DKIM to be verified first (a fresh enable on an unverified domain returns 422), and a domain already receiving inbound for another organization returns 422. The MX records to publish are always listed in dns_records regardless, so enabling — not merely publishing them — is what turns receiving on.
+   *
+   * @example Enable tracking on a domain
    * 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>;
+  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.
+   * Delete a sending domain by id. Revokes its sender authorization: new sends from the domain are rejected afterward, while historical statistics and events for past sends are preserved. Destructive.
    *
-   * @example
+   * @example Delete a sending domain by id
    * 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.gen.d.ts
 type ContactPropertyListQuery = NonNullable<ListContactPropertiesData["query"]>;
-declare class ContactPropertiesResourceBase extends Resource {
+type ContactPropertyCreateParams = NonNullable<CreateContactPropertyData["body"]>;
+type ContactPropertyUpdateParams = NonNullable<UpdateContactPropertyData["body"]>;
+declare class ContactPropertiesResource extends Resource {
   /**
    * List the workspace's contact properties as a cursor page, newest first. Archived properties are included, marked by their archived flag.
    *
@@ -7516,6 +8145,21 @@ declare class ContactPropertiesResourceBase extends Resource {
    * console.log(prop.key, prop.type);
    */
   get(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
+  /**
+   * Define a custom contact property (key + value type) that becomes available in contact data and as a broadcast template variable. The key and type cannot change after creation; a workspace holds at most 200 properties, archived included.
+   *
+   * @example Define a custom property
+   * const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
+   * console.log(prop.id); // "cp_…"
+   */
+  create(params: ContactPropertyCreateParams, options?: RequestOptions): APIPromise<ContactProperty>;
+  /**
+   * Update a contact property's fallback value. The key and type are immutable; create a new property instead.
+   *
+   * @example Change a property's fallback value
+   * await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
+   */
+  update(propertyId: string, params?: ContactPropertyUpdateParams, options?: RequestOptions): APIPromise<ContactProperty>;
   /**
    * Archive a contact property: the key is rejected in new contact writes and stops rendering in templates, while stored values remain readable. The key stays reserved and counts toward the 200-property limit; reverse with `contact_properties.unarchive`.
    *
@@ -7533,34 +8177,12 @@ declare class ContactPropertiesResourceBase extends Resource {
   unarchive(propertyId: string, options?: RequestOptions): APIPromise<ContactProperty>;
 }
 //#endregion
-//#region src/resources/contactProperties.d.ts
-/** Body for `bird.contactProperties.create`. */
-type ContactPropertyCreateParams = ContactPropertyCreateRequest;
-/** Body for `bird.contactProperties.update` — a partial patch. */
-type ContactPropertyUpdateParams = ContactPropertyUpdateRequest;
-declare class ContactPropertiesResource extends ContactPropertiesResourceBase {
-  /**
-   * Define a contact property. The `key` must be unique in the workspace and is
-   * how contacts reference the field in their `data`.
-   *
-   * @example
-   * const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
-   * console.log(prop.id); // "cp_…"
-   */
-  create(params: ContactPropertyCreateParams, options?: RequestOptions): APIPromise<ContactProperty>;
-  /**
-   * Update a contact property. Only the fields you send change.
-   *
-   * @example
-   * await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });
-   */
-  update(propertyId: string, params: ContactPropertyUpdateParams, options?: RequestOptions): APIPromise<ContactProperty>;
-}
-//#endregion
 //#region src/resources/contacts.gen.d.ts
 type ContactListQuery = NonNullable<ListContactsData["query"]>;
 type ContactCreateParams = NonNullable<CreateContactData["body"]>;
-declare class ContactsResourceBase extends Resource {
+type ContactUpdateParams = NonNullable<UpdateContactData["body"]>;
+type ContactBatchParams = NonNullable<CreateContactBatchData["body"]>;
+declare class ContactsResource extends Resource {
   /**
    * List the workspace's contacts as a cursor page, newest first. Look one up by exact email or external_id, or search by email substring.
    *
@@ -7590,6 +8212,16 @@ declare class ContactsResourceBase extends Resource {
    * console.log(contact.id); // "con_…"
    */
   create(params: ContactCreateParams, options?: RequestOptions): APIPromise<Contact>;
+  /**
+   * Update a contact's name, external_id, email, or custom data. Only supplied fields change; custom data keys are merged, with null removing a key.
+   *
+   * @example Change a contact's fields
+   * const contact = await bird.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   first_name: "Jane",
+   * });
+   * console.log(contact.first_name);
+   */
+  update(contactId: string, params?: ContactUpdateParams, options?: RequestOptions): APIPromise<Contact>;
   /**
    * Delete a contact and remove it from every audience it belongs to. Suppression records for the address are unaffected.
    *
@@ -7597,33 +8229,40 @@ declare class ContactsResourceBase extends Resource {
    * await bird.contacts.delete("con_01krdgeqcxet5s7t44vh8rt9mg");
    */
   delete(contactId: string, options?: RequestOptions): APIPromise<void>;
+  /**
+   * Create or update up to 1,000 contacts in one request, matched by email address, and optionally add them all to one or more audiences. Per-contact results are returned in submission order.
+   *
+   * @example Create or update many contacts at once, matched by email
+   * const result = await bird.contacts.batch({
+   *   contacts: [{ email: "jane@acme.com", first_name: "Jane" }],
+   * });
+   * for (const item of result.data) {
+   *   console.log(item.email, item.status);
+   * }
+   */
+  batch(params: ContactBatchParams, options?: RequestOptions): APIPromise<ContactUpsertResult>;
 }
 //#endregion
-//#region src/resources/contacts.d.ts
-/** Body for `bird.contacts.update` — a partial patch. */
-type ContactUpdateParams = ContactUpdateRequest;
-/** Body for `bird.contacts.batch` — create-or-update many contacts in one call. */
-type ContactBatchParams = ContactUpsertRequest;
-declare class ContactsResource extends ContactsResourceBase {
+//#region src/resources/sms.gen.d.ts
+type SmsListQuery = NonNullable<ListSmsMessagesData["query"]>;
+declare class SmsResourceBase extends Resource {
   /**
-   * Update a contact. Only the fields you send change.
+   * Get one SMS message by id: its current delivery status, segment breakdown, cost, and failure detail if it failed.
    *
-   * @example
-   * const contact = await bird.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", {
-   *   first_name: "Jane",
-   * });
+   * @example Read a message back
+   * const msg = await bird.sms.get("sms_abc123");
+   * msg.status; // "accepted" | "delivered" | …
    */
-  update(contactId: string, params: ContactUpdateParams, options?: RequestOptions): APIPromise<Contact>;
+  get(messageId: string, options?: RequestOptions): APIPromise<SmsMessage>;
   /**
-   * Create or update many contacts in one call, matched by email. Returns a
-   * per-contact result.
+   * List SMS messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, category, recipient, sender, or tag.
    *
-   * @example
-   * const result = await bird.contacts.batch({
-   *   contacts: [{ email: "jane@acme.com", first_name: "Jane" }],
-   * });
+   * @example Iterate outbound messages
+   * for await (const msg of bird.sms.list({ direction: "outbound" })) {
+   *   console.log(msg.id, msg.status);
+   * }
    */
-  batch(params: ContactBatchParams, options?: RequestOptions): APIPromise<ContactUpsertResult>;
+  list(query?: SmsListQuery, options?: RequestOptions): PaginatedPromise<SmsMessage>;
 }
 //#endregion
 //#region src/resources/sms.d.ts
@@ -7634,8 +8273,7 @@ type SmsSendBatchParams = SmsMessageBatchRequest;
 /** Result of `bird.sms.sendBatch`. */
 type SmsSendBatchResult = SmsMessageBatchResponse;
 /** Filters and cursor params for `bird.sms.list`. */
-type SmsListQuery = NonNullable<ListSmsMessagesData["query"]>;
-declare class SmsResource extends Resource {
+declare class SmsResource extends SmsResourceBase {
   /**
    * Send one SMS to a single recipient. Supply either `text` (with a `category`)
    * or a stored `template` (by `id` or `name`, with its `parameters`). The
@@ -7668,37 +8306,13 @@ declare class SmsResource extends Resource {
    * ]);
    */
   sendBatch(params: SmsSendBatchParams, options?: RequestOptions): APIPromise<SmsSendBatchResult>;
-  /**
-   * Fetch a single SMS message: its current delivery status, segment breakdown,
-   * cost, and failure detail if it failed.
-   *
-   * @example
-   * const msg = await bird.sms.get("sms_abc123");
-   * msg.status; // "accepted" | "delivered" | …
-   */
-  get(messageId: string, options?: RequestOptions): APIPromise<SmsMessage>;
-  /**
-   * List SMS messages, newest first. `await` resolves the first page; `for await`
-   * walks every message across all pages. Filter by direction, status, category,
-   * recipient, sender, or tag.
-   *
-   * @example
-   * for await (const msg of bird.sms.list({ direction: "outbound" })) {
-   *   console.log(msg.id, msg.status);
-   * }
-   */
-  list(query?: SmsListQuery, options?: RequestOptions): PaginatedPromise<SmsMessage>;
 }
 //#endregion
-//#region src/resources/smsTemplates.d.ts
-/** Filters for `bird.smsTemplates.list`. */
+//#region src/resources/smsTemplates.gen.d.ts
 type SmsTemplateListQuery = NonNullable<ListSmsTemplatesData["query"]>;
 declare class SmsTemplatesResource extends Resource {
   /**
-   * List the SMS templates available to the workspace — Bird's built-in
-   * templates plus any the workspace authored. The catalogue is small and
-   * returned in full (`.data`); this list is not paginated. Filter by `scope`,
-   * `category`, or `language` (a BCP-47 language tag).
+   * List the SMS templates available to your workspace, including Bird's built-in templates. Filter by scope, category, or language. The catalogue is small and returned in full; this list is not paginated. Use sms_templates_get to read one template's variables before sending with it.
    *
    * @example List the built-in templates
    * const { data } = await bird.smsTemplates.list({ scope: "system" });
@@ -7706,127 +8320,102 @@ declare class SmsTemplatesResource extends Resource {
    */
   list(query?: SmsTemplateListQuery, options?: RequestOptions): APIPromise<SmsTemplateList>;
   /**
-   * Fetch a single SMS template by its name or id, including its body and the
-   * variables it expects.
+   * Get one SMS template by its name or id, including its body and the variables it expects. Fetch it before sms_send to see which parameter keys a template send requires.
    *
-   * @example
+   * @example Read one template by name or id
    * const tpl = await bird.smsTemplates.get("bird_otp_verification");
    * console.log(tpl.body, tpl.variables);
    */
   get(templateRef: string, options?: RequestOptions): APIPromise<SmsTemplate>;
 }
 //#endregion
-//#region src/resources/whatsapp.d.ts
-/** Body for `bird.whatsapp.send` — a template send; Bird picks the sender from the template's category. */
-type WhatsappSendParams = WhatsAppMessageSendRequest;
-/** Filters and cursor params for `bird.whatsapp.list`. */
+//#region src/resources/whatsapp.gen.d.ts
 type WhatsappListQuery = NonNullable<ListWhatsAppMessagesData["query"]>;
-/** Filter for `bird.whatsapp.listEvents`. */
 type WhatsappListEventsQuery = NonNullable<ListWhatsAppMessageEventsData["query"]>;
-declare class WhatsappResource extends Resource {
-  /**
-   * Send a template message. Bird selects the sender number from the
-   * template's category, so there is no sender field on the request. The
-   * result is `accepted`, not yet delivered — read it back with `get` to
-   * confirm.
-   *
-   * @example
-   * const msg = await bird.whatsapp.send({
-   *   to: "+15551234567",
-   *   template: {
-   *     name: "bird_otp",
-   *     components: [
-   *       { type: "body", parameters: [{ type: "text", text: "123456" }] },
-   *     ],
-   *   },
-   * });
-   * console.log(msg.id, msg.status);
-   */
-  send(params: WhatsappSendParams, options?: RequestOptions): APIPromise<WhatsAppMessage>;
+declare class WhatsappResourceBase extends Resource {
   /**
-   * Fetch a single WhatsApp message: its current delivery status and failure
-   * detail if it failed.
+   * Get one WhatsApp message by id: current delivery status, sent/delivered/read timestamps, the template it was sent from, and failure detail if it failed. For the per-event timeline use whatsapp_list_events.
    *
-   * @example
+   * @example Read a message back
    * const msg = await bird.whatsapp.get("wa_abc123");
    * msg.status; // "accepted" | "delivered" | …
    */
   get(messageId: string, options?: RequestOptions): APIPromise<WhatsAppMessage>;
   /**
-   * List WhatsApp messages, newest first. `await` resolves the first page;
-   * `for await` walks every message across all pages. Filter by status,
-   * recipient phone number, or business-scoped user ID.
+   * List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by status, contact phone number, bsuid, or tag. Use whatsapp_get for one message's current state.
    *
-   * @example
+   * @example Iterate delivered messages
    * for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
    *   console.log(msg.id, msg.status);
    * }
    */
   list(query?: WhatsappListQuery, options?: RequestOptions): PaginatedPromise<WhatsAppMessage>;
   /**
-   * List a WhatsApp message's lifecycle event timeline, in chronological
-   * order. The timeline is bounded and returned in full — this list is not
-   * paginated.
+   * Get one WhatsApp message's delivery timeline, oldest first: whatsapp.accepted, whatsapp.sent, whatsapp.delivered, whatsapp.read, and whatsapp.failed events, with failure detail on failed events. Not paginated; an unknown message id is a 404. Use whatsapp_get for the condensed current status.
    *
-   * @example
+   * @example Read one message's delivery timeline
    * const { data } = await bird.whatsapp.listEvents("wa_abc123");
    * for (const event of data) console.log(event.type, event.occurred_at);
    */
   listEvents(messageId: string, query?: WhatsappListEventsQuery, options?: RequestOptions): APIPromise<WhatsAppEventList>;
 }
 //#endregion
-//#region src/resources/whatsappTemplates.d.ts
-declare class WhatsappTemplatesResource extends Resource {
+//#region src/resources/whatsapp.d.ts
+/** Body for `bird.whatsapp.send` — a template send; Bird picks the sender from the template's category. */
+type WhatsappSendParams = WhatsAppMessageSendRequest;
+declare class WhatsappResource extends WhatsappResourceBase {
   /**
-   * List the WhatsApp message templates available to the workspace — Meta's
-   * approved templates for this business account. The catalogue is small and
-   * returned in full (`.data`); this list is not paginated.
+   * Send a template message. Bird selects the sender number from the
+   * template's category, so there is no sender field on the request. The
+   * result is `accepted`, not yet delivered — read it back with `get` to
+   * confirm.
    *
    * @example
-   * const { data } = await bird.whatsappTemplates.list();
-   * for (const tpl of data) console.log(tpl.name, tpl.status);
+   * const msg = await bird.whatsapp.send({
+   *   to: "+15551234567",
+   *   template: {
+   *     name: "bird_otp",
+   *     components: [
+   *       { type: "body", parameters: [{ type: "text", text: "123456" }] },
+   *     ],
+   *   },
+   * });
+   * console.log(msg.id, msg.status);
    */
-  list(options?: RequestOptions): APIPromise<WhatsAppTemplateList>;
+  send(params: WhatsappSendParams, options?: RequestOptions): APIPromise<WhatsAppMessage>;
 }
 //#endregion
-//#region src/resources/verify.d.ts
-/** Body for `bird.verify.verifications.create` — a recipient in `to`, plus optional `options`/`metadata`. */
-type VerificationCreateParams = VerificationCreateRequest;
-/** Body for `bird.verify.verifications.check` — the recipient in `to` and the submitted `code`. */
-type VerificationCheckParams = VerificationCheckRequest;
-declare class VerificationsResource extends Resource {
-  /**
-   * Start a verification and send a one-time passcode to the recipient in `to`
-   * (a `phone_number` over SMS, an `email_address` over email, or both). Calling
-   * again for the same recipient re-sends the code after the cooldown rather than
-   * starting a second verification. The passcode is never returned — submit the
-   * recipient's entry with `check`.
-   *
-   * @example Start over SMS
+//#region src/resources/verifyVerifications.gen.d.ts
+type VerifyVerificationsCreateParams = NonNullable<CreateVerificationData["body"]>;
+type VerifyVerificationsCheckParams = NonNullable<CreateVerificationCheckData["body"]>;
+declare class VerifyVerificationsResource extends Resource {
+  /**
+   * Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over SMS, an email address over email, or both; with both, it is sent over one channel and fails over to the other, not to both at once). Calling again for the same recipient reuses the in-progress verification and sends a fresh code after the resend cooldown; it does not start a second one, so use this both to send and to resend. The passcode is never returned; submit what the recipient enters with verify_verifications_check. SMS delivery draws on the workspace's SMS balance.
+   *
+   * @example Start a verification over SMS
    * const verification = await bird.verify.verifications.create({
    *   to: { phone_number: "+15551234567" },
    * });
    * console.log(verification.id, verification.status);
    */
-  create(params: VerificationCreateParams, options?: RequestOptions): APIPromise<Verification>;
+  create(params: VerifyVerificationsCreateParams, options?: RequestOptions): APIPromise<Verification>;
   /**
-   * Check a passcode the recipient submitted. Identify the verification by the same
-   * `to` recipient used to start it — no id needed. A wrong or expired code resolves
-   * with `success: false` and a `reason`, not an error; a verification already
-   * resolved is no longer checkable and returns a 404 error.
+   * Check a passcode a recipient submitted. Identify the verification by the same `to` recipient used to start it; no verification id needed. A wrong or expired code returns HTTP 200 with `success: false` and a `reason` (for example `incorrect_code` or `expired`), not an error. A verification that has already reached a final state is no longer checkable and returns 404, as does a missing verification; malformed input or rate limiting is also an error status.
    *
-   * @example
+   * @example Check a submitted passcode
    * const result = await bird.verify.verifications.check({
    *   to: { phone_number: "+15551234567" },
    *   code: "123456",
    * });
    * console.log(result.success);
    */
-  check(params: VerificationCheckParams, options?: RequestOptions): APIPromise<VerificationCheckResult>;
+  check(params: VerifyVerificationsCheckParams, options?: RequestOptions): APIPromise<VerificationCheckResult>;
 }
+//#endregion
+//#region src/resources/verify.d.ts
 /** The Verify product namespace — holds the `verifications` collection. */
 declare class VerifyResource {
-  readonly verifications: VerificationsResource;
+  readonly verifications: VerifyVerificationsResource;
   constructor(...args: ConstructorParameters<typeof Resource>);
 }
 //#endregion
@@ -7884,24 +8473,24 @@ declare class WebhooksResource {
   unwrap(payload: string, headers: WebhookHeaders, options?: WebhookOptions): BirdWebhookEvent;
 }
 //#endregion
-//#region src/resources/mailbox.d.ts
-/** Parameters for creating a mailbox. */
-type MailboxCreateParams = MailboxCreate;
-/** Partial update for a mailbox; omitted fields are unchanged. */
-type MailboxUpdateParams = MailboxUpdate;
-/** Filters for `bird.mailbox.list`. */
+//#region src/resources/mailbox.gen.d.ts
 type MailboxListQuery = NonNullable<ListMailboxesData["query"]>;
-/** Stats query parameters. */
+type MailboxCreateParams = NonNullable<CreateMailboxData["body"]>;
+type MailboxUpdateParams = NonNullable<UpdateMailboxData["body"]>;
+type MailboxUpdateQuery = NonNullable<UpdateMailboxData["query"]>;
 type MailboxStatsQuery = NonNullable<GetMailboxStatsData["query"]>;
-/** Parameters for composing a new message from a mailbox. */
-type MailboxComposeParams = EmailMailboxComposeRequest;
-/** Parameters for creating a receive rule. */
-type MailboxReceiveRuleCreateParams = ReceiveRuleCreate;
-/** Filters for `bird.mailboxReceiveRule.list`. */
-type MailboxReceiveRuleListQuery = NonNullable<ListMailboxReceiveRulesData["query"]>;
-declare class MailboxResource extends Resource {
+declare class MailboxResourceBase extends Resource {
+  /**
+   * List the workspace's mailboxes as a cursor page, newest first. Search addresses and display names with q, or filter by exact address, state, or domain.
+   *
+   * @example List mailboxes
+   * for await (const mailbox of bird.mailbox.list()) {
+   *   console.log(mailbox.address);
+   * }
+   */
+  list(query?: MailboxListQuery, options?: RequestOptions): PaginatedPromise<Mailbox>;
   /**
-   * Create a mailbox. Omit `local_part` to auto-generate a handle on inbox.ai.
+   * Create a mailbox — a durable agent identity that owns an email address, groups mail into threads, and remembers conversations for its retention tier.
    *
    * @example Create a mailbox
    * const mailbox = await bird.mailbox.create({ display_name: "Support" });
@@ -7909,49 +8498,64 @@ declare class MailboxResource extends Resource {
    */
   create(params?: MailboxCreateParams, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Get a mailbox by id.
-   *
    * @example Get a mailbox
    * const mailbox = await bird.mailbox.get("mbx_01abc");
    * console.log(mailbox.state); // "active"
    */
   get(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Update a mailbox. Only the fields you provide change.
+   * Update a mailbox's display name, reply-to, receive policy, retention tier, contact, or metadata. Lowering the retention tier onto remembered messages older than the new horizon requires confirm=true.
    *
-   * @example Update receive policy
-   * const mailbox = await bird.mailbox.update("mbx_01abc", { receive_policy: "open" });
+   * @example Change a mailbox's receive policy
+   * const mailbox = await bird.mailbox.update("mbx_01abc", {
+   *   receive_policy: "open",
+   * });
+   * console.log(mailbox.id, mailbox.receive_policy);
    */
-  update(mailboxId: string, params: MailboxUpdateParams, options?: RequestOptions): APIPromise<Mailbox>;
+  update(mailboxId: string, params?: MailboxUpdateParams, query?: MailboxUpdateQuery, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Soft-delete a mailbox. It can be restored within 30 days.
+   * Delete a mailbox. The address stops receiving immediately and is quarantined; the mailbox and its remembered messages stay restorable for 30 days via the restore endpoint, then are permanently deleted.
    *
    * @example Delete a mailbox
    * await bird.mailbox.delete("mbx_01abc");
    */
   delete(mailboxId: string, options?: RequestOptions): APIPromise<void>;
   /**
-   * Restore a deleted mailbox within its 30-day window.
+   * Restore a mailbox deleted less than 30 days ago: the address starts receiving again and the remembered messages are back. Past the window the mailbox is permanently deleted and returns 404; a mailbox that is not deleted returns 409.
    *
-   * @example Restore a mailbox
+   * @example Restore a deleted mailbox
    * const mailbox = await bird.mailbox.restore("mbx_01abc");
+   * console.log(mailbox.deleted_at); // null
    */
   restore(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Reactivate a suspended mailbox.
+   * Reactivate a suspended mailbox so it can send and receive again and its threads become visible. Fails if your plan does not have room for another active mailbox (or another custom inbox.ai handle); delete an active mailbox or upgrade first. A mailbox that is not suspended returns 409.
    *
-   * @example Resume a mailbox
+   * @example Resume a suspended mailbox
    * const mailbox = await bird.mailbox.resume("mbx_01abc");
+   * console.log(mailbox.state); // "active"
    */
   resume(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
   /**
-   * Get email activity statistics for a mailbox.
-   *
    * @example Get mailbox stats
    * const stats = await bird.mailbox.stats("mbx_01abc");
    * console.log(stats.summary?.sends_accepted);
    */
   stats(mailboxId: string, query?: MailboxStatsQuery, options?: RequestOptions): APIPromise<MailboxStatsResponse>;
+  /**
+   * List the labels available in a mailbox: the built-in system labels (inbox, archive, spam, blocked, sent, trash, unread) plus every custom label in use.
+   *
+   * @example List a mailbox's labels
+   * const labels = await bird.mailbox.labels("mbx_01abc");
+   * console.log(labels.data.map((label) => label.name));
+   */
+  labels(mailboxId: string, options?: RequestOptions): APIPromise<EmailMailboxLabelList>;
+}
+//#endregion
+//#region src/resources/mailbox.d.ts
+/** Parameters for composing a new message from a mailbox. */
+type MailboxComposeParams = EmailMailboxComposeRequest;
+declare class MailboxResource extends MailboxResourceBase {
   /**
    * Send a new email from this mailbox, starting a new conversation.
    *
@@ -7963,104 +8567,97 @@ declare class MailboxResource extends Resource {
    * });
    */
   compose(mailboxId: string, params: MailboxComposeParams, options?: RequestOptions): APIPromise<EmailThreadMessage>;
+}
+//#endregion
+//#region src/resources/mailboxReceiveRule.gen.d.ts
+type MailboxReceiveRuleListQuery = NonNullable<ListMailboxReceiveRulesData["query"]>;
+type MailboxReceiveRuleCreateParams = NonNullable<CreateMailboxReceiveRuleData["body"]>;
+declare class MailboxReceiveRuleResource extends Resource {
   /**
-   * List labels available in a mailbox.
-   *
-   * @example List labels
-   * const labels = await bird.mailbox.labels("mbx_01abc");
-   * console.log(labels.data.map(l => l.name));
-   */
-  labels(mailboxId: string, options?: RequestOptions): APIPromise<EmailMailboxLabelList>;
-  /**
-   * List mailboxes in the workspace. `await` resolves the first page;
-   * `for await` walks every mailbox.
+   * List a mailbox's allow/block receive rules as a cursor page, oldest first. Filter by action.
    *
-   * @example List mailboxes
-   * for await (const mailbox of bird.mailbox.list()) {
-   *   console.log(mailbox.address);
+   * @example List a mailbox's receive rules
+   * for await (const rule of bird.mailboxReceiveRule.list("mbx_01abc")) {
+   *   console.log(rule.action, rule.entry);
    * }
    */
-  list(query?: MailboxListQuery, options?: RequestOptions): PaginatedPromise<Mailbox>;
-}
-declare class MailboxReceiveRuleResource extends Resource {
+  list(mailboxId: string, query?: MailboxReceiveRuleListQuery, options?: RequestOptions): PaginatedPromise<ReceiveRule>;
   /**
-   * Add an allow or block rule to a mailbox. Block rules always win.
+   * Add an allow or block rule for a sender address or domain to a mailbox. Block always wins; up to 200 rules per mailbox.
    *
    * @example Block a domain
    * const rule = await bird.mailboxReceiveRule.create("mbx_01abc", {
    *   action: "block",
    *   entry: "spam.example.com",
    * });
+   * console.log(rule.id);
    */
   create(mailboxId: string, params: MailboxReceiveRuleCreateParams, options?: RequestOptions): APIPromise<ReceiveRule>;
   /**
-   * Remove a receive rule.
+   * Remove a receive rule from a mailbox. Delete-and-recreate is how an entry's action is flipped.
    *
    * @example Delete a rule
    * await bird.mailboxReceiveRule.delete("mbx_01abc", "erl_01xyz");
    */
   delete(mailboxId: string, ruleId: string, options?: RequestOptions): APIPromise<void>;
-  /**
-   * List receive rules for a mailbox.
-   *
-   * @example List rules
-   * for await (const rule of bird.mailboxReceiveRule.list("mbx_01abc")) {
-   *   console.log(rule.action, rule.entry);
-   * }
-   */
-  list(mailboxId: string, query?: MailboxReceiveRuleListQuery, options?: RequestOptions): PaginatedPromise<ReceiveRule>;
 }
 //#endregion
-//#region src/resources/mailboxThread.d.ts
-/** Partial update for a thread — add/remove labels, link/unlink a contact. */
-type MailboxThreadUpdateParams = EmailThreadUpdateRequest;
-/** Filters for `bird.mailboxThread.list`. */
+//#region src/resources/mailboxThread.gen.d.ts
 type MailboxThreadListQuery = NonNullable<ListEmailThreadsData["query"]>;
-/** Parameters for `bird.mailboxThreadMessage.reply`. */
-type MailboxThreadMessageReplyParams = EmailThreadMessageReplyRequest;
-/** Filters for `bird.mailboxThreadMessage.list`. */
-type MailboxThreadMessageListQuery = NonNullable<ListEmailThreadMessagesData["query"]>;
+type MailboxThreadUpdateParams = NonNullable<UpdateEmailThreadData["body"]>;
+type MailboxThreadDeleteQuery = NonNullable<DeleteEmailThreadData["query"]>;
 declare class MailboxThreadResource extends Resource {
   /**
-   * Get a conversation thread.
+   * List mailbox conversations as a cursor page, most recently active first. `label` selects the view — inbox (default), archive, spam, blocked, or a custom label. Filter by mailbox, contact, participant address, or subject substring.
+   *
+   * @example List conversation threads
+   * for await (const thread of bird.mailboxThread.list({ mailbox_id: "mbx_01abc" })) {
+   *   console.log(thread.id, thread.subject);
+   * }
+   */
+  list(query?: MailboxThreadListQuery, options?: RequestOptions): PaginatedPromise<EmailThread>;
+  /**
+   * Get one conversation: participants, counts, labels, read state. Fetch its messages with the thread messages endpoint.
    *
    * @example Get a thread
    * const thread = await bird.mailboxThread.get("thr_01abc");
-   * console.log(thread.message_count);
+   * console.log(thread.subject);
    */
   get(threadId: string, options?: RequestOptions): APIPromise<EmailThread>;
   /**
-   * Apply label changes or contact link changes to a thread.
+   * Add or remove labels on a conversation — adding `spam` files it as spam, adding `archive` clears it out of the inbox, adding `inbox` brings it back — or link/unlink a contact.
    *
-   * @example Archive a thread
+   * @example Apply label changes to a thread
    * const thread = await bird.mailboxThread.update("thr_01abc", {
    *   labels: { add: ["archive"] },
    * });
+   * console.log(thread.id);
    */
-  update(threadId: string, params: MailboxThreadUpdateParams, options?: RequestOptions): APIPromise<EmailThread>;
+  update(threadId: string, params?: MailboxThreadUpdateParams, options?: RequestOptions): APIPromise<EmailThread>;
   /**
-   * Move a thread to trash. Pass `query.permanent = true` to delete immediately.
+   * Move a conversation and all its messages to trash (purged after 30 days), or delete permanently with ?permanent=true.
    *
    * @example Delete a thread
-   * await bird.mailboxThread.delete("thr_01abc");
+   * await bird.mailboxThread.delete("thr_01abc", { permanent: true });
    */
-  delete(threadId: string, query?: {
-    permanent?: boolean;
-  }, options?: RequestOptions): APIPromise<void>;
+  delete(threadId: string, query?: MailboxThreadDeleteQuery, options?: RequestOptions): APIPromise<void>;
+}
+//#endregion
+//#region src/resources/mailboxThreadMessage.gen.d.ts
+type MailboxThreadMessageListQuery = NonNullable<ListEmailThreadMessagesData["query"]>;
+type MailboxThreadMessageReplyParams = NonNullable<ReplyEmailThreadMessageData["body"]>;
+declare class MailboxThreadMessageResource extends Resource {
   /**
-   * List threads across the workspace's mailboxes. `await` resolves the first
-   * page; `for await` walks every thread.
+   * List the messages in a conversation newest first, both directions. Page older messages with starting_after, and pass include=extracted_text to inline each message's durable plain text.
    *
-   * @example List threads in the inbox
-   * for await (const thread of bird.mailboxThread.list()) {
-   *   console.log(thread.id, thread.message_count);
+   * @example List a thread's messages
+   * for await (const msg of bird.mailboxThreadMessage.list("thr_01abc")) {
+   *   console.log(msg.id, msg.direction);
    * }
    */
-  list(query?: MailboxThreadListQuery, options?: RequestOptions): PaginatedPromise<EmailThread>;
-}
-declare class MailboxThreadMessageResource extends Resource {
+  list(threadId: string, query?: MailboxThreadMessageListQuery, options?: RequestOptions): PaginatedPromise<EmailThreadMessage>;
   /**
-   * Get metadata for a message (not the body; use `body` for that).
+   * Get one conversation message with its extracted plain text — readable for the mailbox's full retention period, no MIME parsing needed.
    *
    * @example Get a message
    * const msg = await bird.mailboxThreadMessage.get("thr_01abc", "rem_01xyz");
@@ -8068,40 +8665,173 @@ declare class MailboxThreadMessageResource extends Resource {
    */
   get(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessage>;
   /**
-   * Get the parsed HTML and plain-text body of a message.
+   * Get the original rendered HTML and plain-text body of a conversation message. Available 30 days; after that use the message's extracted_text.
    *
-   * @example Get message body
+   * @example Get a message body
    * const body = await bird.mailboxThreadMessage.body("thr_01abc", "rem_01xyz");
    * console.log(body.text);
    */
   body(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessageBody>;
   /**
-   * Reply to a message from the mailbox's own address.
+   * Reply to a specific conversation message from the mailbox's own address. To reply to a conversation, target its newest received message. Recipients, subject, and threading headers are derived automatically.
    *
    * @example Reply to a message
    * const reply = await bird.mailboxThreadMessage.reply("thr_01abc", "rem_01xyz", {
    *   text: "Thanks for reaching out!",
    * });
+   * console.log(reply.id);
    */
-  reply(threadId: string, messageId: string, params: MailboxThreadMessageReplyParams, options?: RequestOptions): APIPromise<EmailThreadMessage>;
+  reply(threadId: string, messageId: string, params?: MailboxThreadMessageReplyParams, options?: RequestOptions): APIPromise<EmailThreadMessage>;
   /**
-   * List the attachment manifest for a message.
+   * List the attachments on a conversation message. Bytes are downloadable for 30 days; the metadata also rides the message's attachment_manifest durably.
    *
-   * @example List attachments
+   * @example List a message's attachments
    * const atts = await bird.mailboxThreadMessage.attachments("thr_01abc", "rem_01xyz");
-   * console.log(atts.data.map(a => a.filename));
+   * console.log(atts.data.map((a) => a.filename));
    */
   attachments(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessageAttachmentList>;
+}
+//#endregion
+//#region src/resources/realtime.d.ts
+/** Body for `bird.realtime.publish` — one event to one or more channels. */
+type RealtimePublishParams = RealtimePublish;
+/** Body for `bird.realtime.publishBatch` — up to 10 events, one channel each. */
+type RealtimeBatchPublishParams = RealtimeBatchPublish;
+/** Query params for `bird.realtime.channels.list`. */
+type RealtimeChannelsListQuery = NonNullable<ListRealtimeAppChannelsData["query"]>;
+/** Query params for `bird.realtime.channels.get`. */
+type RealtimeChannelGetQuery = NonNullable<GetRealtimeAppChannelData["query"]>;
+/**
+ * Realtime app credentials — `new BirdClient({ realtime: { key, secret } })`.
+ * They come from the app's credentials (shown once at creation) and must belong
+ * to the calling workspace. Any Realtime method takes the same pair in its
+ * trailing options to override the configured one for a single call — the way
+ * to talk to a second app without a second client.
+ */
+interface RealtimeOptions {
+  /** The Realtime app key, sent as `X-Realtime-Key`. */
+  key?: string;
+  /** The Realtime app secret, sent as `X-Realtime-Secret`. */
+  secret?: string;
+}
+/** Per-call options for a Realtime method: the usual request options plus a credential override. */
+interface RealtimeRequestOptions extends RequestOptions, RealtimeOptions {}
+/** The resolved credential headers, in wire form. */
+interface RealtimeAuthHeaders {
+  "X-Realtime-Key": string;
+  "X-Realtime-Secret": string;
+}
+declare abstract class RealtimeBase extends Resource {
+  #private;
+  constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1], config?: RealtimeOptions);
   /**
-   * List messages in a thread. `await` resolves the first page; `for await`
-   * walks every message.
+   * Resolve the app credentials for one call. Called eagerly at the top of each
+   * method so a missing credential throws before the lifecycle starts — never
+   * as a rejected promise after a request is already in flight.
+   */
+  protected auth(options?: RealtimeOptions): RealtimeAuthHeaders;
+}
+/**
+ * `bird.realtime.channels` — reads the app's live channel state. Channels exist
+ * implicitly: one appears when the first connection subscribes and vanishes when
+ * the last one leaves, so these report occupancy, never existence.
+ */
+declare class RealtimeChannelsResource extends RealtimeBase {
+  /**
+   * List the app's currently occupied channels, optionally filtered by name
+   * prefix. The Realtime service returns them all in one response — this is a
+   * point read, not a cursor list, so there is nothing to iterate.
    *
-   * @example List messages
-   * for await (const msg of bird.mailboxThreadMessage.list("thr_01abc")) {
-   *   console.log(msg.id, msg.direction);
-   * }
+   * @example List the occupied presence channels with their member counts
+   * const { data } = await bird.realtime.channels.list("rap_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   prefix: "presence-",
+   *   include: ["member_count"],
+   * });
+   * for (const channel of data) console.log(channel.name, channel.member_count);
    */
-  list(threadId: string, query?: MailboxThreadMessageListQuery, options?: RequestOptions): PaginatedPromise<EmailThreadMessage>;
+  list(appId: string, query?: RealtimeChannelsListQuery, options?: RealtimeRequestOptions): APIPromise<RealtimeChannelsList>;
+  /**
+   * Read one channel's state. An unknown or never-used name is not an error —
+   * it resolves with `occupied: false`.
+   *
+   * @example Check whether anyone is in a channel
+   * const channel = await bird.realtime.channels.get(
+   *   "rap_01krdgeqcxet5s7t44vh8rt9mg",
+   *   "presence-lobby",
+   *   { include: ["member_count"] },
+   * );
+   * console.log(channel.occupied, channel.member_count);
+   */
+  get(appId: string, channelName: string, query?: RealtimeChannelGetQuery, options?: RealtimeRequestOptions): APIPromise<RealtimeChannelInfo>;
+  /**
+   * List the member ids subscribed to a presence channel. Ids only — the
+   * `member_info` your authorization endpoint attaches is delivered to subscribed
+   * clients over the realtime connection and is not available over REST.
+   *
+   * @example Who is in the lobby
+   * const { members } = await bird.realtime.channels.members(
+   *   "rap_01krdgeqcxet5s7t44vh8rt9mg",
+   *   "presence-lobby",
+   * );
+   * for (const member of members) console.log(member.member_id);
+   */
+  members(appId: string, channelName: string, options?: RealtimeRequestOptions): APIPromise<RealtimeChannelMembers>;
+}
+/** `bird.realtime.members` — acts on a member across all of its connections. */
+declare class RealtimeMembersResource extends RealtimeBase {
+  /**
+   * Disconnect every active connection a member holds — sign-out, ban, or a
+   * revoked session. Resolves once the disconnect is applied; the member may
+   * reconnect immediately unless your authorization endpoint refuses them.
+   *
+   * @example Kick a member off every connection
+   * await bird.realtime.members.disconnect("rap_01krdgeqcxet5s7t44vh8rt9mg", "user_42");
+   */
+  disconnect(appId: string, memberId: string, options?: RealtimeRequestOptions): APIPromise<void>;
+}
+/**
+ * `bird.realtime` — publish events to a Realtime app's channels and inspect its
+ * live state. Every method needs the app's key/secret pair: set it once as
+ * `realtime: { key, secret }` on the client, or pass `{ key, secret }` in a
+ * call's options to reach a different app. Reached as `bird.realtime.*`.
+ */
+declare class RealtimeResource extends RealtimeBase {
+  /** Channel state — `bird.realtime.channels.list(...)`, `.get(...)`, `.members(...)`. */
+  readonly channels: RealtimeChannelsResource;
+  /** Members — `bird.realtime.members.disconnect(...)`. */
+  readonly members: RealtimeMembersResource;
+  constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1], config?: RealtimeOptions);
+  /**
+   * Publish one event to one or more of the app's channels. Listing several
+   * channels broadcasts the same event to all of them in a single call. Resolves
+   * once the event is accepted — delivery to connected clients is asynchronous.
+   *
+   * Pass `exclude_connection_id` to skip the connection that triggered the
+   * change, so the originating client doesn't echo its own update.
+   *
+   * @example Broadcast an event to a channel
+   * const result = await bird.realtime.publish("rap_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   event: "order.updated",
+   *   channels: ["orders", "presence-lobby"],
+   *   data: { order_id: "ord_123", status: "shipped" },
+   * });
+   * console.log(result.data?.length); // one entry per channel
+   */
+  publish(appId: string, params: RealtimePublishParams, options?: RealtimeRequestOptions): APIPromise<RealtimePublishResult>;
+  /**
+   * Publish up to 10 events in one request, each to a single channel. Use it to
+   * fan different events out at once; to send the *same* event to many channels,
+   * use `publish` with several `channels` instead.
+   *
+   * @example Publish two events in one call
+   * await bird.realtime.publishBatch("rap_01krdgeqcxet5s7t44vh8rt9mg", {
+   *   events: [
+   *     { event: "order.created", channel: "orders", data: { id: 1 } },
+   *     { event: "order.updated", channel: "orders", data: { id: 2 } },
+   *   ],
+   * });
+   */
+  publishBatch(appId: string, params: RealtimeBatchPublishParams, options?: RealtimeRequestOptions): APIPromise<RealtimeBatchPublishResult>;
 }
 //#endregion
 //#region src/client.d.ts
@@ -8126,6 +8856,11 @@ interface BirdClientOptions {
   email?: EmailChannelDefaults;
   /** Webhooks config — `secret` is the default used by `bird.webhooks.unwrap`. */
   webhooks?: WebhookOptions;
+  /**
+   * Realtime app credentials. Every `bird.realtime.*` call authenticates to the
+   * Realtime edge with this key/secret pair; a call's options can override it.
+   */
+  realtime?: RealtimeOptions;
 }
 /** A raw request for the `bird.request` escape hatch. */
 interface BirdRequest {
@@ -8185,8 +8920,6 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly smsTemplates: SmsTemplatesResource;
   /** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
   readonly whatsapp: WhatsappResource;
-  /** WhatsApp templates — `bird.whatsappTemplates.list(...)`. */
-  readonly whatsappTemplates: WhatsappTemplatesResource;
   /** The Verify product — `bird.verify.verifications.create(...)`, `.check(...)`. */
   readonly verify: VerifyResource;
   /** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
@@ -8207,6 +8940,8 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly mailboxThread: MailboxThreadResource;
   /** Thread messages — `bird.mailboxThreadMessage.list(...)`, `.get(...)`, `.reply(...)`, `.body(...)`, … */
   readonly mailboxThreadMessage: MailboxThreadMessageResource;
+  /** Realtime — `bird.realtime.publish(...)`, `.channels.list(...)`, `.members.disconnect(...)`, … */
+  readonly realtime: RealtimeResource;
   constructor(options: O);
   /**
    * Escape hatch for endpoints the typed resources don't cover. Runs the full
@@ -8260,11 +8995,6 @@ declare const WebhookEventType: {
   readonly EmailScheduled: "email.scheduled";
   readonly EmailSuppressionCreated: "email_suppression.created";
   readonly EmailUnsubscribed: "email.unsubscribed";
-  readonly RealtimeCacheChannels: "realtime.cache_channels";
-  readonly RealtimeChannelExistence: "realtime.channel_existence";
-  readonly RealtimeClientEvents: "realtime.client_events";
-  readonly RealtimeConnectionCount: "realtime.connection_count";
-  readonly RealtimePresence: "realtime.presence";
   readonly SmsAccepted: "sms.accepted";
   readonly SmsDelivered: "sms.delivered";
   readonly SmsExpired: "sms.expired";
@@ -8294,5 +9024,5 @@ declare const WebhookEventType: {
 /** 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 DnsRecord, type Domain, type DomainCapabilities, type DomainCreateParams, type DomainDkim, type DomainListQuery, type DomainUpdateParams, type EmailChannelDefaults, type EmailListQuery, type EmailMailboxLabelList, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadList, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadMessageList, type ErrorDetail, type ErrorNextAction, type Mailbox, type MailboxComposeParams, type MailboxCreateParams, type MailboxList, type MailboxListQuery, type MailboxReceiveRuleCreateParams, type MailboxReceiveRuleListQuery, type MailboxStatsResponse, type MailboxThreadListQuery, type MailboxThreadMessageListQuery, type MailboxThreadMessageReplyParams, type MailboxThreadUpdateParams, type MailboxUpdateParams, type PaginatedPromise, type ReceiveRule, type ReceiveRuleList, 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 AudienceCreateParams, type AudienceListContactsQuery, 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 EmailMailboxLabelList, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type ErrorDetail, type ErrorNextAction, type Mailbox, type MailboxComposeParams, type MailboxCreateParams, type MailboxListQuery, type MailboxReceiveRuleCreateParams, type MailboxReceiveRuleListQuery, type MailboxStatsResponse, type MailboxThreadDeleteQuery, type MailboxThreadListQuery, type MailboxThreadMessageListQuery, type MailboxThreadMessageReplyParams, type MailboxThreadUpdateParams, type MailboxUpdateParams, type PaginatedPromise, type RealtimeBatchPublishParams, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeChannelsListQuery, type RealtimeOptions, type RealtimePublishParams, type RealtimePublishResult, type RealtimeRequestOptions, type ReceiveRule, 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 VerificationCheckResult, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, type WhatsAppEventList, type WhatsAppMessage, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.d.mts.map