@sendly/node 3.12.2 → 3.13.0

package/dist/index.js

@@ -1520,6 +1520,65 @@ var AccountResource = class {
       path: `/account/keys/${encodeURIComponent(id)}`
     });
   }
+  /**
+   * Rename an API key
+   *
+   * @param id - API key ID
+   * @param name - New name for the API key
+   * @returns Updated API key
+   *
+   * @example
+   * ```typescript
+   * const key = await sendly.account.renameApiKey('key_xxx', 'Production Key');
+   * console.log(`Renamed to: ${key.name}`);
+   * ```
+   */
+  async renameApiKey(id, name) {
+    if (!id) {
+      throw new Error("API key ID is required");
+    }
+    if (!name) {
+      throw new Error("New name is required");
+    }
+    const key = await this.http.request({
+      method: "PATCH",
+      path: `/account/keys/${encodeURIComponent(id)}/rename`,
+      body: { name }
+    });
+    return key;
+  }
+  /**
+   * Rotate an API key
+   *
+   * Creates a new key while optionally keeping the old one active for a grace period.
+   *
+   * @param id - API key ID to rotate
+   * @param options - Rotation options
+   * @returns New API key with the full key value
+   *
+   * @example
+   * ```typescript
+   * // Rotate immediately (old key stops working instantly)
+   * const { newKey, key } = await sendly.account.rotateApiKey('key_xxx');
+   * console.log(`New key: ${key}`); // Save this!
+   *
+   * // Rotate with 24-hour grace period (both keys work for 24h)
+   * const { newKey, key } = await sendly.account.rotateApiKey('key_xxx', {
+   *   gracePeriodHours: 24
+   * });
+   * ```
+   */
+  async rotateApiKey(id, options) {
+    if (!id) {
+      throw new Error("API key ID is required");
+    }
+    const response = await this.http.request({
+      method: "POST",
+      path: `/account/keys/${encodeURIComponent(id)}/rotate`,
+      body: options?.gracePeriodHours ? { gracePeriodHours: options.gracePeriodHours } : {}
+    });
+    return response;
+  }
 };
 
 // src/resources/verify.ts
@@ -1970,6 +2029,37 @@ var TemplatesResource = class {
       path: `/templates/${id}`
     });
   }
+  /**
+   * Clone a template
+   *
+   * Creates a copy of an existing template (including presets).
+   *
+   * @param id - Template ID to clone
+   * @param options - Optional clone options
+   * @returns The cloned template (as draft)
+   *
+   * @example
+   * ```typescript
+   * // Clone a preset template
+   * const myOtp = await sendly.templates.clone('tpl_preset_otp', {
+   *   name: 'My Custom OTP'
+   * });
+   *
+   * // Modify and publish
+   * await sendly.templates.update(myOtp.id, {
+   *   text: 'Your {{app_name}} code: {{code}}. Expires in 5 min.'
+   * });
+   * await sendly.templates.publish(myOtp.id);
+   * ```
+   */
+  async clone(id, options) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/templates/${id}/clone`,
+      body: options?.name ? { name: options.name } : {}
+    });
+    return this.transformTemplate(response);
+  }
   transformTemplate(t) {
     return {
       id: t.id,
@@ -1991,6 +2081,632 @@ var TemplatesResource = class {
   }
 };
 
+// src/resources/campaigns.ts
+var CampaignsResource = class {
+  http;
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Create a new campaign
+   *
+   * @param request - Campaign details
+   * @returns The created campaign (as draft)
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.create({
+   *   name: 'Black Friday Sale',
+   *   text: 'Hi {{name}}! 50% off everything today only. Shop now!',
+   *   contactListIds: ['lst_customers', 'lst_subscribers']
+   * });
+   * ```
+   */
+  async create(request) {
+    const response = await this.http.request({
+      method: "POST",
+      path: "/campaigns",
+      body: {
+        name: request.name,
+        text: request.text,
+        templateId: request.templateId,
+        contactListIds: request.contactListIds
+      }
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * List campaigns with optional filtering
+   *
+   * @param options - Filter and pagination options
+   * @returns List of campaigns
+   *
+   * @example
+   * ```typescript
+   * // List all campaigns
+   * const { campaigns } = await sendly.campaigns.list();
+   *
+   * // List only scheduled campaigns
+   * const { campaigns } = await sendly.campaigns.list({ status: 'scheduled' });
+   *
+   * // Paginate
+   * const { campaigns, total } = await sendly.campaigns.list({ limit: 10, offset: 20 });
+   * ```
+   */
+  async list(options = {}) {
+    const params = new URLSearchParams();
+    if (options.limit) params.set("limit", String(options.limit));
+    if (options.offset) params.set("offset", String(options.offset));
+    if (options.status) params.set("status", options.status);
+    const queryString = params.toString();
+    const response = await this.http.request({
+      method: "GET",
+      path: `/campaigns${queryString ? `?${queryString}` : ""}`
+    });
+    return {
+      campaigns: response.campaigns.map((c) => this.transformCampaign(c)),
+      total: response.total,
+      limit: response.limit,
+      offset: response.offset
+    };
+  }
+  /**
+   * Get a campaign by ID
+   *
+   * @param id - Campaign ID
+   * @returns The campaign
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.get('cmp_xxx');
+   * console.log(`Status: ${campaign.status}`);
+   * console.log(`Delivered: ${campaign.deliveredCount}/${campaign.recipientCount}`);
+   * ```
+   */
+  async get(id) {
+    const response = await this.http.request({
+      method: "GET",
+      path: `/campaigns/${id}`
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * Update a campaign (draft or scheduled only)
+   *
+   * @param id - Campaign ID
+   * @param request - Fields to update
+   * @returns The updated campaign
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.update('cmp_xxx', {
+   *   name: 'Updated Campaign Name',
+   *   text: 'New message text with {{variable}}'
+   * });
+   * ```
+   */
+  async update(id, request) {
+    const response = await this.http.request({
+      method: "PATCH",
+      path: `/campaigns/${id}`,
+      body: {
+        ...request.name && { name: request.name },
+        ...request.text && { text: request.text },
+        ...request.templateId !== void 0 && {
+          template_id: request.templateId
+        },
+        ...request.contactListIds && {
+          contact_list_ids: request.contactListIds
+        }
+      }
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * Delete a campaign
+   *
+   * Only draft and cancelled campaigns can be deleted.
+   *
+   * @param id - Campaign ID
+   *
+   * @example
+   * ```typescript
+   * await sendly.campaigns.delete('cmp_xxx');
+   * ```
+   */
+  async delete(id) {
+    await this.http.request({
+      method: "DELETE",
+      path: `/campaigns/${id}`
+    });
+  }
+  /**
+   * Preview a campaign before sending
+   *
+   * Returns recipient count, credit estimate, and breakdown by country.
+   *
+   * @param id - Campaign ID
+   * @returns Campaign preview with cost estimate
+   *
+   * @example
+   * ```typescript
+   * const preview = await sendly.campaigns.preview('cmp_xxx');
+   *
+   * console.log(`Recipients: ${preview.recipientCount}`);
+   * console.log(`Estimated cost: ${preview.estimatedCredits} credits`);
+   * console.log(`Your balance: ${preview.currentBalance} credits`);
+   *
+   * if (!preview.hasEnoughCredits) {
+   *   console.log('Not enough credits! Please top up.');
+   * }
+   * ```
+   */
+  async preview(id) {
+    const response = await this.http.request({
+      method: "GET",
+      path: `/campaigns/${id}/preview`
+    });
+    return {
+      id: response.id,
+      recipientCount: response.recipient_count,
+      estimatedSegments: response.estimated_segments,
+      estimatedCredits: response.estimated_credits,
+      currentBalance: response.current_balance,
+      hasEnoughCredits: response.has_enough_credits,
+      breakdown: response.breakdown?.map((b) => ({
+        country: b.country,
+        count: b.count,
+        creditsPerMessage: b.credits_per_message,
+        totalCredits: b.total_credits
+      }))
+    };
+  }
+  /**
+   * Send a campaign immediately
+   *
+   * @param id - Campaign ID
+   * @returns The updated campaign (status: sending)
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.send('cmp_xxx');
+   * console.log(`Campaign is now ${campaign.status}`);
+   * ```
+   */
+  async send(id) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/campaigns/${id}/send`
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * Schedule a campaign for later
+   *
+   * @param id - Campaign ID
+   * @param request - Schedule details
+   * @returns The updated campaign (status: scheduled)
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.schedule('cmp_xxx', {
+   *   scheduledAt: '2024-01-15T10:00:00Z',
+   *   timezone: 'America/New_York'
+   * });
+   *
+   * console.log(`Scheduled for ${campaign.scheduledAt}`);
+   * ```
+   */
+  async schedule(id, request) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/campaigns/${id}/schedule`,
+      body: {
+        scheduledAt: request.scheduledAt,
+        timezone: request.timezone
+      }
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * Cancel a scheduled campaign
+   *
+   * @param id - Campaign ID
+   * @returns The updated campaign (status: cancelled)
+   *
+   * @example
+   * ```typescript
+   * const campaign = await sendly.campaigns.cancel('cmp_xxx');
+   * console.log(`Campaign cancelled`);
+   * ```
+   */
+  async cancel(id) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/campaigns/${id}/cancel`
+    });
+    return this.transformCampaign(response);
+  }
+  /**
+   * Clone a campaign
+   *
+   * Creates a new draft campaign with the same settings.
+   *
+   * @param id - Campaign ID to clone
+   * @returns The new campaign (as draft)
+   *
+   * @example
+   * ```typescript
+   * const cloned = await sendly.campaigns.clone('cmp_xxx');
+   * console.log(`Created clone: ${cloned.id}`);
+   * ```
+   */
+  async clone(id) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/campaigns/${id}/clone`
+    });
+    return this.transformCampaign(response);
+  }
+  transformCampaign(raw) {
+    return {
+      id: raw.id,
+      name: raw.name,
+      text: raw.text,
+      templateId: raw.template_id,
+      contactListIds: raw.contact_list_ids || [],
+      status: raw.status,
+      recipientCount: raw.recipient_count || 0,
+      sentCount: raw.sent_count || 0,
+      deliveredCount: raw.delivered_count || 0,
+      failedCount: raw.failed_count || 0,
+      estimatedCredits: raw.estimated_credits || 0,
+      creditsUsed: raw.credits_used || 0,
+      scheduledAt: raw.scheduled_at,
+      timezone: raw.timezone,
+      startedAt: raw.started_at,
+      completedAt: raw.completed_at,
+      createdAt: raw.created_at,
+      updatedAt: raw.updated_at
+    };
+  }
+};
+
+// src/resources/contacts.ts
+var ContactsResource = class {
+  http;
+  lists;
+  constructor(http) {
+    this.http = http;
+    this.lists = new ContactListsResource(http);
+  }
+  /**
+   * List contacts with optional filtering
+   *
+   * @param options - Filter and pagination options
+   * @returns List of contacts
+   *
+   * @example
+   * ```typescript
+   * // List all contacts
+   * const { contacts, total } = await sendly.contacts.list();
+   *
+   * // Search contacts
+   * const { contacts } = await sendly.contacts.list({ search: 'john' });
+   *
+   * // List contacts in a specific list
+   * const { contacts } = await sendly.contacts.list({ listId: 'lst_xxx' });
+   * ```
+   */
+  async list(options = {}) {
+    const params = new URLSearchParams();
+    if (options.limit) params.set("limit", String(options.limit));
+    if (options.offset) params.set("offset", String(options.offset));
+    if (options.search) params.set("search", options.search);
+    if (options.listId) params.set("list_id", options.listId);
+    const queryString = params.toString();
+    const response = await this.http.request({
+      method: "GET",
+      path: `/contacts${queryString ? `?${queryString}` : ""}`
+    });
+    return {
+      contacts: response.contacts.map((c) => this.transformContact(c)),
+      total: response.total,
+      limit: response.limit,
+      offset: response.offset
+    };
+  }
+  /**
+   * Get a contact by ID
+   *
+   * @param id - Contact ID
+   * @returns The contact with associated lists
+   *
+   * @example
+   * ```typescript
+   * const contact = await sendly.contacts.get('cnt_xxx');
+   * console.log(`${contact.name}: ${contact.phoneNumber}`);
+   * console.log(`In ${contact.lists?.length || 0} lists`);
+   * ```
+   */
+  async get(id) {
+    const response = await this.http.request({
+      method: "GET",
+      path: `/contacts/${id}`
+    });
+    return this.transformContact(response);
+  }
+  /**
+   * Create a new contact
+   *
+   * @param request - Contact details
+   * @returns The created contact
+   *
+   * @example
+   * ```typescript
+   * const contact = await sendly.contacts.create({
+   *   phoneNumber: '+15551234567',
+   *   name: 'Jane Smith',
+   *   email: 'jane@example.com',
+   *   metadata: { source: 'signup_form', plan: 'premium' }
+   * });
+   * ```
+   */
+  async create(request) {
+    const response = await this.http.request({
+      method: "POST",
+      path: "/contacts",
+      body: {
+        phone_number: request.phoneNumber,
+        name: request.name,
+        email: request.email,
+        metadata: request.metadata
+      }
+    });
+    return this.transformContact(response);
+  }
+  /**
+   * Update a contact
+   *
+   * @param id - Contact ID
+   * @param request - Fields to update
+   * @returns The updated contact
+   *
+   * @example
+   * ```typescript
+   * const contact = await sendly.contacts.update('cnt_xxx', {
+   *   name: 'Jane Doe',
+   *   metadata: { plan: 'enterprise' }
+   * });
+   * ```
+   */
+  async update(id, request) {
+    const response = await this.http.request({
+      method: "PATCH",
+      path: `/contacts/${id}`,
+      body: {
+        name: request.name,
+        email: request.email,
+        metadata: request.metadata
+      }
+    });
+    return this.transformContact(response);
+  }
+  /**
+   * Delete a contact
+   *
+   * @param id - Contact ID
+   *
+   * @example
+   * ```typescript
+   * await sendly.contacts.delete('cnt_xxx');
+   * ```
+   */
+  async delete(id) {
+    await this.http.request({
+      method: "DELETE",
+      path: `/contacts/${id}`
+    });
+  }
+  transformContact(raw) {
+    return {
+      id: raw.id,
+      phoneNumber: raw.phone_number,
+      name: raw.name,
+      email: raw.email,
+      metadata: raw.metadata,
+      optedOut: raw.opted_out,
+      createdAt: raw.created_at,
+      updatedAt: raw.updated_at,
+      lists: raw.lists?.map((l) => ({ id: l.id, name: l.name }))
+    };
+  }
+};
+var ContactListsResource = class {
+  http;
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * List all contact lists
+   *
+   * @returns All contact lists
+   *
+   * @example
+   * ```typescript
+   * const { lists } = await sendly.contacts.lists.list();
+   * for (const list of lists) {
+   *   console.log(`${list.name}: ${list.contactCount} contacts`);
+   * }
+   * ```
+   */
+  async list() {
+    const response = await this.http.request({
+      method: "GET",
+      path: "/contact-lists"
+    });
+    return {
+      lists: response.lists.map((l) => this.transformList(l))
+    };
+  }
+  /**
+   * Get a contact list by ID
+   *
+   * @param id - Contact list ID
+   * @param options - Pagination options for contacts
+   * @returns The contact list with members
+   *
+   * @example
+   * ```typescript
+   * const list = await sendly.contacts.lists.get('lst_xxx');
+   * console.log(`${list.name}: ${list.contactCount} contacts`);
+   *
+   * // Get list with paginated contacts
+   * const list = await sendly.contacts.lists.get('lst_xxx', { limit: 100 });
+   * console.log(`Showing ${list.contacts?.length} of ${list.contactsTotal}`);
+   * ```
+   */
+  async get(id, options = {}) {
+    const params = new URLSearchParams();
+    if (options.limit) params.set("limit", String(options.limit));
+    if (options.offset) params.set("offset", String(options.offset));
+    const queryString = params.toString();
+    const response = await this.http.request({
+      method: "GET",
+      path: `/contact-lists/${id}${queryString ? `?${queryString}` : ""}`
+    });
+    return this.transformList(response);
+  }
+  /**
+   * Create a new contact list
+   *
+   * @param request - List details
+   * @returns The created list
+   *
+   * @example
+   * ```typescript
+   * const list = await sendly.contacts.lists.create({
+   *   name: 'VIP Customers',
+   *   description: 'High-value customers for priority messaging'
+   * });
+   * ```
+   */
+  async create(request) {
+    const response = await this.http.request({
+      method: "POST",
+      path: "/contact-lists",
+      body: {
+        name: request.name,
+        description: request.description
+      }
+    });
+    return this.transformList(response);
+  }
+  /**
+   * Update a contact list
+   *
+   * @param id - Contact list ID
+   * @param request - Fields to update
+   * @returns The updated list
+   *
+   * @example
+   * ```typescript
+   * const list = await sendly.contacts.lists.update('lst_xxx', {
+   *   name: 'Premium Subscribers',
+   *   description: 'Updated description'
+   * });
+   * ```
+   */
+  async update(id, request) {
+    const response = await this.http.request({
+      method: "PATCH",
+      path: `/contact-lists/${id}`,
+      body: {
+        name: request.name,
+        description: request.description
+      }
+    });
+    return this.transformList(response);
+  }
+  /**
+   * Delete a contact list
+   *
+   * This does not delete the contacts in the list.
+   *
+   * @param id - Contact list ID
+   *
+   * @example
+   * ```typescript
+   * await sendly.contacts.lists.delete('lst_xxx');
+   * ```
+   */
+  async delete(id) {
+    await this.http.request({
+      method: "DELETE",
+      path: `/contact-lists/${id}`
+    });
+  }
+  /**
+   * Add contacts to a list
+   *
+   * @param listId - Contact list ID
+   * @param contactIds - Array of contact IDs to add
+   * @returns Number of contacts added
+   *
+   * @example
+   * ```typescript
+   * const result = await sendly.contacts.lists.addContacts('lst_xxx', [
+   *   'cnt_abc',
+   *   'cnt_def',
+   *   'cnt_ghi'
+   * ]);
+   * console.log(`Added ${result.addedCount} contacts`);
+   * ```
+   */
+  async addContacts(listId, contactIds) {
+    const response = await this.http.request({
+      method: "POST",
+      path: `/contact-lists/${listId}/contacts`,
+      body: { contact_ids: contactIds }
+    });
+    return { addedCount: response.added_count };
+  }
+  /**
+   * Remove a contact from a list
+   *
+   * @param listId - Contact list ID
+   * @param contactId - Contact ID to remove
+   *
+   * @example
+   * ```typescript
+   * await sendly.contacts.lists.removeContact('lst_xxx', 'cnt_abc');
+   * ```
+   */
+  async removeContact(listId, contactId) {
+    await this.http.request({
+      method: "DELETE",
+      path: `/contact-lists/${listId}/contacts/${contactId}`
+    });
+  }
+  transformList(raw) {
+    return {
+      id: raw.id,
+      name: raw.name,
+      description: raw.description,
+      contactCount: raw.contact_count || 0,
+      createdAt: raw.created_at,
+      updatedAt: raw.updated_at,
+      contacts: raw.contacts?.map((c) => ({
+        id: c.id,
+        phoneNumber: c.phone_number,
+        name: c.name,
+        email: c.email
+      })),
+      contactsTotal: raw.contacts_total
+    };
+  }
+};
+
 // src/client.ts
 var DEFAULT_BASE_URL2 = "https://sendly.live/api/v1";
 var DEFAULT_TIMEOUT2 = 3e4;
@@ -2088,6 +2804,47 @@ var Sendly = class {
    * ```
    */
   templates;
+  /**
+   * Campaigns API resource - Bulk SMS campaign management
+   *
+   * @example
+   * ```typescript
+   * // Create a campaign
+   * const campaign = await sendly.campaigns.create({
+   *   name: 'Welcome Campaign',
+   *   text: 'Hello {{name}}!',
+   *   contactListIds: ['lst_xxx']
+   * });
+   *
+   * // Preview cost
+   * const preview = await sendly.campaigns.preview(campaign.id);
+   * console.log(`Cost: ${preview.estimatedCredits} credits`);
+   *
+   * // Send or schedule
+   * await sendly.campaigns.send(campaign.id);
+   * ```
+   */
+  campaigns;
+  /**
+   * Contacts API resource - Contact and list management
+   *
+   * @example
+   * ```typescript
+   * // Create a contact
+   * const contact = await sendly.contacts.create({
+   *   phoneNumber: '+15551234567',
+   *   name: 'John Doe'
+   * });
+   *
+   * // Create a list and add contacts
+   * const list = await sendly.contacts.lists.create({ name: 'VIPs' });
+   * await sendly.contacts.lists.addContacts(list.id, [contact.id]);
+   *
+   * // List all contacts
+   * const { contacts } = await sendly.contacts.list();
+   * ```
+   */
+  contacts;
   http;
   config;
   /**
@@ -2122,6 +2879,8 @@ var Sendly = class {
     this.account = new AccountResource(this.http);
     this.verify = new VerifyResource(this.http);
     this.templates = new TemplatesResource(this.http);
+    this.campaigns = new CampaignsResource(this.http);
+    this.contacts = new ContactsResource(this.http);
   }
   /**
    * Check if the client is using a test API key