@getlatedev/node 0.2.243 → 0.2.245

package/README.md

@@ -554,7 +554,7 @@ try {
 | Method | Description |
 |--------|-------------|
 | `messages.listInboxConversations()` | List conversations |
-| `messages.createInboxConversation()` | Create conversation |
+| `messages.createInboxConversation()` | Create conversation (send a WhatsApp template) |
 | `messages.getInboxConversation()` | Get conversation |
 | `messages.getInboxConversationMessages()` | List messages |
 | `messages.updateInboxConversation()` | Update conversation status |

package/dist/index.d.mts

@@ -12690,32 +12690,68 @@ type SendInboxMessageData = {
             phone?: string;
         }>;
         /**
-         * Generic template for carousels (Instagram/Facebook only, ignored on Telegram).
+         * Platform-dependent template payload. Ignored on Telegram.
+         *
+         * Instagram / Facebook: a generic template (carousel). Set `type: generic`
+         * and provide up to 10 `elements`, each with a `title` (required) and
+         * optional `subtitle`, `imageUrl`, and `buttons`.
+         *
+         * WhatsApp: sends an approved WhatsApp template message, the only message
+         * type WhatsApp accepts when the 24-hour customer-service window is closed.
+         * Provide exactly one element carrying the template reference:
+         * `{ "elements": [{ "name": "order_update", "language": "en_US", "components": [...] }] }`
+         * (`type` is ignored on WhatsApp). `components` is optional and is forwarded
+         * unchanged as the `template.components` array of Meta's Cloud API send
+         * payload; use it to fill body/header variables and button parameters, e.g.
+         * `[{ "type": "body", "parameters": [{ "type": "text", "text": "John" }] }]`.
+         * Templates with media headers (image, video, document) must include the
+         * header component with its media link here at send time. To send a template
+         * to a phone number with no existing conversation, or to have media headers
+         * filled in automatically from the template definition, use the
+         * create-conversation endpoint (POST /v1/inbox/conversations) instead.
+         *
          */
         template?: {
             /**
-             * Template type
+             * Template type. Required for Instagram/Facebook generic templates; ignored on WhatsApp.
              */
             type?: 'generic';
             elements?: Array<{
                 /**
-                 * Element title (max 80 chars)
+                 * Element title (max 80 chars). Required for Instagram/Facebook generic templates.
                  */
-                title: string;
+                title?: string;
                 /**
-                 * Element subtitle
+                 * Element subtitle (Instagram/Facebook only)
                  */
                 subtitle?: string;
                 /**
-                 * Element image URL
+                 * Element image URL (Instagram/Facebook only)
                  */
                 imageUrl?: string;
+                /**
+                 * Element buttons (Instagram/Facebook only)
+                 */
                 buttons?: Array<{
                     type?: 'url' | 'postback';
                     title?: string;
                     url?: string;
                     payload?: string;
                 }>;
+                /**
+                 * WhatsApp only. Name of the approved template to send.
+                 */
+                name?: string;
+                /**
+                 * WhatsApp only. Template language code (e.g. en_US).
+                 */
+                language?: string;
+                /**
+                 * WhatsApp only. Meta Cloud API send-shape components array, forwarded to Meta verbatim.
+                 */
+                components?: Array<{
+                    [key: string]: unknown;
+                }>;
             }>;
         };
         /**
@@ -14847,6 +14883,16 @@ type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
+         *
+         */
+        purchaseIntentId?: string;
+        /**
+         * Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
+         *
+         */
+        allowMultiple?: boolean;
     };
 };
 type PurchaseWhatsAppPhoneNumberResponse = (({
@@ -14863,6 +14909,10 @@ type PurchaseWhatsAppPhoneNumberResponse = (({
         metaPreverifiedId?: string;
         metaVerificationStatus?: string;
     };
+} | {
+    status?: 'already_purchased';
+    numberId?: string;
+    phoneNumber?: string;
 }) | {
     status?: 'kyc_required';
     country?: string;
@@ -14870,6 +14920,9 @@ type PurchaseWhatsAppPhoneNumberResponse = (({
 });
 type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
+} | {
+    error?: string;
+    code?: 'PURCHASE_VELOCITY';
 });
 type ListWhatsAppNumberCountriesResponse = ({
     countries?: Array<{

package/dist/index.d.ts

@@ -12690,32 +12690,68 @@ type SendInboxMessageData = {
             phone?: string;
         }>;
         /**
-         * Generic template for carousels (Instagram/Facebook only, ignored on Telegram).
+         * Platform-dependent template payload. Ignored on Telegram.
+         *
+         * Instagram / Facebook: a generic template (carousel). Set `type: generic`
+         * and provide up to 10 `elements`, each with a `title` (required) and
+         * optional `subtitle`, `imageUrl`, and `buttons`.
+         *
+         * WhatsApp: sends an approved WhatsApp template message, the only message
+         * type WhatsApp accepts when the 24-hour customer-service window is closed.
+         * Provide exactly one element carrying the template reference:
+         * `{ "elements": [{ "name": "order_update", "language": "en_US", "components": [...] }] }`
+         * (`type` is ignored on WhatsApp). `components` is optional and is forwarded
+         * unchanged as the `template.components` array of Meta's Cloud API send
+         * payload; use it to fill body/header variables and button parameters, e.g.
+         * `[{ "type": "body", "parameters": [{ "type": "text", "text": "John" }] }]`.
+         * Templates with media headers (image, video, document) must include the
+         * header component with its media link here at send time. To send a template
+         * to a phone number with no existing conversation, or to have media headers
+         * filled in automatically from the template definition, use the
+         * create-conversation endpoint (POST /v1/inbox/conversations) instead.
+         *
          */
         template?: {
             /**
-             * Template type
+             * Template type. Required for Instagram/Facebook generic templates; ignored on WhatsApp.
              */
             type?: 'generic';
             elements?: Array<{
                 /**
-                 * Element title (max 80 chars)
+                 * Element title (max 80 chars). Required for Instagram/Facebook generic templates.
                  */
-                title: string;
+                title?: string;
                 /**
-                 * Element subtitle
+                 * Element subtitle (Instagram/Facebook only)
                  */
                 subtitle?: string;
                 /**
-                 * Element image URL
+                 * Element image URL (Instagram/Facebook only)
                  */
                 imageUrl?: string;
+                /**
+                 * Element buttons (Instagram/Facebook only)
+                 */
                 buttons?: Array<{
                     type?: 'url' | 'postback';
                     title?: string;
                     url?: string;
                     payload?: string;
                 }>;
+                /**
+                 * WhatsApp only. Name of the approved template to send.
+                 */
+                name?: string;
+                /**
+                 * WhatsApp only. Template language code (e.g. en_US).
+                 */
+                language?: string;
+                /**
+                 * WhatsApp only. Meta Cloud API send-shape components array, forwarded to Meta verbatim.
+                 */
+                components?: Array<{
+                    [key: string]: unknown;
+                }>;
             }>;
         };
         /**
@@ -14847,6 +14883,16 @@ type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
+         *
+         */
+        purchaseIntentId?: string;
+        /**
+         * Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
+         *
+         */
+        allowMultiple?: boolean;
     };
 };
 type PurchaseWhatsAppPhoneNumberResponse = (({
@@ -14863,6 +14909,10 @@ type PurchaseWhatsAppPhoneNumberResponse = (({
         metaPreverifiedId?: string;
         metaVerificationStatus?: string;
     };
+} | {
+    status?: 'already_purchased';
+    numberId?: string;
+    phoneNumber?: string;
 }) | {
     status?: 'kyc_required';
     country?: string;
@@ -14870,6 +14920,9 @@ type PurchaseWhatsAppPhoneNumberResponse = (({
 });
 type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
+} | {
+    error?: string;
+    code?: 'PURCHASE_VELOCITY';
 });
 type ListWhatsAppNumberCountriesResponse = ({
     countries?: Array<{

package/dist/index.js

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
 // package.json
 var package_default = {
   name: "@getlatedev/node",
-  version: "0.2.243",
+  version: "0.2.245",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/dist/index.mjs

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // package.json
 var package_default = {
   name: "@getlatedev/node",
-  version: "0.2.243",
+  version: "0.2.245",
   description: "The official Node.js library for the Zernio API",
   main: "dist/index.js",
   module: "dist/index.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getlatedev/node",
-  "version": "0.2.243",
+  "version": "0.2.245",
   "description": "The official Node.js library for the Zernio API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/generated/sdk.gen.ts

@@ -2335,10 +2335,12 @@ export const listInboxConversations = <ThrowOnError extends boolean = false>(opt
 };
 
 /**
- * Create conversation
+ * Create conversation (send a WhatsApp template)
  * Initiate a new direct message conversation with a specified user. If a conversation already exists with the recipient, the message is added to the existing thread.
  *
- * Supported platforms: X/Twitter, Bluesky, Reddit, and WhatsApp. Other platforms return PLATFORM_NOT_SUPPORTED. For WhatsApp, a conversation can only be started with an approved template (provide templateName, templateLanguage, and any templateParams) — freeform initial messages are not permitted by WhatsApp; a missing template returns TEMPLATE_REQUIRED.
+ * Supported platforms: X/Twitter, Bluesky, Reddit, and WhatsApp. Other platforms return PLATFORM_NOT_SUPPORTED.
+ *
+ * WhatsApp: this is the endpoint for sending an approved template message to a phone number. Provide templateName, templateLanguage, and templateParams (body variable values), with the recipient phone in participantId. A template is required because WhatsApp does not permit freeform messages to open a conversation; a missing template returns TEMPLATE_REQUIRED. Templates with media headers (image, video, document) are handled automatically: Zernio reads the approved template definition and fills the header at send time. Calling this for a number you already have a thread with simply sends the template into that thread, which also makes it the way to re-engage a contact after the 24-hour customer-service window has closed. Once the recipient replies (opening the 24h window), send freeform messages with the send-message endpoint (POST /v1/inbox/conversations/{conversationId}/messages). Template fields are accepted on the JSON body only, not on multipart requests.
  *
  * DM eligibility (X/Twitter): Before sending, the endpoint checks if the recipient accepts DMs from your account (via the receives_your_dm field). If not, a 422 error with code DM_NOT_ALLOWED is returned. You can skip this check with skipDmCheck: true if you have already verified eligibility.
  *
@@ -2419,6 +2421,14 @@ export const getInboxConversationMessages = <ThrowOnError extends boolean = fals
  * buttons, templates, and message tags. Attachment and interactive message
  * support varies by platform.
  *
+ * WhatsApp template messages: to send an approved template into this
+ * conversation (required when the 24-hour customer-service window is
+ * closed), use the `template` field with a single element carrying the
+ * template reference: `{ "elements": [{ "name": ..., "language": ..., "components": [...] }] }`.
+ * See the `template` field below for the exact shape. To send a template
+ * to a phone number you have no conversation with yet, use the
+ * create-conversation endpoint (POST /v1/inbox/conversations) instead.
+ *
  * WhatsApp rich interactive messages (list, CTA URL, Flow) are available via
  * the `interactive` field. Tap events are delivered through the
  * `message.received` webhook with WhatsApp-specific `metadata` fields

package/src/generated/types.gen.ts

@@ -12671,32 +12671,68 @@ export type SendInboxMessageData = {
             phone?: string;
         }>;
         /**
-         * Generic template for carousels (Instagram/Facebook only, ignored on Telegram).
+         * Platform-dependent template payload. Ignored on Telegram.
+         *
+         * Instagram / Facebook: a generic template (carousel). Set `type: generic`
+         * and provide up to 10 `elements`, each with a `title` (required) and
+         * optional `subtitle`, `imageUrl`, and `buttons`.
+         *
+         * WhatsApp: sends an approved WhatsApp template message, the only message
+         * type WhatsApp accepts when the 24-hour customer-service window is closed.
+         * Provide exactly one element carrying the template reference:
+         * `{ "elements": [{ "name": "order_update", "language": "en_US", "components": [...] }] }`
+         * (`type` is ignored on WhatsApp). `components` is optional and is forwarded
+         * unchanged as the `template.components` array of Meta's Cloud API send
+         * payload; use it to fill body/header variables and button parameters, e.g.
+         * `[{ "type": "body", "parameters": [{ "type": "text", "text": "John" }] }]`.
+         * Templates with media headers (image, video, document) must include the
+         * header component with its media link here at send time. To send a template
+         * to a phone number with no existing conversation, or to have media headers
+         * filled in automatically from the template definition, use the
+         * create-conversation endpoint (POST /v1/inbox/conversations) instead.
+         *
          */
         template?: {
             /**
-             * Template type
+             * Template type. Required for Instagram/Facebook generic templates; ignored on WhatsApp.
              */
             type?: 'generic';
             elements?: Array<{
                 /**
-                 * Element title (max 80 chars)
+                 * Element title (max 80 chars). Required for Instagram/Facebook generic templates.
                  */
-                title: string;
+                title?: string;
                 /**
-                 * Element subtitle
+                 * Element subtitle (Instagram/Facebook only)
                  */
                 subtitle?: string;
                 /**
-                 * Element image URL
+                 * Element image URL (Instagram/Facebook only)
                  */
                 imageUrl?: string;
+                /**
+                 * Element buttons (Instagram/Facebook only)
+                 */
                 buttons?: Array<{
                     type?: 'url' | 'postback';
                     title?: string;
                     url?: string;
                     payload?: string;
                 }>;
+                /**
+                 * WhatsApp only. Name of the approved template to send.
+                 */
+                name?: string;
+                /**
+                 * WhatsApp only. Template language code (e.g. en_US).
+                 */
+                language?: string;
+                /**
+                 * WhatsApp only. Meta Cloud API send-shape components array, forwarded to Meta verbatim.
+                 */
+                components?: Array<{
+                    [key: string]: unknown;
+                }>;
             }>;
         };
         /**
@@ -15005,6 +15041,16 @@ export type PurchaseWhatsAppPhoneNumberData = {
          *
          */
         country?: string;
+        /**
+         * Optional idempotency key. Send the same value when retrying a purchase: if a number was already bought under this key, the API returns { status: "already_purchased", numberId, phoneNumber } instead of provisioning a second number. Generate a fresh key for each genuinely new purchase.
+         *
+         */
+        purchaseIntentId?: string;
+        /**
+         * Any second purchase within 10 minutes of a previous one is rejected with 409 code PURCHASE_VELOCITY as duplicate protection. Pass true to confirm the additional purchase is intentional (e.g. bulk provisioning).
+         *
+         */
+        allowMultiple?: boolean;
     };
 };
 
@@ -15022,6 +15068,10 @@ export type PurchaseWhatsAppPhoneNumberResponse = (({
         metaPreverifiedId?: string;
         metaVerificationStatus?: string;
     };
+} | {
+    status?: 'already_purchased';
+    numberId?: string;
+    phoneNumber?: string;
 }) | {
     status?: 'kyc_required';
     country?: string;
@@ -15030,6 +15080,9 @@ export type PurchaseWhatsAppPhoneNumberResponse = (({
 
 export type PurchaseWhatsAppPhoneNumberError = (unknown | {
     error?: string;
+} | {
+    error?: string;
+    code?: 'PURCHASE_VELOCITY';
 });
 
 export type ListWhatsAppNumberCountriesResponse = ({