@sendly/node 3.13.0 → 3.13.2

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
@@ -1178,6 +1197,26 @@ interface CampaignPreview {
         creditsPerMessage: number;
         totalCredits: number;
     }>;
+    /** Number of recipients blocked due to destination restrictions */
+    blockedCount?: number;
+    /** Number of recipients that can be reached */
+    sendableCount?: number;
+    /** Per-country breakdown with access info */
+    byCountry?: Record<string, {
+        count: number;
+        credits: number;
+        allowed: boolean;
+        blockedReason?: string;
+    }>;
+    /** Validation warnings */
+    warnings?: string[];
+    /** User's messaging profile access info */
+    messagingProfile?: {
+        canSendDomestic: boolean;
+        canSendInternational: boolean;
+        verificationType: string | null;
+        verificationStatus: string | null;
+    };
 }
 /**
  * Options for listing campaigns
@@ -1389,6 +1428,28 @@ interface UpdateContactListRequest {
 interface ContactListsResponse {
     lists: ContactList[];
 }
+interface ImportContactItem {
+    phone: string;
+    name?: string;
+    email?: string;
+    optedInAt?: string;
+}
+interface ImportContactsRequest {
+    contacts: ImportContactItem[];
+    listId?: string;
+    optedInAt?: string;
+}
+interface ImportContactsError {
+    index: number;
+    phone: string;
+    error: string;
+}
+interface ImportContactsResponse {
+    imported: number;
+    skippedDuplicates: number;
+    errors: ImportContactsError[];
+    totalErrors: number;
+}
 
 /**
  * HTTP Client Utility
@@ -2729,6 +2790,7 @@ declare class ContactsResource {
      * ```
      */
     delete(id: string): Promise<void>;
+    import(request: ImportContactsRequest): Promise<ImportContactsResponse>;
     private transformContact;
 }
 /**
@@ -3471,4 +3533,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 Campaign, type CampaignListResponse, type CampaignPreview, type CampaignStatus, type CancelledMessageResponse, type CheckVerificationRequest, type CheckVerificationResponse, type CircuitState, type Contact, type ContactList, type ContactListResponse, type ContactListsResponse, type CreateCampaignRequest, type CreateContactListRequest, type CreateContactRequest, type CreateTemplateRequest, type CreateVerifySessionRequest, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListCampaignsOptions, type ListContactsOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type ListVerificationsOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleCampaignRequest, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SendVerificationRequest, type SendVerificationResponse, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, type Template, type TemplateListResponse, type TemplatePreview, type TemplateStatus, type TemplateVariable, TimeoutError, type UpdateCampaignRequest, type UpdateContactListRequest, type UpdateContactRequest, type UpdateTemplateRequest, type UpdateWebhookOptions, type ValidateSessionTokenRequest, type ValidateSessionTokenResponse, ValidationError, type Verification, type VerificationDeliveryStatus, type VerificationListResponse, type VerificationStatus, type VerifySession, type VerifySessionStatus, 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 Campaign, type CampaignListResponse, type CampaignPreview, type CampaignStatus, type CancelledMessageResponse, type CheckVerificationRequest, type CheckVerificationResponse, type CircuitState, type Contact, type ContactList, type ContactListResponse, type ContactListsResponse, type CreateCampaignRequest, type CreateContactListRequest, type CreateContactRequest, type CreateTemplateRequest, type CreateVerifySessionRequest, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, type ImportContactItem, type ImportContactsError, type ImportContactsRequest, type ImportContactsResponse, InsufficientCreditsError, type ListBatchesOptions, type ListCampaignsOptions, type ListContactsOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type ListVerificationsOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleCampaignRequest, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SendVerificationRequest, type SendVerificationResponse, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, type Template, type TemplateListResponse, type TemplatePreview, type TemplateStatus, type TemplateVariable, TimeoutError, type UpdateCampaignRequest, type UpdateContactListRequest, type UpdateContactRequest, type UpdateTemplateRequest, type UpdateWebhookOptions, type ValidateSessionTokenRequest, type ValidateSessionTokenResponse, ValidationError, type Verification, type VerificationDeliveryStatus, type VerificationListResponse, type VerificationStatus, type VerifySession, type VerifySessionStatus, 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

@@ -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
@@ -1178,6 +1197,26 @@ interface CampaignPreview {
         creditsPerMessage: number;
         totalCredits: number;
     }>;
+    /** Number of recipients blocked due to destination restrictions */
+    blockedCount?: number;
+    /** Number of recipients that can be reached */
+    sendableCount?: number;
+    /** Per-country breakdown with access info */
+    byCountry?: Record<string, {
+        count: number;
+        credits: number;
+        allowed: boolean;
+        blockedReason?: string;
+    }>;
+    /** Validation warnings */
+    warnings?: string[];
+    /** User's messaging profile access info */
+    messagingProfile?: {
+        canSendDomestic: boolean;
+        canSendInternational: boolean;
+        verificationType: string | null;
+        verificationStatus: string | null;
+    };
 }
 /**
  * Options for listing campaigns
@@ -1389,6 +1428,28 @@ interface UpdateContactListRequest {
 interface ContactListsResponse {
     lists: ContactList[];
 }
+interface ImportContactItem {
+    phone: string;
+    name?: string;
+    email?: string;
+    optedInAt?: string;
+}
+interface ImportContactsRequest {
+    contacts: ImportContactItem[];
+    listId?: string;
+    optedInAt?: string;
+}
+interface ImportContactsError {
+    index: number;
+    phone: string;
+    error: string;
+}
+interface ImportContactsResponse {
+    imported: number;
+    skippedDuplicates: number;
+    errors: ImportContactsError[];
+    totalErrors: number;
+}
 
 /**
  * HTTP Client Utility
@@ -2729,6 +2790,7 @@ declare class ContactsResource {
      * ```
      */
     delete(id: string): Promise<void>;
+    import(request: ImportContactsRequest): Promise<ImportContactsResponse>;
     private transformContact;
 }
 /**
@@ -3471,4 +3533,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 Campaign, type CampaignListResponse, type CampaignPreview, type CampaignStatus, type CancelledMessageResponse, type CheckVerificationRequest, type CheckVerificationResponse, type CircuitState, type Contact, type ContactList, type ContactListResponse, type ContactListsResponse, type CreateCampaignRequest, type CreateContactListRequest, type CreateContactRequest, type CreateTemplateRequest, type CreateVerifySessionRequest, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, InsufficientCreditsError, type ListBatchesOptions, type ListCampaignsOptions, type ListContactsOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type ListVerificationsOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleCampaignRequest, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SendVerificationRequest, type SendVerificationResponse, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, type Template, type TemplateListResponse, type TemplatePreview, type TemplateStatus, type TemplateVariable, TimeoutError, type UpdateCampaignRequest, type UpdateContactListRequest, type UpdateContactRequest, type UpdateTemplateRequest, type UpdateWebhookOptions, type ValidateSessionTokenRequest, type ValidateSessionTokenResponse, ValidationError, type Verification, type VerificationDeliveryStatus, type VerificationListResponse, type VerificationStatus, type VerifySession, type VerifySessionStatus, 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 Campaign, type CampaignListResponse, type CampaignPreview, type CampaignStatus, type CancelledMessageResponse, type CheckVerificationRequest, type CheckVerificationResponse, type CircuitState, type Contact, type ContactList, type ContactListResponse, type ContactListsResponse, type CreateCampaignRequest, type CreateContactListRequest, type CreateContactRequest, type CreateTemplateRequest, type CreateVerifySessionRequest, type CreateWebhookOptions, type CreditTransaction, type Credits, type DeliveryStatus, type ImportContactItem, type ImportContactsError, type ImportContactsRequest, type ImportContactsResponse, InsufficientCreditsError, type ListBatchesOptions, type ListCampaignsOptions, type ListContactsOptions, type ListMessagesOptions, type ListScheduledMessagesOptions, type ListVerificationsOptions, type Message, type MessageListResponse, type MessageStatus, type MessageType, NetworkError, NotFoundError, type PricingTier, RateLimitError, type RateLimitInfo, SANDBOX_TEST_NUMBERS, SUPPORTED_COUNTRIES, type ScheduleCampaignRequest, type ScheduleMessageRequest, type ScheduledMessage, type ScheduledMessageListResponse, type ScheduledMessageStatus, type SendMessageRequest, type SendVerificationRequest, type SendVerificationResponse, type SenderType, Sendly, type SendlyConfig, SendlyError, type SendlyErrorCode, type Template, type TemplateListResponse, type TemplatePreview, type TemplateStatus, type TemplateVariable, TimeoutError, type UpdateCampaignRequest, type UpdateContactListRequest, type UpdateContactRequest, type UpdateTemplateRequest, type UpdateWebhookOptions, type ValidateSessionTokenRequest, type ValidateSessionTokenResponse, ValidationError, type Verification, type VerificationDeliveryStatus, type VerificationListResponse, type VerificationStatus, type VerifySession, type VerifySessionStatus, 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

@@ -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;
@@ -2508,6 +2511,18 @@ var ContactsResource = class {
       path: `/contacts/${id}`
     });
   }
+  async import(request) {
+    const body = {
+      contacts: request.contacts
+    };
+    if (request.listId) body.listId = request.listId;
+    if (request.optedInAt) body.optedInAt = request.optedInAt;
+    return this.http.request({
+      method: "POST",
+      path: "/contacts/import",
+      body
+    });
+  }
   transformContact(raw) {
     return {
       id: raw.id,

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;
@@ -2448,6 +2451,18 @@ var ContactsResource = class {
       path: `/contacts/${id}`
     });
   }
+  async import(request) {
+    const body = {
+      contacts: request.contacts
+    };
+    if (request.listId) body.listId = request.listId;
+    if (request.optedInAt) body.optedInAt = request.optedInAt;
+    return this.http.request({
+      method: "POST",
+      path: "/contacts/import",
+      body
+    });
+  }
   transformContact(raw) {
     return {
       id: raw.id,

package/package.json

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