@messagebird/sdk 0.8.0 → 0.8.1

package/dist/index.d.mts

@@ -269,6 +269,194 @@ interface PaginatedPromise<T> extends Promise<CursorPage<T>>, AsyncIterable<T> {
 }
 //#endregion
 //#region src/generated/types.gen.d.ts
+/**
+ * Payload of the whatsapp.sent event.
+ */
+type EventWhatsAppSentData = EventWhatsAppBase;
+/**
+ * Structured key/value label attached to a message. Surfaces in list filters, the event log, and webhook payloads. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID). For arbitrary per-send context that does not need to be filterable, use `metadata`.
+ * Tag count and per-tag size are capped to keep per-send tag payloads small — see the send request for the array maximum. Tag names are unique within a send; supplying the same name twice is rejected.
+ *
+ */
+type Tag = {
+  /**
+   * Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
+   *
+   */
+  name: string;
+  /**
+   * Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
+   *
+   */
+  value: string;
+};
+/**
+ * Sender or recipient of a WhatsApp message — a phone number, a business-scoped user ID, or both.
+ */
+type WhatsAppAddress = {
+  /**
+   * Phone number in E.164 format, when known.
+   */
+  phone_number?: string;
+  /**
+   * Business-scoped user ID — Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
+   *
+   */
+  bsuid?: string;
+};
+type WorkspaceId = string;
+type WhatsAppMessageId = string;
+/**
+ * Identity fields shared by every WhatsApp lifecycle event payload.
+ */
+type EventWhatsAppBase = {
+  /**
+   * ID of the WhatsApp message.
+   */
+  whatsapp_id: WhatsAppMessageId;
+  /**
+   * ID of the workspace.
+   */
+  workspace_id: WorkspaceId;
+  /**
+   * Whether the message was sent by the business (`outbound`) or received from the contact (`inbound`).
+   */
+  direction: "outbound" | "inbound";
+  /**
+   * Sender of the message. On outbound messages, the business number it was sent from.
+   */
+  from: WhatsAppAddress;
+  /**
+   * Recipient of the message. On outbound messages, the WhatsApp contact.
+   */
+  to: WhatsAppAddress;
+  /**
+   * Tags provided on the send request, echoed on every event for the message. Null when the message carried no tags.
+   *
+   */
+  tags: Array<Tag> | null;
+  /**
+   * The metadata object provided on the send request, echoed on every event for the message. Null when the message carried no metadata.
+   *
+   */
+  metadata: {
+    [key: string]: unknown;
+  } | null;
+};
+/**
+ * Bird handed the message to Meta for delivery.
+ */
+type EventWhatsAppSent = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.sent";
+  /**
+   * Time Bird handed the message to Meta for delivery.
+   */
+  timestamp: string;
+  data: EventWhatsAppSentData;
+};
+/**
+ * Payload of the whatsapp.read event.
+ */
+type EventWhatsAppReadData = EventWhatsAppBase;
+/**
+ * The recipient read the message.
+ */
+type EventWhatsAppRead = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.read";
+  /**
+   * Time the recipient read the message.
+   */
+  timestamp: string;
+  data: EventWhatsAppReadData;
+};
+/**
+ * Bird-stable failure reason, uniform whether the failure happened internally or was reported by the WhatsApp network. `insufficient_balance` — the workspace could not afford the send. `price_not_found` — no price was configured for this destination/template combination. `internal_error` — an unexpected Bird-side failure. `undeliverable` — the recipient could not be reached (e.g. not on WhatsApp, number invalid). `service_window_expired` — the 24-hour customer care window has closed and a free-form message cannot be sent; send a template instead. `rate_limited` — the send was throttled.
+ *
+ */
+type WhatsAppErrorCode = string;
+/**
+ * Failure detail for a message that could not be delivered. Null when there is no failure.
+ */
+type WhatsAppError = {
+  code: WhatsAppErrorCode;
+  /**
+   * Human-readable explanation of the failure.
+   */
+  readonly description: string;
+  /**
+   * Raw error code from the WhatsApp Cloud API, when available, for low-level debugging.
+   */
+  readonly meta_error_code?: string | null;
+  /**
+   * When the failure occurred.
+   */
+  readonly occurred_at: string;
+} | null;
+/**
+ * Payload of the whatsapp.failed event.
+ */
+type EventWhatsAppFailedData = EventWhatsAppBase & {
+  /**
+   * Why the message terminally failed.
+   */
+  error: WhatsAppError;
+};
+/**
+ * The message terminally failed and will not be delivered.
+ */
+type EventWhatsAppFailed = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.failed";
+  /**
+   * Time the failure was recorded.
+   */
+  timestamp: string;
+  data: EventWhatsAppFailedData;
+};
+/**
+ * Payload of the whatsapp.delivered event.
+ */
+type EventWhatsAppDeliveredData = EventWhatsAppBase;
+/**
+ * The message was delivered to the recipient's device.
+ */
+type EventWhatsAppDelivered = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.delivered";
+  /**
+   * Time the message was delivered to the recipient's device.
+   */
+  timestamp: string;
+  data: EventWhatsAppDeliveredData;
+};
+/**
+ * Payload of the whatsapp.accepted event.
+ */
+type EventWhatsAppAcceptedData = EventWhatsAppBase;
+/**
+ * Bird accepted and charged the send request.
+ */
+type EventWhatsAppAccepted = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.accepted";
+  /**
+   * Time Bird accepted and charged the send request.
+   */
+  timestamp: string;
+  data: EventWhatsAppAcceptedData;
+};
 /**
  * Payload of the sms.undelivered event.
  */
@@ -301,24 +489,6 @@ type SmsError = {
    */
   occurred_at: string;
 } | null;
-/**
- * Structured key/value label attached to a message. Surfaces in list filters, the event log, and webhook payloads. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID). For arbitrary per-send context that does not need to be filterable, use `metadata`.
- * Tag count and per-tag size are capped to keep per-send tag payloads small — see the send request for the array maximum. Tag names are unique within a send; supplying the same name twice is rejected.
- *
- */
-type Tag = {
-  /**
-   * Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
-   *
-   */
-  name: string;
-  /**
-   * Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
-   *
-   */
-  value: string;
-};
-type WorkspaceId = string;
 type SmsMessageId = string;
 /**
  * Identity fields shared by every SMS lifecycle event payload.
@@ -1388,7 +1558,17 @@ type WebhookEvent = ({
   type: "sms.sent";
 } & EventSmsSent) | ({
   type: "sms.undelivered";
-} & EventSmsUndelivered);
+} & EventSmsUndelivered) | ({
+  type: "whatsapp.accepted";
+} & EventWhatsAppAccepted) | ({
+  type: "whatsapp.delivered";
+} & EventWhatsAppDelivered) | ({
+  type: "whatsapp.failed";
+} & EventWhatsAppFailed) | ({
+  type: "whatsapp.read";
+} & EventWhatsAppRead) | ({
+  type: "whatsapp.sent";
+} & EventWhatsAppSent);
 type Timestamps = {
   readonly created_at: string;
   readonly updated_at: string;
@@ -1785,29 +1965,6 @@ type WhatsAppEventList = {
    */
   data: Array<WhatsAppEvent>;
 };
-/**
- * Bird-stable failure reason, uniform whether the failure happened internally or was reported by the WhatsApp network. `insufficient_balance` — the workspace could not afford the send. `price_not_found` — no price was configured for this destination/template combination. `internal_error` — an unexpected Bird-side failure. `undeliverable` — the recipient could not be reached (e.g. not on WhatsApp, number invalid). `service_window_expired` — the 24-hour customer care window has closed and a free-form message cannot be sent; send a template instead. `rate_limited` — the send was throttled.
- *
- */
-type WhatsAppErrorCode = string;
-/**
- * Failure detail for a message that could not be delivered. Null when there is no failure.
- */
-type WhatsAppError = {
-  code: WhatsAppErrorCode;
-  /**
-   * Human-readable explanation of the failure.
-   */
-  readonly description: string;
-  /**
-   * Raw error code from the WhatsApp Cloud API, when available, for low-level debugging.
-   */
-  readonly meta_error_code?: string | null;
-  /**
-   * When the failure occurred.
-   */
-  readonly occurred_at: string;
-} | null;
 type WhatsAppEventId = string;
 type WhatsAppEvent = {
   /**
@@ -1826,7 +1983,7 @@ type WhatsAppEvent = {
   /**
    * Failure detail. Present on `whatsapp.failed` events; null otherwise.
    */
-  error: WhatsAppError;
+  error?: WhatsAppError;
 };
 type SendWhatsAppMessageRequest = {
   /**
@@ -1941,7 +2098,6 @@ type WhatsAppMessageBusiness = {
    */
   readonly phone_number_id?: string;
 };
-type WhatsAppMessageId = string;
 type WhatsAppMessage = {
   /**
    * Message ID.
@@ -4580,6 +4736,11 @@ declare const WebhookEventType: {
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
   readonly SmsUndelivered: "sms.undelivered";
+  readonly WhatsappAccepted: "whatsapp.accepted";
+  readonly WhatsappDelivered: "whatsapp.delivered";
+  readonly WhatsappFailed: "whatsapp.failed";
+  readonly WhatsappRead: "whatsapp.read";
+  readonly WhatsappSent: "whatsapp.sent";
 };
 /** A known webhook event type value. */
 type WebhookEventTypeValue = (typeof WebhookEventType)[keyof typeof WebhookEventType];

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.0`,
+			"User-Agent": `bird-sdk-js/0.8.1`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.8.0"
+			"Bird-Version": "0.8.1"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -3273,7 +3273,12 @@ const WebhookEventType = {
 	SmsFailed: "sms.failed",
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
-	SmsUndelivered: "sms.undelivered"
+	SmsUndelivered: "sms.undelivered",
+	WhatsappAccepted: "whatsapp.accepted",
+	WhatsappDelivered: "whatsapp.delivered",
+	WhatsappFailed: "whatsapp.failed",
+	WhatsappRead: "whatsapp.read",
+	WhatsappSent: "whatsapp.sent"
 };
 //#endregion
 export { BirdAPIError, BirdAuthError, BirdBadRequestError, BirdBillingError, BirdClient, BirdConflictError, BirdConnectionError, BirdError, BirdInternalError, BirdMisdirectedError, BirdNotFoundError, BirdNotImplementedError, BirdPayloadTooLargeError, BirdPermissionError, BirdPreconditionError, BirdRateLimitError, BirdServiceUnavailableError, BirdTimeoutError, BirdValidationError, BirdWebhookVerificationError, WebhookEventType, baseUrlForRegion, regionFromApiKey };