@messagebird/sdk 0.15.0 → 0.16.0

package/dist/index.d.mts

@@ -4251,15 +4251,15 @@ type WhatsAppMessageTemplateComponent = {
  */
 type WhatsAppLanguage = string;
 /**
- * A WhatsApp template's name — the stable handle used to reference the template when sending. Lowercase letters, numbers, and underscores.
+ * A template's slug: its permanent, workspace-unique handle and API address. Lowercase letters, numbers, hyphens, and underscores. Fixed at creation, so anything that references it never breaks; the display name is the label to change freely.
  *
  */
-type WhatsAppTemplateName = string;
+type TemplateSlug = string;
 type WhatsAppTemplateSend = {
   /**
-   * The template to send, by its name (for example `bird_otp`).
+   * The template to send, by its slug (for example `bird_otp`).
    */
-  name: WhatsAppTemplateName;
+  slug: TemplateSlug;
   /**
    * Language code of the template variant to send (for example `en` or `pt_BR`). May be omitted when the template has a single language; when it is stocked in several, omitting the language returns a `422` that names the available codes. The accepted message echoes the resolved language.
    *
@@ -4296,14 +4296,14 @@ type WhatsAppMessageStatus = "scheduled" | "accepted" | "sent" | "delivered" | "
  */
 type WhatsAppTemplateCategory = string;
 /**
- * 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).
+ * The template a message was sent from. On reads `slug`, `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).
  *
  */
 type WhatsAppMessageTemplate = {
   /**
    * The template's stable handle (for example `bird_otp`).
    */
-  readonly name: WhatsAppTemplateName;
+  readonly slug: TemplateSlug;
   /**
    * Content classification applied to messages sent from this template.
    */
@@ -5130,11 +5130,6 @@ type EmailMessageBatchRequest = Array<EmailMessageSendRequest>;
  * A language tag in BCP-47 form, for example `en` or `pt-BR`.
  */
 type LanguageTag = string;
-/**
- * A template's slug: its permanent, workspace-unique handle and API address. Lowercase letters, numbers, hyphens, and underscores. Fixed at creation, so anything that references it never breaks; the display name is the label to change freely.
- *
- */
-type TemplateSlug = string;
 type EmailTemplateSend = unknown & {
   /**
    * The template to send, by its id.
@@ -8625,7 +8620,7 @@ declare class WhatsappResource extends WhatsappResourceBase {
    * const msg = await bird.whatsapp.send({
    *   to: "+15551234567",
    *   template: {
-   *     name: "bird_otp",
+   *     slug: "bird_otp",
    *     components: [
    *       { type: "body", parameters: [{ type: "text", text: "123456" }] },
    *     ],

package/dist/index.mjs

@@ -2056,7 +2056,7 @@ const listWhatsAppMessages = (options) => (options?.client ?? client).get({
 * [List events for a WhatsApp message](/docs/api/reference/list-whats-app-message-events),
 * or `whatsapp.*` webhook events.
 *
-* A template name or language the catalogue does not stock, parameter values
+* A template slug or language the catalogue does not stock, parameter values
 * that do not match the template's declared placeholders, and a recipient
 * that is not a valid phone number each return a `422`.
 *
@@ -4623,7 +4623,7 @@ var WhatsappResource = class extends WhatsappResourceBase {
 	* const msg = await bird.whatsapp.send({
 	*   to: "+15551234567",
 	*   template: {
-	*     name: "bird_otp",
+	*     slug: "bird_otp",
 	*     components: [
 	*       { type: "body", parameters: [{ type: "text", text: "123456" }] },
 	*     ],
@@ -5040,9 +5040,9 @@ var BirdClient = class {
 		this.#headers = {
 			...opts.defaultHeaders,
 			Authorization: `Bearer ${opts.apiKey}`,
-			"User-Agent": `bird-sdk-js/0.15.0`,
+			"User-Agent": `bird-sdk-js/0.16.0`,
 			"Bird-Surface": "sdk-js",
-			"Bird-Version": "0.15.0"
+			"Bird-Version": "0.16.0"
 		};
 		const caller = detectCaller();
 		if (caller) this.#headers["Bird-Caller"] = caller;