@unboundcx/sdk 4.13.112-security.1 → 4.13.113
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/base.js +3 -65
- package/index.js +0 -6
- package/package.json +1 -2
- package/services/login.js +0 -21
- package/services/objects.js +40 -0
- package/services/phoneNumbers.js +15 -1
- package/services/workflowTools.js +74 -0
- package/services/workflows.js +156 -48
- package/lib/refreshInterceptor.js +0 -106
- package/services/licenses.js +0 -330
- package/services/oauth.js +0 -159
package/base.js
CHANGED
|
@@ -13,8 +13,6 @@
|
|
|
13
13
|
* npm install mime-types
|
|
14
14
|
*/
|
|
15
15
|
|
|
16
|
-
import { handleUnauthorized } from './lib/refreshInterceptor.js';
|
|
17
|
-
|
|
18
16
|
const requestBySdk = new WeakMap();
|
|
19
17
|
const SDK_REQUEST = Symbol.for('unbound.sdk.request');
|
|
20
18
|
|
|
@@ -51,33 +49,12 @@ export class BaseSDK {
|
|
|
51
49
|
this.fwRequestId = arguments[3];
|
|
52
50
|
} else {
|
|
53
51
|
// New object-based parameters
|
|
54
|
-
const {
|
|
55
|
-
namespace,
|
|
56
|
-
callId,
|
|
57
|
-
token,
|
|
58
|
-
fwRequestId,
|
|
59
|
-
baseURL,
|
|
60
|
-
autoRefresh,
|
|
61
|
-
onUnauthorized,
|
|
62
|
-
refreshToken,
|
|
63
|
-
} = options;
|
|
52
|
+
const { namespace, callId, token, fwRequestId, baseURL } = options;
|
|
64
53
|
this.namespace = namespace || process?.env?.namespace;
|
|
65
54
|
this.callId = callId;
|
|
66
55
|
this.token = token;
|
|
67
56
|
this.fwRequestId = fwRequestId;
|
|
68
57
|
this._constructorBaseURL = baseURL;
|
|
69
|
-
// api#222 -- opt-in only (default false): existing callers get no
|
|
70
|
-
// behavior change. When on, a 401 from any non-/login* endpoint
|
|
71
|
-
// triggers one single-flight refresh + one retry (lib/refreshInterceptor.js).
|
|
72
|
-
this._autoRefresh = autoRefresh === true;
|
|
73
|
-
this._onUnauthorized =
|
|
74
|
-
typeof onUnauthorized === 'function' ? onUnauthorized : null;
|
|
75
|
-
// Bearer-delivery clients only: the raw refresh token, so autoRefresh
|
|
76
|
-
// has something to send to POST /login/refresh (cookie clients rely
|
|
77
|
-
// on the browser's own refreshToken cookie and never need this).
|
|
78
|
-
// Seeded via this option or setRefreshToken(); updated in place on
|
|
79
|
-
// every rotation by lib/refreshInterceptor.js.
|
|
80
|
-
this._refreshToken = refreshToken;
|
|
81
58
|
}
|
|
82
59
|
this.baseURL;
|
|
83
60
|
this.transports = new Map();
|
|
@@ -127,10 +104,6 @@ export class BaseSDK {
|
|
|
127
104
|
this.token = token;
|
|
128
105
|
}
|
|
129
106
|
|
|
130
|
-
setRefreshToken(refreshToken) {
|
|
131
|
-
this._refreshToken = refreshToken;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
107
|
setNamespace(namespace) {
|
|
135
108
|
this.namespace = namespace;
|
|
136
109
|
const defaultDomain = 'api.unbound.cx';
|
|
@@ -305,7 +278,6 @@ export class BaseSDK {
|
|
|
305
278
|
params,
|
|
306
279
|
returnRawResponse,
|
|
307
280
|
startTime,
|
|
308
|
-
forceFetch,
|
|
309
281
|
);
|
|
310
282
|
}
|
|
311
283
|
} else {
|
|
@@ -320,7 +292,6 @@ export class BaseSDK {
|
|
|
320
292
|
params,
|
|
321
293
|
returnRawResponse,
|
|
322
294
|
startTime,
|
|
323
|
-
forceFetch,
|
|
324
295
|
);
|
|
325
296
|
}
|
|
326
297
|
|
|
@@ -336,7 +307,6 @@ export class BaseSDK {
|
|
|
336
307
|
method,
|
|
337
308
|
endpoint,
|
|
338
309
|
duration,
|
|
339
|
-
{ originalParams: params, forceFetch },
|
|
340
310
|
);
|
|
341
311
|
}
|
|
342
312
|
|
|
@@ -387,7 +357,6 @@ export class BaseSDK {
|
|
|
387
357
|
params = {},
|
|
388
358
|
returnRawResponse = false,
|
|
389
359
|
startTime = Date.now(),
|
|
390
|
-
forceFetch = false,
|
|
391
360
|
) {
|
|
392
361
|
const { body, query, headers = {} } = params;
|
|
393
362
|
|
|
@@ -469,20 +438,10 @@ export class BaseSDK {
|
|
|
469
438
|
return response;
|
|
470
439
|
}
|
|
471
440
|
|
|
472
|
-
return this._processResponse(response, 'https', method, endpoint, duration
|
|
473
|
-
originalParams: params,
|
|
474
|
-
forceFetch,
|
|
475
|
-
});
|
|
441
|
+
return this._processResponse(response, 'https', method, endpoint, duration);
|
|
476
442
|
}
|
|
477
443
|
|
|
478
|
-
async _processResponse(
|
|
479
|
-
response,
|
|
480
|
-
transport,
|
|
481
|
-
method,
|
|
482
|
-
endpoint,
|
|
483
|
-
duration = 0,
|
|
484
|
-
retryCtx = {},
|
|
485
|
-
) {
|
|
444
|
+
async _processResponse(response, transport, method, endpoint, duration = 0) {
|
|
486
445
|
// Check if the response indicates an HTTP error
|
|
487
446
|
// These are API/configuration errors, not transport failures
|
|
488
447
|
|
|
@@ -559,27 +518,6 @@ export class BaseSDK {
|
|
|
559
518
|
);
|
|
560
519
|
}
|
|
561
520
|
|
|
562
|
-
// api#222 -- opt-in single-flight refresh + one retry on 401. Off by
|
|
563
|
-
// default (this._autoRefresh set only via the `autoRefresh` ctor
|
|
564
|
-
// option); the retry's own params carry `__skipAutoRefresh` so a 401
|
|
565
|
-
// on the RETRY itself always falls through to onUnauthorized instead
|
|
566
|
-
// of looping.
|
|
567
|
-
if (response.status === 401 && this._autoRefresh) {
|
|
568
|
-
return handleUnauthorized(this, {
|
|
569
|
-
status: response.status,
|
|
570
|
-
endpoint,
|
|
571
|
-
alreadyRetried: retryCtx?.originalParams?.__skipAutoRefresh === true,
|
|
572
|
-
originalError: httpError,
|
|
573
|
-
retry: () =>
|
|
574
|
-
this.#request(
|
|
575
|
-
endpoint,
|
|
576
|
-
method,
|
|
577
|
-
{ ...(retryCtx.originalParams || {}), __skipAutoRefresh: true },
|
|
578
|
-
retryCtx.forceFetch,
|
|
579
|
-
),
|
|
580
|
-
});
|
|
581
|
-
}
|
|
582
|
-
|
|
583
521
|
throw httpError;
|
|
584
522
|
}
|
|
585
523
|
|
package/index.js
CHANGED
|
@@ -38,7 +38,6 @@ import { FaxService } from './services/fax.js';
|
|
|
38
38
|
import { DocumentsService } from './services/documents.js';
|
|
39
39
|
import { EsignService } from './services/esign.js';
|
|
40
40
|
import { PermissionsService } from './services/permissions.js';
|
|
41
|
-
import { LicensesService } from './services/licenses.js';
|
|
42
41
|
import { UsersService } from './services/users.js';
|
|
43
42
|
import { TriggersService } from './services/triggers.js';
|
|
44
43
|
import { RecentsService } from './services/recents.js';
|
|
@@ -48,7 +47,6 @@ import { ChatService } from './services/chat.js';
|
|
|
48
47
|
import { DeveloperApisService } from './services/developerApis.js';
|
|
49
48
|
import { TextService } from './services/text.js';
|
|
50
49
|
import { ReportingService } from './services/reporting.js';
|
|
51
|
-
import { OAuthService } from './services/oauth.js';
|
|
52
50
|
import {
|
|
53
51
|
DataImportService,
|
|
54
52
|
DataExportService,
|
|
@@ -140,14 +138,12 @@ class UnboundSDK extends BaseSDK {
|
|
|
140
138
|
this.documents = new DocumentsService(this);
|
|
141
139
|
this.esign = new EsignService(this);
|
|
142
140
|
this.permissions = new PermissionsService(this);
|
|
143
|
-
this.licenses = new LicensesService(this);
|
|
144
141
|
this.users = new UsersService(this);
|
|
145
142
|
this.reporting = new ReportingService(this);
|
|
146
143
|
this.triggers = new TriggersService(this);
|
|
147
144
|
this.recents = new RecentsService(this);
|
|
148
145
|
this.search = new SearchService(this);
|
|
149
146
|
this.directory = new DirectoryService(this);
|
|
150
|
-
this.oauth = new OAuthService(this);
|
|
151
147
|
this.chat = new ChatService(this);
|
|
152
148
|
this.developerApis = new DeveloperApisService(this);
|
|
153
149
|
this.dataImport = new DataImportService(this);
|
|
@@ -348,13 +344,11 @@ export { KnowledgeBaseService } from './services/knowledgeBase.js';
|
|
|
348
344
|
export { FaxService } from './services/fax.js';
|
|
349
345
|
export { EsignService, EsignPublicService } from './services/esign.js';
|
|
350
346
|
export { PermissionsService } from './services/permissions.js';
|
|
351
|
-
export { LicensesService } from './services/licenses.js';
|
|
352
347
|
export { UsersService } from './services/users.js';
|
|
353
348
|
export { ReportingService } from './services/reporting.js';
|
|
354
349
|
export { RecentsService } from './services/recents.js';
|
|
355
350
|
export { SearchService } from './services/search.js';
|
|
356
351
|
export { DirectoryService } from './services/directory.js';
|
|
357
|
-
export { OAuthService } from './services/oauth.js';
|
|
358
352
|
export { ChatService } from './services/chat.js';
|
|
359
353
|
export { DeveloperApisService } from './services/developerApis.js';
|
|
360
354
|
export {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@unboundcx/sdk",
|
|
3
|
-
"version": "4.13.
|
|
3
|
+
"version": "4.13.113",
|
|
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",
|
|
@@ -40,7 +40,6 @@
|
|
|
40
40
|
"*.js",
|
|
41
41
|
"services/**/*.js",
|
|
42
42
|
"transports/**/*.js",
|
|
43
|
-
"lib/**/*.js",
|
|
44
43
|
"types/**/*.d.ts",
|
|
45
44
|
"proto/**/*.proto",
|
|
46
45
|
"schemas/**/*.js",
|
package/services/login.js
CHANGED
|
@@ -29,35 +29,14 @@ export class LoginService {
|
|
|
29
29
|
}
|
|
30
30
|
}
|
|
31
31
|
|
|
32
|
-
// api#222: bearer clients get refreshToken back on /login too (same
|
|
33
|
-
// contract as /login/refresh) -- seed it onto the sdk instance so
|
|
34
|
-
// autoRefresh has something to send on the very first refresh, and
|
|
35
|
-
// also return it for a caller that manages the token itself.
|
|
36
|
-
if (login?.refreshToken) this.sdk.setRefreshToken(login.refreshToken);
|
|
37
|
-
|
|
38
32
|
return {
|
|
39
33
|
valid: true,
|
|
40
34
|
userId: login.userId,
|
|
41
35
|
namespace: login.namespace,
|
|
42
36
|
url: login.url,
|
|
43
|
-
refreshToken: login.refreshToken,
|
|
44
37
|
};
|
|
45
38
|
}
|
|
46
39
|
|
|
47
|
-
// api#222. Cookie clients: no args -- the refreshToken cookie is sent
|
|
48
|
-
// automatically and the new authToken/refreshToken cookies come back on
|
|
49
|
-
// the response, nothing to apply to the SDK instance. Bearer clients:
|
|
50
|
-
// pass the refresh token string; the response's `token` is returned so
|
|
51
|
-
// the caller (or lib/refreshInterceptor.js) can call sdk.setToken(token).
|
|
52
|
-
// Always forceFetch (true): refresh exists to recover a dead session, so
|
|
53
|
-
// it must never ride a socket transport that itself depends on that
|
|
54
|
-
// session still being alive.
|
|
55
|
-
async refresh(refreshToken) {
|
|
56
|
-
const options = {};
|
|
57
|
-
if (refreshToken) options.body = { refreshToken };
|
|
58
|
-
return internalRequest(this.sdk, '/login/refresh', 'POST', options, true);
|
|
59
|
-
}
|
|
60
|
-
|
|
61
40
|
async logout() {
|
|
62
41
|
const logout = await internalRequest(this.sdk, '/login', 'DELETE', {}, true);
|
|
63
42
|
|
package/services/objects.js
CHANGED
|
@@ -1416,4 +1416,44 @@ export class ObjectsService {
|
|
|
1416
1416
|
{ body: {} },
|
|
1417
1417
|
);
|
|
1418
1418
|
}
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* P7 (workflows-v2-plan.md W10/W11/W23) -- runs an immediate full
|
|
1422
|
+
* enter+exit sweep for a journey program. Same diff-and-enqueue path a
|
|
1423
|
+
* scheduled tick runs, so this can never 429.
|
|
1424
|
+
* @param {string} programId
|
|
1425
|
+
* @returns {Promise<{queued: true, enterEnqueued: number, exitEnqueued: number}>}
|
|
1426
|
+
*/
|
|
1427
|
+
async runMarketingProgramNow(programId) {
|
|
1428
|
+
this.sdk.validateParams(
|
|
1429
|
+
{ programId },
|
|
1430
|
+
{ programId: { type: 'string', required: true } },
|
|
1431
|
+
);
|
|
1432
|
+
return internalRequest(
|
|
1433
|
+
this.sdk,
|
|
1434
|
+
`/object/marketing-programs/${programId}/run`,
|
|
1435
|
+
'POST',
|
|
1436
|
+
{ body: {} },
|
|
1437
|
+
);
|
|
1438
|
+
}
|
|
1439
|
+
|
|
1440
|
+
/**
|
|
1441
|
+
* P7 -- paginated member list for a journey program (joined to people
|
|
1442
|
+
* for display name; never raw peopleId).
|
|
1443
|
+
* @param {string} programId
|
|
1444
|
+
* @param {{nextId?: string, limit?: number}} [opts]
|
|
1445
|
+
* @returns {Promise<{results: object[], pagination: object}>}
|
|
1446
|
+
*/
|
|
1447
|
+
async listMarketingProgramMembers(programId, opts = {}) {
|
|
1448
|
+
this.sdk.validateParams(
|
|
1449
|
+
{ programId },
|
|
1450
|
+
{ programId: { type: 'string', required: true } },
|
|
1451
|
+
);
|
|
1452
|
+
return internalRequest(
|
|
1453
|
+
this.sdk,
|
|
1454
|
+
`/object/marketing-programs/${programId}/members`,
|
|
1455
|
+
'GET',
|
|
1456
|
+
{ query: opts },
|
|
1457
|
+
);
|
|
1458
|
+
}
|
|
1419
1459
|
}
|
package/services/phoneNumbers.js
CHANGED
|
@@ -257,8 +257,19 @@ export class PhoneNumbersService {
|
|
|
257
257
|
*
|
|
258
258
|
* // Search workflows by name
|
|
259
259
|
* const filtered = await sdk.phoneNumbers.getRoutingOptions({ appType: 'workflows', search: 'customer' });
|
|
260
|
+
*
|
|
261
|
+
* // Page through a large appType's destination list (default 50, max 200)
|
|
262
|
+
* const page = await sdk.phoneNumbers.getRoutingOptions({ appType: 'users', search: 'jo', limit: 50 });
|
|
263
|
+
* // Returns: { users: [...], hasMore: true }
|
|
260
264
|
*/
|
|
261
|
-
async getRoutingOptions({
|
|
265
|
+
async getRoutingOptions({
|
|
266
|
+
mode,
|
|
267
|
+
type,
|
|
268
|
+
appType,
|
|
269
|
+
workflowId,
|
|
270
|
+
search,
|
|
271
|
+
limit,
|
|
272
|
+
} = {}) {
|
|
262
273
|
const validationSchema = {};
|
|
263
274
|
const args = arguments[0] || {};
|
|
264
275
|
|
|
@@ -272,6 +283,8 @@ export class PhoneNumbersService {
|
|
|
272
283
|
validationSchema.workflowId = { type: 'string', required: false };
|
|
273
284
|
if ('search' in args)
|
|
274
285
|
validationSchema.search = { type: 'string', required: false };
|
|
286
|
+
if ('limit' in args)
|
|
287
|
+
validationSchema.limit = { type: 'number', required: false };
|
|
275
288
|
|
|
276
289
|
if (Object.keys(validationSchema).length > 0) {
|
|
277
290
|
this.sdk.validateParams(args, validationSchema);
|
|
@@ -284,6 +297,7 @@ export class PhoneNumbersService {
|
|
|
284
297
|
appType,
|
|
285
298
|
workflowId,
|
|
286
299
|
search,
|
|
300
|
+
limit,
|
|
287
301
|
},
|
|
288
302
|
};
|
|
289
303
|
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { internalRequest } from '../base.js';
|
|
2
|
+
|
|
3
|
+
// P5 "REST twin + SDK" / "Auth" rows: workflows.tools.{list,call} +
|
|
4
|
+
// workflows.mcpTokens.{create,list,revoke}. Kept in its own file (repo
|
|
5
|
+
// file-size convention) rather than growing workflows.js further.
|
|
6
|
+
|
|
7
|
+
export class WorkflowToolsService {
|
|
8
|
+
constructor(sdk) {
|
|
9
|
+
this.sdk = sdk;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
// GET /workflows/tools -> [{name, description, inputSchema, outputSchema, annotations}]
|
|
13
|
+
async list() {
|
|
14
|
+
const result = await internalRequest(this.sdk, '/workflows/tools', 'GET');
|
|
15
|
+
return result;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
// POST /workflows/tools/:slug/call -> {completed, outputs, isError, message, sessionId}
|
|
19
|
+
async call(slug, input) {
|
|
20
|
+
this.sdk.validateParams(
|
|
21
|
+
{ slug },
|
|
22
|
+
{ slug: { type: 'string', required: true } },
|
|
23
|
+
);
|
|
24
|
+
|
|
25
|
+
const params = { body: { input: input || {} } };
|
|
26
|
+
const result = await internalRequest(
|
|
27
|
+
this.sdk,
|
|
28
|
+
`/workflows/tools/${slug}/call`,
|
|
29
|
+
'POST',
|
|
30
|
+
params,
|
|
31
|
+
);
|
|
32
|
+
return result;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export class WorkflowMcpTokensService {
|
|
37
|
+
constructor(sdk) {
|
|
38
|
+
this.sdk = sdk;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// POST /workflows/mcp/tokens -> {id, token, name} -- `token` (the raw
|
|
42
|
+
// JWT) is shown exactly once, never retrievable again.
|
|
43
|
+
async create({ name } = {}) {
|
|
44
|
+
const params = { body: name ? { name } : {} };
|
|
45
|
+
const result = await internalRequest(
|
|
46
|
+
this.sdk,
|
|
47
|
+
'/workflows/mcp/tokens',
|
|
48
|
+
'POST',
|
|
49
|
+
params,
|
|
50
|
+
);
|
|
51
|
+
return result;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// GET /workflows/mcp/tokens -> {tokens: [{id, name, createdAt, lastUsedAt, revokedAt}]}
|
|
55
|
+
async list() {
|
|
56
|
+
const result = await internalRequest(this.sdk, '/workflows/mcp/tokens', 'GET');
|
|
57
|
+
return result;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
// DELETE /workflows/mcp/tokens/:id -> {id, revoked:true}
|
|
61
|
+
async revoke(id) {
|
|
62
|
+
this.sdk.validateParams(
|
|
63
|
+
{ id },
|
|
64
|
+
{ id: { type: 'string', required: true } },
|
|
65
|
+
);
|
|
66
|
+
|
|
67
|
+
const result = await internalRequest(
|
|
68
|
+
this.sdk,
|
|
69
|
+
`/workflows/mcp/tokens/${id}`,
|
|
70
|
+
'DELETE',
|
|
71
|
+
);
|
|
72
|
+
return result;
|
|
73
|
+
}
|
|
74
|
+
}
|
package/services/workflows.js
CHANGED
|
@@ -1,31 +1,20 @@
|
|
|
1
1
|
import { internalRequest } from '../base.js';
|
|
2
|
+
import { WorkflowToolsService, WorkflowMcpTokensService } from './workflowTools.js';
|
|
3
|
+
|
|
2
4
|
export class WorkflowsService {
|
|
3
5
|
constructor(sdk) {
|
|
4
6
|
this.sdk = sdk;
|
|
5
7
|
this.items = new WorkflowItemsService(sdk);
|
|
6
8
|
this.connections = new WorkflowConnectionsService(sdk);
|
|
7
9
|
this.sessions = new WorkflowSessionsService(sdk);
|
|
10
|
+
// P5: MCP tools/tokens surface (workflows-v2-plan.md "REST twin + SDK" row).
|
|
11
|
+
this.tools = new WorkflowToolsService(sdk);
|
|
12
|
+
this.mcpTokens = new WorkflowMcpTokensService(sdk);
|
|
8
13
|
}
|
|
9
14
|
|
|
10
|
-
async
|
|
11
|
-
this.sdk.validateParams(
|
|
12
|
-
{ type },
|
|
13
|
-
{
|
|
14
|
-
type: { type: 'string', required: true },
|
|
15
|
-
},
|
|
16
|
-
);
|
|
17
|
-
|
|
15
|
+
async listModules({ workflowType } = {}) {
|
|
18
16
|
const params = {
|
|
19
|
-
query: {
|
|
20
|
-
};
|
|
21
|
-
|
|
22
|
-
const result = await internalRequest(this.sdk, '/workflows/settings', 'GET', params);
|
|
23
|
-
return result;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
async listModules() {
|
|
27
|
-
const params = {
|
|
28
|
-
query: {},
|
|
17
|
+
query: workflowType ? { workflowType } : {},
|
|
29
18
|
};
|
|
30
19
|
|
|
31
20
|
const result = await internalRequest(this.sdk, '/workflows/modules', 'GET', params);
|
|
@@ -107,6 +96,48 @@ export class WorkflowsService {
|
|
|
107
96
|
);
|
|
108
97
|
return result;
|
|
109
98
|
}
|
|
99
|
+
|
|
100
|
+
// Delete guard (soft-delete workflows / hard-delete draft versions):
|
|
101
|
+
// resolves everything a workflow (or a specific draft version) is
|
|
102
|
+
// referenced by, so the client can block the delete with a named list
|
|
103
|
+
// instead of a generic FK error. Exactly one of workflowId/
|
|
104
|
+
// workflowVersionId is expected.
|
|
105
|
+
async references({ workflowId, workflowVersionId } = {}) {
|
|
106
|
+
this.sdk.validateParams(
|
|
107
|
+
{ workflowId, workflowVersionId },
|
|
108
|
+
{
|
|
109
|
+
workflowId: { type: 'string', required: false },
|
|
110
|
+
workflowVersionId: { type: 'string', required: false },
|
|
111
|
+
},
|
|
112
|
+
);
|
|
113
|
+
|
|
114
|
+
const query = {};
|
|
115
|
+
if (workflowId) query.workflowId = workflowId;
|
|
116
|
+
if (workflowVersionId) query.workflowVersionId = workflowVersionId;
|
|
117
|
+
|
|
118
|
+
const result = await internalRequest(this.sdk, '/workflows/references', 'GET', {
|
|
119
|
+
query,
|
|
120
|
+
});
|
|
121
|
+
return result;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
// P6 §6 — variable catalogue (inputs/system/context/module outputs) for
|
|
125
|
+
// the designer's `{{` autocomplete + variables panel.
|
|
126
|
+
async variables(versionId) {
|
|
127
|
+
this.sdk.validateParams(
|
|
128
|
+
{ versionId },
|
|
129
|
+
{
|
|
130
|
+
versionId: { type: 'string', required: true },
|
|
131
|
+
},
|
|
132
|
+
);
|
|
133
|
+
|
|
134
|
+
const result = await internalRequest(
|
|
135
|
+
this.sdk,
|
|
136
|
+
`/workflows/${versionId}/variables`,
|
|
137
|
+
'GET',
|
|
138
|
+
);
|
|
139
|
+
return result;
|
|
140
|
+
}
|
|
110
141
|
}
|
|
111
142
|
|
|
112
143
|
export class WorkflowItemsService {
|
|
@@ -403,11 +434,10 @@ export class WorkflowSessionsService {
|
|
|
403
434
|
},
|
|
404
435
|
);
|
|
405
436
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
);
|
|
410
|
-
return result;
|
|
437
|
+
return this.sdk.objects.byId({
|
|
438
|
+
object: 'workflowSessions',
|
|
439
|
+
id: sessionId,
|
|
440
|
+
});
|
|
411
441
|
}
|
|
412
442
|
|
|
413
443
|
async update(sessionId, updateData) {
|
|
@@ -431,17 +461,25 @@ export class WorkflowSessionsService {
|
|
|
431
461
|
return result;
|
|
432
462
|
}
|
|
433
463
|
|
|
434
|
-
|
|
464
|
+
/**
|
|
465
|
+
* @param {string} sessionId
|
|
466
|
+
* @param {string} [reason] - passed through as body.reason -- the
|
|
467
|
+
* sessionComplete.js controller already accepts this (defaults to
|
|
468
|
+
* 'completed' server-side); P7's exitProgramMember.js passes
|
|
469
|
+
* 'programExit'. Backward compatible -- omitting it is unchanged.
|
|
470
|
+
*/
|
|
471
|
+
async complete(sessionId, reason) {
|
|
435
472
|
this.sdk.validateParams(
|
|
436
|
-
{ sessionId },
|
|
473
|
+
{ sessionId, reason },
|
|
437
474
|
{
|
|
438
475
|
sessionId: { type: 'string', required: true },
|
|
476
|
+
reason: { type: 'string', required: false },
|
|
439
477
|
},
|
|
440
478
|
);
|
|
441
479
|
|
|
442
|
-
const params = {};
|
|
480
|
+
const params = reason ? { body: { reason } } : {};
|
|
443
481
|
|
|
444
|
-
const result = await internalRequest(this.sdk,
|
|
482
|
+
const result = await internalRequest(this.sdk,
|
|
445
483
|
`/workflows/session/${sessionId}/complete`,
|
|
446
484
|
'PUT',
|
|
447
485
|
params,
|
|
@@ -449,21 +487,6 @@ export class WorkflowSessionsService {
|
|
|
449
487
|
return result;
|
|
450
488
|
}
|
|
451
489
|
|
|
452
|
-
async delete(sessionId) {
|
|
453
|
-
this.sdk.validateParams(
|
|
454
|
-
{ sessionId },
|
|
455
|
-
{
|
|
456
|
-
sessionId: { type: 'string', required: true },
|
|
457
|
-
},
|
|
458
|
-
);
|
|
459
|
-
|
|
460
|
-
const result = await internalRequest(this.sdk,
|
|
461
|
-
`/workflows/sessions/${sessionId}`,
|
|
462
|
-
'DELETE',
|
|
463
|
-
);
|
|
464
|
-
return result;
|
|
465
|
-
}
|
|
466
|
-
|
|
467
490
|
async logTranscript(sessionId, transcriptData) {
|
|
468
491
|
this.sdk.validateParams(
|
|
469
492
|
{ sessionId },
|
|
@@ -499,7 +522,14 @@ export class WorkflowSessionsService {
|
|
|
499
522
|
return result;
|
|
500
523
|
}
|
|
501
524
|
|
|
502
|
-
|
|
525
|
+
// search: phone/email/name, same matching as sessions.list(). allVersions:
|
|
526
|
+
// widen the summary cards + abandoned-by-module to every version of this
|
|
527
|
+
// version's workflow (module/connector traffic on the canvas always
|
|
528
|
+
// stays scoped to workflowVersionId -- the canvas is per-version).
|
|
529
|
+
async analytics(
|
|
530
|
+
workflowVersionId,
|
|
531
|
+
{ startDate, endDate, search, allVersions } = {},
|
|
532
|
+
) {
|
|
503
533
|
this.sdk.validateParams(
|
|
504
534
|
{ workflowVersionId, startDate, endDate },
|
|
505
535
|
{
|
|
@@ -509,15 +539,93 @@ export class WorkflowSessionsService {
|
|
|
509
539
|
},
|
|
510
540
|
);
|
|
511
541
|
|
|
512
|
-
const
|
|
513
|
-
|
|
514
|
-
|
|
542
|
+
const query = { startDate, endDate };
|
|
543
|
+
if (search) query.search = search;
|
|
544
|
+
if (allVersions) query.allVersions = true;
|
|
515
545
|
|
|
516
|
-
const result = await internalRequest(this.sdk,
|
|
546
|
+
const result = await internalRequest(this.sdk,
|
|
517
547
|
`/workflows/${workflowVersionId}/analytics`,
|
|
518
548
|
'GET',
|
|
519
|
-
|
|
549
|
+
{ query },
|
|
520
550
|
);
|
|
521
551
|
return result;
|
|
522
552
|
}
|
|
553
|
+
|
|
554
|
+
// P10 click-to-filter: GET /workflows/:workflowVersionId/sessions ->
|
|
555
|
+
// {sessionIds}. filter is {workflowItemId?, fromItemId?, toItemId?,
|
|
556
|
+
// startDate?, endDate?} -- workflowItemId alone, or fromItemId+toItemId
|
|
557
|
+
// together, is required (validated server-side in sessionsByPath.js).
|
|
558
|
+
async sessionsByPath(workflowVersionId, filter = {}) {
|
|
559
|
+
this.sdk.validateParams(
|
|
560
|
+
{ workflowVersionId },
|
|
561
|
+
{
|
|
562
|
+
workflowVersionId: { type: 'string', required: true },
|
|
563
|
+
},
|
|
564
|
+
);
|
|
565
|
+
|
|
566
|
+
const { workflowItemId, fromItemId, toItemId, startDate, endDate } =
|
|
567
|
+
filter || {};
|
|
568
|
+
const query = {};
|
|
569
|
+
if (workflowItemId) query.workflowItemId = workflowItemId;
|
|
570
|
+
if (fromItemId) query.fromItemId = fromItemId;
|
|
571
|
+
if (toItemId) query.toItemId = toItemId;
|
|
572
|
+
if (startDate) query.startDate = startDate;
|
|
573
|
+
if (endDate) query.endDate = endDate;
|
|
574
|
+
|
|
575
|
+
const result = await internalRequest(
|
|
576
|
+
this.sdk,
|
|
577
|
+
`/workflows/${workflowVersionId}/sessions`,
|
|
578
|
+
'GET',
|
|
579
|
+
{ query },
|
|
580
|
+
);
|
|
581
|
+
return result;
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
// Sessions page rebuild: sessions for a workflow across every version
|
|
585
|
+
// (pass workflowId) or one version (pass workflowVersionId), with
|
|
586
|
+
// server-side search across phone/email/caller-name so the list shows a
|
|
587
|
+
// real caller instead of a raw session id. GET /workflows/sessions/list.
|
|
588
|
+
// Either workflowId or workflowVersionId is required; the rest is
|
|
589
|
+
// optional (workflowItemId / fromItemId+toItemId reuse the same P10
|
|
590
|
+
// path-filter shape as sessionsByPath, and require workflowVersionId).
|
|
591
|
+
async list({
|
|
592
|
+
workflowId,
|
|
593
|
+
workflowVersionId,
|
|
594
|
+
search,
|
|
595
|
+
workflowItemId,
|
|
596
|
+
fromItemId,
|
|
597
|
+
toItemId,
|
|
598
|
+
startDate,
|
|
599
|
+
endDate,
|
|
600
|
+
limit,
|
|
601
|
+
before,
|
|
602
|
+
} = {}) {
|
|
603
|
+
this.sdk.validateParams(
|
|
604
|
+
{ workflowId, workflowVersionId },
|
|
605
|
+
{
|
|
606
|
+
workflowId: { type: 'string', required: false },
|
|
607
|
+
workflowVersionId: { type: 'string', required: false },
|
|
608
|
+
},
|
|
609
|
+
);
|
|
610
|
+
if (!workflowId && !workflowVersionId) {
|
|
611
|
+
throw new Error('workflowId or workflowVersionId is required.');
|
|
612
|
+
}
|
|
613
|
+
|
|
614
|
+
const query = {};
|
|
615
|
+
if (workflowId) query.workflowId = workflowId;
|
|
616
|
+
if (workflowVersionId) query.workflowVersionId = workflowVersionId;
|
|
617
|
+
if (search) query.search = search;
|
|
618
|
+
if (workflowItemId) query.workflowItemId = workflowItemId;
|
|
619
|
+
if (fromItemId) query.fromItemId = fromItemId;
|
|
620
|
+
if (toItemId) query.toItemId = toItemId;
|
|
621
|
+
if (startDate) query.startDate = startDate;
|
|
622
|
+
if (endDate) query.endDate = endDate;
|
|
623
|
+
if (limit) query.limit = limit;
|
|
624
|
+
if (before) query.before = before;
|
|
625
|
+
|
|
626
|
+
const result = await internalRequest(this.sdk, '/workflows/sessions/list', 'GET', {
|
|
627
|
+
query,
|
|
628
|
+
});
|
|
629
|
+
return result;
|
|
630
|
+
}
|
|
523
631
|
}
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
// api#222 client contract -- single-flight 401 -> refresh -> retry-once.
|
|
2
|
-
// base.js's `#request` funnels BOTH the Socket.IO transport and the plain
|
|
3
|
-
// HTTP fallback through the same `_processResponse` (see base.js), so this
|
|
4
|
-
// one hook covers every transport without a per-transport copy.
|
|
5
|
-
//
|
|
6
|
-
// Usage (base.js only -- app code never imports this directly):
|
|
7
|
-
// handleUnauthorized(sdk, { status, endpoint, retry, originalError })
|
|
8
|
-
//
|
|
9
|
-
// `retry` is a caller-supplied () => Promise that re-issues the ORIGINAL
|
|
10
|
-
// request. It has to come from the caller because #request is a private
|
|
11
|
-
// class field method -- this module can't call it directly.
|
|
12
|
-
|
|
13
|
-
// Keyed per SDK instance: a shared module-level variable would let one
|
|
14
|
-
// SDK instance's refresh starve a concurrent, unrelated SDK instance's own
|
|
15
|
-
// 401 recovery (a different user/session in the same Node process -- the
|
|
16
|
-
// API itself increasingly consumes this SDK server-side). Each instance
|
|
17
|
-
// still single-flights its own concurrent 401s against itself.
|
|
18
|
-
const inFlightRefreshBySdk = new WeakMap();
|
|
19
|
-
|
|
20
|
-
function isLoginRoute(endpoint) {
|
|
21
|
-
return typeof endpoint === 'string' && endpoint.startsWith('/login');
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
export function shouldAttemptRefresh(sdk, status, endpoint) {
|
|
25
|
-
return (
|
|
26
|
-
status === 401 &&
|
|
27
|
-
sdk?._autoRefresh === true &&
|
|
28
|
-
!isLoginRoute(endpoint) &&
|
|
29
|
-
typeof sdk?.login?.refresh === 'function'
|
|
30
|
-
);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
async function runRefresh(sdk) {
|
|
34
|
-
let inFlight = inFlightRefreshBySdk.get(sdk);
|
|
35
|
-
if (!inFlight) {
|
|
36
|
-
// Bearer clients (constructed with a raw token, no browser cookie jar)
|
|
37
|
-
// have to hand their raw refresh token back on every call -- the SDK
|
|
38
|
-
// never gets one implicitly the way a cookie client's browser does.
|
|
39
|
-
// sdk._refreshToken is set from login/refresh's own response below, or
|
|
40
|
-
// may be seeded via sdk.setRefreshToken() by a caller that obtained it
|
|
41
|
-
// out of band. Cookie clients simply have no stored value: `undefined`
|
|
42
|
-
// is fine, refresh() omits body.refreshToken and relies on the cookie.
|
|
43
|
-
inFlight = sdk.login
|
|
44
|
-
.refresh(sdk._refreshToken)
|
|
45
|
-
.then((result) => {
|
|
46
|
-
// Bearer clients get a new access token AND a new (rotated) refresh
|
|
47
|
-
// token back in the body; cookie clients rely on the Set-Cookie
|
|
48
|
-
// pair the refresh response already sent -- there is no token
|
|
49
|
-
// string to apply to the SDK instance for them.
|
|
50
|
-
if (result?.token) sdk.setToken(result.token);
|
|
51
|
-
if (result?.refreshToken) sdk._refreshToken = result.refreshToken;
|
|
52
|
-
return result;
|
|
53
|
-
})
|
|
54
|
-
.finally(() => {
|
|
55
|
-
inFlightRefreshBySdk.delete(sdk);
|
|
56
|
-
});
|
|
57
|
-
inFlightRefreshBySdk.set(sdk, inFlight);
|
|
58
|
-
}
|
|
59
|
-
return inFlight;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
function notifyUnauthorized(sdk, err) {
|
|
63
|
-
if (typeof sdk?._onUnauthorized !== 'function') return;
|
|
64
|
-
try {
|
|
65
|
-
sdk._onUnauthorized(err);
|
|
66
|
-
} catch (callbackErr) {
|
|
67
|
-
console.error(
|
|
68
|
-
'refreshInterceptor :: onUnauthorized callback threw ::',
|
|
69
|
-
callbackErr,
|
|
70
|
-
);
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* @param {object} sdk
|
|
76
|
-
* @param {object} ctx
|
|
77
|
-
* @param {number} ctx.status
|
|
78
|
-
* @param {string} ctx.endpoint
|
|
79
|
-
* @param {() => Promise<any>} ctx.retry
|
|
80
|
-
* @param {Error} ctx.originalError -- rethrown whenever refresh isn't
|
|
81
|
-
* attempted, fails, or the retry itself still comes back 401 (never loop
|
|
82
|
-
* past one retry).
|
|
83
|
-
* @param {boolean} [ctx.alreadyRetried]
|
|
84
|
-
*/
|
|
85
|
-
export async function handleUnauthorized(
|
|
86
|
-
sdk,
|
|
87
|
-
{ status, endpoint, retry, originalError, alreadyRetried = false },
|
|
88
|
-
) {
|
|
89
|
-
if (alreadyRetried || !shouldAttemptRefresh(sdk, status, endpoint)) {
|
|
90
|
-
throw originalError;
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
try {
|
|
94
|
-
await runRefresh(sdk);
|
|
95
|
-
} catch (refreshErr) {
|
|
96
|
-
notifyUnauthorized(sdk, originalError);
|
|
97
|
-
throw originalError;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
try {
|
|
101
|
-
return await retry();
|
|
102
|
-
} catch (retryErr) {
|
|
103
|
-
if (retryErr?.status === 401) notifyUnauthorized(sdk, retryErr);
|
|
104
|
-
throw retryErr;
|
|
105
|
-
}
|
|
106
|
-
}
|
package/services/licenses.js
DELETED
|
@@ -1,330 +0,0 @@
|
|
|
1
|
-
import { internalRequest } from '../base.js';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Entitlements / license administration (W2, plan §2 frozen contract).
|
|
5
|
-
* Tenant-admin methods hit `/permissions/*` (admin:license:manage /
|
|
6
|
-
* admin:user:manage, real guard in the controller). Brand-owner methods
|
|
7
|
-
* hit `/permissions/brand/*` (requireBrandOwner + brandId ownership
|
|
8
|
-
* check, 2D). Neither is tenant-writable for seats/overrides/AI --
|
|
9
|
-
* those live under `/internal/authz/*` for account-builder/billing and
|
|
10
|
-
* are not exposed here.
|
|
11
|
-
*/
|
|
12
|
-
export class LicensesService {
|
|
13
|
-
constructor(sdk) {
|
|
14
|
-
this.sdk = sdk;
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* Get the tenant's license catalog: license types, seat usage, and the
|
|
19
|
-
* capability catalog.
|
|
20
|
-
* @returns {Promise<Object>} `{ mode, licenseTypes[], capabilities[] }`
|
|
21
|
-
* @example
|
|
22
|
-
* const { licenseTypes } = await sdk.licenses.getCatalog();
|
|
23
|
-
*/
|
|
24
|
-
async getCatalog() {
|
|
25
|
-
return internalRequest(this.sdk, '/permissions/licenses', 'GET');
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* List users stuck in `needs_seat` (no free seat at assign time).
|
|
30
|
-
* @param {string} [licenseTypeCode] - Filter to one license type
|
|
31
|
-
* @returns {Promise<Object>} `{ results: [{ userId, licenseTypeCode, source, createdAt }] }`
|
|
32
|
-
* @example
|
|
33
|
-
* const { results } = await sdk.licenses.listNeedsSeat('license.support');
|
|
34
|
-
*/
|
|
35
|
-
async listNeedsSeat(licenseTypeCode) {
|
|
36
|
-
const params = licenseTypeCode ? { query: { licenseTypeCode } } : {};
|
|
37
|
-
return internalRequest(
|
|
38
|
-
this.sdk,
|
|
39
|
-
'/permissions/licenses/needs-seat',
|
|
40
|
-
'GET',
|
|
41
|
-
params,
|
|
42
|
-
);
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* Get one user's licenses and resolved entitlements.
|
|
47
|
-
* @param {string} userId
|
|
48
|
-
* @returns {Promise<Object>} `{ licenses[], capabilities[], disabledCapabilities[], licenseGate }`
|
|
49
|
-
* @example
|
|
50
|
-
* await sdk.licenses.getUserLicenses('user-123');
|
|
51
|
-
*/
|
|
52
|
-
async getUserLicenses(userId) {
|
|
53
|
-
this.sdk.validateParams(
|
|
54
|
-
{ userId },
|
|
55
|
-
{ userId: { type: 'string', required: true } },
|
|
56
|
-
);
|
|
57
|
-
return internalRequest(
|
|
58
|
-
this.sdk,
|
|
59
|
-
`/permissions/users/${userId}/licenses`,
|
|
60
|
-
'GET',
|
|
61
|
-
);
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Assign a license directly to a user. 409s with
|
|
66
|
-
* `code:'seat_limit_reached'` at capacity or `code:'license_type_disabled'`
|
|
67
|
-
* for a disabled type.
|
|
68
|
-
* @param {string} userId
|
|
69
|
-
* @param {string} licenseTypeCode
|
|
70
|
-
* @returns {Promise<Object>} The assigned license row
|
|
71
|
-
* @example
|
|
72
|
-
* await sdk.licenses.assignUserLicense('user-123', 'license.core');
|
|
73
|
-
*/
|
|
74
|
-
async assignUserLicense(userId, licenseTypeCode) {
|
|
75
|
-
this.sdk.validateParams(
|
|
76
|
-
{ userId, licenseTypeCode },
|
|
77
|
-
{
|
|
78
|
-
userId: { type: 'string', required: true },
|
|
79
|
-
licenseTypeCode: { type: 'string', required: true },
|
|
80
|
-
},
|
|
81
|
-
);
|
|
82
|
-
return internalRequest(
|
|
83
|
-
this.sdk,
|
|
84
|
-
`/permissions/users/${userId}/licenses`,
|
|
85
|
-
'POST',
|
|
86
|
-
{ body: { licenseTypeCode } },
|
|
87
|
-
);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Remove a user's direct license grant (group-sourced grants are
|
|
92
|
-
* unaffected -- see `recomputeUserLicenses`).
|
|
93
|
-
* @param {string} userId
|
|
94
|
-
* @param {string} licenseTypeCode
|
|
95
|
-
* @returns {Promise<Object>}
|
|
96
|
-
* @example
|
|
97
|
-
* await sdk.licenses.removeUserLicense('user-123', 'license.core');
|
|
98
|
-
*/
|
|
99
|
-
async removeUserLicense(userId, licenseTypeCode) {
|
|
100
|
-
this.sdk.validateParams(
|
|
101
|
-
{ userId, licenseTypeCode },
|
|
102
|
-
{
|
|
103
|
-
userId: { type: 'string', required: true },
|
|
104
|
-
licenseTypeCode: { type: 'string', required: true },
|
|
105
|
-
},
|
|
106
|
-
);
|
|
107
|
-
return internalRequest(
|
|
108
|
-
this.sdk,
|
|
109
|
-
`/permissions/users/${userId}/licenses/${licenseTypeCode}`,
|
|
110
|
-
'DELETE',
|
|
111
|
-
);
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* Get a group's license types (group-sourced grants fan out to members).
|
|
116
|
-
* @param {string} groupId
|
|
117
|
-
* @returns {Promise<Object>} `{ licenseTypeCodes: [] }`
|
|
118
|
-
* @example
|
|
119
|
-
* await sdk.licenses.getGroupLicenses('group-123');
|
|
120
|
-
*/
|
|
121
|
-
async getGroupLicenses(groupId) {
|
|
122
|
-
this.sdk.validateParams(
|
|
123
|
-
{ groupId },
|
|
124
|
-
{ groupId: { type: 'string', required: true } },
|
|
125
|
-
);
|
|
126
|
-
return internalRequest(
|
|
127
|
-
this.sdk,
|
|
128
|
-
`/permissions/groups/${groupId}/licenses`,
|
|
129
|
-
'GET',
|
|
130
|
-
);
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* Replace a group's license types. Triggers a `recomputeUserLicenses`
|
|
135
|
-
* fan-out for every member.
|
|
136
|
-
* @param {string} groupId
|
|
137
|
-
* @param {string[]} licenseTypeCodes
|
|
138
|
-
* @returns {Promise<Object>}
|
|
139
|
-
* @example
|
|
140
|
-
* await sdk.licenses.setGroupLicenses('group-123', ['license.core']);
|
|
141
|
-
*/
|
|
142
|
-
async setGroupLicenses(groupId, licenseTypeCodes) {
|
|
143
|
-
this.sdk.validateParams(
|
|
144
|
-
{ groupId, licenseTypeCodes },
|
|
145
|
-
{
|
|
146
|
-
groupId: { type: 'string', required: true },
|
|
147
|
-
licenseTypeCodes: { type: 'array', required: true },
|
|
148
|
-
},
|
|
149
|
-
);
|
|
150
|
-
return internalRequest(
|
|
151
|
-
this.sdk,
|
|
152
|
-
`/permissions/groups/${groupId}/licenses`,
|
|
153
|
-
'PUT',
|
|
154
|
-
{ body: { licenseTypeCodes } },
|
|
155
|
-
);
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
/**
|
|
159
|
-
* Set a user's active/disabled status (W1-3). Disabling bumps the
|
|
160
|
-
* user's token_version and logs them out of every queue.
|
|
161
|
-
* @param {string} userId
|
|
162
|
-
* @param {'active'|'disabled'} status
|
|
163
|
-
* @returns {Promise<Object>}
|
|
164
|
-
* @example
|
|
165
|
-
* await sdk.licenses.setUserStatus('user-123', 'disabled');
|
|
166
|
-
*/
|
|
167
|
-
async setUserStatus(userId, status) {
|
|
168
|
-
this.sdk.validateParams(
|
|
169
|
-
{ userId, status },
|
|
170
|
-
{
|
|
171
|
-
userId: { type: 'string', required: true },
|
|
172
|
-
status: { type: 'string', required: true },
|
|
173
|
-
},
|
|
174
|
-
);
|
|
175
|
-
return internalRequest(
|
|
176
|
-
this.sdk,
|
|
177
|
-
`/permissions/users/${userId}/status`,
|
|
178
|
-
'PUT',
|
|
179
|
-
{ body: { status } },
|
|
180
|
-
);
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
// -- Brand-owner methods (requireBrandOwner; 2D api routes) --------------
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* Brand owner: list the tenant accounts under this brand, with their
|
|
187
|
-
* seats and overrides.
|
|
188
|
-
* @returns {Promise<Object>} `{ accounts: [{ id, name, code, aiEnabled, seats[], overrides[] }] }`
|
|
189
|
-
* @example
|
|
190
|
-
* const { accounts } = await sdk.licenses.listBrandAccounts();
|
|
191
|
-
*/
|
|
192
|
-
async listBrandAccounts() {
|
|
193
|
-
return internalRequest(this.sdk, '/permissions/brand/accounts', 'GET');
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
/**
|
|
197
|
-
* Brand owner: get one brand account's entitlements.
|
|
198
|
-
* @param {string} accountId
|
|
199
|
-
* @returns {Promise<Object>} `{ id, name, code, aiEnabled, seats[], overrides[] }`
|
|
200
|
-
* @example
|
|
201
|
-
* await sdk.licenses.getBrandAccountEntitlements('acct-123');
|
|
202
|
-
*/
|
|
203
|
-
async getBrandAccountEntitlements(accountId) {
|
|
204
|
-
this.sdk.validateParams(
|
|
205
|
-
{ accountId },
|
|
206
|
-
{ accountId: { type: 'string', required: true } },
|
|
207
|
-
);
|
|
208
|
-
return internalRequest(
|
|
209
|
-
this.sdk,
|
|
210
|
-
`/permissions/brand/accounts/${accountId}/entitlements`,
|
|
211
|
-
'GET',
|
|
212
|
-
);
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
/**
|
|
216
|
-
* Brand owner: set a brand account's seat pool for one license type.
|
|
217
|
-
* @param {string} accountId
|
|
218
|
-
* @param {string} licenseTypeCode
|
|
219
|
-
* @param {Object} seats
|
|
220
|
-
* @param {number} seats.seatCount
|
|
221
|
-
* @param {boolean} [seats.enabled]
|
|
222
|
-
* @param {boolean} [seats.isDefaultForNewUsers]
|
|
223
|
-
* @returns {Promise<Object>}
|
|
224
|
-
* @example
|
|
225
|
-
* await sdk.licenses.setBrandAccountSeats('acct-123', 'license.core', { seatCount: 25 });
|
|
226
|
-
*/
|
|
227
|
-
async setBrandAccountSeats(
|
|
228
|
-
accountId,
|
|
229
|
-
licenseTypeCode,
|
|
230
|
-
{ seatCount, enabled, isDefaultForNewUsers } = {},
|
|
231
|
-
) {
|
|
232
|
-
this.sdk.validateParams(
|
|
233
|
-
{ accountId, licenseTypeCode, seatCount },
|
|
234
|
-
{
|
|
235
|
-
accountId: { type: 'string', required: true },
|
|
236
|
-
licenseTypeCode: { type: 'string', required: true },
|
|
237
|
-
seatCount: { type: 'number', required: true },
|
|
238
|
-
},
|
|
239
|
-
);
|
|
240
|
-
const body = { seatCount };
|
|
241
|
-
if (enabled !== undefined) body.enabled = enabled;
|
|
242
|
-
if (isDefaultForNewUsers !== undefined)
|
|
243
|
-
body.isDefaultForNewUsers = isDefaultForNewUsers;
|
|
244
|
-
return internalRequest(
|
|
245
|
-
this.sdk,
|
|
246
|
-
`/permissions/brand/accounts/${accountId}/license-seats/${licenseTypeCode}`,
|
|
247
|
-
'PUT',
|
|
248
|
-
{ body },
|
|
249
|
-
);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
/**
|
|
253
|
-
* Brand owner: enable or disable a capability override for a brand
|
|
254
|
-
* account.
|
|
255
|
-
* @param {string} accountId
|
|
256
|
-
* @param {string} capabilityCode
|
|
257
|
-
* @param {Object} override
|
|
258
|
-
* @param {'enable'|'disable'} override.mode
|
|
259
|
-
* @param {string} [override.reason]
|
|
260
|
-
* @returns {Promise<Object>}
|
|
261
|
-
* @example
|
|
262
|
-
* await sdk.licenses.setBrandAccountOverride('acct-123', 'capability.chat', { mode: 'disable', reason: 'trial ended' });
|
|
263
|
-
*/
|
|
264
|
-
async setBrandAccountOverride(accountId, capabilityCode, { mode, reason } = {}) {
|
|
265
|
-
this.sdk.validateParams(
|
|
266
|
-
{ accountId, capabilityCode, mode },
|
|
267
|
-
{
|
|
268
|
-
accountId: { type: 'string', required: true },
|
|
269
|
-
capabilityCode: { type: 'string', required: true },
|
|
270
|
-
mode: { type: 'string', required: true },
|
|
271
|
-
},
|
|
272
|
-
);
|
|
273
|
-
const body = { mode };
|
|
274
|
-
if (reason !== undefined) body.reason = reason;
|
|
275
|
-
return internalRequest(
|
|
276
|
-
this.sdk,
|
|
277
|
-
`/permissions/brand/accounts/${accountId}/capability-overrides/${capabilityCode}`,
|
|
278
|
-
'PUT',
|
|
279
|
-
{ body },
|
|
280
|
-
);
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* Brand owner: remove a capability override, reverting to the license
|
|
285
|
-
* template default.
|
|
286
|
-
* @param {string} accountId
|
|
287
|
-
* @param {string} capabilityCode
|
|
288
|
-
* @returns {Promise<Object>}
|
|
289
|
-
* @example
|
|
290
|
-
* await sdk.licenses.deleteBrandAccountOverride('acct-123', 'capability.chat');
|
|
291
|
-
*/
|
|
292
|
-
async deleteBrandAccountOverride(accountId, capabilityCode) {
|
|
293
|
-
this.sdk.validateParams(
|
|
294
|
-
{ accountId, capabilityCode },
|
|
295
|
-
{
|
|
296
|
-
accountId: { type: 'string', required: true },
|
|
297
|
-
capabilityCode: { type: 'string', required: true },
|
|
298
|
-
},
|
|
299
|
-
);
|
|
300
|
-
return internalRequest(
|
|
301
|
-
this.sdk,
|
|
302
|
-
`/permissions/brand/accounts/${accountId}/capability-overrides/${capabilityCode}`,
|
|
303
|
-
'DELETE',
|
|
304
|
-
);
|
|
305
|
-
}
|
|
306
|
-
|
|
307
|
-
/**
|
|
308
|
-
* Brand owner: turn the account's AI features on/off.
|
|
309
|
-
* @param {string} accountId
|
|
310
|
-
* @param {boolean} enabled
|
|
311
|
-
* @returns {Promise<Object>}
|
|
312
|
-
* @example
|
|
313
|
-
* await sdk.licenses.setBrandAccountAiEnabled('acct-123', true);
|
|
314
|
-
*/
|
|
315
|
-
async setBrandAccountAiEnabled(accountId, enabled) {
|
|
316
|
-
this.sdk.validateParams(
|
|
317
|
-
{ accountId, enabled },
|
|
318
|
-
{
|
|
319
|
-
accountId: { type: 'string', required: true },
|
|
320
|
-
enabled: { type: 'boolean', required: true },
|
|
321
|
-
},
|
|
322
|
-
);
|
|
323
|
-
return internalRequest(
|
|
324
|
-
this.sdk,
|
|
325
|
-
`/permissions/brand/accounts/${accountId}/ai-enabled`,
|
|
326
|
-
'PUT',
|
|
327
|
-
{ body: { enabled } },
|
|
328
|
-
);
|
|
329
|
-
}
|
|
330
|
-
}
|
package/services/oauth.js
DELETED
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
import { internalRequest } from '../base.js';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* OAuth provider -- staff registry of OAuth clients (security-upgrades H1
|
|
5
|
-
* frozen contract). Every method hits `/oauth/clients*` under
|
|
6
|
-
* checkApiAuth; the server enforces `admin:oauthclient:manage`. Public
|
|
7
|
-
* authorize/token/introspect/revoke endpoints (H2/H3/H4) are not client
|
|
8
|
-
* methods -- they are third-party-facing, not called through this SDK.
|
|
9
|
-
*
|
|
10
|
-
* Exposed as `sdk.oauth.clients.*` (nested, since `oauth` is expected to
|
|
11
|
-
* grow other sub-surfaces alongside `clients` as H2-H4 land).
|
|
12
|
-
*/
|
|
13
|
-
export class OAuthService {
|
|
14
|
-
constructor(sdk) {
|
|
15
|
-
this.sdk = sdk;
|
|
16
|
-
this.clients = new OAuthClientsService(sdk);
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
class OAuthClientsService {
|
|
21
|
-
constructor(sdk) {
|
|
22
|
-
this.sdk = sdk;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* List this account's OAuth clients.
|
|
27
|
-
* @returns {Promise<Object>} `{ clients: [...] }`
|
|
28
|
-
* @example
|
|
29
|
-
* const { clients } = await sdk.oauth.clients.list();
|
|
30
|
-
*/
|
|
31
|
-
async list() {
|
|
32
|
-
return internalRequest(this.sdk, '/oauth/clients', 'GET');
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Register a new OAuth client.
|
|
37
|
-
* @param {Object} body
|
|
38
|
-
* @param {string} body.name
|
|
39
|
-
* @param {string} body.clientType - 'confidential' | 'public'
|
|
40
|
-
* @param {string[]} body.redirectUris
|
|
41
|
-
* @param {string[]} body.grantTypes - subset of 'authorization_code' | 'refresh_token' | 'client_credentials'
|
|
42
|
-
* @param {string[]} body.allowedScopes
|
|
43
|
-
* @param {string} [body.linkedUserId] - required when grantTypes includes 'client_credentials' (D11)
|
|
44
|
-
* @param {string} [body.logoUrl]
|
|
45
|
-
* @returns {Promise<Object>} `{ client, secret? }` -- secret is plaintext, shown once, confidential clients only
|
|
46
|
-
* @example
|
|
47
|
-
* const { client, secret } = await sdk.oauth.clients.create({
|
|
48
|
-
* name: 'Zapier',
|
|
49
|
-
* clientType: 'confidential',
|
|
50
|
-
* redirectUris: ['https://zapier.com/oauth/callback'],
|
|
51
|
-
* grantTypes: ['authorization_code', 'refresh_token'],
|
|
52
|
-
* allowedScopes: ['cdp:object:*:read'],
|
|
53
|
-
* });
|
|
54
|
-
*/
|
|
55
|
-
async create(body) {
|
|
56
|
-
this.sdk.validateParams(body || {}, {
|
|
57
|
-
name: { type: 'string', required: true },
|
|
58
|
-
clientType: { type: 'string', required: true },
|
|
59
|
-
redirectUris: { type: 'array', required: true },
|
|
60
|
-
grantTypes: { type: 'array', required: true },
|
|
61
|
-
allowedScopes: { type: 'array', required: true },
|
|
62
|
-
linkedUserId: { type: 'string', required: false },
|
|
63
|
-
logoUrl: { type: 'string', required: false },
|
|
64
|
-
});
|
|
65
|
-
return internalRequest(this.sdk, '/oauth/clients', 'POST', { body });
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Get one OAuth client.
|
|
70
|
-
* @param {string} id
|
|
71
|
-
* @returns {Promise<Object>} `{ client }`
|
|
72
|
-
*/
|
|
73
|
-
async get(id) {
|
|
74
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
75
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}`, 'GET');
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
/**
|
|
79
|
-
* Update an OAuth client. Any subset of the create fields, plus `status`
|
|
80
|
-
* ('active' | 'disabled').
|
|
81
|
-
* @param {string} id
|
|
82
|
-
* @param {Object} body
|
|
83
|
-
* @returns {Promise<Object>} `{ client }`
|
|
84
|
-
*/
|
|
85
|
-
async update(id, body) {
|
|
86
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
87
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}`, 'PUT', { body });
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Soft-delete an OAuth client.
|
|
92
|
-
* @param {string} id
|
|
93
|
-
* @returns {Promise<Object>} `{ message }`
|
|
94
|
-
*/
|
|
95
|
-
async remove(id) {
|
|
96
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
97
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}`, 'DELETE');
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* List a client's secrets (id/createdAt/expiresAt/revokedAt/lastUsedAt
|
|
102
|
-
* only -- never the hash or plaintext). Use the returned `id` values
|
|
103
|
-
* with revokeSecret() to decommission an old/compromised secret.
|
|
104
|
-
* @param {string} id
|
|
105
|
-
* @returns {Promise<Object>} `{ secrets: [...] }`
|
|
106
|
-
*/
|
|
107
|
-
async listSecrets(id) {
|
|
108
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
109
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}/secrets`, 'GET');
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* Mint a new client secret. The old secret keeps working until revoked.
|
|
114
|
-
* @param {string} id
|
|
115
|
-
* @returns {Promise<Object>} `{ secret }` -- plaintext, shown once
|
|
116
|
-
*/
|
|
117
|
-
async rotateSecret(id) {
|
|
118
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
119
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}/secrets`, 'POST');
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Revoke one of a client's secrets.
|
|
124
|
-
* @param {string} id
|
|
125
|
-
* @param {string} secretId
|
|
126
|
-
* @returns {Promise<Object>} `{ message }`
|
|
127
|
-
*/
|
|
128
|
-
async revokeSecret(id, secretId) {
|
|
129
|
-
this.sdk.validateParams(
|
|
130
|
-
{ id, secretId },
|
|
131
|
-
{ id: { type: 'string', required: true }, secretId: { type: 'string', required: true } },
|
|
132
|
-
);
|
|
133
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}/secrets/${secretId}`, 'DELETE');
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* List a client's user consent grants.
|
|
138
|
-
* @param {string} id
|
|
139
|
-
* @returns {Promise<Object>} `{ grants: [...] }`
|
|
140
|
-
*/
|
|
141
|
-
async listGrants(id) {
|
|
142
|
-
this.sdk.validateParams({ id }, { id: { type: 'string', required: true } });
|
|
143
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}/grants`, 'GET');
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
/**
|
|
147
|
-
* Revoke a client's consent grant for one user.
|
|
148
|
-
* @param {string} id
|
|
149
|
-
* @param {string} grantId
|
|
150
|
-
* @returns {Promise<Object>} `{ message }`
|
|
151
|
-
*/
|
|
152
|
-
async revokeGrant(id, grantId) {
|
|
153
|
-
this.sdk.validateParams(
|
|
154
|
-
{ id, grantId },
|
|
155
|
-
{ id: { type: 'string', required: true }, grantId: { type: 'string', required: true } },
|
|
156
|
-
);
|
|
157
|
-
return internalRequest(this.sdk, `/oauth/clients/${id}/grants/${grantId}`, 'DELETE');
|
|
158
|
-
}
|
|
159
|
-
}
|