@unboundcx/sdk 4.13.22 → 4.13.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.13.22",
+  "version": "4.13.24",
   "description": "Official JavaScript SDK for the Unbound API - A comprehensive toolkit for integrating with Unbound's communication, AI, and data management services",
   "main": "index.js",
   "type": "module",

package/services/esign.js

@@ -188,6 +188,7 @@ export class EsignService {
    * @param {string} [body.expiresAt]
    * @param {boolean} [body.allowDrawn]
    * @param {string} [body.postSignRedirectUrl]
+   * @param {string[]} [body.feedNotifyEvents] - Subset of `sent`|`opened`|`signed`; auto-posts a chat card to every linked record's feed on each selected event.
    * @returns {Promise<Object>}
    */
   async createPackage({
@@ -199,6 +200,7 @@ export class EsignService {
     expiresAt,
     allowDrawn,
     postSignRedirectUrl,
+    feedNotifyEvents,
   } = {}) {
     this.sdk.validateParams(
       { generatedDocumentId, name, recipients },
@@ -211,6 +213,7 @@ export class EsignService {
         expiresAt: { type: 'string', required: false },
         allowDrawn: { type: 'boolean', required: false },
         postSignRedirectUrl: { type: 'string', required: false },
+        feedNotifyEvents: { type: 'array', required: false },
       },
     );
 
@@ -222,6 +225,9 @@ export class EsignService {
     if (postSignRedirectUrl !== undefined) {
       body.postSignRedirectUrl = postSignRedirectUrl;
     }
+    if (feedNotifyEvents !== undefined) {
+      body.feedNotifyEvents = feedNotifyEvents;
+    }
 
     return internalRequest(this.sdk, '/esign/packages', 'POST', { body });
   }
@@ -266,6 +272,7 @@ export class EsignService {
    * @param {string} [body.expiresAt]
    * @param {boolean} [body.allowDrawn]
    * @param {string} [body.postSignRedirectUrl]
+   * @param {string[]} [body.feedNotifyEvents] - Subset of `sent`|`opened`|`signed`; auto-posts a chat card to every linked record's feed on each selected event.
    * @returns {Promise<Object>}
    */
   async updatePackage(
@@ -278,6 +285,7 @@ export class EsignService {
       expiresAt,
       allowDrawn,
       postSignRedirectUrl,
+      feedNotifyEvents,
     } = {},
   ) {
     this.sdk.validateParams(
@@ -291,6 +299,7 @@ export class EsignService {
         expiresAt: { type: 'string', required: false },
         allowDrawn: { type: 'boolean', required: false },
         postSignRedirectUrl: { type: 'string', required: false },
+        feedNotifyEvents: { type: 'array', required: false },
       },
     );
 
@@ -304,6 +313,9 @@ export class EsignService {
     if (postSignRedirectUrl !== undefined) {
       body.postSignRedirectUrl = postSignRedirectUrl;
     }
+    if (feedNotifyEvents !== undefined) {
+      body.feedNotifyEvents = feedNotifyEvents;
+    }
 
     return internalRequest(this.sdk, `/esign/packages/${id}`, 'PATCH', {
       body,

package/services/messaging/EmailService.js

@@ -63,6 +63,8 @@ export class EmailService {
    * @param {boolean} [params.tracking=true] - Enable email tracking (opens, clicks)
    * @param {string} [params.mailboxId] - Specific mailbox to send from
    * @param {string} [params.draftId] - Convert existing draft to sent email
+   * @param {string} [params.engagementSessionId] - Engagement to attach this email to
+   * @param {string} [params.taskId] - Task the email was sent under (multi-channel-per-task attribution)
    * @returns {Promise<Object>} Email send result with ID and threading info
    */
   async send({
@@ -86,6 +88,7 @@ export class EmailService {
     mailboxId,
     draftId,
     engagementSessionId,
+    taskId,
   }) {
     // Validate required params (relaxed when using draftId)
     if (!draftId) {
@@ -118,6 +121,7 @@ export class EmailService {
         mailboxId,
         draftId,
         engagementSessionId,
+        taskId,
       },
       {
         html: { type: 'string', required: false },
@@ -135,6 +139,7 @@ export class EmailService {
         mailboxId: { type: 'string', required: false },
         draftId: { type: 'string', required: false },
         engagementSessionId: { type: 'string', required: false },
+        taskId: { type: 'string', required: false },
       },
     );
 
@@ -161,6 +166,7 @@ export class EmailService {
     if (draftId) emailData.draftId = draftId;
     if (engagementSessionId)
       emailData.engagementSessionId = engagementSessionId;
+    if (taskId) emailData.taskId = taskId;
 
     const options = {
       body: emailData,

package/services/messaging/SmsService.js

@@ -19,6 +19,8 @@ export class SmsService {
    * @param {string} [params.webhookUrl] - Webhook URL for delivery status
    * @param {string} [params.relatedId] - Task/engagement (or other record) id
    *   to attach this message to, so it surfaces on that record's feed
+   * @param {string} [params.engagementSessionId] - Engagement to attach this message to
+   * @param {string} [params.taskId] - Task the message was sent under (multi-channel-per-task attribution)
    * @returns {Promise<Object>} Message details
    */
   async send({
@@ -30,6 +32,8 @@ export class SmsService {
     mediaUrls,
     webhookUrl,
     relatedId,
+    engagementSessionId,
+    taskId,
   }) {
     const messageData = {};
     if (from) messageData.from = from;
@@ -39,6 +43,8 @@ export class SmsService {
     if (mediaUrls) messageData.mediaUrls = mediaUrls;
     if (webhookUrl) messageData.webhookUrl = webhookUrl;
     if (relatedId) messageData.relatedId = relatedId;
+    if (engagementSessionId) messageData.engagementSessionId = engagementSessionId;
+    if (taskId) messageData.taskId = taskId;
 
     this.sdk.validateParams(
       { to, ...messageData },
@@ -51,6 +57,8 @@ export class SmsService {
         mediaUrls: { type: 'array', required: false },
         webhookUrl: { type: 'string', required: false },
         relatedId: { type: 'string', required: false },
+        engagementSessionId: { type: 'string', required: false },
+        taskId: { type: 'string', required: false },
       },
     );
 

package/services/objects.js

@@ -372,6 +372,7 @@ export class ObjectsService {
    * @param {string} args.object
    * @param {object} args.where
    * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @param {object} [args.options] - Extra delete options (e.g. { deleteEmails: true })
    * @returns {Promise} Delete result
    *
    * @example
@@ -379,15 +380,17 @@ export class ObjectsService {
    *   object: 'people',
    *   where: { id: '013…' },
    *   skipTriggers: true,
+   *   options: { deleteEmails: true },
    * });
    */
-  async delete({ object, where, skipTriggers = false }) {
+  async delete({ object, where, skipTriggers = false, options }) {
     this.sdk.validateParams(
-      { object, where, skipTriggers },
+      { object, where, skipTriggers, options },
       {
         object: { type: 'string', required: true },
         where: { type: 'object', required: true },
         skipTriggers: { type: 'boolean', required: false },
+        options: { type: 'object', required: false },
       },
     );
 
@@ -396,6 +399,7 @@ export class ObjectsService {
         where,
       },
     };
+    if (options) params.body.options = options;
     if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await internalRequest(this.sdk, `/object/${object}`, 'DELETE', params);
@@ -409,18 +413,25 @@ export class ObjectsService {
    * @param {string} args.object
    * @param {string} args.id
    * @param {boolean} [args.skipTriggers=false] - Do not run triggers for this write
+   * @param {object} [args.options] - Extra delete options (e.g. { deleteEmails: true })
    * @returns {Promise} Delete result
    *
    * @example
-   * await sdk.objects.deleteById({ object: 'people', id: '013…', skipTriggers: true });
+   * await sdk.objects.deleteById({
+   *   object: 'people',
+   *   id: '013…',
+   *   skipTriggers: true,
+   *   options: { deleteEmails: true },
+   * });
    */
-  async deleteById({ object, id, skipTriggers = false }) {
+  async deleteById({ object, id, skipTriggers = false, options }) {
     this.sdk.validateParams(
-      { object, id, skipTriggers },
+      { object, id, skipTriggers, options },
       {
         object: { type: 'string', required: true },
         id: { type: 'string', required: true },
         skipTriggers: { type: 'boolean', required: false },
+        options: { type: 'object', required: false },
       },
     );
 
@@ -431,12 +442,84 @@ export class ObjectsService {
         },
       },
     };
+    if (options) params.body.options = options;
     if (skipTriggers) params.query = { skipTriggers: true };
 
     const result = await internalRequest(this.sdk, `/object/${object}`, 'DELETE', params);
     return result;
   }
 
+  /**
+   * Merge 1–3 records into a survivor record. people|company only (v1 gate,
+   * enforced server-side). Related-record cleanup runs sync (owned child rows)
+   * + async (high-volume history) after the survivor is updated and the
+   * losers are deleted.
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {string} args.survivorId - Record that remains after the merge.
+   * @param {string[]} args.mergeIds - 1-3 ids to merge into the survivor (then deleted).
+   * @param {object} [args.fields] - Map of column -> the record id whose value wins.
+   *   Omitted columns keep the survivor's value.
+   * @returns {Promise<{survivorId: string, queued: boolean}>}
+   *
+   * @example
+   * await sdk.objects.merge({
+   *   object: 'people',
+   *   survivorId: '013…',
+   *   mergeIds: ['014…', '015…'],
+   *   fields: { firstName: '014…', email: '015…' },
+   * });
+   */
+  async merge({ object, survivorId, mergeIds, fields }) {
+    this.sdk.validateParams(
+      { object, survivorId, mergeIds, fields },
+      {
+        object: { type: 'string', required: true },
+        survivorId: { type: 'string', required: true },
+        mergeIds: { type: 'array', required: true },
+        fields: { type: 'object', required: false },
+      },
+    );
+
+    const body = { survivorId, mergeIds };
+    if (fields) body.fields = fields;
+
+    const params = { body };
+
+    const result = await internalRequest(this.sdk, `/object/${object}/merge`, 'POST', params);
+    return result;
+  }
+
+  /**
+   * Get merge backfill status for a record (pending Bucket B re-point count
+   * from the recordMerges ledger).
+   *
+   * @param {object} args
+   * @param {string} args.object
+   * @param {string} args.id
+   * @returns {Promise<{pending: number, lastMergedAt: string|null}>}
+   *
+   * @example
+   * await sdk.objects.mergeStatus({ object: 'people', id: '013…' });
+   */
+  async mergeStatus({ object, id }) {
+    this.sdk.validateParams(
+      { object, id },
+      {
+        object: { type: 'string', required: true },
+        id: { type: 'string', required: true },
+      },
+    );
+
+    const result = await internalRequest(
+      this.sdk,
+      `/object/${object}/merge-status/${id}`,
+      'GET',
+    );
+    return result;
+  }
+
   /**
    * List saved list-views for an object (system + shared + own).
    * @param {Object} params