@messagebird/sdk 0.24.0 → 0.25.1

package/dist/index.d.mts

@@ -872,9 +872,9 @@ type EventVerifyVerificationCreated = {
   data: EventVerifyVerificationCreatedData;
 };
 /**
- * Why a passcode send did not deliver. Open enum — new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error. Emitted reasons are `carrier_rejected` (SMS), `hard_bounce` (email, permanent bounce), `soft_bounce` (email, transient bounce such as a full mailbox), `undelivered` (a generic delivery failure), `channel_unavailable` (the channel could not be used and the verification failed over), and `channel_disabled` (Bird has temporarily stopped sending over that channel, so the verification moved on to the next one).
+ * Why a passcode send did not deliver. Open enum — new reasons may be added over time, so treat any unrecognized value as a future reason rather than an error. Emitted reasons are `carrier_rejected` (SMS), `hard_bounce` (email, permanent bounce), `soft_bounce` (email, transient bounce such as a full mailbox), `undelivered` (a generic delivery failure), `channel_unavailable` (the channel could not be used and the verification failed over), `channel_disabled` (Bird has temporarily stopped sending over that channel, so the verification moved on to the next one), and `delivery_timeout` (no delivery confirmation arrived before the channel's timeout, so the verification failed over).
  */
-type VerificationAttemptFailureReason$1 = "carrier_rejected" | "hard_bounce" | "soft_bounce" | "undelivered" | "channel_unavailable" | "channel_disabled" | (string & {});
+type VerificationAttemptFailureReason$1 = "carrier_rejected" | "hard_bounce" | "soft_bounce" | "undelivered" | "channel_unavailable" | "channel_disabled" | "delivery_timeout" | (string & {});
 /**
  * Payload of the verify.attempt.undelivered event.
  */
@@ -998,10 +998,10 @@ type EventSmsUndeliveredData = EventSmsBase & {
   error: SmsError;
 };
 /**
- * Bird-stable failure reason. `invalid_destination`: the number is not assigned, ported out, or malformed. `unreachable`: handset off or out of coverage. `blocked_by_carrier`: the carrier filtered the message. `blocked_by_recipient`: the recipient device blocked the sender. `landline_unreachable`: the destination is a landline that does not accept SMS. `content_rejected`: the carrier rejected the content. `sender_unregistered`: the sender is not registered for the destination. `recipient_opted_out`: the recipient is on a suppression list. `provider_unavailable`: an upstream failure after retries. `insufficient_balance`: the workspace wallet had insufficient balance to send the message. `unknown`: an unmapped failure.
+ * Bird-stable failure reason. Open enum: Bird adds reasons as the carrier platform's own buckets are covered, so treat an unrecognized value as a future reason rather than an error. `invalid_destination`: the number is not assigned, ported out, or malformed. `unreachable`: handset off or out of coverage. `blocked_by_carrier`: the carrier filtered the message. `blocked_by_recipient`: the recipient device blocked the sender. `landline_unreachable`: the destination is a landline that does not accept SMS. `content_rejected`: the carrier rejected the content. `sender_unregistered`: the sender is not registered for the destination. `recipient_opted_out`: the recipient is on a suppression list. `provider_unavailable`: an upstream failure after retries. `insufficient_balance`: the workspace wallet had insufficient balance to send the message. `unknown`: an unmapped failure.
  *
  */
-type SmsErrorCode = "invalid_destination" | "unreachable" | "blocked_by_carrier" | "blocked_by_recipient" | "landline_unreachable" | "content_rejected" | "sender_unregistered" | "recipient_opted_out" | "provider_unavailable" | "insufficient_balance" | "unknown";
+type SmsErrorCode = "invalid_destination" | "unreachable" | "blocked_by_carrier" | "blocked_by_recipient" | "landline_unreachable" | "content_rejected" | "sender_unregistered" | "recipient_opted_out" | "provider_unavailable" | "insufficient_balance" | "unknown" | (string & {});
 /**
  * Failure detail for a message that could not be delivered or was rejected.
  */
@@ -1012,7 +1012,7 @@ type SmsError = {
    */
   description: string;
   /**
-   * Raw carrier-supplied error code, when available, for low-level debugging.
+   * Raw provider-supplied error code, finer-grained than the `code` that normalizes it. Not a Bird-defined value, so quote it to support when asking why a message failed. Null when the provider sent none, including any failure decided before one was reached.
    */
   carrier_error_code?: string | null;
   /**
@@ -1107,13 +1107,13 @@ type EventSmsUndelivered = {
  */
 type EventSmsSentData = EventSmsBase & {
   /**
-   * Carrier that handled the message, or null when not known.
+   * Carrier that handled the message. Absent when the carrier does not report one.
    */
-  carrier: string | null;
+  carrier?: string;
   /**
-   * Mobile country code and mobile network code of the carrier, or null when not known.
+   * Mobile country code and mobile network code of the carrier. Absent when the carrier does not report one.
    */
-  mcc_mnc: string | null;
+  mcc_mnc?: string;
 };
 /**
  * Bird handed the message to the carrier for delivery.
@@ -1152,6 +1152,65 @@ type EventSmsRejected = {
   timestamp: string;
   data: EventSmsRejectedData;
 };
+/**
+ * Payload of the sms.received event.
+ */
+type EventSmsReceivedData = EventSmsBase & unknown & {
+  /**
+   * The message body, so you can act on it without a follow-up read. Absent when the message carried only attachments and no text of its own.
+   *
+   */
+  text?: string;
+  /**
+   * Segment breakdown of the received body.
+   */
+  segments: SmsSegments;
+  /**
+   * Carrier the message came in over. Absent where the carrier does not report one.
+   */
+  carrier?: string;
+  /**
+   * Mobile country code and mobile network code of the carrier. Absent when not known.
+   */
+  mcc_mnc?: string;
+  /**
+   * Subject line. Absent when the message carried none.
+   */
+  subject?: string;
+};
+/**
+ * Segment breakdown for the message body. Segment count drives billing.
+ */
+type SmsSegments = {
+  /**
+   * Number of segments the body is split into. Each segment is a billable unit.
+   */
+  readonly count: number;
+  /**
+   * Encoding used for the body. `GSM_7BIT` fits 160 characters in a single segment (153 per part when multi-segment); `UCS2` is used when the body contains any character outside the GSM 03.38 alphabet (emoji, CJK, some accented characters) and fits 70 characters in a single segment (67 per part when multi-segment).
+   *
+   */
+  readonly encoding: "GSM_7BIT" | "UCS2";
+  /**
+   * Character count of the body under the selected encoding.
+   */
+  readonly characters: number;
+};
+/**
+ * Event type.
+ */
+type SmsReceivedEventType = "sms.received";
+/**
+ * A message was received on one of your numbers.
+ */
+type EventSmsReceived = {
+  type: SmsReceivedEventType;
+  /**
+   * Time the sender sent the message.
+   */
+  timestamp: string;
+  data: EventSmsReceivedData;
+};
 /**
  * Payload of the sms.failed event.
  */
@@ -1178,7 +1237,12 @@ type EventSmsFailed = {
 /**
  * Payload of the sms.expired event.
  */
-type EventSmsExpiredData = EventSmsBase;
+type EventSmsExpiredData = EventSmsBase & {
+  /**
+   * Why the message was still undelivered when its validity period elapsed. Typically `unreachable`, the handset having stayed off or out of coverage for the whole window.
+   */
+  error: SmsError;
+};
 /**
  * The message's validity period elapsed before it could be delivered.
  */
@@ -1198,13 +1262,13 @@ type EventSmsExpired = {
  */
 type EventSmsDeliveredData = EventSmsBase & {
   /**
-   * Carrier that delivered the message, or null when not known.
+   * Carrier that delivered the message. Absent when the carrier does not report one.
    */
-  carrier: string | null;
+  carrier?: string;
   /**
-   * Mobile country code and mobile network code of the carrier, or null when not known.
+   * Mobile country code and mobile network code of the carrier. Absent when the carrier does not report one.
    */
-  mcc_mnc: string | null;
+  mcc_mnc?: string;
 };
 /**
  * The carrier confirmed delivery of the message to the recipient handset.
@@ -1223,7 +1287,12 @@ type EventSmsDelivered = {
 /**
  * Payload of the sms.accepted event.
  */
-type EventSmsAcceptedData = EventSmsBase;
+type EventSmsAcceptedData = EventSmsBase & {
+  /**
+   * Segment breakdown of the body Bird accepted, which is what the send is billed on.
+   */
+  segments: SmsSegments;
+};
 /**
  * Bird accepted the SMS send request and queued it for processing.
  */
@@ -2137,6 +2206,8 @@ type WebhookEvent = ({
 } & EventSmsExpired) | ({
   type: "sms.failed";
 } & EventSmsFailed) | ({
+  type: "sms.received";
+} & EventSmsReceived) | ({
   type: "sms.rejected";
 } & EventSmsRejected) | ({
   type: "sms.sent";
@@ -4315,36 +4386,70 @@ type WhatsAppMessageSendRequest = {
   };
 };
 /**
- * The kind of value a template parameter accepts. `text` (the only kind today) is a plain string substituted into the placeholder. Open enum: more kinds may be added over time.
+ * The values that fill one block of one carousel card.
+ */
+type WhatsAppMessageTemplateCardComponent = {
+  /**
+   * Which part of the card this fills in: `header` for the card's image or video, `body` for its text, `button` for a button's variable.
+   *
+   */
+  type: string;
+  /**
+   * The values that fill this part's placeholders, in placeholder order.
+   */
+  parameters?: Array<WhatsAppMessageTemplateComponentParameter>;
+};
+/**
+ * The kind of value a template parameter carries, which follows the block it fills. `text` is a plain string substituted into a placeholder, including a coupon button's code, which the recipient copies from the button. `image`, `video`, `gif` and `document` carry a media header's file in `url`, each matching its header's `format`. `location` fills a location header and carries a point on the map. Open enum: more kinds may be added over time.
  *
  */
-type WhatsAppTemplateParameterType$1 = "text" | (string & {});
+type WhatsAppTemplateParameterType$1 = "text" | "image" | "video" | "gif" | "document" | "location" | (string & {});
 type WhatsAppMessageTemplateComponentParameter = {
   /**
-   * The kind of value this parameter carries. `text` is the only kind today.
+   * The kind of value this parameter carries, which decides which of the fields below to send.
    */
   type: WhatsAppTemplateParameterType$1;
   /**
-   * The value substituted into the placeholder, as a plain string.
+   * The value substituted into the placeholder, as a plain string. Send it on a `text` parameter.
    */
-  text: string;
+  text?: string;
+  /**
+   * Public `https` URL of the file a media header shows. Send it on an `image`, `video`, `gif` or `document` parameter. WhatsApp fetches it at send time, so it must still be reachable then, the same way a free-form media message's `url` must.
+   *
+   */
+  url?: string;
   /**
    * Required when the template declares named parameters: the placeholder this value fills (for example `first_name`), matching exactly one of the names the template declares. Name every parameter in that case; order does not matter once names are supplied. Omit this field for a positional template, which takes its values in `{{n}}` order instead. Sending the wrong set of names, or leaving one out that the template requires, returns a `422` `WhatsAppTemplateParameterMismatch`.
    *
    */
   name?: string;
 };
+/**
+ * The values that fill one card of a carousel. Cards fill in the order the template was approved with, so send one entry per card and keep them in that order.
+ *
+ */
+type WhatsAppMessageTemplateCard = {
+  /**
+   * The values that fill this card's blocks.
+   */
+  components: Array<WhatsAppMessageTemplateCardComponent>;
+};
 type WhatsAppMessageTemplateComponent = {
   /**
-   * Which part of the template this fills in: `body` for the main text, `button` for a button's variable, `header` for the header. Bird manages header values itself, so a `header` entry supplied on a send is ignored.
+   * Which part of the template this fills in: `body` for the main text, `button` for a button's variable, `header` for the header's text, media or location, `carousel` for the cards.
    *
    */
   type: string;
   /**
-   * The values that fill this part's placeholders. A positional template takes them in `{{n}}` placeholder order; a template with named parameters requires each parameter's `name` to match one the template declares, and order then carries no meaning.
+   * The values that fill this part's placeholders. A positional template takes them in `{{n}}` placeholder order; a template with named parameters requires each parameter's `name` to match one the template declares, and order then carries no meaning. Send it on every part except `carousel`, which carries its values on `cards`.
    *
    */
   parameters?: Array<WhatsAppMessageTemplateComponentParameter>;
+  /**
+   * The values that fill each card of a carousel. Send it only on a `carousel` part. A carousel sends exactly the number of cards its template was approved with, so every card needs an entry.
+   *
+   */
+  cards?: Array<WhatsAppMessageTemplateCard>;
 };
 /**
  * A language tag in BCP-47 form, for example `en` or `pt-BR`.
@@ -4366,7 +4471,7 @@ type WhatsAppTemplateSend = unknown & {
    */
   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 when the template has a single language; when it is stocked in several, omitting the language 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; 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.
    *
    */
   language?: LanguageTag;
@@ -4377,7 +4482,7 @@ type WhatsAppTemplateSend = unknown & {
   components?: Array<WhatsAppMessageTemplateComponent>;
 };
 /**
- * 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).
+ * 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. `received` is the status of an inbound message, one a contact sent you. The remaining values are reserved and not returned today: `scheduled` (queued to send at a future time) and `canceled` (a scheduled message canceled before sending).
  *
  */
 type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "failed" | "rejected" | "canceled" | "received";
@@ -4453,7 +4558,7 @@ type WhatsAppMessage = {
    */
   readonly read_at?: string | 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.
+   * What the message cost, split into Bird's charge and any third-party fees passed through. Null on an inbound message, which is never priced, on an outbound message that has not been priced yet, and on one rejected before pricing. The rate depends on the message category and the recipient's country.
    */
   readonly cost?: MessageCost;
   /**
@@ -4573,7 +4678,7 @@ type SmsTemplateVersionId = string;
  */
 type TemplateVariable = {
   /**
-   * The parameters key this slot is filled with.
+   * The parameter key this slot is filled with.
    */
   readonly key: string;
   /**
@@ -4582,7 +4687,7 @@ type TemplateVariable = {
    */
   readonly type: string;
   /**
-   * Whether the slot must be supplied when sending. Advisory for email templates, where a missing value renders as empty rather than rejecting the send.
+   * Whether the slot must be supplied when sending. A send that leaves a required slot unset is rejected.
    *
    */
   readonly required: boolean;
@@ -4687,24 +4792,6 @@ type SmsBatchSummary = {
    */
   accepted_count: number;
 };
-/**
- * Segment breakdown for the message body. Segment count drives billing.
- */
-type SmsSegments = {
-  /**
-   * Number of segments the body is split into. Each segment is a billable unit.
-   */
-  readonly count: number;
-  /**
-   * Encoding used for the body. `GSM_7BIT` fits 160 characters in a single segment (153 per part when multi-segment); `UCS2` is used when the body contains any character outside the GSM 03.38 alphabet (emoji, CJK, some accented characters) and fits 70 characters in a single segment (67 per part when multi-segment).
-   *
-   */
-  readonly encoding: "GSM_7BIT" | "UCS2";
-  /**
-   * Character count of the body under the selected encoding.
-   */
-  readonly characters: number;
-};
 /**
  * Delivery status. `accepted` (the initial status of an outbound send) means Bird accepted the request and it is awaiting handoff to the carrier network. `sent` means it was handed to the carrier and is awaiting a delivery receipt. `delivered` is confirmed delivery. `undelivered` is a non-permanent non-delivery (handset off or unreachable). `failed` is a terminal permanent failure. `rejected` means Bird refused it before it reached the carrier (for example insufficient balance). `expired` means the validity period elapsed without a terminal receipt. `scheduled` means the message is queued to send at a future time and has not been dispatched yet, and `canceled` means a scheduled message was canceled before it was sent. `received` applies to inbound messages.
  *
@@ -4771,7 +4858,7 @@ type SmsMessage = {
    */
   readonly mcc_mnc?: string;
   /**
-   * Failure detail on a terminally failed or rejected message. Present only when the message failed.
+   * Failure detail on a message that failed, was rejected, was not delivered, or expired. Absent otherwise.
    */
   last_error?: SmsError;
   /**
@@ -4947,11 +5034,11 @@ type Contact = {
    */
   phone: string | null;
   /**
-   * The contact's first name. Available in broadcast templates as the `contact.first_name` variable.
+   * The contact's first name. Available in broadcast templates as `bird.contact.first_name`.
    */
   first_name?: string | null;
   /**
-   * The contact's last name. Available in broadcast templates as the `contact.last_name` variable.
+   * The contact's last name. Available in broadcast templates as `bird.contact.last_name`.
    */
   last_name?: string | null;
   /**
@@ -4959,7 +5046,7 @@ type Contact = {
    */
   external_id?: string | null;
   /**
-   * Custom property values for this contact, available as template variables in broadcasts. Each key is a property created via the contact properties API, and each value is a string, number, boolean, or RFC 3339 datetime matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized. Values stored under a property that was later archived remain readable here.
+   * Custom property values for this contact, available in broadcast templates as `bird.contact.<key>`. Each key is a property created via the contact properties API, and each value is a string, number, boolean, or RFC 3339 datetime matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized. Values stored under a property that was later archived remain readable here.
    *
    */
   data?: {
@@ -5014,7 +5101,7 @@ type ContactPropertyUpdateRequest = {
 };
 type ContactPropertyCreateRequest = {
   /**
-   * The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
+   * The property key, used as the key in contact data and as the attribute in the `bird.contact.<key>` broadcast template variable. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
    */
   key: string;
   type: ContactPropertyType;
@@ -5037,7 +5124,7 @@ type ContactProperty = {
    */
   readonly id: ContactPropertyId;
   /**
-   * The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
+   * The property key, used as the key in contact data and as the attribute in the `bird.contact.<key>` broadcast template variable. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
    */
   key: string;
   type: ContactPropertyType;
@@ -5276,7 +5363,7 @@ type EmailTemplateSend = unknown & {
    */
   language?: LanguageTag;
   /**
-   * Values for the template's variables, keyed by variable name. A token with no matching value renders empty. Nest values to fill dotted tokens: `{"contact": {"first_name": "Ada"}}` fills `{{ contact.first_name }}`. Send everything the template's `variables` lists rather than only what you expect the chosen language to use: languages need not reference the same variables, and a value no language uses is ignored. Cap: 16 KB serialized.
+   * Values for the template's parameters, keyed by parameter name. A parameter name is a single word, and every parameter the template's `variables` lists needs a value here: a send that omits one is rejected rather than delivered with a blank. Send everything `variables` lists rather than only what you expect the chosen language to use, since languages need not reference the same parameters and a value no language uses is ignored. Cap: 16 KB serialized.
    *
    */
   parameters?: {
@@ -5337,7 +5424,7 @@ type EmailMessageSendRequest = {
     [key: string]: unknown;
   };
   /**
-   * Template variables used to personalize inline content. Tokens in the subject and body (e.g. `{{ first_name }}`) are replaced with these values at send time. Shared across all recipients of this send. A token with no matching key renders empty. Cap: 16 KB serialized. When sending a stored `template`, put the values in `template.parameters` instead.
+   * Parameter values used to personalize inline content. A parameter is a single word, and a token in the subject or body (for example `{{ animal }}`) is replaced with the value of that name at send time. Shared across all recipients of this send. A token with no matching key renders empty. Cap: 16 KB serialized. When sending a stored `template`, put the values in `template.parameters` instead.
    *
    */
   parameters?: {
@@ -7587,7 +7674,7 @@ type ListVoiceCallsData = {
      */
     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.
+     * Return only calls with one of these statuses, comma-separated. In-flight and final statuses may be combined freely.
      *
      */
     status?: Array<VoiceCallStatus>;
@@ -8966,7 +9053,7 @@ declare class WhatsappResource extends WhatsappResourceBase {
 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.
+   * List the workspace's calls, newest first. Filter to `ringing`/`in_progress` for the calls in progress right now, to final statuses for completed records, or to any mix of the two. 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"] })) {
@@ -9340,6 +9427,7 @@ declare const WebhookEventType: {
   readonly SmsDelivered: "sms.delivered";
   readonly SmsExpired: "sms.expired";
   readonly SmsFailed: "sms.failed";
+  readonly SmsReceived: "sms.received";
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
   readonly SmsUndelivered: "sms.undelivered";
@@ -9385,6 +9473,26 @@ declare const EmailEventType: {
 };
 /** A known EmailEventType value. */
 type EmailEventTypeValue = (typeof EmailEventType)[keyof typeof EmailEventType];
+/**
+ * Values of SMSErrorCode 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 SMSErrorCode: {
+  readonly BlockedByCarrier: "blocked_by_carrier";
+  readonly BlockedByRecipient: "blocked_by_recipient";
+  readonly ContentRejected: "content_rejected";
+  readonly InsufficientBalance: "insufficient_balance";
+  readonly InvalidDestination: "invalid_destination";
+  readonly LandlineUnreachable: "landline_unreachable";
+  readonly ProviderUnavailable: "provider_unavailable";
+  readonly RecipientOptedOut: "recipient_opted_out";
+  readonly SenderUnregistered: "sender_unregistered";
+  readonly Unknown: "unknown";
+  readonly Unreachable: "unreachable";
+};
+/** A known SMSErrorCode value. */
+type SMSErrorCodeValue = (typeof SMSErrorCode)[keyof typeof SMSErrorCode];
 /**
  * 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
@@ -9394,6 +9502,7 @@ declare const VerificationAttemptFailureReason: {
   readonly CarrierRejected: "carrier_rejected";
   readonly ChannelDisabled: "channel_disabled";
   readonly ChannelUnavailable: "channel_unavailable";
+  readonly DeliveryTimeout: "delivery_timeout";
   readonly HardBounce: "hard_bounce";
   readonly SoftBounce: "soft_bounce";
   readonly Undelivered: "undelivered";
@@ -9457,10 +9566,15 @@ type WhatsAppTemplateCategoryValue = (typeof WhatsAppTemplateCategory)[keyof typ
  * these with a `default` branch rather than treating the set as closed.
  */
 declare const WhatsAppTemplateParameterType: {
+  readonly Document: "document";
+  readonly Gif: "gif";
+  readonly Image: "image";
+  readonly Location: "location";
   readonly Text: "text";
+  readonly Video: "video";
 };
 /** 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, 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 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, 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 };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -3189,9 +3189,9 @@ const listMailboxLabels = (options) => (options.client ?? client).get({
 *
 * Returns a paginated list of the workspace's calls, ordered by start time descending.
 *
-* The `status` filter selects which side of the call lifecycle you get. Omit it, or pass only final statuses, and you get completed calls. Pass only the in-flight statuses (`ringing`, `in_progress`) and you get the calls happening right now. A call in flight carries no economics yet: `duration_ms`, `billable_ms`, `ended_at`, and `cost` are null until it ends, and the completed record then appears under the same `id`.
+* The `status` filter selects where in the lifecycle you look, and any combination is a single page: in-flight statuses (`ringing`, `in_progress`), final ones, or both together. Omit it and you get completed calls, which is what this list has always returned.
 *
-* In-flight and completed calls are paged separately, so a request that mixes in-flight and final statuses returns a 422 `validation_error`.
+* A call in flight carries no economics yet: `duration_ms`, `billable_ms`, `ended_at`, and `cost` are null until it ends. It keeps the same `id` throughout, so the same call answers under one identity from the first ring to settlement.
 *
 */
 const listVoiceCalls = (options) => (options?.client ?? client).get({
@@ -4841,7 +4841,7 @@ var WhatsappResource = class extends WhatsappResourceBase {
 //#region src/resources/voice.gen.ts
 var VoiceResource = class 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.
+	* List the workspace's calls, newest first. Filter to `ringing`/`in_progress` for the calls in progress right now, to final statuses for completed records, or to any mix of the two. 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"] })) {
@@ -5238,9 +5238,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.24.0`,
+			"User-Agent": `bird-sdk-js/0.25.1`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.24.0"
+			"Bird-Version": "0.25.1"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -5364,6 +5364,7 @@ const WebhookEventType = {
 	SmsDelivered: "sms.delivered",
 	SmsExpired: "sms.expired",
 	SmsFailed: "sms.failed",
+	SmsReceived: "sms.received",
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
 	SmsUndelivered: "sms.undelivered",
@@ -5406,6 +5407,24 @@ const EmailEventType = {
 	EmailUnsubscribed: "email.unsubscribed"
 };
 /**
+* Values of SMSErrorCode 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.
+*/
+const SMSErrorCode = {
+	BlockedByCarrier: "blocked_by_carrier",
+	BlockedByRecipient: "blocked_by_recipient",
+	ContentRejected: "content_rejected",
+	InsufficientBalance: "insufficient_balance",
+	InvalidDestination: "invalid_destination",
+	LandlineUnreachable: "landline_unreachable",
+	ProviderUnavailable: "provider_unavailable",
+	RecipientOptedOut: "recipient_opted_out",
+	SenderUnregistered: "sender_unregistered",
+	Unknown: "unknown",
+	Unreachable: "unreachable"
+};
+/**
 * 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
 * these with a `default` branch rather than treating the set as closed.
@@ -5414,6 +5433,7 @@ const VerificationAttemptFailureReason = {
 	CarrierRejected: "carrier_rejected",
 	ChannelDisabled: "channel_disabled",
 	ChannelUnavailable: "channel_unavailable",
+	DeliveryTimeout: "delivery_timeout",
 	HardBounce: "hard_bounce",
 	SoftBounce: "soft_bounce",
 	Undelivered: "undelivered"
@@ -5466,8 +5486,15 @@ const WhatsAppTemplateCategory = {
 * 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.
 */
-const WhatsAppTemplateParameterType = { Text: "text" };
+const WhatsAppTemplateParameterType = {
+	Document: "document",
+	Gif: "gif",
+	Image: "image",
+	Location: "location",
+	Text: "text",
+	Video: "video"
+};
 //#endregion
-export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
+export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, EmailEventType, SMSErrorCode, VerificationAttemptFailureReason, VerificationChannel, VerificationTerminalReason, WebhookEventType, WhatsAppErrorCode, WhatsAppTemplateCategory, WhatsAppTemplateParameterType, baseUrlForRegion, regionFromApiKey };
 
 //# sourceMappingURL=index.mjs.map