@messagebird/sdk 0.21.2 → 0.23.0

package/README.md

@@ -1,6 +1,6 @@
 # @messagebird/sdk
 
-The official TypeScript SDK for the [Bird](https://bird.com) API — fully typed, edge-ready, ESM.
+The official TypeScript SDK for the [Bird](https://bird.com) API: email, SMS, WhatsApp, verification, and Realtime, over one typed client. Fully typed, edge-ready, ESM.
 
 📚 **Documentation:** https://bird.com/docs/sdks/typescript
 

package/dist/index.d.mts

@@ -4508,42 +4508,29 @@ type SmsBatchSummary = {
   accepted_count: number;
 };
 /**
- * Per-component cost breakdown. Returned on single-message reads; omitted from list rows.
+ * What was charged for a message, split into the components that make it up. Null until at least one component has been priced.
+ *
  */
-type SmsCostBreakdown = {
-  /**
-   * Per-segment price as a decimal string.
-   */
-  per_segment: string;
-  /**
-   * Number of billable segments.
-   */
-  segments: number;
+type MessageCost = {
   /**
-   * ISO 3166-1 alpha-2 destination country the price was resolved for.
-   */
-  country_code: string;
-  /**
-   * Carrier surcharge component as a decimal string (for example US 10DLC fees). `0.0000` when none applies.
+   * Total charged, as a decimal string: the sum of the components below. Net of tax, which applies to your wallet balance rather than to an individual charge.
+   *
    */
-  carrier_surcharge: string;
-};
-/**
- * Cost of the message. Null until the message has been priced; the cost is populated as the message is processed, not at the moment it is accepted.
- */
-type SmsCost = {
+  readonly amount: string;
   /**
-   * ISO 4217 currency code for the cost amount. Omitted when the cost is not denominated in a currency (for example a zero-priced internal send).
+   * ISO 4217 currency code. Every component is denominated in this currency.
    */
-  readonly currency_code?: CurrencyCode;
+  readonly currency_code: CurrencyCode;
   /**
-   * Total cost as a decimal string: the per-segment rate multiplied by the segment count, plus any surcharges.
+   * What Bird charged to carry the message, as a decimal string. Null when this component was not priced; `"0.00000"` when it priced at zero.
+   *
    */
-  readonly amount: string;
+  readonly transaction_amount: string | null;
   /**
-   * Per-component cost breakdown. Returned on single-message reads; omitted from list rows.
+   * Third-party fees Bird passes on, as a decimal string, such as US 10DLC carrier surcharges. Null when this component was not priced; `"0.00000"` when it priced at zero.
+   *
    */
-  breakdown?: SmsCostBreakdown;
+  readonly passthrough_amount: string | null;
 } | null;
 /**
  * Segment breakdown for the message body. Segment count drives billing.
@@ -4601,9 +4588,9 @@ type SmsMessage = {
    */
   segments: SmsSegments;
   /**
-   * Cost of the message. Null until the message has been priced.
+   * What the message cost, split into Bird's charge and any third-party fees passed through. Null until the message has been priced.
    */
-  cost?: SmsCost;
+  cost?: MessageCost;
   /**
    * Structured `{name, value}` filter labels applied to this message.
    */
@@ -6277,6 +6264,10 @@ type ListWhatsAppMessagesData = {
      * Filter by business-scoped user ID (Meta identifier).
      */
     bsuid?: string;
+    /**
+     * Filter by category.
+     */
+    category?: WhatsAppTemplateCategory$1;
     /**
      * Filter by tag. Accepts `name` to match any message carrying that tag name, or `name:value` to match a specific tag pair (e.g. `category:welcome`). Repeat the parameter to AND-combine several tag filters.
      *
@@ -8676,7 +8667,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, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, contact phone number, bsuid, or tag. Use whatsapp_get for one message's current state.
+   * List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). 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.
    *
    * @example Iterate delivered messages
    * for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {

package/dist/index.mjs

@@ -2140,7 +2140,7 @@ const createVerificationCheck = (options) => (options.client ?? client).post({
 /**
 * List WhatsApp messages
 *
-* Returns the workspace's WhatsApp messages as a cursor-paginated list, newest first. Filter by direction, status, contact phone number, business-scoped user ID, tag, or creation time; 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-whats-app-message) instead.
+* Returns the workspace's WhatsApp messages as a cursor-paginated list, newest first. 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 `starting_after` to fetch the next page. To follow a single message's delivery, use [Get a WhatsApp message](/docs/api/reference/get-whats-app-message) instead.
 *
 */
 const listWhatsAppMessages = (options) => (options?.client ?? client).get({
@@ -4701,7 +4701,7 @@ var WhatsappResourceBase = class extends Resource {
 		}));
 	}
 	/**
-	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by direction, status, contact phone number, bsuid, or tag. Use whatsapp_get for one message's current state.
+	* List WhatsApp messages, newest first, as a cursor page ({data, next_cursor, …}). 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.
 	*
 	* @example Iterate delivered messages
 	* for await (const msg of bird.whatsapp.list({ status: ["delivered"] })) {
@@ -5109,9 +5109,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.21.2`,
+			"User-Agent": `bird-sdk-js/0.23.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.21.2"
+			"Bird-Version": "0.23.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;