@sendly/node 3.0.0 → 3.4.0

package/dist/index.d.mts

@@ -26,6 +26,10 @@ interface SendlyConfig {
      */
     maxRetries?: number;
 }
+/**
+ * Message type for compliance classification
+ */
+type MessageType = "marketing" | "transactional";
 /**
  * Request payload for sending an SMS message
  */
@@ -44,6 +48,12 @@ interface SendMessageRequest {
      * For US/Canada: Your verified toll-free number
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Message status values
@@ -171,7 +181,7 @@ interface ScheduleMessageRequest {
      */
     text: string;
     /**
-     * When to send the message (ISO 8601 format, must be > 1 minute in future)
+     * When to send the message (ISO 8601 format, must be 5 min - 5 days in future)
      */
     scheduledAt: string;
     /**
@@ -179,6 +189,12 @@ interface ScheduleMessageRequest {
      * For US/Canada: This is ignored - toll-free number pool is used
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Scheduled message status values
@@ -312,6 +328,12 @@ interface BatchMessageRequest {
      * For US/Canada destinations: This is ignored - toll-free number pool is used
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Result for a single message in a batch
@@ -510,6 +532,13 @@ declare const ALL_SUPPORTED_COUNTRIES: string[];
  * Webhook event types
  */
 type WebhookEventType = "message.sent" | "message.delivered" | "message.failed" | "message.bounced" | "message.queued";
+/**
+ * Webhook mode - filters which events are delivered
+ * - "all": Receives all events (sandbox + production)
+ * - "test": Only sandbox/test events (livemode: false)
+ * - "live": Only production events (livemode: true) - requires verification
+ */
+type WebhookMode = "all" | "test" | "live";
 /**
  * Circuit breaker state for webhook delivery
  */
@@ -530,6 +559,8 @@ interface Webhook {
     events: WebhookEventType[];
     /** Optional description */
     description?: string;
+    /** Event mode filter */
+    mode: WebhookMode;
     /** Whether the webhook is active */
     isActive: boolean;
     /** Number of consecutive failures */
@@ -574,6 +605,8 @@ interface CreateWebhookOptions {
     events: WebhookEventType[];
     /** Optional description */
     description?: string;
+    /** Event mode filter (defaults to "all") */
+    mode?: WebhookMode;
     /** Custom metadata */
     metadata?: Record<string, unknown>;
 }
@@ -587,6 +620,8 @@ interface UpdateWebhookOptions {
     events?: WebhookEventType[];
     /** New description */
     description?: string;
+    /** Event mode filter */
+    mode?: WebhookMode;
     /** Enable/disable webhook */
     isActive?: boolean;
     /** Custom metadata */
@@ -1909,4 +1944,4 @@ declare class Webhooks {
  */
 type WebhookMessageData = WebhookMessageObject;
 
-export { ALL_SUPPORTED_COUNTRIES, type Account, type ApiErrorResponse, type ApiKey, AuthenticationError, type BatchListResponse, type BatchMessageItem, type BatchMessageRequest, type BatchMessageResponse, type BatchMessageResult, type BatchStatus, CREDITS_PER_SMS, type CancelledMessageResponse, type CircuitState, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type Message, type MessageListResponse, type MessageStatus, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, TimeoutError, type UpdateWebhookOptions, ValidationError, type Webhook, type WebhookCreatedResponse, type WebhookDelivery, type WebhookEvent, type WebhookEventType, type WebhookMessageData, type WebhookMessageStatus, type WebhookSecretRotation, WebhookSignatureError, type WebhookTestResult, Webhooks, calculateSegments, Sendly as default, generateWebhookSignature, getCountryFromPhone, isCountrySupported, parseWebhookEvent, validateMessageText, validatePhoneNumber, validateSenderId, verifyWebhookSignature };
+export { ALL_SUPPORTED_COUNTRIES, type Account, type ApiErrorResponse, type ApiKey, AuthenticationError, type BatchListResponse, type BatchMessageItem, type BatchMessageRequest, type BatchMessageResponse, type BatchMessageResult, type BatchStatus, CREDITS_PER_SMS, type CancelledMessageResponse, type CircuitState, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, TimeoutError, type UpdateWebhookOptions, ValidationError, type Webhook, type WebhookCreatedResponse, type WebhookDelivery, type WebhookEvent, type WebhookEventType, type WebhookMessageData, type WebhookMessageStatus, type WebhookSecretRotation, WebhookSignatureError, type WebhookTestResult, Webhooks, calculateSegments, Sendly as default, generateWebhookSignature, getCountryFromPhone, isCountrySupported, parseWebhookEvent, validateMessageText, validatePhoneNumber, validateSenderId, verifyWebhookSignature };

package/dist/index.d.ts

@@ -26,6 +26,10 @@ interface SendlyConfig {
      */
     maxRetries?: number;
 }
+/**
+ * Message type for compliance classification
+ */
+type MessageType = "marketing" | "transactional";
 /**
  * Request payload for sending an SMS message
  */
@@ -44,6 +48,12 @@ interface SendMessageRequest {
      * For US/Canada: Your verified toll-free number
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Message status values
@@ -171,7 +181,7 @@ interface ScheduleMessageRequest {
      */
     text: string;
     /**
-     * When to send the message (ISO 8601 format, must be > 1 minute in future)
+     * When to send the message (ISO 8601 format, must be 5 min - 5 days in future)
      */
     scheduledAt: string;
     /**
@@ -179,6 +189,12 @@ interface ScheduleMessageRequest {
      * For US/Canada: This is ignored - toll-free number pool is used
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Scheduled message status values
@@ -312,6 +328,12 @@ interface BatchMessageRequest {
      * For US/Canada destinations: This is ignored - toll-free number pool is used
      */
     from?: string;
+    /**
+     * Message type for compliance (default: "marketing")
+     * - "marketing": Promotional content, subject to quiet hours (8am-9pm recipient time)
+     * - "transactional": OTPs, confirmations, alerts - bypasses quiet hours (24/7)
+     */
+    messageType?: MessageType;
 }
 /**
  * Result for a single message in a batch
@@ -510,6 +532,13 @@ declare const ALL_SUPPORTED_COUNTRIES: string[];
  * Webhook event types
  */
 type WebhookEventType = "message.sent" | "message.delivered" | "message.failed" | "message.bounced" | "message.queued";
+/**
+ * Webhook mode - filters which events are delivered
+ * - "all": Receives all events (sandbox + production)
+ * - "test": Only sandbox/test events (livemode: false)
+ * - "live": Only production events (livemode: true) - requires verification
+ */
+type WebhookMode = "all" | "test" | "live";
 /**
  * Circuit breaker state for webhook delivery
  */
@@ -530,6 +559,8 @@ interface Webhook {
     events: WebhookEventType[];
     /** Optional description */
     description?: string;
+    /** Event mode filter */
+    mode: WebhookMode;
     /** Whether the webhook is active */
     isActive: boolean;
     /** Number of consecutive failures */
@@ -574,6 +605,8 @@ interface CreateWebhookOptions {
     events: WebhookEventType[];
     /** Optional description */
     description?: string;
+    /** Event mode filter (defaults to "all") */
+    mode?: WebhookMode;
     /** Custom metadata */
     metadata?: Record<string, unknown>;
 }
@@ -587,6 +620,8 @@ interface UpdateWebhookOptions {
     events?: WebhookEventType[];
     /** New description */
     description?: string;
+    /** Event mode filter */
+    mode?: WebhookMode;
     /** Enable/disable webhook */
     isActive?: boolean;
     /** Custom metadata */
@@ -1909,4 +1944,4 @@ declare class Webhooks {
  */
 type WebhookMessageData = WebhookMessageObject;
 
-export { ALL_SUPPORTED_COUNTRIES, type Account, type ApiErrorResponse, type ApiKey, AuthenticationError, type BatchListResponse, type BatchMessageItem, type BatchMessageRequest, type BatchMessageResponse, type BatchMessageResult, type BatchStatus, CREDITS_PER_SMS, type CancelledMessageResponse, type CircuitState, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type Message, type MessageListResponse, type MessageStatus, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, TimeoutError, type UpdateWebhookOptions, ValidationError, type Webhook, type WebhookCreatedResponse, type WebhookDelivery, type WebhookEvent, type WebhookEventType, type WebhookMessageData, type WebhookMessageStatus, type WebhookSecretRotation, WebhookSignatureError, type WebhookTestResult, Webhooks, calculateSegments, Sendly as default, generateWebhookSignature, getCountryFromPhone, isCountrySupported, parseWebhookEvent, validateMessageText, validatePhoneNumber, validateSenderId, verifyWebhookSignature };
+export { ALL_SUPPORTED_COUNTRIES, type Account, type ApiErrorResponse, type ApiKey, AuthenticationError, type BatchListResponse, type BatchMessageItem, type BatchMessageRequest, type BatchMessageResponse, type BatchMessageResult, type BatchStatus, CREDITS_PER_SMS, type CancelledMessageResponse, type CircuitState, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, TimeoutError, type UpdateWebhookOptions, ValidationError, type Webhook, type WebhookCreatedResponse, type WebhookDelivery, type WebhookEvent, type WebhookEventType, type WebhookMessageData, type WebhookMessageStatus, type WebhookSecretRotation, WebhookSignatureError, type WebhookTestResult, Webhooks, calculateSegments, Sendly as default, generateWebhookSignature, getCountryFromPhone, isCountrySupported, parseWebhookEvent, validateMessageText, validatePhoneNumber, validateSenderId, verifyWebhookSignature };

package/dist/index.js

@@ -781,12 +781,16 @@ var MessagesResource = class {
     }
     const scheduledTime = new Date(request.scheduledAt);
     const now = /* @__PURE__ */ new Date();
-    const oneMinuteFromNow = new Date(now.getTime() + 60 * 1e3);
+    const fiveMinutesFromNow = new Date(now.getTime() + 5 * 60 * 1e3);
+    const fiveDaysFromNow = new Date(now.getTime() + 5 * 24 * 60 * 60 * 1e3);
     if (isNaN(scheduledTime.getTime())) {
       throw new Error("Invalid scheduledAt format. Use ISO 8601 format.");
     }
-    if (scheduledTime <= oneMinuteFromNow) {
-      throw new Error("scheduledAt must be at least 1 minute in the future.");
+    if (scheduledTime <= fiveMinutesFromNow) {
+      throw new Error("scheduledAt must be at least 5 minutes in the future.");
+    }
+    if (scheduledTime > fiveDaysFromNow) {
+      throw new Error("scheduledAt must be within 5 days.");
     }
     const scheduled = await this.http.request({
       method: "POST",
@@ -1041,6 +1045,7 @@ var WebhooksResource = class {
         url: options.url,
         events: options.events,
         ...options.description && { description: options.description },
+        ...options.mode && { mode: options.mode },
         ...options.metadata && { metadata: options.metadata }
       }
     });
@@ -1131,6 +1136,7 @@ var WebhooksResource = class {
           description: options.description
         },
         ...options.isActive !== void 0 && { is_active: options.isActive },
+        ...options.mode !== void 0 && { mode: options.mode },
         ...options.metadata !== void 0 && { metadata: options.metadata }
       }
     });

package/dist/index.mjs

@@ -721,12 +721,16 @@ var MessagesResource = class {
     }
     const scheduledTime = new Date(request.scheduledAt);
     const now = /* @__PURE__ */ new Date();
-    const oneMinuteFromNow = new Date(now.getTime() + 60 * 1e3);
+    const fiveMinutesFromNow = new Date(now.getTime() + 5 * 60 * 1e3);
+    const fiveDaysFromNow = new Date(now.getTime() + 5 * 24 * 60 * 60 * 1e3);
     if (isNaN(scheduledTime.getTime())) {
       throw new Error("Invalid scheduledAt format. Use ISO 8601 format.");
     }
-    if (scheduledTime <= oneMinuteFromNow) {
-      throw new Error("scheduledAt must be at least 1 minute in the future.");
+    if (scheduledTime <= fiveMinutesFromNow) {
+      throw new Error("scheduledAt must be at least 5 minutes in the future.");
+    }
+    if (scheduledTime > fiveDaysFromNow) {
+      throw new Error("scheduledAt must be within 5 days.");
     }
     const scheduled = await this.http.request({
       method: "POST",
@@ -981,6 +985,7 @@ var WebhooksResource = class {
         url: options.url,
         events: options.events,
         ...options.description && { description: options.description },
+        ...options.mode && { mode: options.mode },
         ...options.metadata && { metadata: options.metadata }
       }
     });
@@ -1071,6 +1076,7 @@ var WebhooksResource = class {
           description: options.description
         },
         ...options.isActive !== void 0 && { is_active: options.isActive },
+        ...options.mode !== void 0 && { mode: options.mode },
         ...options.metadata !== void 0 && { metadata: options.metadata }
       }
     });

package/package.json

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