@sendly/node 3.13.0 → 3.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1178,6 +1178,26 @@ interface CampaignPreview {
1178
1178
  creditsPerMessage: number;
1179
1179
  totalCredits: number;
1180
1180
  }>;
1181
+ /** Number of recipients blocked due to destination restrictions */
1182
+ blockedCount?: number;
1183
+ /** Number of recipients that can be reached */
1184
+ sendableCount?: number;
1185
+ /** Per-country breakdown with access info */
1186
+ byCountry?: Record<string, {
1187
+ count: number;
1188
+ credits: number;
1189
+ allowed: boolean;
1190
+ blockedReason?: string;
1191
+ }>;
1192
+ /** Validation warnings */
1193
+ warnings?: string[];
1194
+ /** User's messaging profile access info */
1195
+ messagingProfile?: {
1196
+ canSendDomestic: boolean;
1197
+ canSendInternational: boolean;
1198
+ verificationType: string | null;
1199
+ verificationStatus: string | null;
1200
+ };
1181
1201
  }
1182
1202
  /**
1183
1203
  * Options for listing campaigns
@@ -1389,6 +1409,28 @@ interface UpdateContactListRequest {
1389
1409
  interface ContactListsResponse {
1390
1410
  lists: ContactList[];
1391
1411
  }
1412
+ interface ImportContactItem {
1413
+ phone: string;
1414
+ name?: string;
1415
+ email?: string;
1416
+ optedInAt?: string;
1417
+ }
1418
+ interface ImportContactsRequest {
1419
+ contacts: ImportContactItem[];
1420
+ listId?: string;
1421
+ optedInAt?: string;
1422
+ }
1423
+ interface ImportContactsError {
1424
+ index: number;
1425
+ phone: string;
1426
+ error: string;
1427
+ }
1428
+ interface ImportContactsResponse {
1429
+ imported: number;
1430
+ skippedDuplicates: number;
1431
+ errors: ImportContactsError[];
1432
+ totalErrors: number;
1433
+ }
1392
1434
 
1393
1435
  /**
1394
1436
  * HTTP Client Utility
@@ -2729,6 +2771,7 @@ declare class ContactsResource {
2729
2771
  * ```
2730
2772
  */
2731
2773
  delete(id: string): Promise<void>;
2774
+ import(request: ImportContactsRequest): Promise<ImportContactsResponse>;
2732
2775
  private transformContact;
2733
2776
  }
2734
2777
  /**
@@ -3471,4 +3514,4 @@ declare class Webhooks {
3471
3514
  */
3472
3515
  type WebhookMessageData = WebhookMessageObject;
3473
3516
 
3474
- 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 };
3517
+ 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 CHANGED
@@ -1178,6 +1178,26 @@ interface CampaignPreview {
1178
1178
  creditsPerMessage: number;
1179
1179
  totalCredits: number;
1180
1180
  }>;
1181
+ /** Number of recipients blocked due to destination restrictions */
1182
+ blockedCount?: number;
1183
+ /** Number of recipients that can be reached */
1184
+ sendableCount?: number;
1185
+ /** Per-country breakdown with access info */
1186
+ byCountry?: Record<string, {
1187
+ count: number;
1188
+ credits: number;
1189
+ allowed: boolean;
1190
+ blockedReason?: string;
1191
+ }>;
1192
+ /** Validation warnings */
1193
+ warnings?: string[];
1194
+ /** User's messaging profile access info */
1195
+ messagingProfile?: {
1196
+ canSendDomestic: boolean;
1197
+ canSendInternational: boolean;
1198
+ verificationType: string | null;
1199
+ verificationStatus: string | null;
1200
+ };
1181
1201
  }
1182
1202
  /**
1183
1203
  * Options for listing campaigns
@@ -1389,6 +1409,28 @@ interface UpdateContactListRequest {
1389
1409
  interface ContactListsResponse {
1390
1410
  lists: ContactList[];
1391
1411
  }
1412
+ interface ImportContactItem {
1413
+ phone: string;
1414
+ name?: string;
1415
+ email?: string;
1416
+ optedInAt?: string;
1417
+ }
1418
+ interface ImportContactsRequest {
1419
+ contacts: ImportContactItem[];
1420
+ listId?: string;
1421
+ optedInAt?: string;
1422
+ }
1423
+ interface ImportContactsError {
1424
+ index: number;
1425
+ phone: string;
1426
+ error: string;
1427
+ }
1428
+ interface ImportContactsResponse {
1429
+ imported: number;
1430
+ skippedDuplicates: number;
1431
+ errors: ImportContactsError[];
1432
+ totalErrors: number;
1433
+ }
1392
1434
 
1393
1435
  /**
1394
1436
  * HTTP Client Utility
@@ -2729,6 +2771,7 @@ declare class ContactsResource {
2729
2771
  * ```
2730
2772
  */
2731
2773
  delete(id: string): Promise<void>;
2774
+ import(request: ImportContactsRequest): Promise<ImportContactsResponse>;
2732
2775
  private transformContact;
2733
2776
  }
2734
2777
  /**
@@ -3471,4 +3514,4 @@ declare class Webhooks {
3471
3514
  */
3472
3515
  type WebhookMessageData = WebhookMessageObject;
3473
3516
 
3474
- 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 };
3517
+ 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 CHANGED
@@ -2508,6 +2508,18 @@ var ContactsResource = class {
2508
2508
  path: `/contacts/${id}`
2509
2509
  });
2510
2510
  }
2511
+ async import(request) {
2512
+ const body = {
2513
+ contacts: request.contacts
2514
+ };
2515
+ if (request.listId) body.listId = request.listId;
2516
+ if (request.optedInAt) body.optedInAt = request.optedInAt;
2517
+ return this.http.request({
2518
+ method: "POST",
2519
+ path: "/contacts/import",
2520
+ body
2521
+ });
2522
+ }
2511
2523
  transformContact(raw) {
2512
2524
  return {
2513
2525
  id: raw.id,
package/dist/index.mjs CHANGED
@@ -2448,6 +2448,18 @@ var ContactsResource = class {
2448
2448
  path: `/contacts/${id}`
2449
2449
  });
2450
2450
  }
2451
+ async import(request) {
2452
+ const body = {
2453
+ contacts: request.contacts
2454
+ };
2455
+ if (request.listId) body.listId = request.listId;
2456
+ if (request.optedInAt) body.optedInAt = request.optedInAt;
2457
+ return this.http.request({
2458
+ method: "POST",
2459
+ path: "/contacts/import",
2460
+ body
2461
+ });
2462
+ }
2451
2463
  transformContact(raw) {
2452
2464
  return {
2453
2465
  id: raw.id,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sendly/node",
3
- "version": "3.13.0",
3
+ "version": "3.13.1",
4
4
  "description": "Official Sendly Node.js SDK for SMS messaging",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",