@messagebird/sdk 0.33.0 → 0.34.0

package/dist/index.d.mts

@@ -4069,6 +4069,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.
  *
@@ -5517,6 +5518,21 @@ type DomainUpdate = {
   inbound?: DomainInboundConfig;
 };
 type SuppressionId = string;
+type Actor = {
+  /**
+   * Actor identifier.
+   */
+  id: string;
+  /**
+   * Who or what performed the action: `user` for a member's own session, `oauth_token` for a token issued to a caller on a member's behalf, `api_key` for a workspace API key, `system` for our own automation, `sso` for an organization's SSO connection, and `service_account` for a workspace's connected Integration acting with no member behind it. Open enum: new actor types may be added over time, so treat any unrecognized value as a future type rather than an error.
+   */
+  type: string;
+  /**
+   * The label the actor is shown under: typically a member's name or email address, or the API key's name. Null when it could not be resolved.
+   *
+   */
+  readonly display_name?: string | null;
+};
 type InboundAddressId = string;
 type InboundEmailMessageId = string;
 type MailboxId = string;
@@ -7910,21 +7926,6 @@ type EventWhatsAppSent = {
   timestamp: string;
   data: EventWhatsAppSentData;
 };
-type AuditLogActor = {
-  /**
-   * ID of the user, API key, integration, or system process that performed the action.
-   */
-  id: string;
-  /**
-   * Type of actor, such as `user`, `api_key`, `service_account`, or `system`.
-   */
-  type: string;
-  /**
-   * Display name of the actor. This is the user's email address for a `user` actor, or the name of the API key or integration that acted. Absent when it could not be resolved.
-   *
-   */
-  readonly display_name?: string | null;
-};
 /**
  * Physical type of a phone number. New number types may be added over time, so treat unrecognized values as supported types rather than errors.
  */
@@ -8034,7 +8035,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.
@@ -8181,7 +8181,7 @@ type VoiceCall = {
   /**
    * Who placed the call: the API key whose credentials it used, the integration acting for the workspace, or the user who placed it from a browser or the CLI. Absent when the call was admitted only by its source IP address, or when no actor was recorded.
    */
-  readonly actor?: AuditLogActor;
+  readonly actor?: Actor;
   /**
    * Identifier of the SIP trunk that originated this call. `null` when no trunk is associated.
    */
@@ -9690,11 +9690,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 +12644,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"] })) {

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.0`,
+			"User-Agent": `bird-sdk-js/0.34.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.33.0"
+			"Bird-Version": "0.34.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;