@messagebird/sdk 0.22.0 → 0.24.0

package/README.md

@@ -1,6 +1,6 @@
 # @messagebird/sdk
 
-The official TypeScript SDK for the [Bird](https://bird.com) API — fully typed, edge-ready, ESM.
+The official TypeScript SDK for the [Bird](https://bird.com) API: email, SMS, WhatsApp, verification, and Realtime, over one typed client. Fully typed, edge-ready, ESM.
 
 📚 **Documentation:** https://bird.com/docs/sdks/typescript
 

package/dist/index.d.mts

@@ -292,6 +292,176 @@ interface PaginatedPromise<T> extends Promise<CursorPage<T>>, AsyncIterable<T> {
 }
 //#endregion
 //#region src/generated/types.gen.d.ts
+/**
+ * ISO 4217 three-letter currency code.
+ */
+type CurrencyCode = string;
+type Money = {
+  /**
+   * Decimal amount as a string, in major currency units.
+   */
+  amount: string;
+  /**
+   * ISO 4217 currency code.
+   */
+  currency_code: CurrencyCode;
+};
+type VoiceMediaQuality = {
+  /**
+   * Mean opinion score, the single number for how the call sounded, from 1 (unintelligible) to 5 (as good as being in the same room). Anything at or above 4.0 is what most people would call a clear line, and below 3.5 is where callers start asking each other to repeat themselves. The three other fields are the impairments that move it.
+   *
+   */
+  readonly mos: number;
+  /**
+   * Variation in the arrival time of the audio packets, in milliseconds. Audio arriving unevenly is heard as choppiness even when no packets are lost at all.
+   */
+  readonly jitter_ms: number;
+  /**
+   * Percentage of audio packets that never arrived. Heard as brief gaps or clipped words, and the impairment that degrades a call fastest.
+   */
+  readonly packet_loss_pct: number;
+  /**
+   * Round-trip time between the two ends, in milliseconds. It does not distort the audio, but above roughly 300 ms the two parties start talking over each other.
+   */
+  readonly round_trip_time_ms: number;
+};
+/**
+ * Why Bird refused the call before dialing a carrier. Every refusal is signalled
+ * to your PBX as `503`, so `sip_response_code` alone cannot tell these causes
+ * apart. This field is where the cause lives.
+ *
+ * Most of them you can fix yourself:
+ *
+ * - `source_not_allowed`: the call came from an IP address that is not in the
+ * trunk's allowed-address list. Add the address your PBX sends from.
+ * - `caller_id_not_verified`: the number in the `From` header is not a verified
+ * caller ID for this workspace. Verify it, or present a number you have
+ * already verified.
+ * - `destination_not_enabled`: you have not turned on calling to this
+ * destination country. Enable it in your voice destination settings.
+ * - `insufficient_balance`: your wallet did not cover the call. Top up, or turn
+ * on automatic top-ups.
+ * - `daily_spend_exceeded`: the call would have passed your organization's daily
+ * voice spend limit. The limit resets at the start of the next UTC day.
+ * - `concurrent_calls_exceeded`: you already have as many calls in progress as
+ * your account allows. Wait for one to end, or ask support to raise the limit.
+ * - `calls_per_second_exceeded`: you placed calls faster than your account
+ * allows. Slow the rate you dial at, then retry.
+ *
+ * The rest need Bird to act, so contact support and quote the call `id`:
+ *
+ * - `routing_not_configured`: no dial plan is attached to this trunk yet.
+ * Expected on a trunk that was just created.
+ * - `no_route_found`: a dial plan is attached, but no rule in it covers this
+ * destination.
+ * - `destination_blocked`: the destination is blocked by Bird's routing
+ * configuration.
+ * - `call_not_permitted`: the call could not be priced for your account.
+ *
+ */
+type VoiceCallRejectionReason = "source_not_allowed" | "caller_id_not_verified" | "routing_not_configured" | "no_route_found" | "destination_blocked" | "destination_not_enabled" | "insufficient_balance" | "daily_spend_exceeded" | "concurrent_calls_exceeded" | "calls_per_second_exceeded" | "call_not_permitted";
+/**
+ * Call status.
+ *
+ * A call that has ended carries answered, no_answer, failed, rejected, or unknown. A call that is still up carries ringing before it is picked up and in_progress once it is; both are what the `status` filter on the call list selects on to show calls happening right now.
+ *
+ * busy and canceled are declared ahead of the feature that produces them, so their arrival is not a breaking contract change: they come with inbound termination, and today both outcomes are folded into failed.
+ *
+ */
+type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
+type SipTrunkId = string;
+type AuditLogActor = {
+  /**
+   * Actor identifier.
+   */
+  id: string;
+  /**
+   * Actor type (e.g. user, api_key, system).
+   */
+  type: string;
+  /**
+   * Display name of the actor — the user's email address for user actors, or the API key's name for API-key actors. Absent when it could not be resolved.
+   *
+   */
+  readonly display_name?: string | null;
+};
+/**
+ * Whether the call originated from your PBX (outbound) or arrived from a remote party (inbound).
+ */
+type VoiceCallDirection = "inbound" | "outbound";
+type WorkspaceId = string;
+type VoiceSessionId = string;
+type VoiceCallId = string;
+type VoiceCall = {
+  /**
+   * Unique identifier for this call record.
+   */
+  readonly id: VoiceCallId;
+  /**
+   * Session identifier shared across all legs of a multi-party or transferred call. Use this to correlate related call records. Null when session correlation is not available for the call.
+   */
+  readonly session_id?: VoiceSessionId | null;
+  readonly workspace_id: WorkspaceId;
+  readonly direction: VoiceCallDirection;
+  /**
+   * Calling party number in E.164 format.
+   */
+  readonly from: string;
+  /**
+   * Called party number in E.164 format.
+   */
+  readonly to: string;
+  /**
+   * Who placed the call. Either the API key whose credentials it used, or the user who placed it from a browser or the Bird CLI. Absent when the call was admitted by its source IP address alone, since no credential identifies a caller there, and for calls placed before Bird started recording this.
+   */
+  readonly actor?: AuditLogActor;
+  /**
+   * Identifier of the SIP trunk that originated this call. Null when no trunk is associated.
+   */
+  readonly sip_trunk_id?: SipTrunkId | null;
+  readonly status: VoiceCallStatus;
+  /**
+   * Final SIP response code received from the carrier. Null when no SIP response was received, for example on timeout or DNS failure.
+   */
+  readonly sip_response_code?: number | null;
+  /**
+   * Why Bird refused the call before dialing a carrier. Absent when Bird did not refuse it, meaning the call either connected or it failed at the carrier, where `sip_response_code` is the whole story.
+   */
+  readonly rejection_reason?: VoiceCallRejectionReason;
+  /**
+   * When the call was initiated.
+   */
+  readonly started_at: string;
+  /**
+   * When the call was answered (200 OK received). Null for unanswered calls.
+   */
+  readonly answered_at?: string | null;
+  /**
+   * When the call ended (BYE or final non-2xx response). Null for calls that ended abnormally without a recorded end event.
+   */
+  readonly ended_at?: string | null;
+  /**
+   * Total call duration in milliseconds, measured from the first INVITE to the BYE or final response. Null while the call is still in progress and has no final duration yet.
+   */
+  readonly duration_ms?: number | null;
+  /**
+   * Post-dial delay in milliseconds: how long the caller heard nothing between dialing and the phone starting to ring at the other end. High values are what callers experience as the call "not going through". Absent when the call never rang, either because it failed first or because the carrier answered it immediately.
+   *
+   */
+  readonly pdd_ms?: number;
+  /**
+   * Billable duration in milliseconds, measured from answer to call end. Zero for unanswered calls, and null while the call is still in progress.
+   */
+  readonly billable_ms?: number | null;
+  /**
+   * How the audio sounded, as opposed to whether the call connected. Absent when the call carried no audio, or when the far end reported nothing to measure from.
+   */
+  media_quality?: VoiceMediaQuality;
+  /**
+   * Amount billed for this call, net of tax, at full precision. Absent until the call has been rated; unanswered or unpriced calls have no cost.
+   */
+  cost?: Money;
+};
 /**
  * Payload of the whatsapp.sent event.
  */
@@ -327,7 +497,6 @@ type WhatsAppAddress = {
    */
   bsuid?: string;
 };
-type WorkspaceId = string;
 type WhatsAppMessageId = string;
 /**
  * Identity fields shared by every WhatsApp lifecycle event payload.
@@ -507,12 +676,6 @@ type EventWhatsAppAccepted = {
  * Payload of the voice_call.initiated event.
  */
 type EventVoiceCallInitiatedData = EventVoiceBase;
-/**
- * Whether the call originated from your PBX (outbound) or arrived from a remote party (inbound).
- */
-type VoiceCallDirection = "inbound" | "outbound";
-type VoiceSessionId = string;
-type VoiceCallId = string;
 /**
  * Identity fields shared by every voice call lifecycle event payload.
  */
@@ -553,15 +716,6 @@ type EventVoiceCallInitiated = {
   timestamp: string;
   data: EventVoiceCallInitiatedData;
 };
-/**
- * Call status.
- *
- * A call that has ended carries answered, no_answer, failed, rejected, or unknown. A call that is still up carries ringing before it is picked up and in_progress once it is; both are what the `status` filter on the call list selects on to show calls happening right now.
- *
- * busy and canceled are declared ahead of the feature that produces them, so their arrival is not a breaking contract change: they come with inbound termination, and today both outcomes are folded into failed.
- *
- */
-type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
 /**
  * Payload of the voice_call.ended event.
  */
@@ -866,6 +1020,31 @@ type SmsError = {
    */
   occurred_at: string;
 } | null;
+/**
+ * What was charged for a message, split into the components that make it up. Null until at least one component has been priced.
+ *
+ */
+type MessageCost = {
+  /**
+   * Total charged, as a decimal string: the sum of the components below. Net of tax, which applies to your wallet balance rather than to an individual charge.
+   *
+   */
+  readonly amount: string;
+  /**
+   * ISO 4217 currency code. Every component is denominated in this currency.
+   */
+  readonly currency_code: CurrencyCode;
+  /**
+   * What Bird charged to carry the message, as a decimal string. Null when this component was not priced; `"0.00000"` when it priced at zero.
+   *
+   */
+  readonly transaction_amount: string | null;
+  /**
+   * Third-party fees Bird passes on, as a decimal string, such as US 10DLC carrier surcharges. Null when this component was not priced; `"0.00000"` when it priced at zero.
+   *
+   */
+  readonly passthrough_amount: string | null;
+} | null;
 type SmsMessageId = string;
 /**
  * Identity fields shared by every SMS lifecycle event payload.
@@ -880,11 +1059,13 @@ type EventSmsBase = {
    */
   workspace_id: WorkspaceId;
   /**
-   * Recipient phone number in E.164 format.
+   * Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.
+   *
    */
   to: string;
   /**
-   * Sender the message was sent from — an E.164 number, an alphanumeric sender ID, or a short code.
+   * Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound one it is the phone number that sent it to you.
+   *
    */
   from: string;
   /**
@@ -899,6 +1080,13 @@ type EventSmsBase = {
   metadata: {
     [key: string]: unknown;
   } | null;
+  /**
+   * What the message had cost as of this event, split into Bird's charge and any third-party fees passed through. Null on an event that priced nothing.
+   *
+   * Components are named so you can merge them per component rather than replacing the object: webhook delivery is not ordered, so an older event arriving late would otherwise overwrite a newer figure. Take the latest `occurred_at` you have seen for each component. `amount` is the sum of the components in THIS payload, not a settled total.
+   *
+   */
+  cost?: MessageCost;
 };
 /**
  * The carrier reported a non-permanent failure to deliver the message.
@@ -4188,20 +4376,6 @@ type WhatsAppTemplateSend = unknown & {
    */
   components?: Array<WhatsAppMessageTemplateComponent>;
 };
-/**
- * ISO 4217 three-letter currency code.
- */
-type CurrencyCode = string;
-type Money = {
-  /**
-   * Decimal amount as a string, in major currency units.
-   */
-  amount: string;
-  /**
-   * ISO 4217 currency code.
-   */
-  currency_code: CurrencyCode;
-};
 /**
  * Delivery status. `accepted` (the initial status of an outbound send) means Bird accepted the request and it is queued for sending. `sent` means it was handed to the WhatsApp network. `delivered` is confirmed delivery to the recipient's device. `failed` is a terminal permanent failure. `rejected` means Bird refused the message before sending it to WhatsApp, because the recipient is on the workspace's suppression list, the wallet had insufficient balance, or the destination is unpriced. A rejected message was not sent and not charged. There is no `read` status: a read receipt is reported as `read_at` and a `whatsapp.read` event, not a status value. The remaining values are reserved and not returned today: `scheduled` (queued to send at a future time), `canceled` (a scheduled message canceled before sending), and `received` (a message a contact sent you).
  *
@@ -4278,7 +4452,10 @@ type WhatsAppMessage = {
    * When the message was read by the recipient. Null until then.
    */
   readonly read_at?: string | null;
-  cost?: Money | null;
+  /**
+   * What the message cost, split into Bird's charge and any third-party fees passed through. Null until the message has been priced, and on messages that were rejected before pricing. The rate depends on the message category and the recipient's country.
+   */
+  readonly cost?: MessageCost;
   /**
    * Structured `{name, value}` filter labels applied to this message.
    */
@@ -4290,6 +4467,9 @@ type WhatsAppMessage = {
     [key: string]: unknown;
   };
 };
+type VerificationNextChannelRequest = {
+  to: VerificationTo;
+};
 type VerificationCheckResult = {
   /**
    * Whether the submitted passcode verified this verification. `true` means the passcode was correct and the verification is now complete; `false` means it did not verify, and `reason` says why. A verification that has already reached a final state is no longer checkable and returns `404`.
@@ -4324,7 +4504,7 @@ type Verification = {
   readonly reason?: VerificationTerminalReason$1 | null;
   readonly to: VerificationTo;
   /**
-   * The channels this verification uses to deliver the passcode, in attempt order: the first entry is tried first and later entries are fallbacks. An email recipient is verified over email; a phone recipient is verified over SMS.
+   * The channels this verification uses to deliver the passcode, in attempt order: the first entry is tried first and later entries are fallbacks. An email recipient is verified over email; a phone recipient is verified over the phone channels enabled for its destination country, in the order that country's configuration sets.
    */
   readonly channels: Array<VerificationChannelEntry>;
   /**
@@ -4507,44 +4687,6 @@ type SmsBatchSummary = {
    */
   accepted_count: number;
 };
-/**
- * Per-component cost breakdown. Returned on single-message reads; omitted from list rows.
- */
-type SmsCostBreakdown = {
-  /**
-   * Per-segment price as a decimal string.
-   */
-  per_segment: string;
-  /**
-   * Number of billable segments.
-   */
-  segments: number;
-  /**
-   * ISO 3166-1 alpha-2 destination country the price was resolved for.
-   */
-  country_code: string;
-  /**
-   * Carrier surcharge component as a decimal string (for example US 10DLC fees). `0.0000` when none applies.
-   */
-  carrier_surcharge: string;
-};
-/**
- * Cost of the message. Null until the message has been priced; the cost is populated as the message is processed, not at the moment it is accepted.
- */
-type SmsCost = {
-  /**
-   * ISO 4217 currency code for the cost amount. Omitted when the cost is not denominated in a currency (for example a zero-priced internal send).
-   */
-  readonly currency_code?: CurrencyCode;
-  /**
-   * Total cost as a decimal string: the per-segment rate multiplied by the segment count, plus any surcharges.
-   */
-  readonly amount: string;
-  /**
-   * Per-component cost breakdown. Returned on single-message reads; omitted from list rows.
-   */
-  breakdown?: SmsCostBreakdown;
-} | null;
 /**
  * Segment breakdown for the message body. Segment count drives billing.
  */
@@ -4580,18 +4722,20 @@ type SmsMessage = {
   readonly direction: "outbound" | "inbound";
   readonly status: SmsMessageStatus;
   /**
-   * Recipient phone number in E.164 format.
+   * Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.
+   *
    */
   to: string;
   /**
-   * Sender the message was sent from: an E.164 number, an alphanumeric sender ID, or a short code.
+   * Where the message came from. On an outbound message this is the sender you sent it from (an E.164 number, an alphanumeric sender ID, or a short code); on an inbound one it is the phone number that sent it to you.
+   *
    */
   from: string;
   /**
-   * The message body as sent. For a template send, this is the rendered text after parameter substitution. When `category` is `authentication` (a message carrying a one-time code), this is `**REDACTED**`: the code still reaches the recipient, Bird just does not persist it for later reads.
+   * The message body. Every message carries body text, attachments, or both, so this is absent only on a received message that carried attachments and no text. For a template send, this is the rendered text after parameter substitution. When `category` is `authentication` (a message carrying a one-time code), this is `**REDACTED**`: the code still reaches the recipient, Bird just does not persist it for later reads.
    *
    */
-  text: string;
+  text?: string;
   /**
    * Content classification supplied on the send. Null for inbound messages.
    */
@@ -4601,9 +4745,9 @@ type SmsMessage = {
    */
   segments: SmsSegments;
   /**
-   * Cost of the message. Null until the message has been priced.
+   * What the message cost, split into Bird's charge and any third-party fees passed through. Null until the message has been priced.
    */
-  cost?: SmsCost;
+  cost?: MessageCost;
   /**
    * Structured `{name, value}` filter labels applied to this message.
    */
@@ -4619,13 +4763,13 @@ type SmsMessage = {
    */
   readonly validity_period?: number;
   /**
-   * Carrier that handled the message, when known. Populated once a delivery receipt identifies it.
+   * Carrier that handled the message. Absent until a delivery receipt identifies it, and on a received message the carrier reports it only where a carrier fee applies.
    */
-  readonly carrier?: string | null;
+  readonly carrier?: string;
   /**
-   * Mobile country code and mobile network code of the carrier, when known.
+   * Mobile country code and mobile network code of the carrier. Absent until the carrier is identified.
    */
-  readonly mcc_mnc?: string | null;
+  readonly mcc_mnc?: string;
   /**
    * Failure detail on a terminally failed or rejected message. Present only when the message failed.
    */
@@ -4821,6 +4965,10 @@ type Contact = {
   data?: {
     [key: string]: unknown;
   };
+  /**
+   * The audiences this contact belongs to, most-recently-joined first. Only present when listing contacts; omitted from every other contact operation.
+   */
+  readonly audiences?: Array<AudienceRef>;
 } & Timestamps;
 type AudienceMember = {
   contact: Contact;
@@ -5063,6 +5211,10 @@ type ContactCreateRequest = {
     [key: string]: unknown;
   };
 };
+/**
+ * Which identifier a contact has on file, `email` for an email address or `phone` for a phone number.
+ */
+type ContactIdentifierFilter = "email" | "phone";
 type EmailMessageBatchResponse = {
   /**
    * One entry per message in the batch, in submission order.
@@ -5804,6 +5956,10 @@ type ListContactsData = {
      * Case-insensitive substring match against the contact's email address, first name, last name, or phone number. Phone matching is over the digits of the international form, so a full pasted number, a formatted number, or trailing digits all match; a national form with a leading trunk zero does not.
      */
     q?: string;
+    /**
+     * Filter to contacts that have a specific identifier on file.
+     */
+    identifier?: ContactIdentifierFilter;
     /**
      * Maximum number of items to return per page.
      */
@@ -6236,6 +6392,31 @@ type CreateVerificationCheckData = {
   query?: never;
   url: "/v1/verify/verifications/check";
 };
+type CreateVerificationNextChannelData = {
+  body: VerificationNextChannelRequest;
+  headers?: {
+    /**
+     * Workspace context. Required for session auth; derived from API key otherwise.
+     */
+    "X-Workspace-Id"?: string;
+    /**
+     * Client-supplied deduplication key. When present, the server replays the original response for any duplicate request with the same key within the idempotency TTL window (3 hours by default).
+     * Two distinct 409 errors signal misuse:
+     * - `request_in_progress` (E01004): the same key is currently being
+     * processed by a concurrent request. Wait briefly and retry; the lock
+     * expires within 30 seconds.
+     * - `idempotency_key_reuse` (E01005): the same key has already completed
+     * against a different request body or method. Generate a new key.
+     *
+     * Recommended key format is `<event-type>/<entity-id>` (e.g. `welcome-user/usr_abc123`).
+     *
+     */
+    "Idempotency-Key"?: string;
+  };
+  path?: never;
+  query?: never;
+  url: "/v1/verify/verifications/next-channel";
+};
 type ListWhatsAppMessagesData = {
   body?: never;
   path?: never;
@@ -7397,6 +7578,64 @@ type ReplyEmailThreadMessageData = {
   query?: never;
   url: "/v1/email/threads/{thread_id}/messages/{message_id}/reply";
 };
+type ListVoiceCallsData = {
+  body?: never;
+  path?: never;
+  query?: {
+    /**
+     * Return only calls in this direction.
+     */
+    direction?: VoiceCallDirection;
+    /**
+     * Return only calls with one of these statuses, comma-separated. The in-flight statuses (`ringing`, `in_progress`) cannot be combined with final ones in the same request.
+     *
+     */
+    status?: Array<VoiceCallStatus>;
+    /**
+     * Return only calls belonging to this session, which is how the legs of one multi-party or transferred call are correlated.
+     */
+    session_id?: VoiceSessionId;
+    /**
+     * Return only calls carried by this SIP trunk.
+     */
+    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.
+     *
+     */
+    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.
+     *
+     */
+    to?: string;
+    /**
+     * Return only calls where the calling or called number contains this value. Matches a partial number, so a country or area-code prefix returns every call to or from it. Combines with `from`/`to`, which match one side exactly.
+     */
+    number?: string;
+    /**
+     * Return only calls that started at or after this instant, inclusive. RFC 3339 timestamp.
+     */
+    started_after?: string;
+    /**
+     * Return only calls that started at or before this instant, inclusive. RFC 3339 timestamp.
+     */
+    started_before?: string;
+    /**
+     * Maximum number of items to return per page.
+     */
+    limit?: number;
+    /**
+     * Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.
+     */
+    starting_after?: string;
+    /**
+     * Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.
+     */
+    ending_before?: string;
+  };
+  url: "/v1/voice/calls";
+};
 //#endregion
 //#region src/generated/core/auth.gen.d.ts
 type AuthToken = string | undefined;
@@ -8723,12 +8962,36 @@ declare class WhatsappResource extends WhatsappResourceBase {
   send(params: WhatsappSendParams, options?: RequestOptions): APIPromise<WhatsAppMessage>;
 }
 //#endregion
+//#region src/resources/voice.gen.d.ts
+type VoiceListQuery = NonNullable<ListVoiceCallsData["query"]>;
+declare class VoiceResource extends Resource {
+  /**
+   * List the workspace's calls, newest first. Filter to `ringing`/`in_progress` for the calls in progress right now, or to final statuses for completed records. The two cannot be combined in one request. Use `from`/`to` for one known party number in international form, and `number` to search either side by fragment. These are per-call records: for rates and totals over a period use voice_stats_summary rather than summing them here, and voice_get to follow one call to settlement.
+   *
+   * @example Iterate the calls happening right now
+   * for await (const call of bird.voice.list({ status: ["ringing", "in_progress"] })) {
+   *   console.log(call.id, call.status);
+   * }
+   */
+  list(query?: VoiceListQuery, options?: RequestOptions): PaginatedPromise<VoiceCall>;
+  /**
+   * Fetch one call by id, at any point in its lifecycle. A call still ringing or connected carries no economics yet: `duration_ms`, `billable_ms`, `ended_at`, and `cost` are null until it ends, and this same id then answers with the settled record. Poll here to watch one known call; use voice_list to find calls in the first place. When a call was refused, `rejection_reason` names the gate that turned it away.
+   *
+   * @example Read one call back
+   * const call = await bird.voice.get("vcl_01k0p3v9wera3v6q6xw3e9y2mh");
+   * // A call still ringing or connected carries no economics yet.
+   * call.status; // "answered" | "no_answer" | "ringing" | …
+   */
+  get(callId: string, options?: RequestOptions): APIPromise<VoiceCall>;
+}
+//#endregion
 //#region src/resources/verifyVerifications.gen.d.ts
 type VerifyVerificationsCreateParams = NonNullable<CreateVerificationData["body"]>;
 type VerifyVerificationsCheckParams = NonNullable<CreateVerificationCheckData["body"]>;
+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 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.
+   * 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.
    *
    * @example Start a verification over SMS
    * const verification = await bird.verify.verifications.create({
@@ -8748,6 +9011,16 @@ declare class VerifyVerificationsResource extends Resource {
    * console.log(result.success);
    */
   check(params: VerifyVerificationsCheckParams, options?: RequestOptions): APIPromise<VerificationCheckResult>;
+  /**
+   * Advance an in-progress verification to the next channel in its plan and send a fresh passcode there: the "I didn't receive my code" action. The verification is identified by the same `to` recipient used to start it, with no verification id needed. The send bypasses the resend cooldown, and earlier passcodes stay valid. Returns the verification with `last_channel` set to the channel the new code went to; when concurrent advances race for the same recipient, the response reflects committed state: `last_channel` names the most recent completed send, and the racing call that completed the newer send is authoritative. A plan with no further channel returns a 422 named NoNextChannel, after which only re-creating the verification will resend.
+   *
+   * @example Send the code again on the next channel
+   * const verification = await bird.verify.verifications.nextChannel({
+   *   to: { phone_number: "+15551234567" },
+   * });
+   * console.log(verification.last_channel);
+   */
+  nextChannel(params: VerifyVerificationsNextChannelParams, options?: RequestOptions): APIPromise<Verification>;
 }
 //#endregion
 //#region src/resources/verify.d.ts
@@ -8994,6 +9267,8 @@ declare class BirdClient<const O extends BirdClientOptions = BirdClientOptions>
   readonly smsTemplates: SmsTemplatesResource;
   /** The WhatsApp channel — `bird.whatsapp.send(...)`, `.get(...)`, `.list(...)`, `.listEvents(...)`. */
   readonly whatsapp: WhatsappResource;
+  /** The Voice call log — `bird.voice.list(...)`, `.get(...)`. Calls are placed by your own SIP equipment, so this is a read surface. */
+  readonly voice: VoiceResource;
   /** The Verify product — `bird.verify.verifications.create(...)`, `.check(...)`. */
   readonly verify: VerifyResource;
   /** Contacts — `bird.contacts.create(...)`, `.list(...)`, `.get(...)`, `.batch(...)`, … */
@@ -9187,5 +9462,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 EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type ErrorNextAction, type Mailbox, type MailboxStatsResponse, type PaginatedPromise, type 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, 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, 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 EmailMailboxLabelList, type EmailMailboxesCreateParams, type EmailMailboxesListQuery, type EmailMailboxesMessagesCreateParams, type EmailMailboxesReceiveRulesCreateParams, type EmailMailboxesReceiveRulesListQuery, type EmailMailboxesStatsQuery, type EmailMailboxesUpdateParams, type EmailMailboxesUpdateQuery, type EmailMessage, type EmailSendBatchParams, type EmailSendBatchResult, type EmailSendParams, type EmailStatsByBounceCodeQuery, type EmailStatsByBounceCodeResponse, type EmailStatsByBroadcastQuery, type EmailStatsByBroadcastResponse, type EmailStatsByCategoryQuery, type EmailStatsByCategoryResponse, type EmailStatsByClientQuery, type EmailStatsByClientResponse, type EmailStatsByComplaintTypeQuery, type EmailStatsByComplaintTypeResponse, type EmailStatsByLocationQuery, type EmailStatsByLocationResponse, type EmailStatsByMailboxProviderQuery, type EmailStatsByMailboxProviderRegionQuery, type EmailStatsByMailboxProviderRegionResponse, type EmailStatsByMailboxProviderResponse, type EmailStatsByRecipientDomainQuery, type EmailStatsByRecipientDomainResponse, type EmailStatsBySendingDomainQuery, type EmailStatsBySendingDomainResponse, type EmailStatsBySendingIpQuery, type EmailStatsBySendingIpResponse, type EmailStatsByTagQuery, type EmailStatsByTemplateQuery, type EmailStatsByTemplateResponse, type EmailStatsDailyQuery, type EmailStatsHourlyQuery, type EmailStatsResponse, type EmailStatsSummary, type EmailStatsSummaryQuery, type EmailStatsTagsResponse, type EmailThread, type EmailThreadMessage, type EmailThreadMessageAttachmentList, type EmailThreadMessageBody, type EmailThreadsDeleteQuery, type EmailThreadsListQuery, type EmailThreadsMessagesListQuery, type EmailThreadsMessagesReplyParams, type EmailThreadsUpdateParams, type ErrorDetail, type ErrorNextAction, type Mailbox, type MailboxStatsResponse, type PaginatedPromise, type 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, 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 };
 //# sourceMappingURL=index.d.mts.map