@messagebird/sdk 0.8.4 → 0.9.0

package/dist/index.d.mts

@@ -381,7 +381,7 @@ type EventWhatsAppRead = {
  */
 type WhatsAppErrorCode = string;
 /**
- * Failure detail for a message that could not be delivered. Null when there is no failure.
+ * Failure detail for a message that could not be delivered.
  */
 type WhatsAppError = {
   code: WhatsAppErrorCode;
@@ -472,7 +472,7 @@ type EventSmsUndeliveredData = EventSmsBase & {
  */
 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";
 /**
- * Failure detail for a message that could not be delivered or was rejected. Null when there is no failure.
+ * Failure detail for a message that could not be delivered or was rejected.
  */
 type SmsError = {
   code: SmsErrorCode;
@@ -1942,15 +1942,15 @@ type WhatsAppTemplateCategory = string;
  */
 type TemplateScope = "system" | "workspace";
 /**
- * A template's send-by handle — the stable reference used in place of the template id when sending. Lowercase letters, numbers, hyphens, and underscores; starts and ends with a letter or number.
+ * A WhatsApp template's name — the stable handle used to reference the template when sending. Lowercase letters, numbers, and underscores.
  *
  */
-type TemplateName = string;
+type WhatsAppTemplateName = string;
 type WhatsAppTemplate = {
   /**
    * The template's stable handle. Pass it as the template reference when sending.
    */
-  readonly name: TemplateName;
+  readonly name: WhatsAppTemplateName;
   scope: TemplateScope;
   /**
    * The language code of this template variant (for example `en` or `pt_BR`).
@@ -1991,11 +1991,11 @@ type WhatsAppEvent = {
    */
   readonly occurred_at: string;
   /**
-   * Failure detail. Present on `whatsapp.failed` events; null otherwise.
+   * Failure detail. Present only on `whatsapp.failed` events.
    */
   error?: WhatsAppError;
 };
-type SendWhatsAppMessageRequest = {
+type WhatsAppMessageSendRequest = {
   /**
    * The message recipient's phone number in E.164 format (for example `+31612345678`).
    */
@@ -2004,7 +2004,7 @@ type SendWhatsAppMessageRequest = {
    * The template to send. Bird selects the sender number from the template's category, so there is no sender field on this request. Templates are currently the only supported content type, so every send must include one; free-text content will be added in a future release.
    *
    */
-  template?: SendWhatsAppMessageTemplate;
+  template?: WhatsAppTemplateSend;
   /**
    * Structured `{name, value}` labels for filtering. Tags become first-class query dimensions: filter the list endpoint by tag name. Maximum 20 tags per send. Use tags for low-cardinality dimensions (`category`, `experiment_variant`). For arbitrary structured context you do not need as a filter dimension, use `metadata` instead.
    *
@@ -2038,11 +2038,11 @@ type WhatsAppMessageTemplateComponent = {
    */
   parameters?: Array<WhatsAppMessageTemplateComponentParameter>;
 };
-type SendWhatsAppMessageTemplate = {
+type WhatsAppTemplateSend = {
   /**
    * The template to send, by its name (for example `bird_otp`).
    */
-  name: TemplateName;
+  name: WhatsAppTemplateName;
   /**
    * Language code of the template variant to send (for example `en` or `pt_BR`). May be omitted when the template has a single language.
    *
@@ -2066,7 +2066,7 @@ type WhatsAppMessageTemplate = {
   /**
    * The template's stable handle (for example `bird_otp`).
    */
-  readonly name: TemplateName;
+  readonly name: WhatsAppTemplateName;
   /**
    * Content classification applied to messages sent from this template.
    */
@@ -2081,33 +2081,6 @@ type WhatsAppMessageTemplate = {
    */
   readonly components: Array<WhatsAppMessageTemplateComponent>;
 };
-/**
- * Contact on the other end of the message. Fields are omitted when not available; at least one is always present.
- */
-type WhatsAppMessageContact = {
-  /**
-   * Contact's phone number in E.164 format, when known.
-   */
-  readonly phone_number?: string;
-  /**
-   * Business-scoped user ID (Meta's WhatsApp identifier for this contact within the business account), when available.
-   */
-  readonly bsuid?: string;
-};
-/**
- * The business identity that sent the message. `phone_number` is always present; `phone_number_id` is included only for account-owned numbers.
- *
- */
-type WhatsAppMessageBusiness = {
-  /**
-   * E.164 phone number of the WhatsApp business account that sent the message.
-   */
-  readonly phone_number?: string;
-  /**
-   * The WhatsApp phone number identifier. Present only for account-owned numbers.
-   */
-  readonly phone_number_id?: string;
-};
 type WhatsAppMessage = {
   /**
    * Message ID.
@@ -2117,15 +2090,21 @@ type WhatsAppMessage = {
    * Whether the message was sent by the business (`outbound`) or received from the contact (`inbound`).
    */
   readonly direction: "outbound" | "inbound";
-  readonly business: WhatsAppMessageBusiness;
-  readonly contact: WhatsAppMessageContact;
+  /**
+   * Sender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.
+   */
+  readonly from: WhatsAppAddress;
+  /**
+   * Recipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.
+   */
+  readonly to: WhatsAppAddress;
   /**
    * The template the message was sent from. For authentication templates the filled-in values are not returned.
    */
   readonly template?: WhatsAppMessageTemplate;
   readonly status: WhatsAppMessageStatus;
   /**
-   * Failure detail for a message that did not reach the recipient. Null when there is no failure.
+   * Failure detail for a message that did not reach the recipient. Present only when the message failed.
    */
   last_error?: WhatsAppError;
   /**
@@ -2290,6 +2269,11 @@ type TemplateVariable = {
  * Content classification. Drives opt-out (STOP) policy, quiet-hours, and per-country compliance.
  */
 type SmsMessageCategory = "transactional" | "marketing" | "authentication" | "service";
+/**
+ * A template's send-by handle — the stable reference used in place of the template id when sending. Lowercase letters, numbers, hyphens, and underscores; starts and ends with a letter or number.
+ *
+ */
+type TemplateName = string;
 type SmsTemplateId = string;
 type SmsTemplate = {
   /**
@@ -2487,7 +2471,7 @@ type SmsMessage = {
    */
   readonly mcc_mnc?: string | null;
   /**
-   * Failure detail on a terminally failed or rejected message. Null otherwise.
+   * Failure detail on a terminally failed or rejected message. Present only when the message failed.
    */
   last_error?: SmsError;
   /**
@@ -4420,7 +4404,7 @@ declare class SmsTemplatesResource extends Resource {
 //#endregion
 //#region src/resources/whatsapp.d.ts
 /** Body for `bird.whatsapp.send` — a template send; Bird picks the sender from the template's category. */
-type WhatsappSendParams = SendWhatsAppMessageRequest;
+type WhatsappSendParams = WhatsAppMessageSendRequest;
 /** Filters and cursor params for `bird.whatsapp.list`. */
 type WhatsappListQuery = NonNullable<ListWhatsAppMessagesData["query"]>;
 /** Filter for `bird.whatsapp.listEvents`. */

package/dist/index.mjs

@@ -3153,9 +3153,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.8.4`,
+			"User-Agent": `bird-sdk-js/0.9.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.8.4"
+			"Bird-Version": "0.9.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;