@unboundcx/sdk 4.13.55 → 4.13.57

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unboundcx/sdk",
3
- "version": "4.13.55",
3
+ "version": "4.13.57",
4
4
  "description": "Official JavaScript SDK for the Unbound API - A comprehensive toolkit for integrating with Unbound's communication, AI, and data management services",
5
5
  "main": "index.js",
6
6
  "type": "module",
@@ -14,7 +14,12 @@ export class AssistService {
14
14
  * @param {Object} options - Evaluate options
15
15
  * @param {string} options.taskId - Task ID
16
16
  * @param {Array} options.utterances - Utterances to evaluate
17
- * @returns {Promise<Object>} Evaluation result
17
+ * @returns {Promise<Object>} Evaluation result. Beyond the existing fields, now includes:
18
+ * @returns {string} result.coach - Agent-only guidance (may draw on internal + public KB, cards, playbook)
19
+ * @returns {Array<{sourceId:string,title:string,visibility:'internal'|'public',knowledgeBaseId:string}>} result.citations
20
+ * @returns {'ok'|'legacy'|'blocked:citation'|'blocked:overlap'|'blocked:dontSay'} result.guardResult
21
+ * @returns {'legacy'|'split'} result.visibilityMode
22
+ * @returns {string} result.reply - Insertable customer-facing text; empty when guardResult is blocked:*
18
23
  *
19
24
  * @example
20
25
  * const result = await sdk.ai.assist.evaluate({
@@ -44,7 +49,8 @@ export class AssistService {
44
49
  *
45
50
  * @param {Object} options - Options
46
51
  * @param {string} options.taskId - Task ID
47
- * @returns {Promise<Object>} Last evaluation
52
+ * @returns {Promise<Object>} Last evaluation. Same shape as evaluate()'s result, including
53
+ * coach, citations, guardResult, visibilityMode, reply (see evaluate() for field docs).
48
54
  *
49
55
  * @example
50
56
  * const last = await sdk.ai.assist.getLast({
@@ -63,6 +69,41 @@ export class AssistService {
63
69
  return result;
64
70
  }
65
71
 
72
+ /**
73
+ * List persisted AI Assist suggestions (assistSuggestions table), optionally scoped to a queue.
74
+ *
75
+ * @param {Object} [options] - Options
76
+ * @param {string} [options.queueId] - Filter by queue
77
+ * @param {number} [options.limit] - Max rows to return
78
+ * @returns {Promise<Object>} List of suggestion rows
79
+ *
80
+ * @example
81
+ * const { suggestions } = await sdk.ai.assist.listSuggestions({ queueId: 'queue_123', limit: 50 });
82
+ */
83
+ async listSuggestions({ queueId, limit } = {}) {
84
+ const result = await internalRequest(this.sdk, '/ai/assist/suggestions', 'GET', {
85
+ query: { queueId, limit },
86
+ });
87
+ return result;
88
+ }
89
+
90
+ /**
91
+ * Get aggregate stats for AI Assist suggestions (counts by guardResult, top blocked citations).
92
+ *
93
+ * @param {Object} [options] - Options
94
+ * @param {string} [options.queueId] - Filter by queue
95
+ * @returns {Promise<Object>} Stats { byGuardResult, topBlockedCitations, ... }
96
+ *
97
+ * @example
98
+ * const stats = await sdk.ai.assist.suggestionStats({ queueId: 'queue_123' });
99
+ */
100
+ async suggestionStats({ queueId } = {}) {
101
+ const result = await internalRequest(this.sdk, '/ai/assist/suggestions/stats', 'GET', {
102
+ query: { queueId },
103
+ });
104
+ return result;
105
+ }
106
+
66
107
  async listQueueKnowledgeBases({ queueId }) {
67
108
  this.sdk.validateParams(
68
109
  { queueId },
@@ -17,9 +17,11 @@ export class KnowledgeBaseService {
17
17
  * @param {string} [params.filters.sourceType] - Filter by source type (article, document, source)
18
18
  * @param {Array} [params.filters.tags] - Filter by tags
19
19
  * @param {boolean} [params.rerank] - Whether to apply LLM reranking (default: true)
20
+ * @param {'all'|'public'} [params.visibility] - Result visibility scope: 'all' (default) or 'public' only.
21
+ * Each result's source now also includes isPublic, knowledgeBaseId, knowledgeBaseName.
20
22
  * @returns {Promise<Object>} Search results with source attribution
21
23
  */
22
- async search({ query, knowledgeBaseId, limit, filters, rerank }) {
24
+ async search({ query, knowledgeBaseId, limit, filters, rerank, visibility }) {
23
25
  this.sdk.validateParams(
24
26
  { query },
25
27
  {
@@ -28,7 +30,7 @@ export class KnowledgeBaseService {
28
30
  );
29
31
 
30
32
  const params = {
31
- body: { query, knowledgeBaseId, limit, filters, rerank },
33
+ body: { query, knowledgeBaseId, limit, filters, rerank, visibility },
32
34
  };
33
35
 
34
36
  const result = await internalRequest(this.sdk,
@@ -0,0 +1,71 @@
1
+ import { internalRequest } from '../../base.js';
2
+
3
+ /**
4
+ * Offer Service - accept/decline a direct offer (transfer/invite/help) routed to a user
5
+ */
6
+ export class OfferService {
7
+ constructor(sdk) {
8
+ this.sdk = sdk;
9
+ }
10
+
11
+ /**
12
+ * Accept a pending direct offer.
13
+ * Creates/reuses the caller's worker session as needed and assigns the task to them.
14
+ *
15
+ * @param {Object} options - Options
16
+ * @param {string} options.offerId - Offer ID
17
+ * @returns {Promise<Object>} { taskId, workerId, isVoice }
18
+ *
19
+ * @example
20
+ * const result = await sdk.taskRouter.offer.accept({ offerId: 'offer_123' });
21
+ */
22
+ async accept({ offerId }) {
23
+ this.sdk.validateParams(
24
+ { offerId },
25
+ {
26
+ offerId: { type: 'string', required: true },
27
+ },
28
+ );
29
+
30
+ const params = {
31
+ body: { offerId },
32
+ };
33
+
34
+ const result = await internalRequest(this.sdk,
35
+ '/taskRouter/offers/accept',
36
+ 'PUT',
37
+ params,
38
+ );
39
+ return result;
40
+ }
41
+
42
+ /**
43
+ * Decline a pending direct offer.
44
+ *
45
+ * @param {Object} options - Options
46
+ * @param {string} options.offerId - Offer ID
47
+ * @returns {Promise<Object>} { offerId }
48
+ *
49
+ * @example
50
+ * const result = await sdk.taskRouter.offer.decline({ offerId: 'offer_123' });
51
+ */
52
+ async decline({ offerId }) {
53
+ this.sdk.validateParams(
54
+ { offerId },
55
+ {
56
+ offerId: { type: 'string', required: true },
57
+ },
58
+ );
59
+
60
+ const params = {
61
+ body: { offerId },
62
+ };
63
+
64
+ const result = await internalRequest(this.sdk,
65
+ '/taskRouter/offers/decline',
66
+ 'PUT',
67
+ params,
68
+ );
69
+ return result;
70
+ }
71
+ }
@@ -2,6 +2,7 @@ import { WorkerService } from './WorkerService.js';
2
2
  import { TaskService } from './TaskService.js';
3
3
  import { MetricsService } from './MetricsService.js';
4
4
  import { CCService } from './CCService.js';
5
+ import { OfferService } from './OfferService.js';
5
6
 
6
7
  export class TaskRouterService {
7
8
  constructor(sdk) {
@@ -10,5 +11,6 @@ export class TaskRouterService {
10
11
  this.task = new TaskService(sdk);
11
12
  this.metrics = new MetricsService(sdk);
12
13
  this.cc = new CCService(sdk);
14
+ this.offer = new OfferService(sdk);
13
15
  }
14
16
  }