@messagebird/sdk 0.28.0 → 0.29.0

package/dist/index.d.mts

@@ -97,14 +97,34 @@ interface ErrorDetail {
   /** What is wrong with this field. */
   message: string;
 }
-/** One recovery step: an operation to call to resolve the error. */
-interface ErrorNextAction {
-  /** operationId of the follow-up operation that resolves this error. */
-  operation: string;
-  /** Short human-readable label for the recovery step. */
-  description?: string;
-  /** Permission scope the recovery operation requires, when it is scoped. */
-  scope?: string;
+/**
+ * One recovery step the server suggests. Read `kind` before `operation`: only an
+ * `operation` step carries one.
+ */
+interface NextAction {
+  /**
+   * What to do about this step: `operation` calls the operation named in
+   * `operation` and reads again, `external` acts somewhere this API does not
+   * reach, `wait` reads again later, `terminal` means nothing resolves this so
+   * stop retrying. A value this SDK version does not know is display-only: show
+   * `description` and offer no action.
+   */
+  kind: string;
+  /** Short human-readable label for the step, suitable for display. */
+  description: string;
+  /** operationId to call. Present only when `kind` is `operation`. */
+  operation?: string;
+  /**
+   * Parameters that address `operation`, by name — every parameter the call
+   * needs, so it can be made from this step alone. A request body, when the
+   * operation takes one, is described by the operation and never appears here.
+   */
+  params?: Record<string, string>;
+  /**
+   * A URL to open. Present only when `kind` is `external`, and only when the step
+   * has one; an external step with nothing to open is normal.
+   */
+  url?: string;
 }
 /** One verification requirement blocking the action, with the flow that resolves it. */
 interface UnmetGate {
@@ -137,8 +157,8 @@ interface BirdAPIErrorFields {
   vendorCode?: string;
   /** Human recovery line for this error, when a recovery is known. */
   remediation?: string;
-  /** Operations that resolve this error, in the order to try them. */
-  next?: ErrorNextAction[];
+  /** Recovery steps for this error, in the order to take them. */
+  next?: NextAction[];
   /** Verification requirements blocking this action, when it is blocked pending verification. */
   unmetGates?: UnmetGate[];
 }
@@ -153,7 +173,7 @@ declare class BirdAPIError extends BirdError {
   readonly param?: string;
   readonly vendorCode?: string;
   readonly remediation?: string;
-  readonly next?: ErrorNextAction[];
+  readonly next?: NextAction[];
   readonly unmetGates?: UnmetGate[];
   constructor(fields: BirdAPIErrorFields);
 }
@@ -786,7 +806,7 @@ type EventVerifyVerificationVerifiedData = EventVerifyBase & {
 /**
  * The channel a passcode is delivered over. Open enum — new channels may be added over time, so treat any unrecognized value as a future channel rather than an error.
  */
-type VerificationChannel$1 = "email" | "sms" | "whatsapp" | (string & {});
+type VerificationChannel$1 = "email" | "sms" | "whatsapp" | "telegram" | (string & {});
 /**
  * The recipient to verify. Provide an `email`, a `phone_number`, or both; at least one is required. The addresses also identify the verification: a check must supply exactly the set used on the create call, so a verification created with both addresses is not found by either one alone.
  *
@@ -962,11 +982,11 @@ type EventVerifyAttemptDeliveredData = EventVerifyBase & {
    */
   address: string;
   /**
-   * Carrier that delivered the message, when the carrier network reports it. Always null for email and WhatsApp.
+   * Carrier that delivered the message, when the carrier network reports it. Always null for email, WhatsApp, and Telegram.
    */
   carrier: string | null;
   /**
-   * Mobile country code and mobile network code of the delivering carrier, when reported. Always null for email and WhatsApp.
+   * Mobile country code and mobile network code of the delivering carrier, when reported. Always null for email, WhatsApp, and Telegram.
    */
   mcc_mnc: string | null;
   /**
@@ -4426,17 +4446,18 @@ type WhatsAppEventList = {
    */
   data: Array<WhatsAppEvent>;
 };
+/**
+ * Type of an event in a WhatsApp message's delivery timeline. `whatsapp.accepted`: Bird accepted the request. `whatsapp.sent`: handed to the WhatsApp network. `whatsapp.delivered`: delivery confirmed to the recipient's device. `whatsapp.read`: the recipient opened the message (this does not change the message `status`, which never becomes `read`). `whatsapp.failed`: terminal permanent failure. `whatsapp.rejected`: Bird refused the message before sending it, so it was never charged. `whatsapp.received`: an inbound message arrived from the contact. Open enum, new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
+ *
+ */
+type WhatsAppEventType$1 = "whatsapp.accepted" | "whatsapp.delivered" | "whatsapp.failed" | "whatsapp.read" | "whatsapp.rejected" | "whatsapp.sent" | (string & {});
 type WhatsAppEventId = string;
 type WhatsAppEvent = {
   /**
    * ID of the event (`ev_`-prefixed), unique within the message's timeline.
    */
   readonly id: WhatsAppEventId;
-  /**
-   * Lifecycle event type. `whatsapp.accepted`: Bird accepted the request. `whatsapp.sent`: handed to the WhatsApp network. `whatsapp.delivered`: delivery confirmed to the recipient's device. `whatsapp.read`: the recipient opened the message (this does not change the message `status`, which never becomes `read`). `whatsapp.failed`: terminal permanent failure. `whatsapp.rejected`: Bird refused the message before sending it, so it was never charged. `whatsapp.received`: an inbound message arrived from the contact. Open enum: new event types may be added over time, so treat any unrecognized value as a future event rather than an error.
-   *
-   */
-  readonly type: string;
+  readonly type: WhatsAppEventType$1;
   /**
    * When this event occurred.
    */
@@ -4556,11 +4577,11 @@ type WhatsAppTemplateSend = unknown & {
    */
   id?: WhatsAppTemplateId;
   /**
-   * The template to send, by its slug (for example `bird_otp`).
+   * The template to send, by its slug handle (for example `bird_otp`).
    */
   slug?: TemplateSlug;
   /**
-   * Which of the template's languages to send, as a BCP-47 tag (for example `en` or `pt-BR`). Meta's underscore form (`pt_BR`) is accepted and normalized; the accepted message echoes the canonical BCP-47 form. May be omitted, in which case the template's default language is sent. A language the template is not stocked in returns a `422` that names the available tags.
+   * Which of the template's languages to send, as a BCP-47 tag (for example `en` or `pt-BR`); Meta's underscore form (`pt_BR`) is accepted and normalized. 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. The accepted message echoes the canonical BCP-47 form of the language it resolved to.
    *
    */
   language?: LanguageTag;
@@ -5040,7 +5061,7 @@ type LookupNetworkInfo = {
 type CountryCode = string;
 type PhoneNumberLookupRequest = {
   /**
-   * The phone number to look up, in E.164 format, which is a leading `+`, the country calling code, then the national number.
+   * The phone number to look up, in international format: the country calling code, then the national number. The leading `+` is optional, and `00` works in its place, so `+31612345678`, `31612345678` and `0031612345678` are all the same number. A number written for dialling inside one country, with no country code, is rejected rather than guessed at.
    */
   phone_number: string;
   /**
@@ -5072,21 +5093,56 @@ type SmsTemplateList = {
 };
 type SmsTemplateVersionId = string;
 /**
- * One variable a template's content uses, filled in from the values you give when you send. Templates on every channel report their variables this way, so this reads the same whether you are looking at an SMS template or an email one.
+ * What a send or a preview does when it asks for a language the template
+ * cannot serve.
+ *
+ * `fallback` serves the closest match instead. It tries a broader form of the
+ * same language first, so a request for `pt-BR` can be served by a stocked
+ * `pt`, and then the template's default language. A send never fails because a
+ * language is missing.
+ *
+ * `fail` rejects the send rather than serving a different language, for content
+ * where sending the wrong language is worse than not sending at all. It matches
+ * the requested tag or a broader form of it and refuses a sibling variant, so
+ * `pt-BR` is never served by `pt-PT`. A send that names no language still uses
+ * the default language.
+ *
+ * The default is per channel and stated on each channel's own field, because
+ * what a wrong-language send costs differs: where every language is separately
+ * reviewed and separately priced, falling back silently would send content the
+ * recipient did not expect at a rate the sender did not choose.
+ *
+ */
+type TemplateOnMissingLanguage = "fallback" | "fail";
+/**
+ * Where one language of a template stands, on a channel whose content Bird publishes directly. `live` is what sends serve today. `draft` is a language the draft carries that has never been published. `superseded` is a language a later version replaced. Open enum: treat an unrecognised value as not sendable.
+ *
+ */
+type TemplateLanguageStatus$1 = "draft" | "live" | "superseded" | (string & {});
+/**
+ * One language's state on a template: whether it is live for sends. Content is not here; the template carries the body of its default language, and a send resolves the rest.
+ *
+ */
+type SmsTemplateLanguageState = {
+  status: TemplateLanguageStatus$1;
+};
+/**
+ * A single variable slot a template fills in from the values supplied when sending. The same shape on email, SMS and WhatsApp, so reading what a template needs works the same way whichever channel you are sending on.
  *
  */
 type TemplateVariable = {
   /**
-   * The variable's name, the key you use for it in `parameters` when you send.
+   * The key this slot is filled by. On email and SMS it is the key you set in the send's `parameters` object. On WhatsApp it is the `name` you repeat on the matching parameter inside `components`, or, for a template whose placeholders are positional, the position itself as `1`, `2` and so on.
+   *
    */
   readonly key: string;
   /**
-   * The value type this variable accepts. We can add new types to this list over time, so treat a value you do not recognize as a new type rather than as an error. SMS templates use the typed values, such as `code` and `amount`. Email templates only use `text`.
+   * The value type this slot accepts. SMS templates use the typed slots (`code`, `amount` and the rest), each of which rejects a value that does not match its `constraint`. Email and WhatsApp templates use `text`, which accepts any value. Open enum: treat an unrecognized value as a future type rather than an error.
    *
    */
   readonly type: string;
   /**
-   * Whether a value has to be supplied when sending. A send that leaves a required variable unset is rejected.
+   * Whether the slot must be supplied when sending. On SMS and WhatsApp a missing required value is rejected with a `422`. On email it is advisory: a missing value renders as empty rather than rejecting the send.
    *
    */
   readonly required: boolean;
@@ -5095,7 +5151,7 @@ type TemplateVariable = {
    */
   readonly constraint: string;
   /**
-   * Whether this variable's value gets redacted before it is stored. When it does, the rendered value never appears in message content you read back through the API: a placeholder is stored in its place instead.
+   * Whether this slot's value is kept out of durable storage. A sensitive slot's rendered value never appears in message content read back through the API: a stand-in placeholder is stored instead.
    *
    */
   readonly sensitive?: boolean;
@@ -5104,70 +5160,135 @@ type TemplateVariable = {
  * Content classification. Tells Bird and carriers why you're sending; per-country compliance rules (opt-out policy, quiet hours) key on it as they roll out.
  */
 type SmsMessageCategory = "transactional" | "marketing" | "authentication" | "service";
+/**
+ * Where the template stands as a whole. The same five states on every channel.
+ *
+ * - `draft`: nothing has ever gone live.
+ * - `pending`: nothing is live and at least one language is in review.
+ * - `active`: at least one language is live, so something can be sent.
+ * - `rejected`: it was reviewed and every language was refused.
+ * - `inactive`: nothing is live and nothing is in review, so content was withdrawn or was blocked before anything went live.
+ *
+ * This is a summary. It answers whether the template is usable at all, not
+ * whether every language is: a template with one language live is `active` even
+ * while another is still drafted or refused. Read `languages` for per-language
+ * state, which is what says which language is where and why.
+ *
+ * Which of the five a template can reach follows its channel's review model. A
+ * channel whose content a third party reviews reaches all five; one whose
+ * content goes live on publish moves between `draft`, `active` and `inactive`.
+ *
+ * Open enum: treat a value you do not recognize as a new one rather than as
+ * an error.
+ *
+ */
+type TemplateStatus$1 = "draft" | "pending" | "active" | "rejected" | "inactive" | (string & {});
 /**
  * Whether the template is one of our built-in templates (`system`) or one your workspace created (`workspace`).
  */
 type TemplateScope = "system" | "workspace";
+type SmsTemplateId = string;
 /**
- * A template's name: the stable handle you send it by, used in place of the template id. It can contain lowercase letters, numbers, hyphens, and underscores, has to start and end with a letter or a number, and can be up to 63 characters long.
+ * A message template: one identity holding a copy of the message per language, resolved to one at send. It declares the variable slots a send fills in, so the parts that change travel with the request and the wording does not.
  *
  */
-type TemplateName = string;
-type SmsTemplateId = string;
 type SmsTemplate = {
   /**
    * Unique identifier for the template.
    */
   readonly id: SmsTemplateId;
   /**
-   * The template's stable handle. Pass it (or the id) as the template reference when sending.
+   * The template's permanent handle. Pass it (or the id) as the template reference when sending. Handles beginning with `bird_` are reserved for Bird's built-in templates.
+   *
+   */
+  readonly slug: TemplateSlug;
+  /**
+   * The template's display name, shown wherever the template is listed. Nothing resolves through it, so it is safe to show wherever a human reads the template.
+   *
    */
-  readonly name: TemplateName;
+  readonly name: string;
   /**
-   * Human-readable description of what the template is for.
+   * What the template is for. Null when unset.
    */
-  readonly description: string;
+  readonly description: string | null;
   scope: TemplateScope;
+  status: TemplateStatus$1;
   /**
    * Content classification applied to messages sent from this template.
    */
   readonly category: SmsMessageCategory;
   /**
-   * The template body in its default language, shown for preview. Variable placeholders appear inline (for example `{{ code }}`).
+   * The template body in its default language, shown for preview. Variable placeholders appear inline (for example `{{ code }}`). Name a `language` on the send to have another one served.
    *
    */
   readonly body: string;
   /**
-   * The typed slots this template fills in from the values you supply when sending.
+   * The typed slots this template fills in from the values you supply in `parameters` when sending. Every language of a template declares the same slots, so this list holds for whichever one a send resolves to.
+   *
    */
   readonly variables: Array<TemplateVariable>;
   /**
-   * The languages this template is available in, as BCP-47 tags.
+   * The language a send uses when it names none, and the last resort when `on_missing_language` is `fallback` and the language asked for is not available.
+   *
+   */
+  readonly default_language: LanguageTag;
+  /**
+   * The languages a send can resolve right now, as BCP-47 tags. The set may shrink for reasons other than editing, so read it rather than assuming it matches what you last saw.
+   *
+   */
+  readonly available_languages: Array<LanguageTag>;
+  /**
+   * Where each of the template's languages stands, keyed by BCP-47 language tag. Content is not here: `body` previews the default language, and a send resolves the one it needs.
+   *
+   */
+  readonly languages: {
+    [key: string]: SmsTemplateLanguageState;
+  };
+  /**
+   * What a send does when it asks for a language this template does not carry. Defaults to `fallback` on SMS.
+   *
    */
-  readonly available_languages: Array<string>;
+  readonly on_missing_language: TemplateOnMissingLanguage;
   /**
-   * The template's lifecycle state. `active` means the template can be sent; every built-in Bird template is `active`. `draft` (being edited), `pending` (submitted for review), `approved` (passed review), and `rejected` (failed review) describe a workspace-authored template's authoring lifecycle; workspace-authored SMS templates are not available yet, so today every template is `active`.
+   * Whether a send has to name a language. When true, a send that names none is rejected instead of being served the default language.
    *
    */
-  readonly status: "active" | "draft" | "pending" | "approved" | "rejected";
+  readonly language_source_required: boolean;
   /**
-   * The current editable draft version. Always null today: SMS templates are not yet versioned; present for parity with email templates.
+   * The current editable draft version, or null for a built-in `system` template, which has no draft.
+   *
    */
   readonly draft_version_id: SmsTemplateVersionId | null;
   /**
-   * The currently published version, or null if the template has never been published. Always null today: SMS templates are not yet versioned; present for parity with email templates.
+   * The version a send resolves to, or null for a built-in `system` template, which Bird ships ready to send rather than versioning.
+   *
    */
-  readonly published_version_id?: SmsTemplateVersionId | null;
+  readonly live_version_id: SmsTemplateVersionId | null;
   /**
-   * The draft's revision counter. Always null today: SMS templates are not yet versioned; present for parity with email templates.
+   * Deprecated: use `live_version_id` instead, which carries the same value.
+   *
+   *
+   * @deprecated
+   */
+  readonly published_version_id: SmsTemplateVersionId | null;
+  /**
+   * The draft's revision counter. Null for a built-in `system` template, which is unversioned.
+   *
    */
   readonly revision: number | null;
   /**
-   * When the template was created. Null for built-in templates.
+   * When this template was last submitted. Null for a built-in `system` template: Bird ships it ready to send, so there is nothing submitted to date.
+   *
+   */
+  readonly last_submitted_at: string | null;
+  /**
+   * When the template was created. Null for a built-in `system` template, which Bird ships rather than stores.
+   *
    */
   readonly created_at: string | null;
   /**
-   * When the template was last updated. Null for built-in templates.
+   * When the template was last modified. Null for a built-in `system` template, which Bird ships rather than stores.
+   *
    */
   readonly updated_at: string | null;
 };
@@ -5299,12 +5420,19 @@ type SmsTemplateSend = unknown & {
    */
   id?: SmsTemplateId;
   /**
-   * The template to send, by its name handle (for example `bird_otp_verification`). Browse the available templates and their variables with the templates endpoint.
+   * The template to send, by its slug handle (for example `bird_otp_verification`). Browse the available templates and their variables with the templates endpoint.
    *
    */
-  name?: TemplateName;
+  slug?: TemplateSlug;
   /**
-   * Which of the template's localized bodies to send, as a BCP-47 tag. Falls back to the closest available language, then English, when the exact tag is not stocked. Omit for English.
+   * Deprecated: use `slug` instead. Resolved as a slug first, and only if that finds nothing, matched against the template's display name.
+   *
+   *
+   * @deprecated
+   */
+  name?: string;
+  /**
+   * 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;
@@ -5341,7 +5469,8 @@ type SmsSendOptions = {
 };
 type SmsMessageSendRequest = unknown & {
   /**
-   * Recipient phone number in E.164 format (for example `+15551234567`). One recipient per message.
+   * Recipient phone number in E.164 format (for example `+14155550100`). One recipient per message. The number is stored and returned in canonical E.164; a recipient that cannot be routed returns a `422` `SMSInvalidRecipient`.
+   *
    */
   to: string;
   /**
@@ -6467,9 +6596,9 @@ type ListContactsData = {
      */
     email?: string;
     /**
-     * Return the contact with exactly this phone number in international E.164 form. Encode the leading plus sign as `%2B` (an unencoded `+` arrives as a space and is rejected). Phone numbers are unique within a workspace, so this matches at most one contact. Non-canonical forms of the same number match the contact they canonicalize to; a value that is not a phone number shape, or an empty value, is a validation error, never an unfiltered page.
+     * Return the contacts with exactly this phone number in international E.164 form. Repeat the parameter to match any of up to 50 numbers, and set `limit` to at least the number of values you pass: `limit` defaults to 25, and a page cut short by it looks exactly like numbers that matched nothing. Different identifier parameters still combine with AND, so `phone_number=a&phone_number=b&email=c` asks for a contact whose phone number is `a` or `b` and whose email is `c`. Encode the leading plus sign as `%2B` (an unencoded `+` arrives as a space and is rejected). Phone numbers are unique within a workspace, so each value matches at most one contact. Non-canonical forms of the same number match the contact they canonicalize to; a value that is not a phone number shape, or an empty value, is a validation error, never an unfiltered page.
      */
-    phone_number?: string;
+    phone_number?: Array<string>;
     /**
      * Return the contact with exactly this external_id (your own identifier for the contact). Unique within a workspace, so this matches at most one contact. An empty value is a validation error, never an unfiltered page.
      */
@@ -6857,7 +6986,7 @@ type ListSmsTemplatesData = {
   path?: never;
   query?: {
     /**
-     * Keep only templates of this scope: `system` for Bird's built-in templates, `workspace` for templates authored in your workspace. Omit for all. Workspace-authored SMS templates are not available yet, so `workspace` currently matches nothing.
+     * Keep only templates of this scope: `system` for Bird's built-in templates, `workspace` for templates authored in your workspace. Omit for all.
      *
      */
     scope?: TemplateScope;
@@ -6869,7 +6998,7 @@ type ListSmsTemplatesData = {
      * Keep only templates available in this language, as a BCP-47 tag. Matches the template's `available_languages` entries exactly, with no fallback.
      *
      */
-    language?: string;
+    language?: LanguageTag;
   };
   url: "/v1/sms/templates";
 };
@@ -7069,7 +7198,7 @@ type ListWhatsAppMessageEventsData = {
      * Keep only events of this exact type (for example `whatsapp.delivered` or `whatsapp.failed`). Omit for the full timeline.
      *
      */
-    type?: string;
+    type?: WhatsAppEventType$1;
   };
   url: "/v1/whatsapp/messages/{message_id}/events";
 };
@@ -8196,12 +8325,12 @@ type ListVoiceCallsData = {
      */
     sip_trunk_id?: SipTrunkId;
     /**
-     * Return only calls placed from this calling party number, matched as a whole number rather than as a fragment. Give it in international form: `+14155551234`, `14155551234`, and `0014155551234` all select the same calls, because a call record keeps the number exactly as the calling equipment presented it. A number given without a country code matches only calls recorded in that same form, since it names a different number in every country. Use `number` instead to match part of a number, or either side of the call.
+     * Return only calls placed from this calling party number, matched as a whole number rather than as a fragment. Give it in international form: `+14155551234`, `14155551234`, and `0014155551234` all select the same calls. A number given without a country code is read as an international one, so give the country code to be sure of what you are matching. Use `number` instead to match part of a number, or either side of the call.
      *
      */
     from?: string;
     /**
-     * Return only calls placed to this called party number, matched as a whole number rather than as a fragment. Give it in international form: `+16505559876`, `16505559876`, and `0016505559876` all select the same calls, because a call record keeps the number exactly as the calling equipment presented it. A number given without a country code matches only calls recorded in that same form, since it names a different number in every country. Use `number` instead to match part of a number, or either side of the call.
+     * Return only calls placed to this called party number, matched as a whole number rather than as a fragment. Give it in international form: `+16505559876`, `16505559876`, and `0016505559876` all select the same calls. A number given without a country code is read as an international one, so give the country code to be sure of what you are matching. Use `number` instead to match part of a number, or either side of the call.
      *
      */
     to?: string;
@@ -9078,6 +9207,29 @@ declare class EmailResource<D extends EmailChannelDefaults | undefined = undefin
    * });
    * console.log(msg.id, msg.status); // "em_…", "accepted"
    *
+   * @example Send a published template instead of inline content
+   * const msg = await bird.email.send({
+   *   from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *   to: ["delivered@messagebird.dev"],
+   *   category: "transactional",
+   *   template: {
+   *     slug: "welcome-email",
+   *     parameters: { first_name: "Jane" },
+   *   },
+   * });
+   * console.log(msg.id, msg.status);
+   *
+   * @example Sending to the sandbox bounce address, which hard-bounces every time
+   * const msg = await bird.email.send({
+   *   from: { email: "onboarding@messagebird.dev", name: "Bird" },
+   *   to: ["bounce+signup-flow@messagebird.dev"],
+   *   subject: "Sandbox bounce test",
+   *   html: "<p>This message will hard-bounce.</p>",
+   *   tags: [{ name: "flow", value: "signup" }],
+   *   metadata: { test_run: "docs-capture-1" },
+   * });
+   * console.log(msg.id, msg.status); // "em_…", "accepted"
+   *
    * @example A richer send — cc/bcc, reply-to, tags, metadata, click-tracking off, and an idempotency key (safe to retry; the server dedupes)
    * await bird.email.send(
    *   {
@@ -9357,7 +9509,7 @@ type ContactUpdateParams = NonNullable<UpdateContactData["body"]>;
 type ContactBatchParams = NonNullable<CreateContactBatchData["body"]>;
 declare class ContactsResource extends Resource {
   /**
-   * List the workspace's contacts as a cursor page, newest first. Look one up by exact email, phone_number, or external_id, or search by email, name, or phone substring. Pass include_total for a total count.
+   * List the workspace's contacts as a cursor page, newest first. Look one up by exact email, phone_number, or external_id, repeating phone_number to resolve up to 50 numbers in one call (raise limit to match), or search by email, name, or phone substring. Pass include_total for a total count.
    *
    * @example Iterate every contact, or take one page
    * for await (const contact of bird.contacts.list({ q: "acme.com" })) {
@@ -9449,7 +9601,7 @@ type SmsSendBatchResult = SmsMessageBatchResponse;
 declare class SmsResource extends SmsResourceBase {
   /**
    * Send one SMS to a single recipient. Supply either `text` (with a `category`)
-   * or a stored `template` (by `id` or `name`, with its `parameters`). The
+   * or a stored `template` (by `id` or `slug`, with its `parameters`). The
    * result is `accepted`, not yet delivered — read it back with `get` to confirm.
    *
    * @example Send free text
@@ -9464,7 +9616,7 @@ declare class SmsResource extends SmsResourceBase {
    * @example Send by template
    * await bird.sms.send({
    *   to: "+14155550100",
-   *   template: { name: "bird_otp_verification", parameters: { code: "123456" } },
+   *   template: { slug: "bird_otp_verification", parameters: { code: "123456" } },
    * });
    */
   send(params: SmsSendParams, options?: RequestOptions): APIPromise<SmsMessage>;
@@ -9489,13 +9641,13 @@ declare class SmsTemplatesResource extends Resource {
    *
    * @example List the built-in templates
    * const { data } = await bird.smsTemplates.list({ scope: "system" });
-   * for (const tpl of data) console.log(tpl.id, tpl.name);
+   * for (const tpl of data) console.log(tpl.id, tpl.slug);
    */
   list(query?: SmsTemplateListQuery, options?: RequestOptions): APIPromise<SmsTemplateList>;
   /**
-   * 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.
+   * Get one SMS template by its slug 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 Read one template by name or id
+   * @example Read one template by slug or id
    * const tpl = await bird.smsTemplates.get("bird_otp_verification");
    * console.log(tpl.body, tpl.variables);
    */
@@ -9548,9 +9700,7 @@ declare class WhatsappResource extends WhatsappResourceBase {
    *   to: "+15551234567",
    *   template: {
    *     slug: "bird_otp",
-   *     components: [
-   *       { type: "body", parameters: [{ type: "text", text: "123456" }] },
-   *     ],
+   *     components: [{ type: "body", parameters: [{ type: "text", text: "123456" }] }],
    *   },
    * });
    * console.log(msg.id, msg.status);
@@ -9587,7 +9737,7 @@ type VerifyVerificationsCheckParams = NonNullable<CreateVerificationCheckData["b
 type VerifyVerificationsNextChannelParams = NonNullable<CreateVerificationNextChannelData["body"]>;
 declare class VerifyVerificationsResource extends Resource {
   /**
-   * Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over the phone channels enabled for its destination country; an email address over email; or both). It is sent over one channel at a time and fails over to the next in the plan, never over two 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.
+   * Start a verification: generate a one-time passcode and send it to the recipient in `to` (a phone number over the phone channels enabled for its destination country; an email address over email; or both). It is sent over one channel at a time and fails over to the next in the plan, never over two 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, WhatsApp and Telegram delivery all draw on the workspace's balance.
    *
    * @example Start a verification over SMS
    * const verification = await bird.verify.verifications.create({
@@ -10092,6 +10242,32 @@ declare const SMSErrorCode: {
 };
 /** A known SMSErrorCode value. */
 type SMSErrorCodeValue = (typeof SMSErrorCode)[keyof typeof SMSErrorCode];
+/**
+ * Values of TemplateLanguageStatus known at this SDK version. The wire value is an open
+ * string: a value added by a newer server deserializes unchanged, so switch on
+ * these with a `default` branch rather than treating the set as closed.
+ */
+declare const TemplateLanguageStatus: {
+  readonly Draft: "draft";
+  readonly Live: "live";
+  readonly Superseded: "superseded";
+};
+/** A known TemplateLanguageStatus value. */
+type TemplateLanguageStatusValue = (typeof TemplateLanguageStatus)[keyof typeof TemplateLanguageStatus];
+/**
+ * Values of TemplateStatus known at this SDK version. The wire value is an open
+ * string: a value added by a newer server deserializes unchanged, so switch on
+ * these with a `default` branch rather than treating the set as closed.
+ */
+declare const TemplateStatus: {
+  readonly Active: "active";
+  readonly Draft: "draft";
+  readonly Inactive: "inactive";
+  readonly Pending: "pending";
+  readonly Rejected: "rejected";
+};
+/** A known TemplateStatus value. */
+type TemplateStatusValue = (typeof TemplateStatus)[keyof typeof TemplateStatus];
 /**
  * Values of VerificationAttemptFailureReason known at this SDK version. The wire value is an open
  * string: a value added by a newer server deserializes unchanged, so switch on
@@ -10116,6 +10292,7 @@ type VerificationAttemptFailureReasonValue = (typeof VerificationAttemptFailureR
 declare const VerificationChannel: {
   readonly Email: "email";
   readonly Sms: "sms";
+  readonly Telegram: "telegram";
   readonly Whatsapp: "whatsapp";
 };
 /** A known VerificationChannel value. */
@@ -10147,6 +10324,21 @@ declare const WhatsAppErrorCode: {
 };
 /** A known WhatsAppErrorCode value. */
 type WhatsAppErrorCodeValue = (typeof WhatsAppErrorCode)[keyof typeof WhatsAppErrorCode];
+/**
+ * Values of WhatsAppEventType known at this SDK version. The wire value is an open
+ * string: a value added by a newer server deserializes unchanged, so switch on
+ * these with a `default` branch rather than treating the set as closed.
+ */
+declare const WhatsAppEventType: {
+  readonly WhatsappAccepted: "whatsapp.accepted";
+  readonly WhatsappDelivered: "whatsapp.delivered";
+  readonly WhatsappFailed: "whatsapp.failed";
+  readonly WhatsappRead: "whatsapp.read";
+  readonly WhatsappRejected: "whatsapp.rejected";
+  readonly WhatsappSent: "whatsapp.sent";
+};
+/** A known WhatsAppEventType value. */
+type WhatsAppEventTypeValue = (typeof WhatsAppEventType)[keyof typeof WhatsAppEventType];
 /**
  * Values of WhatsAppTemplateCategory known at this SDK version. The wire value is an open
  * string: a value added by a newer server deserializes unchanged, so switch on
@@ -10175,5 +10367,5 @@ declare const WhatsAppTemplateParameterType: {
 /** A known WhatsAppTemplateParameterType value. */
 type WhatsAppTemplateParameterTypeValue = (typeof WhatsAppTemplateParameterType)[keyof typeof WhatsAppTemplateParameterType];
 //#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, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, 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 LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type PaginatedPromise, type PhoneNumberLookup, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, type SafeResult, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, type UnmetGate, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, 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, EmailEventType, type EmailEventTypeValue, type EmailListQuery, type EmailLookup, EmailLookupFlag, type EmailLookupFlagValue, EmailLookupReason, type EmailLookupReasonValue, EmailLookupResult, type EmailLookupResultValue, 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 LookupEmailParams, LookupFlag, type LookupFlagValue, type LookupPhoneNumberParams, LookupPropertyStatus, type LookupPropertyStatusValue, type Mailbox, type MailboxStatsResponse, type NextAction, type PaginatedPromise, type PhoneNumberLookup, type RealtimeBatchPublishResult, type RealtimeChannelGetQuery, type RealtimeChannelInclude, type RealtimeChannelInfo, type RealtimeChannelListItem, type RealtimeChannelListQuery, type RealtimeChannelMember, type RealtimeChannelMembers, type RealtimeChannelsList, type RealtimeOptions, type RealtimePublishBatchParams, type RealtimePublishParams, type RealtimePublishResult, type ReceiveRule, type RequestOptions, SMSErrorCode, type SMSErrorCodeValue, type SafeResult, type SmsListQuery, type SmsMessage, type SmsSendBatchParams, type SmsSendBatchResult, type SmsSendParams, type SmsTemplate, type SmsTemplateList, type SmsTemplateListQuery, TemplateLanguageStatus, type TemplateLanguageStatusValue, TemplateStatus, type TemplateStatusValue, type UnmetGate, type Verification, VerificationAttemptFailureReason, type VerificationAttemptFailureReasonValue, VerificationChannel, type VerificationChannelValue, type VerificationCheckResult, VerificationTerminalReason, type VerificationTerminalReasonValue, type VerifyVerificationsCheckParams, type VerifyVerificationsCreateParams, type VerifyVerificationsNextChannelParams, WebhookEventType, type WebhookEventTypeValue, type WebhookHeaders, type WebhookOptions, WhatsAppErrorCode, type WhatsAppErrorCodeValue, type WhatsAppEventList, WhatsAppEventType, type WhatsAppEventTypeValue, type WhatsAppMessage, WhatsAppTemplateCategory, type WhatsAppTemplateCategoryValue, WhatsAppTemplateParameterType, type WhatsAppTemplateParameterTypeValue, type WhatsappListEventsQuery, type WhatsappListQuery, type WhatsappSendParams, baseUrlForRegion, regionFromApiKey };
 //# sourceMappingURL=index.d.mts.map