@messagebird/sdk 0.12.1 → 0.14.0

package/dist/index.mjs

@@ -907,7 +907,7 @@ var BirdNotImplementedError = class extends BirdAPIError {
 		Object.setPrototypeOf(this, new.target.prototype);
 	}
 };
-/** 421 — request reached the wrong region (ADR-0036). */
+/** 421 — request reached the wrong region. */
 var BirdMisdirectedError = class extends BirdAPIError {
 	constructor(fields) {
 		super(fields);
@@ -1183,6 +1183,116 @@ const client = createClient(createConfig());
 //#endregion
 //#region src/generated/sdk.gen.ts
 /**
+* Publish a Realtime event
+*
+* Publishes an event to one or more channels of a Realtime app. Listing several channels broadcasts the event to all of them in one call. Connected clients subscribed to those channels receive it in real time.
+*/
+const publishRealtimeAppEvent = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/events",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Publish a batch of Realtime events
+*
+* Publishes up to 10 events (each to one channel) in a single request.
+*/
+const publishRealtimeAppBatch = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/batch-events",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* List Realtime channels
+*
+* Lists the app's currently occupied channels, optionally filtered by name prefix.
+*/
+const listRealtimeAppChannels = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/channels",
+	...options
+});
+/**
+* Get a Realtime channel
+*
+* Returns a single channel's occupancy and (on request) counts. Channels exist implicitly — a channel appears when the first connection subscribes and vanishes when the last one leaves — so this endpoint reports state, not existence: an unknown or never-used name returns 200 with `occupied: false`, never 404.
+*/
+const getRealtimeAppChannel = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}",
+	...options
+});
+/**
+* List members on a presence channel
+*
+* Lists the member ids currently subscribed to a presence channel. Ids only: `member_info` (the profile data attached by your authorization endpoint) is delivered to subscribed clients over the realtime connection and is not available over REST.
+*/
+const listRealtimeAppChannelMembers = (options) => (options.client ?? client).get({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}/members",
+	...options
+});
+/**
+* Disconnect a member
+*
+* Disconnects all of a member's active connections (e.g. on sign-out or ban).
+*/
+const disconnectRealtimeAppMember = (options) => (options.client ?? client).post({
+	security: [{
+		scheme: "bearer",
+		type: "http"
+	}, {
+		in: "cookie",
+		name: "bird_session",
+		type: "apiKey"
+	}],
+	url: "/v1/realtime/apps/{realtime_app_id}/members/{member_id}/disconnect",
+	...options
+});
+/**
 * List messages
 *
 * Returns the workspace's sent and scheduled messages, newest first, as a cursor page. Each item carries the aggregate delivery `status` and per-state recipient counts, not the message body. Combine filters to narrow the page: `status`, `category`, `tag`, exact `to`/`from` address, and a `created_after`/`created_before` time window.
@@ -1937,8 +2047,7 @@ const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 * placeholders in `components`; Bird selects the sender number from the
 * template's category, so the request carries no sender field. Templates are
 * the only supported content type: a request without `template` is rejected
-* with a `422`. Browse what you can send with
-* [List available message templates](/docs/api/reference/list-whats-app-templates).
+* with a `422`. Browse your workspace's templates in the Bird dashboard.
 *
 * The `202` response is the accepted message, echoing the resolved template
 * and language; it is not a delivery confirmation. Follow delivery with
@@ -2005,24 +2114,6 @@ const listWhatsAppMessageEvents = (options) => (options.client ?? client).get({
 	...options
 });
 /**
-* List available message templates
-*
-* Returns the WhatsApp message templates you can send from. Each entry carries the template's `name` (the reference you pass when sending), its language, category, review status, and its content blocks with example values for every placeholder. The catalogue is returned in full, so this list is not paginated, and it can differ by region: you see the templates stocked for the region you call. Pick a template here, then fill its placeholders in the `components` of [Send a WhatsApp message](/docs/api/reference/send-whats-app-message).
-*
-*/
-const listWhatsAppTemplates = (options) => (options?.client ?? client).get({
-	security: [{
-		scheme: "bearer",
-		type: "http"
-	}, {
-		in: "cookie",
-		name: "bird_session",
-		type: "apiKey"
-	}],
-	url: "/v1/whatsapp/templates",
-	...options
-});
-/**
 * Daily sending statistics
 *
 * Returns one row of aggregate sending statistics per calendar day for the workspace: UTC days by default, or your local days when `timezone` is set. Days with no activity are included with zero counts, so the series charts without client-side gap handling. Suited to charts and trend lines; for per-message exact accounting use the message detail endpoints.
@@ -2986,6 +3077,60 @@ function mergeHeaders(idempotencyKey, extra) {
 	};
 }
 //#endregion
+//#region src/resources/email.gen.ts
+var EmailResourceBase = class 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, options) {
+		return this.call("GET", options, ({ signal, headers }) => getEmailMessage({
+			client: this.client,
+			path: { message_id: messageId },
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailMessages({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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, options) {
+		return this.call("POST", options, ({ signal, headers }) => cancelEmailMessage({
+			client: this.client,
+			path: { message_id: messageId },
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
 //#region src/resources/emailStats.gen.ts
 var EmailStatsResource = class extends Resource {
 	/**
@@ -3282,7 +3427,7 @@ var EmailStatsResource = class extends Resource {
 };
 //#endregion
 //#region src/resources/email.ts
-var EmailResource = class extends Resource {
+var EmailResource = class extends EmailResourceBase {
 	#defaults;
 	/** Email statistics — `bird.email.stats.summary(...)`, `.daily(...)`, `.byTag(...)`, … */
 	stats;
@@ -3400,85 +3545,14 @@ var EmailResource = class extends Resource {
 			signal
 		}));
 	}
-	/**
-	* 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, options) {
-		return this.call("GET", options, ({ signal, headers }) => getEmailMessage({
-			client: this.client,
-			path: { message_id: messageId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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, options) {
-		return this.call("POST", options, ({ signal, headers }) => cancelEmailMessage({
-			client: this.client,
-			path: { message_id: messageId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailMessages({
-			client: this.client,
-			query: {
-				...query,
-				starting_after: cursor ?? query?.starting_after
-			},
-			headers,
-			signal
-		}));
-	}
 };
 //#endregion
-//#region src/resources/audiences.ts
+//#region src/resources/audiences.gen.ts
 var AudiencesResource = class 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, options) {
-		return this.call("POST", options, ({ signal, headers }) => createAudience({
-			client: this.client,
-			body: params,
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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);
 	* }
@@ -3495,10 +3569,11 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, options) {
 		return this.call("GET", options, ({ signal, headers }) => getAudience({
@@ -3509,12 +3584,27 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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_…"
+	*/
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createAudience({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* Update an audience's name or description. Omitted fields are unchanged; a null description clears it.
+	*
+	* @example Rename an audience
+	* await bird.audiences.update("adn_01krdgeqcxet5s7t44vh8rt9mg", { name: "Renamed" });
 	*/
-	update(audienceId, params, options) {
+	update(audienceId, params = {}, options) {
 		return this.call("PATCH", options, ({ signal, headers }) => updateAudience({
 			client: this.client,
 			path: { audience_id: audienceId },
@@ -3524,10 +3614,10 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Delete an audience. Its contacts are unaffected.
+	* 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
-	* await bird.audiences.delete("aud_01krdgeqcxet5s7t44vh8rt9mg");
+	* @example Delete an audience by id
+	* await bird.audiences.delete("adn_01krdgeqcxet5s7t44vh8rt9mg");
 	*/
 	delete(audienceId, options) {
 		return this.call("DELETE", options, ({ signal, headers }) => deleteAudience({
@@ -3538,11 +3628,10 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
 	* }
 	*/
@@ -3559,11 +3648,11 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, params, options) {
@@ -3576,11 +3665,11 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, params, options) {
@@ -3593,10 +3682,13 @@ var AudiencesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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");
+	* @example Remove one contact's membership
+	* await bird.audiences.removeContact(
+	*   "adn_01krdgeqcxet5s7t44vh8rt9mg",
+	*   "con_01krdgeqcxet5s7t44vh8rt9mg",
+	* );
 	*/
 	removeContact(audienceId, contactId, options) {
 		return this.call("DELETE", options, ({ signal, headers }) => unassignAudienceContact({
@@ -3611,29 +3703,12 @@ var AudiencesResource = class extends Resource {
 	}
 };
 //#endregion
-//#region src/resources/domains.ts
+//#region src/resources/domains.gen.ts
 var DomainsResource = class extends Resource {
 	/**
-	* Register a sending domain. Returns it in `pending` with the `dns_records`
-	* to publish at your DNS provider; call `verify` once they are in place.
-	*
-	* @example Register a sending domain
-	* const domain = await bird.domains.create({ domain: "mail.acme.com" });
-	* console.log(domain.id, domain.status); // "dom_…", "pending"
-	*/
-	create(params, options) {
-		return this.call("POST", options, ({ signal, headers }) => createDomain({
-			client: this.client,
-			body: params,
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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);
 	* }
@@ -3650,11 +3725,11 @@ var DomainsResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, options) {
 		return this.call("GET", options, ({ signal, headers }) => getDomain({
@@ -3665,34 +3740,29 @@ var DomainsResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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
-	* await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
-	*   settings: { click_tracking: true, open_tracking: true },
-	*   tracking: { name: "links" },
-	* });
+	* @example Register a sending domain
+	* const domain = await bird.domains.create({ domain: "mail.acme.com" });
+	* console.log(domain.id, domain.status); // "dom_…", "pending"
 	*/
-	update(domainId, params, options) {
-		return this.call("PATCH", options, ({ signal, headers }) => updateDomain({
-			client: this.client,
-			path: { domain_id: domainId },
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createDomain({
+			client: this.client,
 			body: params,
 			headers,
 			signal
 		}));
 	}
 	/**
-	* Delete a sending domain. Mail already accepted still sends; you can no
-	* longer send new mail from it.
+	* 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
-	* await bird.domains.delete("dom_01krdgeqcxet5s7t44vh8rt9mg");
+	* @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
 	*/
-	delete(domainId, options) {
-		return this.call("DELETE", options, ({ signal, headers }) => deleteDomain({
+	verify(domainId, options) {
+		return this.call("POST", options, ({ signal, headers }) => verifyDomain({
 			client: this.client,
 			path: { domain_id: domainId },
 			headers,
@@ -3700,49 +3770,49 @@ var DomainsResource = class extends Resource {
 		}));
 	}
 	/**
-	* Trigger a fresh DNS check and return the refreshed domain with per-record
-	* results. Safe to repeat while waiting for DNS to propagate.
+	* 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
-	* const domain = await bird.domains.verify("dom_01krdgeqcxet5s7t44vh8rt9mg");
-	* console.log(domain.status); // "verified" once DNS is in place
+	* @example Enable tracking on a domain
+	* await bird.domains.update("dom_01krdgeqcxet5s7t44vh8rt9mg", {
+	*   settings: { click_tracking: true, open_tracking: true },
+	*   tracking: { name: "links" },
+	* });
 	*/
-	verify(domainId, options) {
-		return this.call("POST", options, ({ signal, headers }) => verifyDomain({
+	update(domainId, params = {}, options) {
+		return this.call("PATCH", options, ({ signal, headers }) => updateDomain({
 			client: this.client,
 			path: { domain_id: domainId },
+			body: params,
 			headers,
 			signal
 		}));
 	}
-};
-//#endregion
-//#region src/resources/contactProperties.ts
-var ContactPropertiesResource = class extends Resource {
 	/**
-	* Define a contact property. The `key` must be unique in the workspace and is
-	* how contacts reference the field in their `data`.
+	* 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
-	* const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
-	* console.log(prop.id); // "cp_…"
+	* @example Delete a sending domain by id
+	* await bird.domains.delete("dom_01krdgeqcxet5s7t44vh8rt9mg");
 	*/
-	create(params, options) {
-		return this.call("POST", options, ({ signal, headers }) => createContactProperty({
+	delete(domainId, options) {
+		return this.call("DELETE", options, ({ signal, headers }) => deleteDomain({
 			client: this.client,
-			body: params,
+			path: { domain_id: domainId },
 			headers,
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/contactProperties.gen.ts
+var ContactPropertiesResource = class extends Resource {
 	/**
-	* List the workspace's contact properties. `await` resolves the first page;
-	* `for await` walks every property across pages.
+	* List the workspace's contact properties as a cursor page, newest first. Archived properties are included, marked by their archived flag.
 	*
-	* @example
+	* @example Iterate every contact property, or take one page
 	* for await (const prop of bird.contactProperties.list()) {
 	*   console.log(prop.key, prop.type);
 	* }
+	* const page = await bird.contactProperties.list({ limit: 50 }); // page.data, page.next_cursor
 	*/
 	list(query, options) {
 		return this.paginated("GET", options, ({ signal, headers }, cursor) => listContactProperties({
@@ -3756,10 +3826,11 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Fetch a single contact property by id.
+	* Get a single contact property by ID: key, type, fallback value, and archived state.
 	*
-	* @example
+	* @example Fetch a contact property by id
 	* const prop = await bird.contactProperties.get("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* console.log(prop.key, prop.type);
 	*/
 	get(propertyId, options) {
 		return this.call("GET", options, ({ signal, headers }) => getContactProperty({
@@ -3770,12 +3841,27 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Update a contact property. Only the fields you send change.
+	* 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
+	* @example Define a custom property
+	* const prop = await bird.contactProperties.create({ key: "plan", type: "string" });
+	* console.log(prop.id); // "cp_…"
+	*/
+	create(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => createContactProperty({
+			client: this.client,
+			body: params,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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, params, options) {
+	update(propertyId, params = {}, options) {
 		return this.call("PATCH", options, ({ signal, headers }) => updateContactProperty({
 			client: this.client,
 			path: { property_id: propertyId },
@@ -3785,10 +3871,11 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Archive a contact property, retiring the field without deleting its data.
+	* 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`.
 	*
-	* @example
-	* await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* @example Archive a property, retiring the field without deleting its data
+	* const prop = await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
+	* console.log(prop.key, prop.archived);
 	*/
 	archive(propertyId, options) {
 		return this.call("POST", options, ({ signal, headers }) => archiveContactProperty({
@@ -3799,9 +3886,9 @@ var ContactPropertiesResource = class extends Resource {
 		}));
 	}
 	/**
-	* Restore an archived contact property.
+	* Reactivate an archived contact property so its key is accepted in contact writes and renders in templates again. Fails with a conflict if the property is not archived.
 	*
-	* @example
+	* @example Restore an archived property
 	* await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
 	*/
 	unarchive(propertyId, options) {
@@ -3815,7 +3902,7 @@ var ContactPropertiesResource = class extends Resource {
 };
 //#endregion
 //#region src/resources/contacts.gen.ts
-var ContactsResourceBase = class extends Resource {
+var ContactsResource = class 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.
 	*
@@ -3870,48 +3957,47 @@ var ContactsResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* Delete a contact and remove it from every audience it belongs to. Suppression records for the address are unaffected.
+	* 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 Delete a contact by id
-	* await bird.contacts.delete("con_01krdgeqcxet5s7t44vh8rt9mg");
+	* @example Change a contact's fields
+	* const contact = await bird.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", {
+	*   first_name: "Jane",
+	* });
+	* console.log(contact.first_name);
 	*/
-	delete(contactId, options) {
-		return this.call("DELETE", options, ({ signal, headers }) => deleteContact({
+	update(contactId, params = {}, options) {
+		return this.call("PATCH", options, ({ signal, headers }) => updateContact({
 			client: this.client,
 			path: { contact_id: contactId },
+			body: params,
 			headers,
 			signal
 		}));
 	}
-};
-//#endregion
-//#region src/resources/contacts.ts
-var ContactsResource = class extends ContactsResourceBase {
 	/**
-	* Update a contact. Only the fields you send change.
+	* Delete a contact and remove it from every audience it belongs to. Suppression records for the address are unaffected.
 	*
-	* @example
-	* const contact = await bird.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", {
-	*   first_name: "Jane",
-	* });
+	* @example Delete a contact by id
+	* await bird.contacts.delete("con_01krdgeqcxet5s7t44vh8rt9mg");
 	*/
-	update(contactId, params, options) {
-		return this.call("PATCH", options, ({ signal, headers }) => updateContact({
+	delete(contactId, options) {
+		return this.call("DELETE", options, ({ signal, headers }) => deleteContact({
 			client: this.client,
 			path: { contact_id: contactId },
-			body: params,
 			headers,
 			signal
 		}));
 	}
 	/**
-	* Create or update many contacts in one call, matched by email. Returns a
-	* per-contact result.
+	* 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
+	* @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, options) {
 		return this.call("POST", options, ({ signal, headers }) => createContactBatch({
@@ -3923,8 +4009,47 @@ var ContactsResource = class extends ContactsResourceBase {
 	}
 };
 //#endregion
+//#region src/resources/sms.gen.ts
+var SmsResourceBase = class extends Resource {
+	/**
+	* Get one SMS message by id: its current delivery status, segment breakdown, cost, and failure detail if it failed.
+	*
+	* @example Read a message back
+	* const msg = await bird.sms.get("sms_abc123");
+	* msg.status; // "accepted" | "delivered" | …
+	*/
+	get(messageId, options) {
+		return this.call("GET", options, ({ signal, headers }) => getSmsMessage({
+			client: this.client,
+			path: { message_id: messageId },
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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 Iterate outbound messages
+	* for await (const msg of bird.sms.list({ direction: "outbound" })) {
+	*   console.log(msg.id, msg.status);
+	* }
+	*/
+	list(query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listSmsMessages({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+};
+//#endregion
 //#region src/resources/sms.ts
-var SmsResource = class extends Resource {
+/** Filters and cursor params for `bird.sms.list`. */
+var SmsResource = class 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
@@ -3971,52 +4096,12 @@ var SmsResource = class extends Resource {
 			signal
 		}));
 	}
-	/**
-	* 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, options) {
-		return this.call("GET", options, ({ signal, headers }) => getSmsMessage({
-			client: this.client,
-			path: { message_id: messageId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listSmsMessages({
-			client: this.client,
-			query: {
-				...query,
-				starting_after: cursor ?? query?.starting_after
-			},
-			headers,
-			signal
-		}));
-	}
 };
 //#endregion
-//#region src/resources/smsTemplates.ts
+//#region src/resources/smsTemplates.gen.ts
 var SmsTemplatesResource = class 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" });
@@ -4031,10 +4116,9 @@ var SmsTemplatesResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
 	*/
@@ -4048,39 +4132,12 @@ var SmsTemplatesResource = class extends Resource {
 	}
 };
 //#endregion
-//#region src/resources/whatsapp.ts
-var WhatsappResource = class extends Resource {
+//#region src/resources/whatsapp.gen.ts
+var WhatsappResourceBase = class 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.
+	* 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
-	* 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, options) {
-		return this.call("POST", options, ({ signal, headers }) => sendWhatsAppMessage({
-			client: this.client,
-			body: params,
-			headers,
-			signal
-		}));
-	}
-	/**
-	* Fetch a single WhatsApp message: its current delivery status and failure
-	* detail if it failed.
-	*
-	* @example
+	* @example Read a message back
 	* const msg = await bird.whatsapp.get("wa_abc123");
 	* msg.status; // "accepted" | "delivered" | …
 	*/
@@ -4093,11 +4150,9 @@ var WhatsappResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
 	* }
@@ -4114,11 +4169,9 @@ var WhatsappResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
 	*/
@@ -4133,36 +4186,42 @@ var WhatsappResource = class extends Resource {
 	}
 };
 //#endregion
-//#region src/resources/whatsappTemplates.ts
-var WhatsappTemplatesResource = class extends Resource {
+//#region src/resources/whatsapp.ts
+var WhatsappResource = class 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) {
-		return this.call("GET", options, ({ signal, headers }) => listWhatsAppTemplates({
+	send(params, options) {
+		return this.call("POST", options, ({ signal, headers }) => sendWhatsAppMessage({
 			client: this.client,
+			body: params,
 			headers,
 			signal
 		}));
 	}
 };
 //#endregion
-//#region src/resources/verify.ts
-var VerificationsResource = class extends Resource {
+//#region src/resources/verifyVerifications.gen.ts
+var VerifyVerificationsResource = class 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`.
+	* 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 over SMS
+	* @example Start a verification over SMS
 	* const verification = await bird.verify.verifications.create({
 	*   to: { phone_number: "+15551234567" },
 	* });
@@ -4177,12 +4236,9 @@ var VerificationsResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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",
@@ -4198,11 +4254,13 @@ var VerificationsResource = class extends Resource {
 		}));
 	}
 };
+//#endregion
+//#region src/resources/verify.ts
 /** The Verify product namespace — holds the `verifications` collection. */
 var VerifyResource = class {
 	verifications;
 	constructor(...args) {
-		this.verifications = new VerificationsResource(...args);
+		this.verifications = new VerifyVerificationsResource(...args);
 	}
 };
 //#endregion
@@ -4267,26 +4325,43 @@ function toHeaderRecord(headers) {
 	return headers instanceof Headers ? Object.fromEntries(headers) : headers;
 }
 //#endregion
-//#region src/resources/mailbox.ts
-var MailboxResource = class extends Resource {
+//#region src/resources/mailbox.gen.ts
+var MailboxResourceBase = class extends Resource {
 	/**
-	* Create a mailbox. Omit `local_part` to auto-generate a handle on inbox.ai.
+	* 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, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listMailboxes({
+			client: this.client,
+			query: {
+				...query,
+				starting_after: cursor ?? query?.starting_after
+			},
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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, options) {
+	create(params = {}, options) {
 		return this.call("POST", options, ({ signal, headers }) => createMailbox({
 			client: this.client,
-			body: params ?? {},
+			body: params,
 			headers,
 			signal
 		}));
 	}
 	/**
-	* Get a mailbox by id.
-	*
 	* @example Get a mailbox
 	* const mailbox = await bird.mailbox.get("mbx_01abc");
 	* console.log(mailbox.state); // "active"
@@ -4300,22 +4375,26 @@ var MailboxResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, params, options) {
+	update(mailboxId, params = {}, query, options) {
 		return this.call("PATCH", options, ({ signal, headers }) => updateMailbox({
 			client: this.client,
 			path: { mailbox_id: mailboxId },
 			body: params,
+			query,
 			headers,
 			signal
 		}));
 	}
 	/**
-	* 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");
@@ -4329,10 +4408,11 @@ var MailboxResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, options) {
 		return this.call("POST", options, ({ signal, headers }) => restoreMailbox({
@@ -4343,10 +4423,11 @@ var MailboxResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, options) {
 		return this.call("POST", options, ({ signal, headers }) => resumeMailbox({
@@ -4357,8 +4438,6 @@ var MailboxResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
@@ -4367,11 +4446,30 @@ var MailboxResource = class extends Resource {
 		return this.call("GET", options, ({ signal, headers }) => getMailboxStats({
 			client: this.client,
 			path: { mailbox_id: mailboxId },
-			query: query ?? {},
+			query,
+			headers,
+			signal
+		}));
+	}
+	/**
+	* 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, options) {
+		return this.call("GET", options, ({ signal, headers }) => listMailboxLabels({
+			client: this.client,
+			path: { mailbox_id: mailboxId },
 			headers,
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/mailbox.ts
+var MailboxResource = class extends MailboxResourceBase {
 	/**
 	* Send a new email from this mailbox, starting a new conversation.
 	*
@@ -4391,33 +4489,22 @@ var MailboxResource = class extends Resource {
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/mailboxReceiveRule.gen.ts
+var MailboxReceiveRuleResource = class 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, options) {
-		return this.call("GET", options, ({ signal, headers }) => listMailboxLabels({
-			client: this.client,
-			path: { mailbox_id: mailboxId },
-			headers,
-			signal
-		}));
-	}
-	/**
-	* 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, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listMailboxes({
+	list(mailboxId, query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listMailboxReceiveRules({
 			client: this.client,
+			path: { mailbox_id: mailboxId },
 			query: {
 				...query,
 				starting_after: cursor ?? query?.starting_after
@@ -4426,16 +4513,15 @@ var MailboxResource = class extends Resource {
 			signal
 		}));
 	}
-};
-var MailboxReceiveRuleResource = class extends Resource {
 	/**
-	* 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, params, options) {
 		return this.call("POST", options, ({ signal, headers }) => createMailboxReceiveRule({
@@ -4447,7 +4533,7 @@ var MailboxReceiveRuleResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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");
@@ -4463,18 +4549,21 @@ var MailboxReceiveRuleResource = class extends Resource {
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/mailboxThread.gen.ts
+var MailboxThreadResource = class extends Resource {
 	/**
-	* List receive rules for a mailbox.
+	* 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 rules
-	* for await (const rule of bird.mailboxReceiveRule.list("mbx_01abc")) {
-	*   console.log(rule.action, rule.entry);
+	* @example List conversation threads
+	* for await (const thread of bird.mailboxThread.list({ mailbox_id: "mbx_01abc" })) {
+	*   console.log(thread.id, thread.subject);
 	* }
 	*/
-	list(mailboxId, query, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listMailboxReceiveRules({
+	list(query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailThreads({
 			client: this.client,
-			path: { mailbox_id: mailboxId },
 			query: {
 				...query,
 				starting_after: cursor ?? query?.starting_after
@@ -4483,16 +4572,12 @@ var MailboxReceiveRuleResource = class extends Resource {
 			signal
 		}));
 	}
-};
-//#endregion
-//#region src/resources/mailboxThread.ts
-var MailboxThreadResource = class extends Resource {
 	/**
-	* Get a conversation thread.
+	* 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, options) {
 		return this.call("GET", options, ({ signal, headers }) => getEmailThread({
@@ -4503,14 +4588,15 @@ var MailboxThreadResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, params, options) {
+	update(threadId, params = {}, options) {
 		return this.call("PATCH", options, ({ signal, headers }) => updateEmailThread({
 			client: this.client,
 			path: { thread_id: threadId },
@@ -4520,10 +4606,10 @@ var MailboxThreadResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, query, options) {
 		return this.call("DELETE", options, ({ signal, headers }) => deleteEmailThread({
@@ -4534,18 +4620,22 @@ var MailboxThreadResource = class extends Resource {
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/mailboxThreadMessage.gen.ts
+var MailboxThreadMessageResource = class 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, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailThreads({
+	list(threadId, query, options) {
+		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailThreadMessages({
 			client: this.client,
+			path: { thread_id: threadId },
 			query: {
 				...query,
 				starting_after: cursor ?? query?.starting_after
@@ -4554,10 +4644,8 @@ var MailboxThreadResource = class extends Resource {
 			signal
 		}));
 	}
-};
-var MailboxThreadMessageResource = class extends Resource {
 	/**
-	* 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");
@@ -4575,9 +4663,9 @@ var MailboxThreadMessageResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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);
 	*/
@@ -4593,14 +4681,15 @@ var MailboxThreadMessageResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, messageId, params, options) {
+	reply(threadId, messageId, params = {}, options) {
 		return this.call("POST", options, ({ signal, headers }) => replyEmailThreadMessage({
 			client: this.client,
 			path: {
@@ -4613,11 +4702,11 @@ var MailboxThreadMessageResource = class extends Resource {
 		}));
 	}
 	/**
-	* 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, messageId, options) {
 		return this.call("GET", options, ({ signal, headers }) => listEmailThreadMessageAttachments({
@@ -4630,24 +4719,211 @@ var MailboxThreadMessageResource = class extends Resource {
 			signal
 		}));
 	}
+};
+//#endregion
+//#region src/resources/realtime.ts
+var RealtimeBase = class extends Resource {
+	#config;
+	constructor(core, client, config) {
+		super(core, client);
+		this.#config = config;
+	}
+	/**
+	* 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.
+	*/
+	auth(options) {
+		const key = options?.key ?? this.#config?.key;
+		const secret = options?.secret ?? this.#config?.secret;
+		if (!key || !secret) throw new Error("No Realtime app credentials. Set `realtime: { key, secret }` on the client, or pass `{ key, secret }` in the call options.");
+		return {
+			"X-Realtime-Key": key,
+			"X-Realtime-Secret": secret
+		};
+	}
+};
+/**
+* `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.
+*/
+var RealtimeChannelsResource = class extends RealtimeBase {
 	/**
-	* List messages in a thread. `await` resolves the first page; `for await`
-	* walks every message.
+	* 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, query, options) {
-		return this.paginated("GET", options, ({ signal, headers }, cursor) => listEmailThreadMessages({
+	list(appId, query, options) {
+		const auth = this.auth(options);
+		return this.call("GET", options, ({ signal, headers }) => listRealtimeAppChannels({
 			client: this.client,
-			path: { thread_id: threadId },
-			query: {
-				...query,
-				starting_after: cursor ?? query?.starting_after
+			path: { realtime_app_id: appId },
+			query,
+			headers: {
+				...headers,
+				...auth
+			},
+			signal
+		}));
+	}
+	/**
+	* 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, channelName, query, options) {
+		const auth = this.auth(options);
+		return this.call("GET", options, ({ signal, headers }) => getRealtimeAppChannel({
+			client: this.client,
+			path: {
+				realtime_app_id: appId,
+				channel_name: channelName
+			},
+			query,
+			headers: {
+				...headers,
+				...auth
+			},
+			signal
+		}));
+	}
+	/**
+	* 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, channelName, options) {
+		const auth = this.auth(options);
+		return this.call("GET", options, ({ signal, headers }) => listRealtimeAppChannelMembers({
+			client: this.client,
+			path: {
+				realtime_app_id: appId,
+				channel_name: channelName
+			},
+			headers: {
+				...headers,
+				...auth
+			},
+			signal
+		}));
+	}
+};
+/** `bird.realtime.members` — acts on a member across all of its connections. */
+var RealtimeMembersResource = class 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, memberId, options) {
+		const auth = this.auth(options);
+		return this.call("POST", options, ({ signal, headers }) => disconnectRealtimeAppMember({
+			client: this.client,
+			path: {
+				realtime_app_id: appId,
+				member_id: memberId
+			},
+			headers: {
+				...headers,
+				...auth
+			},
+			signal
+		}));
+	}
+};
+/**
+* `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.*`.
+*/
+var RealtimeResource = class extends RealtimeBase {
+	/** Channel state — `bird.realtime.channels.list(...)`, `.get(...)`, `.members(...)`. */
+	channels;
+	/** Members — `bird.realtime.members.disconnect(...)`. */
+	members;
+	constructor(core, client, config) {
+		super(core, client, config);
+		this.channels = new RealtimeChannelsResource(core, client, config);
+		this.members = new RealtimeMembersResource(core, client, config);
+	}
+	/**
+	* 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, params, options) {
+		const auth = this.auth(options);
+		return this.call("POST", options, ({ signal, headers }) => publishRealtimeAppEvent({
+			client: this.client,
+			path: { realtime_app_id: appId },
+			body: params,
+			headers: {
+				...headers,
+				...auth
+			},
+			signal
+		}));
+	}
+	/**
+	* 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, params, options) {
+		const auth = this.auth(options);
+		return this.call("POST", options, ({ signal, headers }) => publishRealtimeAppBatch({
+			client: this.client,
+			path: { realtime_app_id: appId },
+			body: params,
+			headers: {
+				...headers,
+				...auth
 			},
-			headers,
 			signal
 		}));
 	}
@@ -4714,8 +4990,6 @@ var BirdClient = class {
 	smsTemplates;
 	/** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
 	whatsapp;
-	/** WhatsApp templates — `bird.whatsappTemplates.list(...)`. */
-	whatsappTemplates;
 	/** The Verify product — `bird.verify.verifications.create(...)`, `.check(...)`. */
 	verify;
 	/** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
@@ -4736,6 +5010,8 @@ var BirdClient = class {
 	mailboxThread;
 	/** Thread messages — `bird.mailboxThreadMessage.list(...)`, `.get(...)`, `.reply(...)`, `.body(...)`, … */
 	mailboxThreadMessage;
+	/** Realtime — `bird.realtime.publish(...)`, `.channels.list(...)`, `.members.disconnect(...)`, … */
+	realtime;
 	constructor(options) {
 		const opts = options;
 		this.#baseUrl = resolveBaseUrl(opts);
@@ -4743,9 +5019,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.12.1`,
+			"User-Agent": `bird-sdk-js/0.14.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.12.1"
+			"Bird-Version": "0.14.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -4762,7 +5038,6 @@ var BirdClient = class {
 		this.sms = new SmsResource(this.core, this.#client);
 		this.smsTemplates = new SmsTemplatesResource(this.core, this.#client);
 		this.whatsapp = new WhatsappResource(this.core, this.#client);
-		this.whatsappTemplates = new WhatsappTemplatesResource(this.core, this.#client);
 		this.verify = new VerifyResource(this.core, this.#client);
 		this.contacts = new ContactsResource(this.core, this.#client);
 		this.audiences = new AudiencesResource(this.core, this.#client);
@@ -4773,6 +5048,7 @@ var BirdClient = class {
 		this.mailboxReceiveRule = new MailboxReceiveRuleResource(this.core, this.#client);
 		this.mailboxThread = new MailboxThreadResource(this.core, this.#client);
 		this.mailboxThreadMessage = new MailboxThreadMessageResource(this.core, this.#client);
+		this.realtime = new RealtimeResource(this.core, this.#client, opts.realtime);
 	}
 	/**
 	* Escape hatch for endpoints the typed resources don't cover. Runs the full
@@ -4856,11 +5132,6 @@ const WebhookEventType = {
 	EmailScheduled: "email.scheduled",
 	EmailSuppressionCreated: "email_suppression.created",
 	EmailUnsubscribed: "email.unsubscribed",
-	RealtimeCacheChannels: "realtime.cache_channels",
-	RealtimeChannelExistence: "realtime.channel_existence",
-	RealtimeClientEvents: "realtime.client_events",
-	RealtimeConnectionCount: "realtime.connection_count",
-	RealtimePresence: "realtime.presence",
 	SmsAccepted: "sms.accepted",
 	SmsDelivered: "sms.delivered",
 	SmsExpired: "sms.expired",
@@ -4872,6 +5143,11 @@ const WebhookEventType = {
 	SmsTfnVerificationRejected: "sms.tfn_verification.rejected",
 	SmsTfnVerificationSubmitted: "sms.tfn_verification.submitted",
 	SmsUndelivered: "sms.undelivered",
+	VerifyAttemptDelivered: "verify.attempt.delivered",
+	VerifyAttemptSent: "verify.attempt.sent",
+	VerifyAttemptUndelivered: "verify.attempt.undelivered",
+	VerifyVerificationCreated: "verify.verification.created",
+	VerifyVerificationVerified: "verify.verification.verified",
 	VoiceCallAnswered: "voice_call.answered",
 	VoiceCallEnded: "voice_call.ended",
 	VoiceCallInitiated: "voice_call.initiated",