@messagebird/sdk 0.25.0 → 0.26.0

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.
  */
@@ -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.
  */
@@ -1203,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.
@@ -1228,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.
  */
@@ -2142,6 +2206,8 @@ type WebhookEvent = ({
 } & EventSmsExpired) | ({
   type: "sms.failed";
 } & EventSmsFailed) | ({
+  type: "sms.received";
+} & EventSmsReceived) | ({
   type: "sms.rejected";
 } & EventSmsRejected) | ({
   type: "sms.sent";
@@ -4726,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.
  *
@@ -9379,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";
@@ -9453,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";

package/dist/index.mjs

@@ -5238,9 +5238,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.25.0`,
+			"User-Agent": `bird-sdk-js/0.26.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.25.0"
+			"Bird-Version": "0.26.0"
 		};
 		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",
@@ -5432,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"