@sendly/node 3.13.1 → 3.15.1

package/dist/index.d.mts

@@ -54,6 +54,11 @@ interface SendMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to the message (max 4KB).
+     * Stored on the message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Message status values
@@ -135,6 +140,10 @@ interface Message {
      * ISO 8601 timestamp when the message was delivered (if applicable)
      */
     deliveredAt?: string | null;
+    /**
+     * Custom JSON metadata attached to the message
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Options for listing messages
@@ -195,6 +204,11 @@ interface ScheduleMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to the message (max 4KB).
+     * Stored on the message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Scheduled message status values
@@ -334,6 +348,11 @@ interface BatchMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to all messages in the batch (max 4KB).
+     * Stored on each message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Result for a single message in a batch

package/dist/index.d.ts

@@ -54,6 +54,11 @@ interface SendMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to the message (max 4KB).
+     * Stored on the message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Message status values
@@ -135,6 +140,10 @@ interface Message {
      * ISO 8601 timestamp when the message was delivered (if applicable)
      */
     deliveredAt?: string | null;
+    /**
+     * Custom JSON metadata attached to the message
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Options for listing messages
@@ -195,6 +204,11 @@ interface ScheduleMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to the message (max 4KB).
+     * Stored on the message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Scheduled message status values
@@ -334,6 +348,11 @@ interface BatchMessageRequest {
      * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
      */
     messageType?: MessageType;
+    /**
+     * Custom JSON metadata to attach to all messages in the batch (max 4KB).
+     * Stored on each message record and included in webhook event payloads.
+     */
+    metadata?: Record<string, any>;
 }
 /**
  * Result for a single message in a batch

package/dist/index.js

@@ -639,7 +639,8 @@ var MessagesResource = class {
         to: request.to,
         text: request.text,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return message;
@@ -804,7 +805,8 @@ var MessagesResource = class {
         text: request.text,
         scheduledAt: request.scheduledAt,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return scheduled;
@@ -928,7 +930,8 @@ var MessagesResource = class {
       body: {
         messages: request.messages,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return batch;

package/dist/index.mjs

@@ -579,7 +579,8 @@ var MessagesResource = class {
         to: request.to,
         text: request.text,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return message;
@@ -744,7 +745,8 @@ var MessagesResource = class {
         text: request.text,
         scheduledAt: request.scheduledAt,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return scheduled;
@@ -868,7 +870,8 @@ var MessagesResource = class {
       body: {
         messages: request.messages,
         ...request.from && { from: request.from },
-        ...request.messageType && { messageType: request.messageType }
+        ...request.messageType && { messageType: request.messageType },
+        ...request.metadata && { metadata: request.metadata }
       }
     });
     return batch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendly/node",
-  "version": "3.13.1",
+  "version": "3.15.1",
   "description": "Official Sendly Node.js SDK for SMS messaging",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",