@unboundcx/sdk 4.13.60 → 4.13.62

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "4.13.60",
+  "version": "4.13.62",
   "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/fax.js

@@ -86,6 +86,7 @@ export class FaxService {
    * @param {boolean} [options.ecm] - Enable Error Correction Mode (default: true)
    * @param {number} [options.timeout] - Dial timeout in seconds (defaults to mailbox dialTimeout)
    * @param {string} [options.relatedId] - Record (e.g. engagement/task) id; server posts a fax card into that record's activity feed
+   * @param {string} [options.taskId] - Task the outbound fax is sent from; server resolves the from-number chain (queue/user/account fax caller ID) and stamps the fax document to the task
    * @returns {Promise<Object>} Send result
    * @returns {string} result.id - The fax document ID
    * @returns {string} result.status - 'sending' on success, 'failed' on NATS error
@@ -133,9 +134,10 @@ export class FaxService {
     ecm,
     timeout,
     relatedId,
+    taskId,
   }) {
     this.sdk.validateParams(
-      { faxMailboxId, toNumber, fromNumber, coverStorageId, paperSize },
+      { faxMailboxId, toNumber, fromNumber, coverStorageId, paperSize, taskId },
       {
         faxMailboxId: { type: 'string', required: true },
         toNumber: { type: 'string', required: true },
@@ -145,6 +147,7 @@ export class FaxService {
         tiffStorageId: { type: 'string', required: false },
         coverStorageId: { type: 'string', required: false },
         paperSize: { type: 'string', required: false },
+        taskId: { type: 'string', required: false },
       },
     );
 

package/services/taskRouter/ParticipantService.js

@@ -36,31 +36,63 @@ export class ParticipantService {
   }
 
   /**
-   * Add a participant to a task: invite a specific user to join, or request
-   * help from a queue.
+   * Add a participant to a task: invite a specific user to join, request
+   * help from a queue, or dial an external caller onto the live voice bridge.
    *
    * @param {Object} options - Options
    * @param {string} options.taskId - Task ID
-   * @param {string} options.kind - 'user' | 'queue'
+   * @param {string} options.kind - 'user' | 'queue' | 'external'
    * @param {string} [options.userId] - Required when kind is 'user'
    * @param {string} [options.queueId] - Required when kind is 'queue'
+   * @param {string} [options.phoneNumber] - External caller's phone number (kind 'external'; alternative to peopleId/companyId)
+   * @param {string} [options.peopleId] - External caller resolved from a person record (kind 'external'; alternative to phoneNumber/companyId)
+   * @param {string} [options.companyId] - External caller resolved from a company record (kind 'external'; alternative to phoneNumber/peopleId)
+   * @param {string} [options.displayName] - Optional display name shown for the external caller (kind 'external')
    * @param {string} [options.note] - Optional note shown to the invitee
    * @param {string} [options.bridgeRole='main'] - Voice bridge role (only 'main' is supported until the media update)
-   * @returns {Promise<Object>} { participant, offerId } for kind 'user'; { helpTaskId } for kind 'queue'
+   * @returns {Promise<Object>} { participant, offerId } for kind 'user'; { helpTaskId } for kind 'queue'; { participant } for kind 'external'
    *
    * @example
    * await sdk.taskRouter.participants.add({ taskId: 'task_123', kind: 'user', userId: 'user_456', note: 'Need a hand' });
    * @example
    * await sdk.taskRouter.participants.add({ taskId: 'task_123', kind: 'queue', queueId: 'queue_789' });
+   * @example
+   * await sdk.taskRouter.participants.add({ taskId: 'task_123', kind: 'external', phoneNumber: '+15551234567', displayName: 'Jane Doe' });
    */
-  async add({ taskId, kind, userId, queueId, note, bridgeRole } = {}) {
+  async add({
+    taskId,
+    kind,
+    userId,
+    queueId,
+    phoneNumber,
+    peopleId,
+    companyId,
+    displayName,
+    note,
+    bridgeRole,
+  } = {}) {
     this.sdk.validateParams(
-      { taskId, kind, userId, queueId, note, bridgeRole },
+      {
+        taskId,
+        kind,
+        userId,
+        queueId,
+        phoneNumber,
+        peopleId,
+        companyId,
+        displayName,
+        note,
+        bridgeRole,
+      },
       {
         taskId: { type: 'string', required: true },
         kind: { type: 'string', required: true },
         userId: { type: 'string', required: false },
         queueId: { type: 'string', required: false },
+        phoneNumber: { type: 'string', required: false },
+        peopleId: { type: 'string', required: false },
+        companyId: { type: 'string', required: false },
+        displayName: { type: 'string', required: false },
         note: { type: 'string', required: false },
         bridgeRole: { type: 'string', required: false },
       },
@@ -69,6 +101,10 @@ export class ParticipantService {
     const params = { body: { kind } };
     if (userId !== undefined) params.body.userId = userId;
     if (queueId !== undefined) params.body.queueId = queueId;
+    if (phoneNumber !== undefined) params.body.phoneNumber = phoneNumber;
+    if (peopleId !== undefined) params.body.peopleId = peopleId;
+    if (companyId !== undefined) params.body.companyId = companyId;
+    if (displayName !== undefined) params.body.displayName = displayName;
     if (note !== undefined) params.body.note = note;
     if (bridgeRole !== undefined) params.body.bridgeRole = bridgeRole;
 
@@ -175,28 +211,38 @@ export class ParticipantService {
   }
 
   /**
-   * Swap task ownership between the current owner and a joined helper.
+   * Swap task ownership between the current owner and a joined helper. When
+   * the helper has no access to the task's queue, this chains: it creates a
+   * new task in the helper's queue and makes them its owner. If `queueId` is
+   * omitted and the helper has access to more than one queue, the server
+   * responds 409 with `{ needsQueue: true, queues }` — retry with a chosen
+   * `queueId`.
    *
    * @param {Object} options - Options
    * @param {string} options.taskId - Task ID
    * @param {string} options.participantId - The helper participant taking/giving control
    * @param {string} options.action - 'give' | 'take'
-   * @returns {Promise<Object>} { taskId, workerId }
+   * @param {string} [options.queueId] - Target queue for a cross-queue control chain (only relevant when the helper lacks access to the task's own queue)
+   * @returns {Promise<Object>} { taskId, workerId } for a same-queue swap; { taskId, newTaskId, workerId } for a cross-queue chain
    *
    * @example
    * await sdk.taskRouter.participants.control({ taskId: 'task_123', participantId: 'tp_456', action: 'give' });
+   * @example
+   * await sdk.taskRouter.participants.control({ taskId: 'task_123', participantId: 'tp_456', action: 'take', queueId: 'queue_789' });
    */
-  async control({ taskId, participantId, action }) {
+  async control({ taskId, participantId, action, queueId }) {
     this.sdk.validateParams(
-      { taskId, participantId, action },
+      { taskId, participantId, action, queueId },
       {
         taskId: { type: 'string', required: true },
         participantId: { type: 'string', required: true },
         action: { type: 'string', required: true },
+        queueId: { type: 'string', required: false },
       },
     );
 
     const params = { body: { action } };
+    if (queueId !== undefined) params.body.queueId = queueId;
 
     return await internalRequest(
       this.sdk,