@messagebird/sdk 0.33.1 → 0.35.0

package/dist/index.d.mts

@@ -368,6 +368,8 @@ type WebhookEvent = ({
 } & EventSmsSent) | ({
   type: "sms.undelivered";
 } & EventSmsUndelivered) | ({
+  type: "sms_suppression.created";
+} & EventSmsSuppressionCreated) | ({
   type: "verify.attempt.delivered";
 } & EventVerifyAttemptDelivered) | ({
   type: "verify.attempt.sent";
@@ -4069,6 +4071,7 @@ type WhatsAppEventList = {
    */
   data: Array<WhatsAppEvent>;
 };
+type NumbersDedicatedAllocationId = string;
 /**
  * The window and bucket grain the response covers, echoed from the request, plus the freshness boundary the data is current to.
  *
@@ -7352,6 +7355,43 @@ type EventSmsUndelivered = {
   timestamp: string;
   data: EventSmsUndeliveredData;
 };
+/**
+ * Always `sms_suppression.created` for this event.
+ */
+type SmsSuppressionCreatedEventType = "sms_suppression.created";
+/**
+ * Payload of the sms_suppression.created event.
+ */
+type EventSmsSuppressionCreatedData = {
+  /**
+   * The suppression episode that was opened.
+   */
+  suppression_id: SmsSuppressionId;
+  /**
+   * The subscriber, in E.164 format.
+   */
+  destination: string;
+  /**
+   * The sender this stops. An SMS suppression is the exact (sender, recipient) pair, so your other senders still reach this subscriber.
+   */
+  originator: string;
+  reason: SmsSuppressionReason;
+  /**
+   * The workspace the suppression belongs to.
+   */
+  workspace_id: WorkspaceId;
+};
+/**
+ * A destination was added to the workspace's SMS suppression ledger: a subscriber's STOP, a carrier opt-out, or a manual add.
+ */
+type EventSmsSuppressionCreated = {
+  type: SmsSuppressionCreatedEventType;
+  /**
+   * When the episode's opening statement took effect (`effective_at`).
+   */
+  timestamp: string;
+  data: EventSmsSuppressionCreatedData;
+};
 /**
  * Identity fields shared by every Verify lifecycle event payload.
  */
@@ -8034,7 +8074,6 @@ type AvailableNumber = {
  */
 type NumbersOrderStatus$1 = "charging" | "ordering" | "pending" | "completed" | "failed" | (string & {});
 type NumbersOrderId = string;
-type NumbersDedicatedAllocationId = string;
 type NumbersOrder = {
   /**
    * Identifier of this purchase order.
@@ -9690,11 +9729,25 @@ type ListWhatsAppMessagesData = {
      */
     direction?: MessageDirection;
     /**
-     * Filter by contact phone number (E.164 exact match).
+     * Filter by recipient, exact match. The recipient is the contact on an outbound message and your business number on an inbound one, matching the `to` each message returns. Accepts an E.164 phone number, or a business-scoped user ID to name the contact. Only a contact is ever identified by a business-scoped user ID, so `to=<business-scoped user ID>` matches outbound messages only.
+     *
+     */
+    to?: string;
+    /**
+     * Filter by sender, exact match. The sender is your business number on an outbound message and the contact on an inbound one, matching the `from` each message returns. Accepts an E.164 phone number, or a business-scoped user ID to name the contact. Only a contact is ever identified by a business-scoped user ID, so `from=<business-scoped user ID>` matches inbound messages only.
+     *
+     */
+    from?: string;
+    /**
+     * Deprecated: use `to` or `from` instead, which also match a business-scoped user ID. Filters by contact phone number (E.164 exact match), in either direction.
+     *
+     *
+     * @deprecated
      */
     phone_number?: string;
     /**
-     * Filter by business-scoped user ID (Meta identifier).
+     * Filter by business-scoped user ID (Meta identifier), matching the contact in either direction. `to` and `from` also accept one, but each matches a single end of the message.
+     *
      */
     bsuid?: string;
     /**
@@ -12630,7 +12683,7 @@ declare class WhatsappResourceBase extends Resource {
    */
   get(messageId: string, options?: RequestOptions): APIPromise<WhatsAppMessage>;
   /**
-   * List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document or location. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, contact phone number, bsuid, template category, or tag. Use whatsapp_get for one message's current state.
+   * List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document or location. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, recipient (to), sender (from), business-scoped user ID (bsuid), template category, or tag. to and from each accept a phone number or a business-scoped user ID; pair either with direction to search a single side of the message. Use whatsapp_get for one message's current state.
    *
    * @example Iterate delivered messages
    * for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
@@ -13271,6 +13324,7 @@ declare const WebhookEventType: {
   readonly SmsReceived: "sms.received";
   readonly SmsRejected: "sms.rejected";
   readonly SmsSent: "sms.sent";
+  readonly SmsSuppressionCreated: "sms_suppression.created";
   readonly SmsUndelivered: "sms.undelivered";
   readonly VerifyAttemptDelivered: "verify.attempt.delivered";
   readonly VerifyAttemptSent: "verify.attempt.sent";

package/dist/index.mjs

@@ -2798,8 +2798,12 @@ const createVerificationNextChannel = (options) => (options.client ?? client).po
 * `image`, `video`, `audio`, `sticker`, `document` or `location`. An inbound
 * message whose content WhatsApp models and we do not carries `unsupported`
 * instead, naming the type rather than reading back empty.
-* Filter by direction, status, contact phone number,
-* business-scoped user ID, template category, tag, or creation time; pass the response's `next_cursor` back as
+* Filter by direction, status, recipient (`to`), sender (`from`),
+* business-scoped user ID (`bsuid`), template category, tag, or creation
+* time. `to` and `from` name the same ends of the message the response
+* does, and each accepts an E.164 phone number or a business-scoped user
+* ID. Pair either with `direction` to search a single side of the message.
+* Pass the response's `next_cursor` back as
 * `starting_after` to fetch the next page. To follow a single message's
 * delivery, use
 * [Get a WhatsApp message](/docs/api/reference/get-whatsapp-message)
@@ -6110,7 +6114,7 @@ var WhatsappResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document or location. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, contact phone number, bsuid, template category, or tag. Use whatsapp_get for one message's current state.
+	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Each message carries the one content it was built from: a template, or free-form text, image, video, audio, sticker, document or location. Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, recipient (to), sender (from), business-scoped user ID (bsuid), template category, or tag. to and from each accept a phone number or a business-scoped user ID; pair either with direction to search a single side of the message. Use whatsapp_get for one message's current state.
 	*
 	* @example Iterate delivered messages
 	* for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
@@ -7128,9 +7132,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.33.1`,
+			"User-Agent": `bird-sdk-js/0.35.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.33.1"
+			"Bird-Version": "0.35.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;
@@ -7261,6 +7265,7 @@ const WebhookEventType = {
 	SmsReceived: "sms.received",
 	SmsRejected: "sms.rejected",
 	SmsSent: "sms.sent",
+	SmsSuppressionCreated: "sms_suppression.created",
 	SmsUndelivered: "sms.undelivered",
 	VerifyAttemptDelivered: "verify.attempt.delivered",
 	VerifyAttemptSent: "verify.attempt.sent",