@unboundcx/sdk 4.8.9 → 4.8.11

package/services/search.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../base.js';
 /**
  * SearchService -- cross-entity fan-out search (WP6.1).
  * Backed by GET /search on app1-api: parallel per-store LIKE/fulltext
@@ -43,6 +44,6 @@ export class SearchService {
       query.entities = Array.isArray(entities) ? entities.join(',') : entities;
     }
 
-    return await this.sdk._fetch('/search', 'GET', { query });
+    return await internalRequest(this.sdk, '/search', 'GET', { query });
   }
 }

package/services/sipEndpoints.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../base.js';
 export class SipEndpointsService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -45,7 +46,7 @@ export class SipEndpointsService {
       },
     };
 
-    const result = await this.sdk._fetch('/sipEndpoints', 'POST', params);
+    const result = await internalRequest(this.sdk, '/sipEndpoints', 'POST', params);
     return result;
   }
 
@@ -54,7 +55,7 @@ export class SipEndpointsService {
    * @returns {Promise<Object>} WebRTC endpoint configuration
    */
   async getWebRtcDetails() {
-    const result = await this.sdk._fetch('/sipEndpoints/webrtc', 'GET');
+    const result = await internalRequest(this.sdk, '/sipEndpoints/webrtc', 'GET');
     return result;
   }
 
@@ -82,7 +83,7 @@ export class SipEndpointsService {
       body: { ...options }, // Pass all options through
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/sipEndpoints/${endpointId}`,
       'PUT',
       params,
@@ -103,7 +104,7 @@ export class SipEndpointsService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/sipEndpoints/${endpointId}`,
       'DELETE',
     );
@@ -123,7 +124,7 @@ export class SipEndpointsService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/sipEndpoints/${endpointId}/reboot`,
       'POST',
     );
@@ -143,7 +144,7 @@ export class SipEndpointsService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/sipEndpoints/${endpointId}/secret`,
       'POST',
     );
@@ -163,7 +164,7 @@ export class SipEndpointsService {
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/sipEndpoints/${endpointId}/secret/provisioning`,
       'POST',
     );

package/services/storage.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../base.js';
 export class StorageService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -327,7 +328,7 @@ export class StorageService {
       headers,
     };
 
-    return await this.sdk._fetch(endpoint, method, params, true);
+    return await internalRequest(this.sdk, endpoint, method, params, true);
   }
 
   // Upload with progress tracking using XMLHttpRequest
@@ -655,7 +656,7 @@ Response:
       headers,
     };
 
-    return await this.sdk._fetch('/storage/upload', 'POST', params, true);
+    return await internalRequest(this.sdk, '/storage/upload', 'POST', params, true);
   }
 
   async getFile(storageId, path, download = false) {
@@ -678,7 +679,7 @@ Response:
       url += `/storage/${path.startsWith('/') ? path.slice(1) : path}`;
     }
 
-    const result = await this.sdk._fetch(url, 'GET', params, true);
+    const result = await internalRequest(this.sdk, url, 'GET', params, true);
     return result;
   }
 
@@ -713,7 +714,7 @@ Response:
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/${storageId}`,
       'DELETE',
     );
@@ -721,7 +722,7 @@ Response:
   }
 
   async getStorageClassifications() {
-    const result = await this.sdk._fetch('/storage/classifications', 'GET');
+    const result = await internalRequest(this.sdk, '/storage/classifications', 'GET');
     return result;
   }
 
@@ -771,7 +772,7 @@ Response:
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/file/${storageId}/info`,
       'GET',
     );
@@ -791,7 +792,7 @@ Response:
       body: { metadata },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/file/${storageId}/metadata`,
       'PUT',
       params,
@@ -822,7 +823,7 @@ Response:
       query: options,
     };
 
-    const result = await this.sdk._fetch('/storage/files', 'GET', params);
+    const result = await internalRequest(this.sdk, '/storage/files', 'GET', params);
     return result;
   }
 
@@ -845,7 +846,7 @@ Response:
       body: { expiresIn },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/${fileId}/accessKey`,
       'POST',
       params,
@@ -882,7 +883,7 @@ Response:
       query: options,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/storage/configurations',
       'GET',
       params,
@@ -933,7 +934,7 @@ Response:
       body: config,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/storage/configurations',
       'POST',
       params,
@@ -962,7 +963,7 @@ Response:
       body: updates,
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/configurations/${id}`,
       'PUT',
       params,
@@ -984,7 +985,7 @@ Response:
       },
     );
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/storage/configurations/${id}`,
       'DELETE',
     );
@@ -1091,7 +1092,7 @@ Response:
 
     const params = { body };
 
-    return await this.sdk._fetch(`/storage/${storageId}/convert`, 'POST', params);
+    return await internalRequest(this.sdk, `/storage/${storageId}/convert`, 'POST', params);
   }
 
   /**
@@ -1174,7 +1175,7 @@ Response:
         body: updateData,
       };
 
-      const result = await this.sdk._fetch(
+      const result = await internalRequest(this.sdk, 
         `/storage/${storageId}`,
         'PUT',
         options,

package/services/subscriptions.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../base.js';
 export class SubscriptionsService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -24,7 +25,7 @@ export class SocketSubscriptionsService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/subscriptions/socket/connection',
       'GET',
       params,
@@ -52,7 +53,7 @@ export class SocketSubscriptionsService {
     if (subscriptionParams?.id) {
       uri = `/subscriptions/socket/${subscriptionParams.id}`;
     }
-    const result = await this.sdk._fetch(uri, 'POST', params);
+    const result = await internalRequest(this.sdk, uri, 'POST', params);
     return result;
   }
 
@@ -71,7 +72,7 @@ export class SocketSubscriptionsService {
       },
     };
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       `/subscriptions/socket/${id}`,
       'DELETE',
       params,

package/services/taskRouter/CCService.js

@@ -0,0 +1,303 @@
+import { internalRequest } from '../../base.js';
+export class CCService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * Resolve the caller's Contact Center queue scope + role.
+   * Managers see every non-deleted queue; agents see only the queues they
+   * belong to (queueUsers).
+   *
+   * @returns {Promise<Object>} result
+   * @returns {boolean} result.isManager - Whether the caller has queue-manager scope
+   * @returns {string|null} result.workerId - The caller's own worker id, if any
+   * @returns {Array<Object>} result.queues - Accessible queues [{id, name, slaThreshold, slaTargetPct, timezone}]
+   *
+   * @example
+   * const scope = await sdk.taskRouter.cc.getScope();
+   * console.log(scope.isManager, scope.queues.length);
+   */
+  async getScope() {
+    const result = await internalRequest(this.sdk, '/taskRouter/cc/scope', 'GET', {});
+    return result;
+  }
+
+  /**
+   * Get a live Contact Center snapshot (KPIs, per-queue summaries, team roster
+   * with active tasks) scoped to a set of queues.
+   *
+   * @param {Object} [options] - Parameters
+   * @param {string[]} [options.queueIds] - Queue ids to scope to (must be a subset of the caller's accessible queues). Omit/empty for full scope.
+   * @returns {Promise<Object>} result
+   * @returns {Object} result.kpis - Aggregate KPIs (inQueueNow, longestWaitSec, myHandledToday, myAvgHandleSecToday, slaTodayPct, slaTargetPct)
+   * @returns {Array<Object>} result.queues - Per-queue summaries (id, name, waiting, longestWaitSec, agentsAvailable, agentsTotal, slaPct, slaThreshold, slaTargetPct, timezone, health)
+   * @returns {Array<Object>} result.team - Team roster with active tasks
+   *
+   * @example
+   * const snapshot = await sdk.taskRouter.cc.getSnapshot({ queueIds: ['q1', 'q2'] });
+   * console.log(snapshot.kpis.inQueueNow);
+   */
+  async getSnapshot(options = {}) {
+    const { queueIds } = options;
+
+    this.sdk.validateParams(
+      { queueIds },
+      {
+        queueIds: { type: 'array', required: false },
+      },
+    );
+
+    const params = {};
+    if (queueIds && queueIds.length) {
+      params.query = { queueIds: queueIds.join(',') };
+    }
+
+    const result = await internalRequest(this.sdk, 
+      '/taskRouter/cc/snapshot',
+      'GET',
+      params,
+    );
+    return result;
+  }
+
+  /**
+   * Get on-queue session history for a worker (self allowed; another
+   * worker's sessions require the queue-manager scope).
+   *
+   * @param {Object} [options] - Parameters
+   * @param {string} [options.workerId] - Worker id to fetch sessions for (defaults to the caller's own worker)
+   * @param {string} [options.from] - ISO-8601 range start
+   * @param {string} [options.to] - ISO-8601 range end
+   * @returns {Promise<Object>} result
+   * @returns {Array<Object>} result.sessions - [{id, startedAt, endedAt, onQueueSec, breakSec, doneCount}]
+   *
+   * @example
+   * const { sessions } = await sdk.taskRouter.cc.getSessions({ workerId: 'w1', from: '2026-08-12T00:00:00Z', to: '2026-08-19T00:00:00Z' });
+   */
+  async getSessions(options = {}) {
+    const { workerId, from, to } = options;
+
+    this.sdk.validateParams(
+      { workerId, from, to },
+      {
+        workerId: { type: 'string', required: false },
+        from: { type: 'string', required: false },
+        to: { type: 'string', required: false },
+      },
+    );
+
+    const query = {};
+    if (workerId) query.workerId = workerId;
+    if (from) query.from = from;
+    if (to) query.to = to;
+
+    const result = await internalRequest(this.sdk, '/taskRouter/cc/sessions', 'GET', {
+      query,
+    });
+    return result;
+  }
+
+  /**
+   * Get windowed composite agent rankings (top/struggling) per queue + an
+   * 'all' rollup, scored from sentiment/SLA/volume/acceptance. `struggling`
+   * arrays are only present when the caller has the queue-manager scope
+   * (see `strugglingIncluded` on the result).
+   *
+   * @param {Object} [options] - Parameters
+   * @param {string[]} [options.queueIds] - Queue ids to scope to (must be a subset of the caller's accessible queues). Omit/empty for full scope.
+   * @param {string} options.from - ISO-8601 window start
+   * @param {string} options.to - ISO-8601 window end
+   * @returns {Promise<Object>} result
+   * @returns {Object} result.queues - Per-queue rankings, keyed by queueId: `{ top: [{workerId,name,score}], struggling?: [...] }`
+   * @returns {Object} result.all - Same shape, aggregated across every scoped queue
+   * @returns {boolean} result.strugglingIncluded - Whether `struggling` arrays were included
+   *
+   * @example
+   * const { queues, all } = await sdk.taskRouter.cc.getRankings({
+   *   queueIds: ['q1'],
+   *   from: '2026-08-12T00:00:00Z',
+   *   to: '2026-08-19T00:00:00Z',
+   * });
+   * console.log(all.top[0].name, all.top[0].score);
+   */
+  async getRankings(options = {}) {
+    const { queueIds, from, to } = options;
+
+    this.sdk.validateParams(
+      { queueIds, from, to },
+      {
+        queueIds: { type: 'array', required: false },
+        from: { type: 'string', required: true },
+        to: { type: 'string', required: true },
+      },
+    );
+
+    const query = { from, to };
+    if (queueIds && queueIds.length) {
+      query.queueIds = queueIds.join(',');
+    }
+
+    const result = await internalRequest(this.sdk, '/taskRouter/cc/rankings', 'GET', {
+      query,
+    });
+    return result;
+  }
+
+  /**
+   * Set a queue's composite ranking-weights override. Manager-only
+   * (`taskrouter:queue:manage`). Weights must be integers 0-100 that sum to
+   * exactly 100.
+   *
+   * @param {Object} options - Parameters
+   * @param {string} options.queueId - Queue id to update
+   * @param {Object} options.weights - `{sentiment, aht, volume, acceptance}` ints summing to 100
+   * @returns {Promise<Object>} result
+   * @returns {string} result.queueId
+   * @returns {Object} result.rankingWeights - The stored weights
+   *
+   * @example
+   * await sdk.taskRouter.cc.setQueueRankingWeights({
+   *   queueId: 'q1',
+   *   weights: { sentiment: 40, aht: 30, volume: 5, acceptance: 25 },
+   * });
+   */
+  async setQueueRankingWeights(options = {}) {
+    const { queueId, weights } = options;
+
+    this.sdk.validateParams(
+      { queueId, weights },
+      {
+        queueId: { type: 'string', required: true },
+        weights: { type: 'object', required: true },
+      },
+    );
+
+    const result = await internalRequest(this.sdk, 
+      `/taskRouter/cc/queues/${queueId}/rankingWeights`,
+      'PUT',
+      { body: weights },
+    );
+    return result;
+  }
+
+  /**
+   * Get one agent's Contact Center performance summary (KPIs, per-day
+   * charts, live tasks, on-queue sessions) over a date/date-range, with a
+   * comparison window for deltas. Self allowed; another worker's summary
+   * requires the queue-manager scope.
+   *
+   * @param {Object} options - Parameters
+   * @param {string} options.workerId - Worker id to summarize
+   * @param {string} options.from - ISO-8601 window start
+   * @param {string} options.to - ISO-8601 window end
+   * @param {string} [options.compareFrom] - ISO-8601 comparison window start (defaults to the preceding equal-length period)
+   * @param {string} [options.compareTo] - ISO-8601 comparison window end
+   * @returns {Promise<Object>} result
+   * @returns {Object} result.kpis - tasksHandled, offersAccepted, avgHandleSec, slaMet, avgSentiment, composite, onQueue
+   * @returns {Array<Object>} result.tasksPerDay - [{date, count}]
+   * @returns {Array<Object>} result.trend - [{date, sentiment, slaPct}]
+   * @returns {Array<Object>} result.liveNow - Current tasks (only when the window includes today)
+   * @returns {Array<Object>} result.sessions - On-queue session log
+   *
+   * @example
+   * const summary = await sdk.taskRouter.cc.getAgentSummary({
+   *   workerId: 'w1',
+   *   from: '2026-08-12T00:00:00Z',
+   *   to: '2026-08-19T00:00:00Z',
+   * });
+   * console.log(summary.kpis.tasksHandled.value);
+   */
+  async getAgentSummary(options = {}) {
+    const { workerId, from, to, compareFrom, compareTo } = options;
+
+    this.sdk.validateParams(
+      { workerId, from, to, compareFrom, compareTo },
+      {
+        workerId: { type: 'string', required: true },
+        from: { type: 'string', required: true },
+        to: { type: 'string', required: true },
+        compareFrom: { type: 'string', required: false },
+        compareTo: { type: 'string', required: false },
+      },
+    );
+
+    const query = { from, to };
+    if (compareFrom) query.compareFrom = compareFrom;
+    if (compareTo) query.compareTo = compareTo;
+
+    const result = await internalRequest(this.sdk, 
+      `/taskRouter/cc/agents/${workerId}/summary`,
+      'GET',
+      { query },
+    );
+    return result;
+  }
+
+  /**
+   * Log a worker into or out of a queue. Manager-only
+   * (`taskrouter:queue:manage`). Mutates the worker's queue membership
+   * through task-router (audited).
+   *
+   * @param {Object} options - Parameters
+   * @param {string} options.workerId - Worker id to update
+   * @param {string} options.queueId - Queue id to log in/out of
+   * @param {'login'|'logout'} options.action - Whether to add or remove the queue
+   * @returns {Promise<Object>} result
+   * @returns {string} result.workerId
+   * @returns {string} result.status
+   * @returns {Array<string>} result.queues - The worker's updated queue list
+   *
+   * @example
+   * await sdk.taskRouter.cc.setWorkerQueue({ workerId: 'w1', queueId: 'q1', action: 'login' });
+   */
+  async setWorkerQueue(options = {}) {
+    const { workerId, queueId, action } = options;
+
+    this.sdk.validateParams(
+      { workerId, queueId, action },
+      {
+        workerId: { type: 'string', required: true },
+        queueId: { type: 'string', required: true },
+        action: { type: 'string', required: true },
+      },
+    );
+
+    const result = await internalRequest(this.sdk, 
+      `/taskRouter/cc/workers/${workerId}/queues`,
+      'PUT',
+      { body: { queueId, action } },
+    );
+    return result;
+  }
+
+  /**
+   * Force a worker offline (out of every queue), closing their on-queue
+   * session. Manager-only (`taskrouter:queue:manage`, audited).
+   *
+   * @param {Object} options - Parameters
+   * @param {string} options.workerId - Worker id to log out
+   * @returns {Promise<Object>} result
+   * @returns {string} result.workerId
+   * @returns {string} result.status
+   * @returns {Array<string>} result.queues
+   *
+   * @example
+   * await sdk.taskRouter.cc.forceLogoutWorker({ workerId: 'w1' });
+   */
+  async forceLogoutWorker(options = {}) {
+    const { workerId } = options;
+
+    this.sdk.validateParams(
+      { workerId },
+      { workerId: { type: 'string', required: true } },
+    );
+
+    const result = await internalRequest(this.sdk, 
+      `/taskRouter/cc/workers/${workerId}/forceLogout`,
+      'POST',
+      {},
+    );
+    return result;
+  }
+}

package/services/taskRouter/MetricsService.js

@@ -1,3 +1,4 @@
+import { internalRequest } from '../../base.js';
 export class MetricsService {
   constructor(sdk) {
     this.sdk = sdk;
@@ -101,11 +102,65 @@ export class MetricsService {
       requestParams.body.metricType = metricType;
     }
 
-    const result = await this.sdk._fetch(
+    const result = await internalRequest(this.sdk, 
       '/taskRouter/metrics/current',
       'GET',
       requestParams,
     );
     return result;
   }
+
+  /**
+   * Get windowed queue/company metrics with a compare-window delta, per
+   * queue + an 'all' rollup (avg wait, avg handle, service level, longest
+   * wait, live depth/workers, and a waiting-count sparkline).
+   *
+   * @param {Object} params - Parameters
+   * @param {string[]} [params.queueIds] - Queue ids to scope to. Omit/empty for all queues.
+   * @param {string} params.from - ISO-8601 window start
+   * @param {string} params.to - ISO-8601 window end
+   * @param {string} params.compareFrom - ISO-8601 compare-window start
+   * @param {string} params.compareTo - ISO-8601 compare-window end
+   * @returns {Promise<Object>} result
+   * @returns {Object} result.window - `{from, to}`
+   * @returns {Object} result.compare - `{from, to}`
+   * @returns {Object} result.all - Rollup across every scoped queue (avgWaitSec, avgHandleSec, serviceLevelPct, longestWaitSec, depth, workersAvailable, workersTotal, waitingSparkline, deltas)
+   * @returns {Object} result.queues - Same shape as `result.all`, keyed by queueId
+   *
+   * @example
+   * const { all, queues } = await sdk.taskRouter.metrics.getWindow({
+   *   queueIds: ['q1', 'q2'],
+   *   from: '2026-08-19T22:00:00Z',
+   *   to: '2026-08-19T23:00:00Z',
+   *   compareFrom: '2026-08-19T21:00:00Z',
+   *   compareTo: '2026-08-19T22:00:00Z',
+   * });
+   * console.log(all.serviceLevelPct, all.deltas.serviceLevelPct);
+   */
+  async getWindow(params = {}) {
+    const { queueIds, from, to, compareFrom, compareTo } = params;
+
+    this.sdk.validateParams(
+      { queueIds, from, to, compareFrom, compareTo },
+      {
+        queueIds: { type: 'array', required: false },
+        from: { type: 'string', required: true },
+        to: { type: 'string', required: true },
+        compareFrom: { type: 'string', required: false },
+        compareTo: { type: 'string', required: false },
+      },
+    );
+
+    const query = { from, to };
+    if (queueIds && queueIds.length) query.queueIds = queueIds.join(',');
+    if (compareFrom) query.compareFrom = compareFrom;
+    if (compareTo) query.compareTo = compareTo;
+
+    const result = await internalRequest(this.sdk, 
+      '/taskRouter/metrics/window',
+      'GET',
+      { query },
+    );
+    return result;
+  }
 }

package/services/taskRouter/TaskRouterService.js

@@ -1,6 +1,7 @@
 import { WorkerService } from './WorkerService.js';
 import { TaskService } from './TaskService.js';
 import { MetricsService } from './MetricsService.js';
+import { CCService } from './CCService.js';
 
 export class TaskRouterService {
   constructor(sdk) {
@@ -8,5 +9,6 @@ export class TaskRouterService {
     this.worker = new WorkerService(sdk);
     this.task = new TaskService(sdk);
     this.metrics = new MetricsService(sdk);
+    this.cc = new CCService(sdk);
   }
 }