@messagebird/sdk 0.10.0 → 0.11.0

package/dist/index.d.mts

@@ -358,30 +358,21 @@ type EventWhatsAppSent = {
   data: EventWhatsAppSentData;
 };
 /**
- * Payload of the whatsapp.read event.
- */
-type EventWhatsAppReadData = EventWhatsAppBase;
-/**
- * The recipient read the message.
+ * Payload of the whatsapp.rejected event.
  */
-type EventWhatsAppRead = {
+type EventWhatsAppRejectedData = EventWhatsAppBase & {
   /**
-   * Event type.
-   */
-  type: "whatsapp.read";
-  /**
-   * Time the recipient read the message.
+   * Why the message was rejected before sending.
    */
-  timestamp: string;
-  data: EventWhatsAppReadData;
+  error: WhatsAppError;
 };
 /**
- * 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 (for example not on WhatsApp, or the number is 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. Open enum: new codes may be added over time, so treat any unrecognized value as a future code rather than an error.
+ * 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 (for example not on WhatsApp, or the number is 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. `recipient_suppressed`: the recipient is on the workspace's suppression list; the message was rejected before sending. Open enum: new codes may be added over time, so treat any unrecognized value as a future code rather than an error.
  *
  */
 type WhatsAppErrorCode = string;
 /**
- * Failure detail for a message that could not be delivered.
+ * Failure detail for a message that could not be delivered or was rejected.
  */
 type WhatsAppError = {
   code: WhatsAppErrorCode;
@@ -398,6 +389,38 @@ type WhatsAppError = {
    */
   readonly occurred_at: string;
 } | null;
+/**
+ * Bird rejected the message before sending it to WhatsApp (the recipient is on the workspace suppression list).
+ */
+type EventWhatsAppRejected = {
+  /**
+   * Event type.
+   */
+  type: "whatsapp.rejected";
+  /**
+   * Time the rejection was recorded.
+   */
+  timestamp: string;
+  data: EventWhatsAppRejectedData;
+};
+/**
+ * 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;
+};
 /**
  * Payload of the whatsapp.failed event.
  */
@@ -458,7 +481,7 @@ type EventWhatsAppAccepted = {
   data: EventWhatsAppAcceptedData;
 };
 /**
- * Payload of the voice.call.initiated event.
+ * Payload of the voice_call.initiated event.
  */
 type EventVoiceCallInitiatedData = EventVoiceBase;
 /**
@@ -500,7 +523,7 @@ type EventVoiceCallInitiated = {
   /**
    * Event type.
    */
-  type: "voice.call.initiated";
+  type: "voice_call.initiated";
   /**
    * Time the call was initiated.
    */
@@ -513,7 +536,7 @@ type EventVoiceCallInitiated = {
  */
 type VoiceCallStatus = "answered" | "no_answer" | "busy" | "canceled" | "failed" | "rejected" | "unknown" | "ringing" | "in_progress";
 /**
- * Payload of the voice.call.ended event.
+ * Payload of the voice_call.ended event.
  */
 type EventVoiceCallEndedData = EventVoiceBase & {
   status: VoiceCallStatus;
@@ -537,7 +560,7 @@ type EventVoiceCallEnded = {
   /**
    * Event type.
    */
-  type: "voice.call.ended";
+  type: "voice_call.ended";
   /**
    * When the call ended (BYE or final non-2xx response).
    */
@@ -545,7 +568,7 @@ type EventVoiceCallEnded = {
   data: EventVoiceCallEndedData;
 };
 /**
- * Payload of the voice.call.answered event.
+ * Payload of the voice_call.answered event.
  */
 type EventVoiceCallAnsweredData = EventVoiceBase;
 /**
@@ -555,7 +578,7 @@ type EventVoiceCallAnswered = {
   /**
    * Event type.
    */
-  type: "voice.call.answered";
+  type: "voice_call.answered";
   /**
    * Time the call was answered.
    */
@@ -1795,11 +1818,11 @@ type WebhookEvent = ({
 } & EventSmsTfnVerificationSubmitted) | ({
   type: "sms.undelivered";
 } & EventSmsUndelivered) | ({
-  type: "voice.call.answered";
+  type: "voice_call.answered";
 } & EventVoiceCallAnswered) | ({
-  type: "voice.call.ended";
+  type: "voice_call.ended";
 } & EventVoiceCallEnded) | ({
-  type: "voice.call.initiated";
+  type: "voice_call.initiated";
 } & EventVoiceCallInitiated) | ({
   type: "whatsapp.accepted";
 } & EventWhatsAppAccepted) | ({
@@ -1809,6 +1832,8 @@ type WebhookEvent = ({
 } & EventWhatsAppFailed) | ({
   type: "whatsapp.read";
 } & EventWhatsAppRead) | ({
+  type: "whatsapp.rejected";
+} & EventWhatsAppRejected) | ({
   type: "whatsapp.sent";
 } & EventWhatsAppSent);
 type Timestamps = {
@@ -3339,10 +3364,10 @@ type WhatsAppTemplateSend = {
   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. 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` (an inbound message, `direction: inbound`, sent to you by a contact).
+ * 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 the recipient is on the workspace's suppression list; the 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` (an inbound message, `direction: inbound`, sent to you by a contact).
  *
  */
-type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "failed" | "canceled" | "received";
+type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "failed" | "rejected" | "canceled" | "received";
 /**
  * The template a message was sent from. On reads `name`, `language`, `category`, and `components` are always present; `components` is an empty array for an authentication template (the filled-in values, for example a verification code, are never returned).
  *
@@ -4551,11 +4576,11 @@ type ListEmailMessagesData = {
      */
     ending_before?: string;
     /**
-     * Return only resources created strictly after this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created at or after this timestamp (inclusive lower bound). Combine with `created_before` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_after?: string;
     /**
-     * Return only resources created strictly before this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created strictly before this timestamp (exclusive upper bound). Combine with `created_after` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_before?: string;
     /**
@@ -4702,11 +4727,11 @@ type ListSmsMessagesData = {
      */
     ending_before?: string;
     /**
-     * Return only resources created strictly after this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created at or after this timestamp (inclusive lower bound). Combine with `created_before` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_after?: string;
     /**
-     * Return only resources created strictly before this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created strictly before this timestamp (exclusive upper bound). Combine with `created_after` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_before?: string;
     /**
@@ -4781,11 +4806,11 @@ type ListWhatsAppMessagesData = {
      */
     ending_before?: string;
     /**
-     * Return only resources created strictly after this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created at or after this timestamp (inclusive lower bound). Combine with `created_before` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_after?: string;
     /**
-     * Return only resources created strictly before this timestamp. RFC 3339 / ISO 8601 with timezone.
+     * Return only resources created strictly before this timestamp (exclusive upper bound). Combine with `created_after` to filter to a time window. RFC 3339 / ISO 8601 with timezone.
      */
     created_before?: string;
     /**
@@ -6937,13 +6962,14 @@ declare const WebhookEventType: {
   readonly SmsTfnVerificationRejected: "sms.tfn_verification.rejected";
   readonly SmsTfnVerificationSubmitted: "sms.tfn_verification.submitted";
   readonly SmsUndelivered: "sms.undelivered";
-  readonly VoiceCallAnswered: "voice.call.answered";
-  readonly VoiceCallEnded: "voice.call.ended";
-  readonly VoiceCallInitiated: "voice.call.initiated";
+  readonly VoiceCallAnswered: "voice_call.answered";
+  readonly VoiceCallEnded: "voice_call.ended";
+  readonly VoiceCallInitiated: "voice_call.initiated";
   readonly WhatsappAccepted: "whatsapp.accepted";
   readonly WhatsappDelivered: "whatsapp.delivered";
   readonly WhatsappFailed: "whatsapp.failed";
   readonly WhatsappRead: "whatsapp.read";
+  readonly WhatsappRejected: "whatsapp.rejected";
   readonly WhatsappSent: "whatsapp.sent";
 };
 /** A known webhook event type value. */

package/dist/index.mjs

@@ -3935,9 +3935,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.10.0`,
+			"User-Agent": `bird-sdk-js/0.11.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.10.0"
+			"Bird-Version": "0.11.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -4060,13 +4060,14 @@ const WebhookEventType = {
 	SmsTfnVerificationRejected: "sms.tfn_verification.rejected",
 	SmsTfnVerificationSubmitted: "sms.tfn_verification.submitted",
 	SmsUndelivered: "sms.undelivered",
-	VoiceCallAnswered: "voice.call.answered",
-	VoiceCallEnded: "voice.call.ended",
-	VoiceCallInitiated: "voice.call.initiated",
+	VoiceCallAnswered: "voice_call.answered",
+	VoiceCallEnded: "voice_call.ended",
+	VoiceCallInitiated: "voice_call.initiated",
 	WhatsappAccepted: "whatsapp.accepted",
 	WhatsappDelivered: "whatsapp.delivered",
 	WhatsappFailed: "whatsapp.failed",
 	WhatsappRead: "whatsapp.read",
+	WhatsappRejected: "whatsapp.rejected",
 	WhatsappSent: "whatsapp.sent"
 };
 //#endregion