@messagebird/sdk 0.14.0 → 0.16.0

package/dist/index.d.mts

@@ -4251,15 +4251,15 @@ type WhatsAppMessageTemplateComponent = {
  */
 type WhatsAppLanguage = string;
 /**
- * A WhatsApp template's name — the stable handle used to reference the template when sending. Lowercase letters, numbers, and underscores.
+ * 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 WhatsAppTemplateName = string;
+type TemplateSlug = string;
 type WhatsAppTemplateSend = {
   /**
-   * The template to send, by its name (for example `bird_otp`).
+   * The template to send, by its slug (for example `bird_otp`).
    */
-  name: WhatsAppTemplateName;
+  slug: TemplateSlug;
   /**
    * Language code of the template variant to send (for example `en` or `pt_BR`). May be omitted when the template has a single language; when it is stocked in several, omitting the language returns a `422` that names the available codes. The accepted message echoes the resolved language.
    *
@@ -4296,14 +4296,14 @@ type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "
  */
 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).
+ * The template a message was sent from. On reads `slug`, `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).
  *
  */
 type WhatsAppMessageTemplate = {
   /**
    * The template's stable handle (for example `bird_otp`).
    */
-  readonly name: WhatsAppTemplateName;
+  readonly slug: TemplateSlug;
   /**
    * Content classification applied to messages sent from this template.
    */
@@ -5130,11 +5130,6 @@ 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.
@@ -5145,7 +5140,7 @@ type EmailTemplateSend = unknown & {
    */
   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.
+   * Which of the template's languages to send. Omit it to send the template's default language, unless the template sets `language_source_required`, in which case a send naming no language is rejected. 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;
@@ -5235,6 +5230,10 @@ type EmailMessageSendRequest = {
    *
    */
   ip_pool_id?: string;
+  /**
+   * 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. When you send with `template` and omit this field, the message takes the template's own classification, so a template created as `transactional` sends as transactional. Set this field to classify a single send differently from its template; it always takes precedence. Sends that carry no template and no category are `marketing`.
+   *
+   */
   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.
@@ -5336,7 +5335,8 @@ type EmailMessage = {
    */
   bcc?: Array<EmailAddress>;
   /**
-   * Message subject line.
+   * The subject line as delivered. For a send that used a template, the stored subject is the template's, so this reports it with the send's `parameters` substituted in, which is what the recipient saw.
+   *
    */
   subject: string;
   category: EmailMessageCategory;
@@ -5411,6 +5411,13 @@ type EmailMessage = {
   metadata?: {
     [key: string]: unknown;
   };
+  /**
+   * The substitution values this send supplied, or null for a send that carried its content inline. They are the values applied to `subject` and to the bodies the content endpoint returns, kept so you can see what produced the delivered copy and not only the result.
+   *
+   */
+  readonly parameters?: {
+    [key: string]: unknown;
+  } | null;
   /**
    * Attachment metadata for the send. Empty when no attachments were included. Raw content is not echoed; when content storage is enabled, download an attachment by its `id` via the message's attachment endpoint.
    */
@@ -7865,6 +7872,241 @@ declare class EmailStatsResource extends Resource {
   byBroadcast(query?: EmailStatsByBroadcastQuery, options?: RequestOptions): APIPromise<EmailStatsByBroadcastResponse>;
 }
 //#endregion
+//#region src/resources/emailMailboxes.gen.d.ts
+type EmailMailboxesListQuery = NonNullable<ListMailboxesData["query"]>;
+type EmailMailboxesCreateParams = NonNullable<CreateMailboxData["body"]>;
+type EmailMailboxesUpdateParams = NonNullable<UpdateMailboxData["body"]>;
+type EmailMailboxesUpdateQuery = NonNullable<UpdateMailboxData["query"]>;
+type EmailMailboxesStatsQuery = NonNullable<GetMailboxStatsData["query"]>;
+declare class EmailMailboxesResource$1 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.email.mailboxes.list()) {
+   *   console.log(mailbox.address);
+   * }
+   */
+  list(query?: EmailMailboxesListQuery, options?: RequestOptions): PaginatedPromise<Mailbox>;
+  /**
+   * 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.email.mailboxes.create({ display_name: "Support" });
+   * console.log(mailbox.address); // "abc123@inbox.ai"
+   */
+  create(params?: EmailMailboxesCreateParams, options?: RequestOptions): APIPromise<Mailbox>;
+  /**
+   * @example Get a mailbox
+   * const mailbox = await bird.email.mailboxes.get("mbx_01abc");
+   * console.log(mailbox.state); // "active"
+   */
+  get(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
+  /**
+   * 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 Change a mailbox's receive policy
+   * const mailbox = await bird.email.mailboxes.update("mbx_01abc", {
+   *   receive_policy: "open",
+   * });
+   * console.log(mailbox.id, mailbox.receive_policy);
+   */
+  update(mailboxId: string, params?: EmailMailboxesUpdateParams, query?: EmailMailboxesUpdateQuery, options?: RequestOptions): APIPromise<Mailbox>;
+  /**
+   * 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.email.mailboxes.delete("mbx_01abc");
+   */
+  delete(mailboxId: string, options?: RequestOptions): APIPromise<void>;
+  /**
+   * 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 deleted mailbox
+   * const mailbox = await bird.email.mailboxes.restore("mbx_01abc");
+   * console.log(mailbox.deleted_at); // null
+   */
+  restore(mailboxId: string, options?: RequestOptions): APIPromise<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 suspended mailbox
+   * const mailbox = await bird.email.mailboxes.resume("mbx_01abc");
+   * console.log(mailbox.state); // "active"
+   */
+  resume(mailboxId: string, options?: RequestOptions): APIPromise<Mailbox>;
+  /**
+   * @example Get mailbox stats
+   * const stats = await bird.email.mailboxes.stats("mbx_01abc");
+   * console.log(stats.summary?.sends_accepted);
+   */
+  stats(mailboxId: string, query?: EmailMailboxesStatsQuery, 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.email.mailboxes.labels("mbx_01abc");
+   * console.log(labels.data.map((label) => label.name));
+   */
+  labels(mailboxId: string, options?: RequestOptions): APIPromise<EmailMailboxLabelList>;
+}
+//#endregion
+//#region src/resources/emailMailboxesMessages.d.ts
+/** Parameters for sending a new message from a mailbox. */
+type EmailMailboxesMessagesCreateParams = EmailMailboxComposeRequest;
+declare class EmailMailboxesMessagesResource extends Resource {
+  /**
+   * Send a new email from this mailbox, starting a new conversation.
+   *
+   * @example Send from a mailbox
+   * const msg = await bird.email.mailboxes.messages.create("mbx_01abc", {
+   *   to: ["customer@example.com"],
+   *   subject: "Hello",
+   *   text: "Hi there!",
+   * });
+   */
+  create(mailboxId: string, params: EmailMailboxesMessagesCreateParams, options?: RequestOptions): APIPromise<EmailThreadMessage>;
+}
+//#endregion
+//#region src/resources/emailMailboxesReceiveRules.gen.d.ts
+type EmailMailboxesReceiveRulesListQuery = NonNullable<ListMailboxReceiveRulesData["query"]>;
+type EmailMailboxesReceiveRulesCreateParams = NonNullable<CreateMailboxReceiveRuleData["body"]>;
+declare class EmailMailboxesReceiveRulesResource extends Resource {
+  /**
+   * List a mailbox's allow/block receive rules as a cursor page, oldest first. Filter by action.
+   *
+   * @example List a mailbox's receive rules
+   * for await (const rule of bird.email.mailboxes.receiveRules.list("mbx_01abc")) {
+   *   console.log(rule.action, rule.entry);
+   * }
+   */
+  list(mailboxId: string, query?: EmailMailboxesReceiveRulesListQuery, options?: RequestOptions): PaginatedPromise<ReceiveRule>;
+  /**
+   * 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.email.mailboxes.receiveRules.create("mbx_01abc", {
+   *   action: "block",
+   *   entry: "spam.example.com",
+   * });
+   * console.log(rule.id);
+   */
+  create(mailboxId: string, params: EmailMailboxesReceiveRulesCreateParams, options?: RequestOptions): APIPromise<ReceiveRule>;
+  /**
+   * Remove a receive rule from a mailbox. Delete-and-recreate is how an entry's action is flipped.
+   *
+   * @example Delete a rule
+   * await bird.email.mailboxes.receiveRules.delete("mbx_01abc", "erl_01xyz");
+   */
+  delete(mailboxId: string, ruleId: string, options?: RequestOptions): APIPromise<void>;
+}
+//#endregion
+//#region src/resources/emailMailboxes.d.ts
+declare class EmailMailboxesResource extends EmailMailboxesResource$1 {
+  /** Messages sent from the mailbox's own address — `bird.email.mailboxes.messages.create(...)`. */
+  readonly messages: EmailMailboxesMessagesResource;
+  /** Per-sender allow/block rules — `bird.email.mailboxes.receiveRules.create(...)`, `.list(...)`, `.delete(...)`. */
+  readonly receiveRules: EmailMailboxesReceiveRulesResource;
+  constructor(...args: ConstructorParameters<typeof Resource>);
+}
+//#endregion
+//#region src/resources/emailThreads.gen.d.ts
+type EmailThreadsListQuery = NonNullable<ListEmailThreadsData["query"]>;
+type EmailThreadsUpdateParams = NonNullable<UpdateEmailThreadData["body"]>;
+type EmailThreadsDeleteQuery = NonNullable<DeleteEmailThreadData["query"]>;
+declare class EmailThreadsResource$1 extends Resource {
+  /**
+   * 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.email.threads.list({ mailbox_id: "mbx_01abc" })) {
+   *   console.log(thread.id, thread.subject);
+   * }
+   */
+  list(query?: EmailThreadsListQuery, 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.email.threads.get("thr_01abc");
+   * console.log(thread.subject);
+   */
+  get(threadId: string, options?: RequestOptions): APIPromise<EmailThread>;
+  /**
+   * 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 Apply label changes to a thread
+   * const thread = await bird.email.threads.update("thr_01abc", {
+   *   labels: { add: ["archive"] },
+   * });
+   * console.log(thread.id);
+   */
+  update(threadId: string, params?: EmailThreadsUpdateParams, options?: RequestOptions): APIPromise<EmailThread>;
+  /**
+   * 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.email.threads.delete("thr_01abc", { permanent: true });
+   */
+  delete(threadId: string, query?: EmailThreadsDeleteQuery, options?: RequestOptions): APIPromise<void>;
+}
+//#endregion
+//#region src/resources/emailThreadsMessages.gen.d.ts
+type EmailThreadsMessagesListQuery = NonNullable<ListEmailThreadMessagesData["query"]>;
+type EmailThreadsMessagesReplyParams = NonNullable<ReplyEmailThreadMessageData["body"]>;
+declare class EmailThreadsMessagesResource extends Resource {
+  /**
+   * 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 a thread's messages
+   * for await (const msg of bird.email.threads.messages.list("thr_01abc")) {
+   *   console.log(msg.id, msg.direction);
+   * }
+   */
+  list(threadId: string, query?: EmailThreadsMessagesListQuery, options?: RequestOptions): PaginatedPromise<EmailThreadMessage>;
+  /**
+   * 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.email.threads.messages.get("thr_01abc", "rem_01xyz");
+   * console.log(msg.direction); // "inbound"
+   */
+  get(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessage>;
+  /**
+   * 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 a message body
+   * const body = await bird.email.threads.messages.body("thr_01abc", "rem_01xyz");
+   * console.log(body.text);
+   */
+  body(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessageBody>;
+  /**
+   * 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.email.threads.messages.reply("thr_01abc", "rem_01xyz", {
+   *   text: "Thanks for reaching out!",
+   * });
+   * console.log(reply.id);
+   */
+  reply(threadId: string, messageId: string, params?: EmailThreadsMessagesReplyParams, options?: RequestOptions): APIPromise<EmailThreadMessage>;
+  /**
+   * 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 a message's attachments
+   * const atts = await bird.email.threads.messages.attachments("thr_01abc", "rem_01xyz");
+   * console.log(atts.data.map((a) => a.filename));
+   */
+  attachments(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessageAttachmentList>;
+}
+//#endregion
+//#region src/resources/emailThreads.d.ts
+declare class EmailThreadsResource extends EmailThreadsResource$1 {
+  /** Messages in a conversation — `bird.email.threads.messages.list(...)`, `.reply(...)`, … */
+  readonly messages: EmailThreadsMessagesResource;
+  constructor(...args: ConstructorParameters<typeof Resource>);
+}
+//#endregion
 //#region src/resources/email.d.ts
 /** Body for `bird.email.send`. */
 type EmailSendParams = EmailMessageSendRequest;
@@ -7889,6 +8131,10 @@ declare class EmailResource<D extends EmailChannelDefaults | undefined = undefin
   #private;
   /** Email statistics — `bird.email.stats.summary(...)`, `.daily(...)`, `.byTag(...)`, … */
   readonly stats: EmailStatsResource;
+  /** Durable agent mailboxes — `bird.email.mailboxes.list(...)`, `.create(...)`, … */
+  readonly mailboxes: EmailMailboxesResource;
+  /** Conversations across every mailbox — `bird.email.threads.list(...)`, `.get(...)`, … */
+  readonly threads: EmailThreadsResource;
   constructor(core: ConstructorParameters<typeof Resource>[0], client: ConstructorParameters<typeof Resource>[1], defaults?: D);
   /**
    * Send an email message. Resolves once the message is accepted for delivery
@@ -8374,7 +8620,7 @@ declare class WhatsappResource extends WhatsappResourceBase {
    * const msg = await bird.whatsapp.send({
    *   to: "+15551234567",
    *   template: {
-   *     name: "bird_otp",
+   *     slug: "bird_otp",
    *     components: [
    *       { type: "body", parameters: [{ type: "text", text: "123456" }] },
    *     ],
@@ -8473,225 +8719,6 @@ declare class WebhooksResource {
   unwrap(payload: string, headers: WebhookHeaders, options?: WebhookOptions): BirdWebhookEvent;
 }
 //#endregion
-//#region src/resources/mailbox.gen.d.ts
-type MailboxListQuery = NonNullable<ListMailboxesData["query"]>;
-type MailboxCreateParams = NonNullable<CreateMailboxData["body"]>;
-type MailboxUpdateParams = NonNullable<UpdateMailboxData["body"]>;
-type MailboxUpdateQuery = NonNullable<UpdateMailboxData["query"]>;
-type MailboxStatsQuery = NonNullable<GetMailboxStatsData["query"]>;
-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 — 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" });
-   * console.log(mailbox.address); // "abc123@inbox.ai"
-   */
-  create(params?: MailboxCreateParams, options?: RequestOptions): APIPromise<Mailbox>;
-  /**
-   * @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'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 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, query?: MailboxUpdateQuery, options?: RequestOptions): APIPromise<Mailbox>;
-  /**
-   * 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 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 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 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 suspended mailbox
-   * const mailbox = await bird.mailbox.resume("mbx_01abc");
-   * console.log(mailbox.state); // "active"
-   */
-  resume(mailboxId: string, options?: RequestOptions): APIPromise<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.
-   *
-   * @example Send from a mailbox
-   * const msg = await bird.mailbox.compose("mbx_01abc", {
-   *   to: ["customer@example.com"],
-   *   subject: "Hello",
-   *   text: "Hi there!",
-   * });
-   */
-  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 a mailbox's allow/block receive rules as a cursor page, oldest first. Filter by action.
-   *
-   * @example List a mailbox's receive 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>;
-  /**
-   * 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 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>;
-}
-//#endregion
-//#region src/resources/mailboxThread.gen.d.ts
-type MailboxThreadListQuery = NonNullable<ListEmailThreadsData["query"]>;
-type MailboxThreadUpdateParams = NonNullable<UpdateEmailThreadData["body"]>;
-type MailboxThreadDeleteQuery = NonNullable<DeleteEmailThreadData["query"]>;
-declare class MailboxThreadResource extends Resource {
-  /**
-   * 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.subject);
-   */
-  get(threadId: string, options?: RequestOptions): APIPromise<EmailThread>;
-  /**
-   * 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 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>;
-  /**
-   * 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", { permanent: true });
-   */
-  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 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 a thread's messages
-   * for await (const msg of bird.mailboxThreadMessage.list("thr_01abc")) {
-   *   console.log(msg.id, msg.direction);
-   * }
-   */
-  list(threadId: string, query?: MailboxThreadMessageListQuery, options?: RequestOptions): PaginatedPromise<EmailThreadMessage>;
-  /**
-   * 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");
-   * console.log(msg.direction); // "inbound"
-   */
-  get(threadId: string, messageId: string, options?: RequestOptions): APIPromise<EmailThreadMessage>;
-  /**
-   * 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 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 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>;
-  /**
-   * 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 a message's attachments
-   * const atts = await bird.mailboxThreadMessage.attachments("thr_01abc", "rem_01xyz");
-   * 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;
@@ -8932,14 +8959,6 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly domains: DomainsResource;
   /** Webhooks — `bird.webhooks.unwrap(payload, headers)` verifies an inbound delivery. */
   readonly webhooks: WebhooksResource;
-  /** Agent mailboxes — `bird.mailbox.create(...)`, `.compose(...)`, `.list(...)`, … */
-  readonly mailbox: MailboxResource;
-  /** Mailbox receive rules — `bird.mailboxReceiveRule.create(...)`, `.delete(...)`, `.list(...)`. */
-  readonly mailboxReceiveRule: MailboxReceiveRuleResource;
-  /** Mailbox threads — `bird.mailboxThread.list(...)`, `.get(...)`, `.update(...)`, `.delete(...)`. */
-  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);
@@ -9024,5 +9043,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 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 };
+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 EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, 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 EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type ErrorNextAction, type Mailbox, type MailboxStatsResponse, 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