@roarkanalytics/cli 0.73.1 → 0.75.0
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/CHANGELOG.md +18 -0
- package/README.md +191 -148
- package/commands.js +2883 -941
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +3 -3
- package/man/roark-agent-conversation-create.1 +106 -0
- package/man/roark-agent-create.1 +27 -3
- package/man/roark-agent-draft-update.1 +4 -1
- package/man/roark-agent-endpoint-create.1 +5 -5
- package/man/roark-agent-endpoint-get.1 +1 -1
- package/man/roark-agent-get.1 +1 -1
- package/man/roark-autoimprove-job-cancel.1 +1 -1
- package/man/roark-autoimprove-job-dismiss.1 +1 -1
- package/man/roark-autoimprove-job-guidance-send.1 +1 -1
- package/man/roark-autoimprove-job-promote.1 +1 -1
- package/man/roark-benchmark-target-history-list.1 +1 -1
- package/man/roark-call-get.1 +1 -1
- package/man/roark-connections-agent-backfill-cancel.1 +96 -0
- package/man/roark-connections-agent-backfill-create.1 +97 -0
- package/man/roark-connections-agent-backfill-list.1 +93 -0
- package/man/roark-connections-agent-create.1 +124 -0
- package/man/roark-connections-agent-delete.1 +93 -0
- package/man/roark-connections-agent-discover.1 +96 -0
- package/man/roark-connections-agent-get.1 +93 -0
- package/man/roark-connections-agent-list.1 +93 -0
- package/man/roark-connections-agent-provider-list.1 +89 -0
- package/man/roark-connections-agent-update.1 +128 -0
- package/man/roark-connections-calendar-calendar-list.1 +93 -0
- package/man/roark-connections-calendar-calendly-oauth-start.1 +99 -0
- package/man/{roark-calendar-connection-check.1 → roark-connections-calendar-check.1} +5 -5
- package/man/{roark-calendar-connection-create.1 → roark-connections-calendar-create.1} +7 -7
- package/man/{roark-calendar-connection-delete.1 → roark-connections-calendar-delete.1} +5 -5
- package/man/{roark-calendar-connection-get.1 → roark-connections-calendar-get.1} +5 -5
- package/man/roark-connections-calendar-google-oauth-start.1 +102 -0
- package/man/{roark-calendar-connection-list.1 → roark-connections-calendar-list.1} +6 -6
- package/man/roark-connections-calendar-target-create.1 +124 -0
- package/man/roark-connections-calendar-target-delete.1 +96 -0
- package/man/{roark-calendar-connection-target-get.1 → roark-connections-calendar-target-get.1} +5 -5
- package/man/{roark-calendar-connection-target-list.1 → roark-connections-calendar-target-list.1} +5 -5
- package/man/roark-connections-calendar-target-update.1 +124 -0
- package/man/{roark-calendar-connection-update.1 → roark-connections-calendar-update.1} +5 -5
- package/man/roark-connections-mcp-server-create.1 +105 -0
- package/man/roark-connections-mcp-server-delete.1 +93 -0
- package/man/roark-connections-mcp-server-discover.1 +99 -0
- package/man/roark-connections-mcp-server-get.1 +93 -0
- package/man/roark-connections-mcp-server-list.1 +89 -0
- package/man/roark-connections-mcp-server-refresh.1 +93 -0
- package/man/roark-connections-mcp-server-update.1 +100 -0
- package/man/roark-conversation-get.1 +93 -0
- package/man/roark-credential-create.1 +2 -2
- package/man/roark-credential-list.1 +2 -2
- package/man/roark-credential-revoke.1 +2 -2
- package/man/{roark-customer-profile-attribute-delete.1 → roark-customer-attribute-delete.1} +5 -5
- package/man/{roark-customer-profile-attribute-unlock.1 → roark-customer-attribute-unlock.1} +5 -5
- package/man/{roark-customer-profile-attribute-update.1 → roark-customer-attribute-update.1} +5 -5
- package/man/{roark-customer-profile-conversation-list.1 → roark-customer-conversation-list.1} +5 -5
- package/man/{roark-customer-profile-delete.1 → roark-customer-delete.1} +6 -6
- package/man/roark-customer-field-create.1 +105 -0
- package/man/roark-customer-field-delete.1 +93 -0
- package/man/roark-customer-field-list.1 +89 -0
- package/man/roark-customer-field-update.1 +106 -0
- package/man/roark-customer-flow-edge-case-create.1 +1 -1
- package/man/roark-customer-flow-edge-case-update.1 +1 -1
- package/man/roark-customer-flow-folder-create.1 +99 -0
- package/man/roark-customer-flow-folder-delete.1 +93 -0
- package/man/roark-customer-flow-folder-list.1 +89 -0
- package/man/roark-customer-flow-get.1 +1 -1
- package/man/roark-customer-flow-happy-path-update.1 +1 -1
- package/man/roark-customer-flow-list.1 +3 -0
- package/man/roark-customer-flow-update.1 +4 -1
- package/man/{roark-customer-profile-get.1 → roark-customer-get.1} +6 -6
- package/man/{roark-customer-profile-list.1 → roark-customer-list.1} +8 -8
- package/man/{roark-customer-profile-notes-update.1 → roark-customer-notes-update.1} +5 -5
- package/man/roark-dashboard-list.1 +1 -1
- package/man/roark-dashboard-update.1 +1 -1
- package/man/roark-http-request-definition-create.1 +1 -1
- package/man/roark-http-request-definition-get.1 +1 -1
- package/man/roark-http-request-definition-update.1 +1 -1
- package/man/roark-metric-collection-job-get.1 +1 -1
- package/man/roark-metric-definition-create.1 +1 -1
- package/man/roark-metric-definition-update.1 +1 -1
- package/man/roark-metric-policy-create.1 +1 -1
- package/man/roark-metric-policy-get.1 +1 -1
- package/man/roark-metric-variant-list.1 +1 -1
- package/man/roark-metric-variant-update.1 +1 -1
- package/man/roark-project-list.1 +1 -1
- package/man/roark-simulation-environment-create.1 +12 -0
- package/man/roark-simulation-environment-get.1 +1 -1
- package/man/roark-simulation-environment-update.1 +12 -0
- package/man/roark-simulation-group-create.1 +2 -2
- package/man/roark-simulation-group-delete.1 +1 -1
- package/man/roark-simulation-group-get.1 +1 -1
- package/man/roark-simulation-group-list.1 +1 -1
- package/man/roark-simulation-group-run.1 +2 -2
- package/man/roark-simulation-group-update.1 +1 -1
- package/man/roark-simulation-job-get.1 +1 -1
- package/man/roark-simulation-job-lookup.1 +1 -1
- package/man/roark-simulation-persona-create.1 +1 -1
- package/man/roark-simulation-persona-get.1 +1 -1
- package/man/roark-simulation-persona-update.1 +1 -1
- package/man/roark-simulation-plan-get.1 +1 -1
- package/man/roark-simulation-plan-job-cancel.1 +1 -1
- package/man/roark-simulation-plan-job-cost-get.1 +1 -1
- package/man/roark-simulation-plan-job-debrief-create.1 +1 -1
- package/man/roark-simulation-plan-job-delete.1 +1 -1
- package/man/roark-simulation-plan-job-get.1 +1 -1
- package/man/roark-simulation-plan-job-list.1 +1 -1
- package/man/roark-simulation-plan-job-result-get.1 +1 -1
- package/man/roark-simulation-plan-update.1 +7 -1
- package/man/roark-simulation-resource-generate.1 +120 -0
- package/man/roark-simulation-resource-generation-answer.1 +97 -0
- package/man/roark-simulation-resource-generation-cancel.1 +93 -0
- package/man/roark-simulation-resource-generation-get.1 +93 -0
- package/man/roark-simulation-resource-generation-guidance-send.1 +97 -0
- package/man/roark-simulation-resource-generation-list.1 +96 -0
- package/man/roark-simulation-run-group-list.1 +1 -1
- package/man/roark-tool-create.1 +32 -2
- package/man/roark-tool-update.1 +32 -2
- package/man/roark-usage-get.1 +1 -1
- package/man/roark-webhook-create.1 +2 -2
- package/man/roark-webhook-delete.1 +1 -1
- package/man/roark-webhook-get.1 +1 -1
- package/man/roark-whoami.1 +1 -1
- package/man/roark.1 +208 -94
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -18
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/commands.js
CHANGED
|
@@ -9,6 +9,7 @@ exports.DESCRIPTION = 'Command line interface for the Roark Analytics API';
|
|
|
9
9
|
// Help text for the command groups, which have no operation of their own.
|
|
10
10
|
exports.GROUPS = {
|
|
11
11
|
agent: 'Manage agents',
|
|
12
|
+
'agent conversation': 'Manage agent conversation',
|
|
12
13
|
'agent draft': 'Manage agent drafts',
|
|
13
14
|
'agent endpoint': 'Manage agent endpoints',
|
|
14
15
|
'agent prompt': 'Manage agent prompts',
|
|
@@ -28,8 +29,6 @@ exports.GROUPS = {
|
|
|
28
29
|
'benchmark target': 'Read benchmark targets',
|
|
29
30
|
'benchmark target history': 'Read benchmark target histories',
|
|
30
31
|
'benchmark target score-sample': 'Read benchmark target score samples',
|
|
31
|
-
'calendar-connection': 'Manage calendar connections',
|
|
32
|
-
'calendar-connection target': 'Read calendar connection targets',
|
|
33
32
|
call: 'Manage calls',
|
|
34
33
|
'call batch': 'Manage call batch',
|
|
35
34
|
'call cost': 'Read call cost',
|
|
@@ -39,15 +38,28 @@ exports.GROUPS = {
|
|
|
39
38
|
'call tool-invocation': 'Manage call tool invocations',
|
|
40
39
|
'call transcript': 'Read call transcript',
|
|
41
40
|
config: 'Read configs',
|
|
41
|
+
connections: 'Manage connectionses',
|
|
42
|
+
'connections agent': 'Manage connections agents',
|
|
43
|
+
'connections agent backfill': 'Manage connections agent backfills',
|
|
44
|
+
'connections agent provider': 'Read connections agent providers',
|
|
45
|
+
'connections calendar': 'Manage connections calendars',
|
|
46
|
+
'connections calendar calendar': 'Read connections calendar calendars',
|
|
47
|
+
'connections calendar calendly-oauth': 'Manage connections calendar calendly oauth',
|
|
48
|
+
'connections calendar google-oauth': 'Manage connections calendar google oauth',
|
|
49
|
+
'connections calendar target': 'Manage connections calendar targets',
|
|
50
|
+
'connections mcp-server': 'Manage connections mcp servers',
|
|
51
|
+
conversation: 'Read conversation',
|
|
42
52
|
credential: 'Manage credentials',
|
|
53
|
+
customer: 'Manage customers',
|
|
54
|
+
'customer attribute': 'Manage customer attributes',
|
|
55
|
+
'customer conversation': 'Read customer conversations',
|
|
56
|
+
'customer field': 'Manage customer fields',
|
|
57
|
+
'customer notes': 'Manage customer notes',
|
|
43
58
|
'customer-flow': 'Manage customer flows',
|
|
44
59
|
'customer-flow edge-case': 'Manage customer flow edge cases',
|
|
60
|
+
'customer-flow folder': 'Manage customer flow folders',
|
|
45
61
|
'customer-flow graph': 'Manage customer flow graph',
|
|
46
62
|
'customer-flow happy-path': 'Manage customer flow happy path',
|
|
47
|
-
'customer-profile': 'Manage customer profiles',
|
|
48
|
-
'customer-profile attribute': 'Manage customer profile attributes',
|
|
49
|
-
'customer-profile conversation': 'Read customer profile conversations',
|
|
50
|
-
'customer-profile notes': 'Manage customer profile notes',
|
|
51
63
|
dashboard: 'Manage dashboards',
|
|
52
64
|
'dashboard data': 'Read dashboard data',
|
|
53
65
|
'dashboard widget': 'Manage dashboard widgets',
|
|
@@ -76,6 +88,9 @@ exports.GROUPS = {
|
|
|
76
88
|
'simulation plan job cost': 'Read simulation plan job cost',
|
|
77
89
|
'simulation plan job debrief': 'Manage simulation plan job debrief',
|
|
78
90
|
'simulation plan job result': 'Read simulation plan job result',
|
|
91
|
+
'simulation resource': 'Read simulation resource',
|
|
92
|
+
'simulation resource-generation': 'Read simulation resource generations',
|
|
93
|
+
'simulation resource-generation guidance': 'Read simulation resource generation guidance',
|
|
79
94
|
'simulation run-group': 'Manage simulation run groups',
|
|
80
95
|
'simulation run-group report': 'Read simulation run group report',
|
|
81
96
|
'simulation template': 'Read simulation templates',
|
|
@@ -138,7 +153,16 @@ exports.COMMANDS = [
|
|
|
138
153
|
required: true,
|
|
139
154
|
description: 'Text-to-speech provider, for example ELEVENLABS',
|
|
140
155
|
valueKind: 'string',
|
|
141
|
-
enumValues: [
|
|
156
|
+
enumValues: [
|
|
157
|
+
'CARTESIA',
|
|
158
|
+
'ELEVENLABS',
|
|
159
|
+
'OPENAI',
|
|
160
|
+
'RIME',
|
|
161
|
+
'ASSEMBLYAI',
|
|
162
|
+
'DEEPGRAM',
|
|
163
|
+
'FISH_AUDIO',
|
|
164
|
+
'SMALLEST',
|
|
165
|
+
],
|
|
142
166
|
repeatable: false,
|
|
143
167
|
},
|
|
144
168
|
{
|
|
@@ -174,7 +198,15 @@ exports.COMMANDS = [
|
|
|
174
198
|
required: true,
|
|
175
199
|
description: 'Speech-to-text provider, for example DEEPGRAM',
|
|
176
200
|
valueKind: 'string',
|
|
177
|
-
enumValues: [
|
|
201
|
+
enumValues: [
|
|
202
|
+
'DEEPGRAM',
|
|
203
|
+
'OPENAI_WHISPER',
|
|
204
|
+
'SPEECHMATICS',
|
|
205
|
+
'ASSEMBLYAI',
|
|
206
|
+
'ELEVENLABS',
|
|
207
|
+
'SONIOX',
|
|
208
|
+
'SMALLEST',
|
|
209
|
+
],
|
|
178
210
|
repeatable: false,
|
|
179
211
|
},
|
|
180
212
|
{
|
|
@@ -201,7 +233,20 @@ exports.COMMANDS = [
|
|
|
201
233
|
required: true,
|
|
202
234
|
description: 'Text model provider, for example OPENAI',
|
|
203
235
|
valueKind: 'string',
|
|
204
|
-
enumValues: [
|
|
236
|
+
enumValues: [
|
|
237
|
+
'OPENAI',
|
|
238
|
+
'ANTHROPIC',
|
|
239
|
+
'GOOGLE',
|
|
240
|
+
'XAI',
|
|
241
|
+
'ULTRAVOX',
|
|
242
|
+
'AWS',
|
|
243
|
+
'ELEVENLABS',
|
|
244
|
+
'GROQ',
|
|
245
|
+
'META',
|
|
246
|
+
'RIME',
|
|
247
|
+
'PHONIC',
|
|
248
|
+
'SMALLEST',
|
|
249
|
+
],
|
|
205
250
|
repeatable: false,
|
|
206
251
|
},
|
|
207
252
|
{
|
|
@@ -221,13 +266,74 @@ exports.COMMANDS = [
|
|
|
221
266
|
acceptsBody: true,
|
|
222
267
|
requiresAuth: true,
|
|
223
268
|
},
|
|
269
|
+
{
|
|
270
|
+
commandPath: ['agent', 'conversation', 'create'],
|
|
271
|
+
clientProperty: 'agentConversation',
|
|
272
|
+
methodName: 'create',
|
|
273
|
+
httpMethod: 'post',
|
|
274
|
+
httpPath: '/v1/agent/{agentId}/conversations',
|
|
275
|
+
summary: 'Start a conversation with an agent',
|
|
276
|
+
description: 'Starts a voice conversation (`modality: voice`) or chat (`modality: chat`) with this Roark-hosted agent and returns its id right away. `channel: web` is a conversation in a browser on your site. Call this endpoint from your server, never the browser: it needs your API key. Give the page only `web.clientToken`; the web SDK spends it to join from one of `allowedOrigins` before `web.clientTokenExpiresAt`. Read it back with `GET /v1/conversation/{conversationId}` straight away: `PENDING` until the browser joins, `IN_PROGRESS`, then `ENDED`. One nobody joins ends without ever starting and is never billed. Starting a voice conversation needs `call:create`, a chat `chat:create`, and the agent a published version that takes that kind.',
|
|
277
|
+
positionals: [
|
|
278
|
+
{
|
|
279
|
+
name: 'agent-id',
|
|
280
|
+
paramKey: 'agentId',
|
|
281
|
+
},
|
|
282
|
+
],
|
|
283
|
+
flags: [
|
|
284
|
+
{
|
|
285
|
+
name: 'modality',
|
|
286
|
+
path: ['modality'],
|
|
287
|
+
location: 'body',
|
|
288
|
+
required: true,
|
|
289
|
+
description: '`voice` or `chat`. The agent must have that modality turned on.',
|
|
290
|
+
valueKind: 'string',
|
|
291
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
292
|
+
repeatable: false,
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
name: 'channel',
|
|
296
|
+
path: ['channel'],
|
|
297
|
+
location: 'body',
|
|
298
|
+
required: true,
|
|
299
|
+
description: 'How it is reached. `web`: in a browser on one of `allowedOrigins`, joined with the web SDK.',
|
|
300
|
+
valueKind: 'string',
|
|
301
|
+
enumValues: ['web'],
|
|
302
|
+
repeatable: false,
|
|
303
|
+
},
|
|
304
|
+
{
|
|
305
|
+
name: 'allowed-origins',
|
|
306
|
+
path: ['allowedOrigins'],
|
|
307
|
+
location: 'body',
|
|
308
|
+
required: true,
|
|
309
|
+
description: 'The origins your page may join from, exactly as the browser sends them: https only (http on localhost for development), no paths or wildcards.',
|
|
310
|
+
valueKind: 'array',
|
|
311
|
+
repeatable: true,
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
name: 'client-token-ttl-seconds',
|
|
315
|
+
path: ['clientTokenTtlSeconds'],
|
|
316
|
+
location: 'body',
|
|
317
|
+
required: false,
|
|
318
|
+
description: 'How long the browser has to join, in seconds. Default 120.',
|
|
319
|
+
valueKind: 'integer',
|
|
320
|
+
repeatable: false,
|
|
321
|
+
},
|
|
322
|
+
],
|
|
323
|
+
hasParams: true,
|
|
324
|
+
paramsAllOptional: false,
|
|
325
|
+
bodyOpaque: false,
|
|
326
|
+
bodyVariants: [],
|
|
327
|
+
acceptsBody: true,
|
|
328
|
+
requiresAuth: true,
|
|
329
|
+
},
|
|
224
330
|
{
|
|
225
331
|
commandPath: ['agent', 'create'],
|
|
226
332
|
clientProperty: 'agent',
|
|
227
333
|
methodName: 'create',
|
|
228
334
|
httpMethod: 'post',
|
|
229
335
|
httpPath: '/v1/agent',
|
|
230
|
-
summary: 'Create
|
|
336
|
+
summary: 'Create an agent',
|
|
231
337
|
description: 'Creates a new agent for the authenticated project.',
|
|
232
338
|
positionals: [],
|
|
233
339
|
flags: [
|
|
@@ -254,7 +360,98 @@ exports.COMMANDS = [
|
|
|
254
360
|
path: ['customId'],
|
|
255
361
|
location: 'body',
|
|
256
362
|
required: false,
|
|
257
|
-
description: 'Custom identifier for the agent',
|
|
363
|
+
description: 'Custom identifier for the agent. Must be unique in the project.',
|
|
364
|
+
valueKind: 'string',
|
|
365
|
+
repeatable: false,
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
name: 'industry',
|
|
369
|
+
path: ['industry'],
|
|
370
|
+
location: 'body',
|
|
371
|
+
required: false,
|
|
372
|
+
description: 'The industry the agent serves.',
|
|
373
|
+
valueKind: 'string',
|
|
374
|
+
enumValues: [
|
|
375
|
+
'HEALTHCARE',
|
|
376
|
+
'FINANCIAL_SERVICES',
|
|
377
|
+
'INSURANCE',
|
|
378
|
+
'DEBT_COLLECTION',
|
|
379
|
+
'RETAIL',
|
|
380
|
+
'TRAVEL_AND_HOSPITALITY',
|
|
381
|
+
'TELECOMMUNICATIONS',
|
|
382
|
+
'TECHNOLOGY',
|
|
383
|
+
'PUBLIC_SECTOR',
|
|
384
|
+
'UTILITIES',
|
|
385
|
+
'LOGISTICS',
|
|
386
|
+
'AUTOMOTIVE',
|
|
387
|
+
'HOME_SERVICES',
|
|
388
|
+
'RESTAURANTS',
|
|
389
|
+
'EDUCATION',
|
|
390
|
+
'OTHER',
|
|
391
|
+
],
|
|
392
|
+
repeatable: false,
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
name: 'prompt',
|
|
396
|
+
path: ['prompt'],
|
|
397
|
+
location: 'body',
|
|
398
|
+
required: false,
|
|
399
|
+
description: "The agent's system prompt.",
|
|
400
|
+
valueKind: 'string',
|
|
401
|
+
repeatable: false,
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
name: 'endpoint',
|
|
405
|
+
path: ['endpoint'],
|
|
406
|
+
location: 'body',
|
|
407
|
+
required: false,
|
|
408
|
+
description: 'The phone number or connection Roark calls to test the agent',
|
|
409
|
+
valueKind: 'object',
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
name: 'endpoint.value',
|
|
413
|
+
path: ['endpoint', 'value'],
|
|
414
|
+
location: 'body',
|
|
415
|
+
required: false,
|
|
416
|
+
description: 'Phone number in E.164 format (e.g., +12345678900). Optional when direction is OUTGOING, for an agent that calls from numbers you do not know up front.',
|
|
417
|
+
valueKind: 'string',
|
|
418
|
+
repeatable: false,
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
name: 'endpoint.environment',
|
|
422
|
+
path: ['endpoint', 'environment'],
|
|
423
|
+
location: 'body',
|
|
424
|
+
required: false,
|
|
425
|
+
description: 'Environment name (default: production)',
|
|
426
|
+
valueKind: 'string',
|
|
427
|
+
repeatable: false,
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
name: 'endpoint.direction',
|
|
431
|
+
path: ['endpoint', 'direction'],
|
|
432
|
+
location: 'body',
|
|
433
|
+
required: true,
|
|
434
|
+
description: 'Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING',
|
|
435
|
+
valueKind: 'string',
|
|
436
|
+
enumValues: ['INCOMING', 'OUTGOING', 'INCOMING_AND_OUTGOING'],
|
|
437
|
+
repeatable: false,
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
name: 'endpoint.outbound-dial-type',
|
|
441
|
+
path: ['endpoint', 'outboundDialType'],
|
|
442
|
+
location: 'body',
|
|
443
|
+
required: false,
|
|
444
|
+
description: 'Outbound dial type: NONE or HTTP_REQUEST (default: NONE)',
|
|
445
|
+
valueKind: 'string',
|
|
446
|
+
enumValues: ['NONE', 'HTTP_REQUEST'],
|
|
447
|
+
repeatable: false,
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
name: 'endpoint.outbound-dial-http-request-definition-id',
|
|
451
|
+
path: ['endpoint', 'outboundDialHttpRequestDefinitionId'],
|
|
452
|
+
location: 'body',
|
|
453
|
+
required: false,
|
|
454
|
+
description: 'ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST)',
|
|
258
455
|
valueKind: 'string',
|
|
259
456
|
repeatable: false,
|
|
260
457
|
},
|
|
@@ -421,7 +618,7 @@ exports.COMMANDS = [
|
|
|
421
618
|
location: 'body',
|
|
422
619
|
required: false,
|
|
423
620
|
valueKind: 'array',
|
|
424
|
-
enumValues: ['
|
|
621
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
425
622
|
repeatable: true,
|
|
426
623
|
},
|
|
427
624
|
{
|
|
@@ -482,6 +679,14 @@ exports.COMMANDS = [
|
|
|
482
679
|
valueKind: 'number',
|
|
483
680
|
repeatable: false,
|
|
484
681
|
},
|
|
682
|
+
{
|
|
683
|
+
name: 'settings.vad-max-silence-secs',
|
|
684
|
+
path: ['settings', 'vadMaxSilenceSecs'],
|
|
685
|
+
location: 'body',
|
|
686
|
+
required: false,
|
|
687
|
+
valueKind: 'number',
|
|
688
|
+
repeatable: false,
|
|
689
|
+
},
|
|
485
690
|
{
|
|
486
691
|
name: 'settings.call-max-duration-seconds',
|
|
487
692
|
path: ['settings', 'callMaxDurationSeconds'],
|
|
@@ -622,19 +827,10 @@ exports.COMMANDS = [
|
|
|
622
827
|
methodName: 'create',
|
|
623
828
|
httpMethod: 'post',
|
|
624
829
|
httpPath: '/v1/agent/endpoint',
|
|
625
|
-
summary: 'Create
|
|
830
|
+
summary: 'Create an agent endpoint',
|
|
626
831
|
description: 'Creates a new agent endpoint for the authenticated project.',
|
|
627
832
|
positionals: [],
|
|
628
833
|
flags: [
|
|
629
|
-
{
|
|
630
|
-
name: 'agent-id',
|
|
631
|
-
path: ['agentId'],
|
|
632
|
-
location: 'body',
|
|
633
|
-
required: true,
|
|
634
|
-
description: 'Agent ID to associate this endpoint with',
|
|
635
|
-
valueKind: 'string',
|
|
636
|
-
repeatable: false,
|
|
637
|
-
},
|
|
638
834
|
{
|
|
639
835
|
name: 'value',
|
|
640
836
|
path: ['value'],
|
|
@@ -682,6 +878,15 @@ exports.COMMANDS = [
|
|
|
682
878
|
valueKind: 'string',
|
|
683
879
|
repeatable: false,
|
|
684
880
|
},
|
|
881
|
+
{
|
|
882
|
+
name: 'agent-id',
|
|
883
|
+
path: ['agentId'],
|
|
884
|
+
location: 'body',
|
|
885
|
+
required: true,
|
|
886
|
+
description: 'Agent ID to associate this endpoint with',
|
|
887
|
+
valueKind: 'string',
|
|
888
|
+
repeatable: false,
|
|
889
|
+
},
|
|
685
890
|
],
|
|
686
891
|
hasParams: true,
|
|
687
892
|
paramsAllOptional: false,
|
|
@@ -696,7 +901,7 @@ exports.COMMANDS = [
|
|
|
696
901
|
methodName: 'getByID',
|
|
697
902
|
httpMethod: 'get',
|
|
698
903
|
httpPath: '/v1/agent/endpoint/{endpointId}',
|
|
699
|
-
summary: 'Get agent endpoint
|
|
904
|
+
summary: 'Get an agent endpoint',
|
|
700
905
|
description: 'Returns a specific agent endpoint by its ID.',
|
|
701
906
|
positionals: [
|
|
702
907
|
{
|
|
@@ -825,7 +1030,7 @@ exports.COMMANDS = [
|
|
|
825
1030
|
methodName: 'getByID',
|
|
826
1031
|
httpMethod: 'get',
|
|
827
1032
|
httpPath: '/v1/agent/{agentId}',
|
|
828
|
-
summary: 'Get agent
|
|
1033
|
+
summary: 'Get an agent',
|
|
829
1034
|
description: 'Returns a specific agent by its ID.',
|
|
830
1035
|
positionals: [
|
|
831
1036
|
{
|
|
@@ -1472,7 +1677,7 @@ exports.COMMANDS = [
|
|
|
1472
1677
|
methodName: 'cancel',
|
|
1473
1678
|
httpMethod: 'post',
|
|
1474
1679
|
httpPath: '/v1/autoimprove/job/{jobId}/cancel',
|
|
1475
|
-
summary: 'Cancel
|
|
1680
|
+
summary: 'Cancel an Autoimprove job',
|
|
1476
1681
|
description: 'Stop a live job. Production is never changed by a cancel; everything the job set up (the shadow agent, its phone number, authored test flows and run plan) is cleaned up automatically.',
|
|
1477
1682
|
positionals: [
|
|
1478
1683
|
{
|
|
@@ -1593,7 +1798,7 @@ exports.COMMANDS = [
|
|
|
1593
1798
|
methodName: 'dismiss',
|
|
1594
1799
|
httpMethod: 'post',
|
|
1595
1800
|
httpPath: '/v1/autoimprove/job/{jobId}/dismiss',
|
|
1596
|
-
summary: 'Dismiss
|
|
1801
|
+
summary: 'Dismiss an Autoimprove job',
|
|
1597
1802
|
description: 'Discard a verified job without promoting: production stays untouched and the staging resources are cleaned up. Only a job in AWAITING_PROMOTE can be dismissed.',
|
|
1598
1803
|
positionals: [
|
|
1599
1804
|
{
|
|
@@ -1637,7 +1842,7 @@ exports.COMMANDS = [
|
|
|
1637
1842
|
methodName: 'sendGuidance',
|
|
1638
1843
|
httpMethod: 'post',
|
|
1639
1844
|
httpPath: '/v1/autoimprove/job/{jobId}/guidance',
|
|
1640
|
-
summary: '
|
|
1845
|
+
summary: 'Guide a running Autoimprove job',
|
|
1641
1846
|
description: 'Steer Roark mid-job. The message is folded into its next decision and is binding. Accepted while the job is live (RUNNING, NEEDS_INPUT, or PAUSED); a concluded job returns a conflict.',
|
|
1642
1847
|
positionals: [
|
|
1643
1848
|
{
|
|
@@ -1686,7 +1891,7 @@ exports.COMMANDS = [
|
|
|
1686
1891
|
methodName: 'promote',
|
|
1687
1892
|
httpMethod: 'post',
|
|
1688
1893
|
httpPath: '/v1/autoimprove/job/{jobId}/promote',
|
|
1689
|
-
summary: 'Promote
|
|
1894
|
+
summary: 'Promote an Autoimprove job to production',
|
|
1690
1895
|
description: 'Apply the verified staging changes to the PRODUCTION agent. Only a job in AWAITING_PROMOTE can be promoted. A snapshot of the production configuration is taken immediately before the write, so the promote is fully rollbackable. After the promote the staging shadow and its phone number are cleaned up.',
|
|
1691
1896
|
positionals: [
|
|
1692
1897
|
{
|
|
@@ -1892,7 +2097,7 @@ exports.COMMANDS = [
|
|
|
1892
2097
|
methodName: 'listTargetHistory',
|
|
1893
2098
|
httpMethod: 'get',
|
|
1894
2099
|
httpPath: '/v1/benchmark/target/{targetKey}/history',
|
|
1895
|
-
summary:
|
|
2100
|
+
summary: "List a benchmark target's published generations",
|
|
1896
2101
|
description: 'Returns every sweep published for a target, newest first, including superseded ones. This is the trend read: it answers "did this model regress?" from Roark’s own published record. Metadata only — pass a row’s `publicationId` to GET /v1/benchmark/target/{targetKey} for that generation’s numbers.',
|
|
1897
2102
|
positionals: [
|
|
1898
2103
|
{
|
|
@@ -2017,18 +2222,44 @@ exports.COMMANDS = [
|
|
|
2017
2222
|
requiresAuth: true,
|
|
2018
2223
|
},
|
|
2019
2224
|
{
|
|
2020
|
-
commandPath: ['
|
|
2021
|
-
clientProperty: '
|
|
2022
|
-
methodName: '
|
|
2225
|
+
commandPath: ['call', 'batch', 'delete'],
|
|
2226
|
+
clientProperty: 'call',
|
|
2227
|
+
methodName: 'batchDelete',
|
|
2023
2228
|
httpMethod: 'post',
|
|
2024
|
-
httpPath: '/v1/
|
|
2025
|
-
summary: '
|
|
2026
|
-
description: '
|
|
2229
|
+
httpPath: '/v1/call/batch-delete',
|
|
2230
|
+
summary: 'Delete calls in batch',
|
|
2231
|
+
description: 'Deletes up to 100 calls by ID in one request. Each deleted call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. IDs that do not exist in this project, or were already deleted, are returned in notFoundCallIds and left untouched. The request succeeds even when none of the calls are found. IDs are returned lowercase, each once.',
|
|
2232
|
+
positionals: [],
|
|
2233
|
+
flags: [
|
|
2234
|
+
{
|
|
2235
|
+
name: 'call-ids',
|
|
2236
|
+
path: ['callIds'],
|
|
2237
|
+
location: 'body',
|
|
2238
|
+
required: true,
|
|
2239
|
+
description: 'IDs of the calls to delete, at most 100. Repeated IDs are counted once.',
|
|
2240
|
+
valueKind: 'array',
|
|
2241
|
+
repeatable: true,
|
|
2242
|
+
},
|
|
2243
|
+
],
|
|
2244
|
+
hasParams: true,
|
|
2245
|
+
paramsAllOptional: false,
|
|
2246
|
+
bodyOpaque: false,
|
|
2247
|
+
bodyVariants: [],
|
|
2248
|
+
acceptsBody: true,
|
|
2249
|
+
requiresAuth: true,
|
|
2250
|
+
},
|
|
2251
|
+
{
|
|
2252
|
+
commandPath: ['call', 'cost', 'get'],
|
|
2253
|
+
clientProperty: 'call',
|
|
2254
|
+
methodName: 'getCost',
|
|
2255
|
+
httpMethod: 'get',
|
|
2256
|
+
httpPath: '/v1/call/{callId}/cost',
|
|
2257
|
+
summary: 'Get call cost',
|
|
2258
|
+
description: 'The billable spend attributed to one call, split by cost type, with every cost line behind it. Simulated calls include the costs their simulation incurred before the call connected. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.',
|
|
2027
2259
|
positionals: [
|
|
2028
2260
|
{
|
|
2029
|
-
name: '
|
|
2030
|
-
paramKey: '
|
|
2031
|
-
description: 'Calendar connection ID',
|
|
2261
|
+
name: 'call-id',
|
|
2262
|
+
paramKey: 'callId',
|
|
2032
2263
|
},
|
|
2033
2264
|
],
|
|
2034
2265
|
flags: [],
|
|
@@ -2040,341 +2271,61 @@ exports.COMMANDS = [
|
|
|
2040
2271
|
requiresAuth: true,
|
|
2041
2272
|
},
|
|
2042
2273
|
{
|
|
2043
|
-
commandPath: ['
|
|
2044
|
-
clientProperty: '
|
|
2274
|
+
commandPath: ['call', 'create'],
|
|
2275
|
+
clientProperty: 'call',
|
|
2045
2276
|
methodName: 'create',
|
|
2046
2277
|
httpMethod: 'post',
|
|
2047
|
-
httpPath: '/v1/
|
|
2048
|
-
summary: '
|
|
2049
|
-
description: '
|
|
2278
|
+
httpPath: '/v1/call',
|
|
2279
|
+
summary: 'Create a call',
|
|
2280
|
+
description: 'Create a new call with recording, transcript, agents, and customers',
|
|
2050
2281
|
positionals: [],
|
|
2051
2282
|
flags: [
|
|
2052
2283
|
{
|
|
2053
|
-
name: '
|
|
2054
|
-
path: ['
|
|
2284
|
+
name: 'recording-url',
|
|
2285
|
+
path: ['recordingUrl'],
|
|
2055
2286
|
location: 'body',
|
|
2056
2287
|
required: true,
|
|
2057
|
-
description: '
|
|
2288
|
+
description: 'URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.',
|
|
2058
2289
|
valueKind: 'string',
|
|
2059
|
-
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2060
2290
|
repeatable: false,
|
|
2061
2291
|
},
|
|
2062
2292
|
{
|
|
2063
|
-
name: '
|
|
2064
|
-
path: ['
|
|
2293
|
+
name: 'stereo-recording-url',
|
|
2294
|
+
path: ['stereoRecordingUrl'],
|
|
2065
2295
|
location: 'body',
|
|
2066
|
-
required:
|
|
2067
|
-
description: '
|
|
2296
|
+
required: false,
|
|
2297
|
+
description: 'URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.',
|
|
2068
2298
|
valueKind: 'string',
|
|
2069
2299
|
repeatable: false,
|
|
2070
2300
|
},
|
|
2071
2301
|
{
|
|
2072
|
-
name: '
|
|
2073
|
-
path: ['
|
|
2302
|
+
name: 'started-at',
|
|
2303
|
+
path: ['startedAt'],
|
|
2074
2304
|
location: 'body',
|
|
2075
2305
|
required: true,
|
|
2076
|
-
description: '
|
|
2306
|
+
description: 'When the call started (ISO 8601 format)',
|
|
2077
2307
|
valueKind: 'string',
|
|
2078
2308
|
repeatable: false,
|
|
2079
2309
|
},
|
|
2080
2310
|
{
|
|
2081
|
-
name: '
|
|
2082
|
-
path: ['
|
|
2311
|
+
name: 'interface-type',
|
|
2312
|
+
path: ['interfaceType'],
|
|
2083
2313
|
location: 'body',
|
|
2084
|
-
required:
|
|
2085
|
-
description: '
|
|
2314
|
+
required: true,
|
|
2315
|
+
description: 'Interface type of the call (PHONE or WEB)',
|
|
2086
2316
|
valueKind: 'string',
|
|
2317
|
+
enumValues: ['PHONE', 'WEB'],
|
|
2087
2318
|
repeatable: false,
|
|
2088
2319
|
},
|
|
2089
|
-
],
|
|
2090
|
-
hasParams: true,
|
|
2091
|
-
paramsAllOptional: false,
|
|
2092
|
-
bodyOpaque: false,
|
|
2093
|
-
bodyVariants: [],
|
|
2094
|
-
acceptsBody: true,
|
|
2095
|
-
requiresAuth: true,
|
|
2096
|
-
},
|
|
2097
|
-
{
|
|
2098
|
-
commandPath: ['calendar-connection', 'delete'],
|
|
2099
|
-
clientProperty: 'calendarConnection',
|
|
2100
|
-
methodName: 'delete',
|
|
2101
|
-
httpMethod: 'delete',
|
|
2102
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2103
|
-
summary: 'Delete a calendar connection',
|
|
2104
|
-
description: 'Disconnects the calendar and destroys the stored credential. A credential the customer deleted should stop existing, so this is not an archive. Appointments already recorded against the connection are kept, so a booking stays explainable after the calendar is disconnected. Refused with a 409 while a calendar tool is still bound to the connection, naming the tools: point them at another calendar, or delete them, first. A dangling binding would otherwise be found by whoever next tried to ship the agent, who is not the person who disconnected the calendar.',
|
|
2105
|
-
positionals: [
|
|
2106
2320
|
{
|
|
2107
|
-
name: '
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
bodyOpaque: false,
|
|
2116
|
-
bodyVariants: [],
|
|
2117
|
-
acceptsBody: false,
|
|
2118
|
-
requiresAuth: true,
|
|
2119
|
-
},
|
|
2120
|
-
{
|
|
2121
|
-
commandPath: ['calendar-connection', 'get'],
|
|
2122
|
-
clientProperty: 'calendarConnection',
|
|
2123
|
-
methodName: 'getByID',
|
|
2124
|
-
httpMethod: 'get',
|
|
2125
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2126
|
-
summary: 'Get a calendar connection',
|
|
2127
|
-
description: 'Returns one calendar connection. The stored credential is never included.',
|
|
2128
|
-
positionals: [
|
|
2129
|
-
{
|
|
2130
|
-
name: 'connection-id',
|
|
2131
|
-
paramKey: 'connectionId',
|
|
2132
|
-
description: 'Calendar connection ID',
|
|
2133
|
-
},
|
|
2134
|
-
],
|
|
2135
|
-
flags: [],
|
|
2136
|
-
hasParams: false,
|
|
2137
|
-
paramsAllOptional: true,
|
|
2138
|
-
bodyOpaque: false,
|
|
2139
|
-
bodyVariants: [],
|
|
2140
|
-
acceptsBody: false,
|
|
2141
|
-
requiresAuth: true,
|
|
2142
|
-
},
|
|
2143
|
-
{
|
|
2144
|
-
commandPath: ['calendar-connection', 'list'],
|
|
2145
|
-
clientProperty: 'calendarConnection',
|
|
2146
|
-
methodName: 'list',
|
|
2147
|
-
httpMethod: 'get',
|
|
2148
|
-
httpPath: '/v1/calendar-connection',
|
|
2149
|
-
summary: 'List calendar connections',
|
|
2150
|
-
description: 'Returns every calendar connection in the authenticated project, by label. A project has a handful of these, so the list is not paginated: `pagination.hasMore` is always false.',
|
|
2151
|
-
positionals: [],
|
|
2152
|
-
flags: [
|
|
2153
|
-
{
|
|
2154
|
-
name: 'provider',
|
|
2155
|
-
path: ['provider'],
|
|
2156
|
-
location: 'query',
|
|
2157
|
-
required: false,
|
|
2158
|
-
description: 'Who holds the calendar. CAL_COM is the only provider that can be connected today; GOOGLE and CALENDLY are described by `capabilities` but not yet connectable.',
|
|
2159
|
-
valueKind: 'string',
|
|
2160
|
-
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2161
|
-
repeatable: false,
|
|
2162
|
-
},
|
|
2163
|
-
],
|
|
2164
|
-
hasParams: true,
|
|
2165
|
-
paramsAllOptional: true,
|
|
2166
|
-
bodyOpaque: false,
|
|
2167
|
-
bodyVariants: [],
|
|
2168
|
-
acceptsBody: false,
|
|
2169
|
-
requiresAuth: true,
|
|
2170
|
-
},
|
|
2171
|
-
{
|
|
2172
|
-
commandPath: ['calendar-connection', 'target', 'get'],
|
|
2173
|
-
clientProperty: 'calendarConnection',
|
|
2174
|
-
methodName: 'getTarget',
|
|
2175
|
-
httpMethod: 'get',
|
|
2176
|
-
httpPath: '/v1/calendar-connection/{connectionId}/targets/{targetId}',
|
|
2177
|
-
summary: 'Read one bookable target',
|
|
2178
|
-
description: 'The same entry as the list, plus what it demands of a booker. `requiresAttendeeEmail` is the field that decides an agent’s design: the attendee object itself needs only a name and a timezone, but an event type can declare email required, and an agent that cannot collect one simply cannot book on it. Read this when configuring a calendar tool, not after a caller is already waiting. Costs one provider call more than the list, which is why the list does not fold it in.',
|
|
2179
|
-
positionals: [
|
|
2180
|
-
{
|
|
2181
|
-
name: 'connection-id',
|
|
2182
|
-
paramKey: 'connectionId',
|
|
2183
|
-
description: 'Calendar connection ID',
|
|
2184
|
-
},
|
|
2185
|
-
{
|
|
2186
|
-
name: 'target-id',
|
|
2187
|
-
paramKey: 'targetId',
|
|
2188
|
-
description: 'Target id, as the list returned it',
|
|
2189
|
-
},
|
|
2190
|
-
],
|
|
2191
|
-
flags: [],
|
|
2192
|
-
hasParams: true,
|
|
2193
|
-
paramsAllOptional: false,
|
|
2194
|
-
bodyOpaque: false,
|
|
2195
|
-
bodyVariants: [],
|
|
2196
|
-
acceptsBody: false,
|
|
2197
|
-
requiresAuth: true,
|
|
2198
|
-
},
|
|
2199
|
-
{
|
|
2200
|
-
commandPath: ['calendar-connection', 'target', 'list'],
|
|
2201
|
-
clientProperty: 'calendarConnection',
|
|
2202
|
-
methodName: 'listTargets',
|
|
2203
|
-
httpMethod: 'get',
|
|
2204
|
-
httpPath: '/v1/calendar-connection/{connectionId}/targets',
|
|
2205
|
-
summary: 'List what can be booked on a calendar',
|
|
2206
|
-
description: 'What an agent can be pointed at on this connection: Cal.com event types today, Google calendars when that lands. Read live from the provider, so an event type added since you connected is here without reconnecting. Each entry carries a `target` ready to put on a calendar tool, so nothing has to assemble one by hand.',
|
|
2207
|
-
positionals: [
|
|
2208
|
-
{
|
|
2209
|
-
name: 'connection-id',
|
|
2210
|
-
paramKey: 'connectionId',
|
|
2211
|
-
description: 'Calendar connection ID',
|
|
2212
|
-
},
|
|
2213
|
-
],
|
|
2214
|
-
flags: [],
|
|
2215
|
-
hasParams: false,
|
|
2216
|
-
paramsAllOptional: true,
|
|
2217
|
-
bodyOpaque: false,
|
|
2218
|
-
bodyVariants: [],
|
|
2219
|
-
acceptsBody: false,
|
|
2220
|
-
requiresAuth: true,
|
|
2221
|
-
},
|
|
2222
|
-
{
|
|
2223
|
-
commandPath: ['calendar-connection', 'update'],
|
|
2224
|
-
clientProperty: 'calendarConnection',
|
|
2225
|
-
methodName: 'update',
|
|
2226
|
-
httpMethod: 'patch',
|
|
2227
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2228
|
-
summary: 'Update a calendar connection',
|
|
2229
|
-
description: 'Renames a connection, changes the timezone slots are offered in, or rotates the credential. A rotated credential is verified first, and a verified credential returns the connection to ACTIVE.',
|
|
2230
|
-
positionals: [
|
|
2231
|
-
{
|
|
2232
|
-
name: 'connection-id',
|
|
2233
|
-
paramKey: 'connectionId',
|
|
2234
|
-
description: 'Calendar connection ID',
|
|
2235
|
-
},
|
|
2236
|
-
],
|
|
2237
|
-
flags: [
|
|
2238
|
-
{
|
|
2239
|
-
name: 'label',
|
|
2240
|
-
path: ['label'],
|
|
2241
|
-
location: 'body',
|
|
2242
|
-
required: false,
|
|
2243
|
-
description: 'Rename the connection.',
|
|
2244
|
-
valueKind: 'string',
|
|
2245
|
-
repeatable: false,
|
|
2246
|
-
},
|
|
2247
|
-
{
|
|
2248
|
-
name: 'timezone',
|
|
2249
|
-
path: ['timezone'],
|
|
2250
|
-
location: 'body',
|
|
2251
|
-
required: false,
|
|
2252
|
-
description: 'Change the named IANA timezone slots are offered in.',
|
|
2253
|
-
valueKind: 'string',
|
|
2254
|
-
repeatable: false,
|
|
2255
|
-
},
|
|
2256
|
-
{
|
|
2257
|
-
name: 'api-key',
|
|
2258
|
-
path: ['apiKey'],
|
|
2259
|
-
location: 'body',
|
|
2260
|
-
required: false,
|
|
2261
|
-
description: 'Rotate the credential. The new key is verified before it is stored, and a verified key returns the connection to ACTIVE, which is how a connection recovers from INVALID_CREDENTIALS.',
|
|
2262
|
-
valueKind: 'string',
|
|
2263
|
-
repeatable: false,
|
|
2264
|
-
},
|
|
2265
|
-
],
|
|
2266
|
-
hasParams: true,
|
|
2267
|
-
paramsAllOptional: true,
|
|
2268
|
-
bodyOpaque: false,
|
|
2269
|
-
bodyVariants: [],
|
|
2270
|
-
acceptsBody: true,
|
|
2271
|
-
requiresAuth: true,
|
|
2272
|
-
},
|
|
2273
|
-
{
|
|
2274
|
-
commandPath: ['call', 'batch', 'delete'],
|
|
2275
|
-
clientProperty: 'call',
|
|
2276
|
-
methodName: 'batchDelete',
|
|
2277
|
-
httpMethod: 'post',
|
|
2278
|
-
httpPath: '/v1/call/batch-delete',
|
|
2279
|
-
summary: 'Delete calls in batch',
|
|
2280
|
-
description: 'Deletes up to 100 calls by ID in one request. Each deleted call, its metrics and its analysis are hidden from every read, and any analysis still running on it is cancelled. IDs that do not exist in this project, or were already deleted, are returned in notFoundCallIds and left untouched. The request succeeds even when none of the calls are found. IDs are returned lowercase, each once.',
|
|
2281
|
-
positionals: [],
|
|
2282
|
-
flags: [
|
|
2283
|
-
{
|
|
2284
|
-
name: 'call-ids',
|
|
2285
|
-
path: ['callIds'],
|
|
2286
|
-
location: 'body',
|
|
2287
|
-
required: true,
|
|
2288
|
-
description: 'IDs of the calls to delete, at most 100. Repeated IDs are counted once.',
|
|
2289
|
-
valueKind: 'array',
|
|
2290
|
-
repeatable: true,
|
|
2291
|
-
},
|
|
2292
|
-
],
|
|
2293
|
-
hasParams: true,
|
|
2294
|
-
paramsAllOptional: false,
|
|
2295
|
-
bodyOpaque: false,
|
|
2296
|
-
bodyVariants: [],
|
|
2297
|
-
acceptsBody: true,
|
|
2298
|
-
requiresAuth: true,
|
|
2299
|
-
},
|
|
2300
|
-
{
|
|
2301
|
-
commandPath: ['call', 'cost', 'get'],
|
|
2302
|
-
clientProperty: 'call',
|
|
2303
|
-
methodName: 'getCost',
|
|
2304
|
-
httpMethod: 'get',
|
|
2305
|
-
httpPath: '/v1/call/{callId}/cost',
|
|
2306
|
-
summary: 'Get call cost',
|
|
2307
|
-
description: 'The billable spend attributed to one call, split by cost type, with every cost line behind it. Simulated calls include the costs their simulation incurred before the call connected. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.',
|
|
2308
|
-
positionals: [
|
|
2309
|
-
{
|
|
2310
|
-
name: 'call-id',
|
|
2311
|
-
paramKey: 'callId',
|
|
2312
|
-
},
|
|
2313
|
-
],
|
|
2314
|
-
flags: [],
|
|
2315
|
-
hasParams: false,
|
|
2316
|
-
paramsAllOptional: true,
|
|
2317
|
-
bodyOpaque: false,
|
|
2318
|
-
bodyVariants: [],
|
|
2319
|
-
acceptsBody: false,
|
|
2320
|
-
requiresAuth: true,
|
|
2321
|
-
},
|
|
2322
|
-
{
|
|
2323
|
-
commandPath: ['call', 'create'],
|
|
2324
|
-
clientProperty: 'call',
|
|
2325
|
-
methodName: 'create',
|
|
2326
|
-
httpMethod: 'post',
|
|
2327
|
-
httpPath: '/v1/call',
|
|
2328
|
-
summary: 'Create a call',
|
|
2329
|
-
description: 'Create a new call with recording, transcript, agents, and customers',
|
|
2330
|
-
positionals: [],
|
|
2331
|
-
flags: [
|
|
2332
|
-
{
|
|
2333
|
-
name: 'recording-url',
|
|
2334
|
-
path: ['recordingUrl'],
|
|
2335
|
-
location: 'body',
|
|
2336
|
-
required: true,
|
|
2337
|
-
description: 'URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.',
|
|
2338
|
-
valueKind: 'string',
|
|
2339
|
-
repeatable: false,
|
|
2340
|
-
},
|
|
2341
|
-
{
|
|
2342
|
-
name: 'stereo-recording-url',
|
|
2343
|
-
path: ['stereoRecordingUrl'],
|
|
2344
|
-
location: 'body',
|
|
2345
|
-
required: false,
|
|
2346
|
-
description: 'URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.',
|
|
2347
|
-
valueKind: 'string',
|
|
2348
|
-
repeatable: false,
|
|
2349
|
-
},
|
|
2350
|
-
{
|
|
2351
|
-
name: 'started-at',
|
|
2352
|
-
path: ['startedAt'],
|
|
2353
|
-
location: 'body',
|
|
2354
|
-
required: true,
|
|
2355
|
-
description: 'When the call started (ISO 8601 format)',
|
|
2356
|
-
valueKind: 'string',
|
|
2357
|
-
repeatable: false,
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
name: 'interface-type',
|
|
2361
|
-
path: ['interfaceType'],
|
|
2362
|
-
location: 'body',
|
|
2363
|
-
required: true,
|
|
2364
|
-
description: 'Interface type of the call (PHONE or WEB)',
|
|
2365
|
-
valueKind: 'string',
|
|
2366
|
-
enumValues: ['PHONE', 'WEB'],
|
|
2367
|
-
repeatable: false,
|
|
2368
|
-
},
|
|
2369
|
-
{
|
|
2370
|
-
name: 'call-direction',
|
|
2371
|
-
path: ['callDirection'],
|
|
2372
|
-
location: 'body',
|
|
2373
|
-
required: true,
|
|
2374
|
-
description: 'Direction of the call (INBOUND or OUTBOUND)',
|
|
2375
|
-
valueKind: 'string',
|
|
2376
|
-
enumValues: ['INBOUND', 'OUTBOUND'],
|
|
2377
|
-
repeatable: false,
|
|
2321
|
+
name: 'call-direction',
|
|
2322
|
+
path: ['callDirection'],
|
|
2323
|
+
location: 'body',
|
|
2324
|
+
required: true,
|
|
2325
|
+
description: 'Direction of the call (INBOUND or OUTBOUND)',
|
|
2326
|
+
valueKind: 'string',
|
|
2327
|
+
enumValues: ['INBOUND', 'OUTBOUND'],
|
|
2328
|
+
repeatable: false,
|
|
2378
2329
|
},
|
|
2379
2330
|
{
|
|
2380
2331
|
name: 'ended-status',
|
|
@@ -2576,7 +2527,7 @@ exports.COMMANDS = [
|
|
|
2576
2527
|
methodName: 'getByID',
|
|
2577
2528
|
httpMethod: 'get',
|
|
2578
2529
|
httpPath: '/v1/call/{callId}',
|
|
2579
|
-
summary: 'Get a call
|
|
2530
|
+
summary: 'Get a call',
|
|
2580
2531
|
description: 'Retrieve an existing call by its unique identifier',
|
|
2581
2532
|
positionals: [
|
|
2582
2533
|
{
|
|
@@ -2980,87 +2931,1767 @@ exports.COMMANDS = [
|
|
|
2980
2931
|
requiresAuth: true,
|
|
2981
2932
|
},
|
|
2982
2933
|
{
|
|
2983
|
-
commandPath: ['
|
|
2984
|
-
clientProperty: '
|
|
2985
|
-
methodName: '
|
|
2934
|
+
commandPath: ['connections', 'agent', 'backfill', 'cancel'],
|
|
2935
|
+
clientProperty: 'agentConnection',
|
|
2936
|
+
methodName: 'cancelBackfill',
|
|
2986
2937
|
httpMethod: 'post',
|
|
2987
|
-
httpPath: '/v1/
|
|
2988
|
-
summary: '
|
|
2989
|
-
description: '
|
|
2990
|
-
positionals: [
|
|
2991
|
-
flags: [
|
|
2938
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills/{backfillId}/cancel',
|
|
2939
|
+
summary: 'Cancel a backfill',
|
|
2940
|
+
description: 'Stops a running backfill. Calls it already imported stay.',
|
|
2941
|
+
positionals: [
|
|
2992
2942
|
{
|
|
2993
|
-
name: '
|
|
2994
|
-
|
|
2995
|
-
location: 'body',
|
|
2996
|
-
required: true,
|
|
2997
|
-
description: 'A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from.',
|
|
2998
|
-
valueKind: 'string',
|
|
2999
|
-
repeatable: false,
|
|
2943
|
+
name: 'connection-id',
|
|
2944
|
+
paramKey: 'connectionId',
|
|
3000
2945
|
},
|
|
3001
2946
|
{
|
|
3002
|
-
name: '
|
|
3003
|
-
|
|
3004
|
-
|
|
2947
|
+
name: 'backfill-id',
|
|
2948
|
+
paramKey: 'backfillId',
|
|
2949
|
+
},
|
|
2950
|
+
],
|
|
2951
|
+
flags: [],
|
|
2952
|
+
hasParams: true,
|
|
2953
|
+
paramsAllOptional: false,
|
|
2954
|
+
bodyOpaque: false,
|
|
2955
|
+
bodyVariants: [],
|
|
2956
|
+
acceptsBody: false,
|
|
2957
|
+
requiresAuth: true,
|
|
2958
|
+
},
|
|
2959
|
+
{
|
|
2960
|
+
commandPath: ['connections', 'agent', 'backfill', 'create'],
|
|
2961
|
+
clientProperty: 'agentConnection',
|
|
2962
|
+
methodName: 'createBackfill',
|
|
2963
|
+
httpMethod: 'post',
|
|
2964
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills',
|
|
2965
|
+
summary: 'Import past calls',
|
|
2966
|
+
description: 'Starts a backfill that imports up to `maxCalls` of the most recent past calls from a Retell, Vapi, ElevenLabs or Leaping connection. Other platforms return 400.',
|
|
2967
|
+
positionals: [
|
|
2968
|
+
{
|
|
2969
|
+
name: 'connection-id',
|
|
2970
|
+
paramKey: 'connectionId',
|
|
2971
|
+
},
|
|
2972
|
+
],
|
|
2973
|
+
flags: [
|
|
2974
|
+
{
|
|
2975
|
+
name: 'max-calls',
|
|
2976
|
+
path: ['maxCalls'],
|
|
2977
|
+
location: 'body',
|
|
2978
|
+
required: true,
|
|
2979
|
+
description: 'How many of the most recent past calls to import, up to 1000.',
|
|
2980
|
+
valueKind: 'integer',
|
|
2981
|
+
repeatable: false,
|
|
2982
|
+
},
|
|
2983
|
+
],
|
|
2984
|
+
hasParams: true,
|
|
2985
|
+
paramsAllOptional: false,
|
|
2986
|
+
bodyOpaque: false,
|
|
2987
|
+
bodyVariants: [],
|
|
2988
|
+
acceptsBody: true,
|
|
2989
|
+
requiresAuth: true,
|
|
2990
|
+
},
|
|
2991
|
+
{
|
|
2992
|
+
commandPath: ['connections', 'agent', 'backfill', 'list'],
|
|
2993
|
+
clientProperty: 'agentConnection',
|
|
2994
|
+
methodName: 'listBackfills',
|
|
2995
|
+
httpMethod: 'get',
|
|
2996
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills',
|
|
2997
|
+
summary: 'List backfills',
|
|
2998
|
+
description: "A connection's imports of past calls, newest first.",
|
|
2999
|
+
positionals: [
|
|
3000
|
+
{
|
|
3001
|
+
name: 'connection-id',
|
|
3002
|
+
paramKey: 'connectionId',
|
|
3003
|
+
},
|
|
3004
|
+
],
|
|
3005
|
+
flags: [],
|
|
3006
|
+
hasParams: false,
|
|
3007
|
+
paramsAllOptional: true,
|
|
3008
|
+
bodyOpaque: false,
|
|
3009
|
+
bodyVariants: [],
|
|
3010
|
+
acceptsBody: false,
|
|
3011
|
+
requiresAuth: true,
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
commandPath: ['connections', 'agent', 'create'],
|
|
3015
|
+
clientProperty: 'agentConnection',
|
|
3016
|
+
methodName: 'create',
|
|
3017
|
+
httpMethod: 'post',
|
|
3018
|
+
httpPath: '/v1/connections/agent',
|
|
3019
|
+
summary: 'Connect an agent',
|
|
3020
|
+
description: 'Connects the platform a project’s agents run on. The body is shaped by `provider`; `GET /v1/connections/agent/providers` lists what each needs. Retell, Vapi, ElevenLabs and Bland keys are checked by listing agents first, so a refused key returns 400 and nothing is stored. Platforms that pull agents start syncing straight away. For LIVEKIT_SELF_HOSTED and the Pipecat providers, the response carries `observerApiKey`, shown once, for your SDK to report calls with. Most platforms connect once per project, and a second create returns 409; LiveKit Cloud may connect several accounts.',
|
|
3021
|
+
positionals: [],
|
|
3022
|
+
flags: [],
|
|
3023
|
+
hasParams: true,
|
|
3024
|
+
paramsAllOptional: false,
|
|
3025
|
+
bodyOpaque: true,
|
|
3026
|
+
bodyVariants: [
|
|
3027
|
+
{
|
|
3028
|
+
name: 'AgentConnectionCreateRetell',
|
|
3029
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
name: 'AgentConnectionCreateVapi',
|
|
3033
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
name: 'AgentConnectionCreateElevenLabs',
|
|
3037
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3038
|
+
},
|
|
3039
|
+
{
|
|
3040
|
+
name: 'AgentConnectionCreateBland',
|
|
3041
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
name: 'AgentConnectionCreateLeaping',
|
|
3045
|
+
required: ['provider', 'name', 'apiKey', 'agentIds'],
|
|
3046
|
+
},
|
|
3047
|
+
{
|
|
3048
|
+
name: 'AgentConnectionCreateLivekit',
|
|
3049
|
+
required: ['provider', 'name', 'url', 'apiKey', 'apiSecret'],
|
|
3050
|
+
},
|
|
3051
|
+
{
|
|
3052
|
+
name: 'AgentConnectionCreateLivekitSelfHosted',
|
|
3053
|
+
required: ['provider', 'name'],
|
|
3054
|
+
},
|
|
3055
|
+
{
|
|
3056
|
+
name: 'AgentConnectionCreatePipecatSelfHosted',
|
|
3057
|
+
required: ['provider', 'name'],
|
|
3058
|
+
},
|
|
3059
|
+
{
|
|
3060
|
+
name: 'AgentConnectionCreatePipecatCloud',
|
|
3061
|
+
required: ['provider', 'name'],
|
|
3062
|
+
},
|
|
3063
|
+
{
|
|
3064
|
+
name: 'AgentConnectionCreateKore',
|
|
3065
|
+
required: ['provider', 'name', 'apiKey', 'appId', 'envName'],
|
|
3066
|
+
},
|
|
3067
|
+
{
|
|
3068
|
+
name: 'AgentConnectionCreateGoogleCes',
|
|
3069
|
+
required: ['provider', 'name', 'wifConfig', 'location', 'appId', 'deploymentId'],
|
|
3070
|
+
},
|
|
3071
|
+
],
|
|
3072
|
+
acceptsBody: true,
|
|
3073
|
+
requiresAuth: true,
|
|
3074
|
+
},
|
|
3075
|
+
{
|
|
3076
|
+
commandPath: ['connections', 'agent', 'delete'],
|
|
3077
|
+
clientProperty: 'agentConnection',
|
|
3078
|
+
methodName: 'delete',
|
|
3079
|
+
httpMethod: 'delete',
|
|
3080
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3081
|
+
summary: 'Disconnect an agent connection',
|
|
3082
|
+
description: 'Deletes the connection and its stored credential, and stops syncing. Agents and calls it already brought in stay in the project. Alerts that notify through it stop notifying.',
|
|
3083
|
+
positionals: [
|
|
3084
|
+
{
|
|
3085
|
+
name: 'connection-id',
|
|
3086
|
+
paramKey: 'connectionId',
|
|
3087
|
+
},
|
|
3088
|
+
],
|
|
3089
|
+
flags: [],
|
|
3090
|
+
hasParams: false,
|
|
3091
|
+
paramsAllOptional: true,
|
|
3092
|
+
bodyOpaque: false,
|
|
3093
|
+
bodyVariants: [],
|
|
3094
|
+
acceptsBody: false,
|
|
3095
|
+
requiresAuth: true,
|
|
3096
|
+
},
|
|
3097
|
+
{
|
|
3098
|
+
commandPath: ['connections', 'agent', 'discover'],
|
|
3099
|
+
clientProperty: 'agentConnection',
|
|
3100
|
+
methodName: 'discover',
|
|
3101
|
+
httpMethod: 'post',
|
|
3102
|
+
httpPath: '/v1/connections/agent/discover',
|
|
3103
|
+
summary: 'Discover agents with a platform API key',
|
|
3104
|
+
description: 'Lists the agents a Retell, Vapi, ElevenLabs or Bland API key can see, without storing anything. Use it to check a key and to pick `agentIds` before connecting. A key the platform refuses returns 400.',
|
|
3105
|
+
positionals: [],
|
|
3106
|
+
flags: [
|
|
3107
|
+
{
|
|
3108
|
+
name: 'provider',
|
|
3109
|
+
path: ['provider'],
|
|
3110
|
+
location: 'body',
|
|
3111
|
+
required: true,
|
|
3112
|
+
description: 'Platforms whose agents can be listed with a key.',
|
|
3113
|
+
valueKind: 'string',
|
|
3114
|
+
enumValues: ['RETELL', 'VAPI', 'ELEVEN_LABS', 'BLAND'],
|
|
3115
|
+
repeatable: false,
|
|
3116
|
+
},
|
|
3117
|
+
{
|
|
3118
|
+
name: 'api-key',
|
|
3119
|
+
path: ['apiKey'],
|
|
3120
|
+
location: 'body',
|
|
3121
|
+
required: true,
|
|
3122
|
+
description: 'The platform API key to list agents with. Stored nowhere.',
|
|
3123
|
+
valueKind: 'string',
|
|
3124
|
+
repeatable: false,
|
|
3125
|
+
},
|
|
3126
|
+
],
|
|
3127
|
+
hasParams: true,
|
|
3128
|
+
paramsAllOptional: false,
|
|
3129
|
+
bodyOpaque: false,
|
|
3130
|
+
bodyVariants: [],
|
|
3131
|
+
acceptsBody: true,
|
|
3132
|
+
requiresAuth: true,
|
|
3133
|
+
},
|
|
3134
|
+
{
|
|
3135
|
+
commandPath: ['connections', 'agent', 'get'],
|
|
3136
|
+
clientProperty: 'agentConnection',
|
|
3137
|
+
methodName: 'getByID',
|
|
3138
|
+
httpMethod: 'get',
|
|
3139
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3140
|
+
summary: 'Get an agent connection',
|
|
3141
|
+
description: 'One connection, with its settings and latest sync. Credentials are never returned.',
|
|
3142
|
+
positionals: [
|
|
3143
|
+
{
|
|
3144
|
+
name: 'connection-id',
|
|
3145
|
+
paramKey: 'connectionId',
|
|
3146
|
+
},
|
|
3147
|
+
],
|
|
3148
|
+
flags: [],
|
|
3149
|
+
hasParams: false,
|
|
3150
|
+
paramsAllOptional: true,
|
|
3151
|
+
bodyOpaque: false,
|
|
3152
|
+
bodyVariants: [],
|
|
3153
|
+
acceptsBody: false,
|
|
3154
|
+
requiresAuth: true,
|
|
3155
|
+
},
|
|
3156
|
+
{
|
|
3157
|
+
commandPath: ['connections', 'agent', 'list'],
|
|
3158
|
+
clientProperty: 'agentConnection',
|
|
3159
|
+
methodName: 'list',
|
|
3160
|
+
httpMethod: 'get',
|
|
3161
|
+
httpPath: '/v1/connections/agent',
|
|
3162
|
+
summary: 'List agent connections',
|
|
3163
|
+
description: "The project's connections to the platforms its agents run on (Retell, Vapi, LiveKit, Pipecat and others), each with its settings and latest sync. Credentials are never returned.",
|
|
3164
|
+
positionals: [],
|
|
3165
|
+
flags: [
|
|
3166
|
+
{
|
|
3167
|
+
name: 'provider',
|
|
3168
|
+
path: ['provider'],
|
|
3169
|
+
location: 'query',
|
|
3170
|
+
required: false,
|
|
3171
|
+
description: 'The platform the agents run on. LIVEKIT is LiveKit Cloud; LIVEKIT_SELF_HOSTED is the LiveKit Agents SDK reporting through the Roark plugin. PIPECAT_CLOUD_INTEGRATION and PIPECAT_SELF_HOSTED_INTEGRATION are Pipecat Cloud and a self-hosted Pipecat bot. `GET /v1/connections/agent/providers` describes what each one needs.',
|
|
3172
|
+
valueKind: 'string',
|
|
3173
|
+
enumValues: [
|
|
3174
|
+
'RETELL',
|
|
3175
|
+
'VAPI',
|
|
3176
|
+
'ELEVEN_LABS',
|
|
3177
|
+
'BLAND',
|
|
3178
|
+
'LEAPING',
|
|
3179
|
+
'LIVEKIT',
|
|
3180
|
+
'LIVEKIT_SELF_HOSTED',
|
|
3181
|
+
'PIPECAT_CLOUD_INTEGRATION',
|
|
3182
|
+
'PIPECAT_SELF_HOSTED_INTEGRATION',
|
|
3183
|
+
'KORE',
|
|
3184
|
+
'GOOGLE_CES',
|
|
3185
|
+
],
|
|
3186
|
+
repeatable: false,
|
|
3187
|
+
},
|
|
3188
|
+
],
|
|
3189
|
+
hasParams: true,
|
|
3190
|
+
paramsAllOptional: true,
|
|
3191
|
+
bodyOpaque: false,
|
|
3192
|
+
bodyVariants: [],
|
|
3193
|
+
acceptsBody: false,
|
|
3194
|
+
requiresAuth: true,
|
|
3195
|
+
},
|
|
3196
|
+
{
|
|
3197
|
+
commandPath: ['connections', 'agent', 'provider', 'list'],
|
|
3198
|
+
clientProperty: 'agentConnection',
|
|
3199
|
+
methodName: 'listProviders',
|
|
3200
|
+
httpMethod: 'get',
|
|
3201
|
+
httpPath: '/v1/connections/agent/providers',
|
|
3202
|
+
summary: 'List agent connection providers',
|
|
3203
|
+
description: 'Every platform a project can connect, with the fields its create body needs, how its calls reach Roark, and which settings apply. Read this before connecting one.',
|
|
3204
|
+
positionals: [],
|
|
3205
|
+
flags: [],
|
|
3206
|
+
hasParams: false,
|
|
3207
|
+
paramsAllOptional: true,
|
|
3208
|
+
bodyOpaque: false,
|
|
3209
|
+
bodyVariants: [],
|
|
3210
|
+
acceptsBody: false,
|
|
3211
|
+
requiresAuth: true,
|
|
3212
|
+
},
|
|
3213
|
+
{
|
|
3214
|
+
commandPath: ['connections', 'agent', 'update'],
|
|
3215
|
+
clientProperty: 'agentConnection',
|
|
3216
|
+
methodName: 'update',
|
|
3217
|
+
httpMethod: 'patch',
|
|
3218
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3219
|
+
summary: 'Update an agent connection',
|
|
3220
|
+
description: 'Changes a connection’s settings or rotates its credential. Send `provider` (it must match the connection’s) and only the fields to change; the rest keep their stored values. A new Retell, Vapi, ElevenLabs or Bland key is checked by listing agents first. Set `status` to INACTIVE to pause syncing without deleting anything.',
|
|
3221
|
+
positionals: [
|
|
3222
|
+
{
|
|
3223
|
+
name: 'connection-id',
|
|
3224
|
+
paramKey: 'connectionId',
|
|
3225
|
+
},
|
|
3226
|
+
],
|
|
3227
|
+
flags: [],
|
|
3228
|
+
hasParams: true,
|
|
3229
|
+
paramsAllOptional: false,
|
|
3230
|
+
bodyOpaque: true,
|
|
3231
|
+
bodyVariants: [
|
|
3232
|
+
{
|
|
3233
|
+
name: 'AgentConnectionUpdateRetell',
|
|
3234
|
+
required: ['provider'],
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
name: 'AgentConnectionUpdateVapi',
|
|
3238
|
+
required: ['provider'],
|
|
3239
|
+
},
|
|
3240
|
+
{
|
|
3241
|
+
name: 'AgentConnectionUpdateElevenLabs',
|
|
3242
|
+
required: ['provider'],
|
|
3243
|
+
},
|
|
3244
|
+
{
|
|
3245
|
+
name: 'AgentConnectionUpdateBland',
|
|
3246
|
+
required: ['provider'],
|
|
3247
|
+
},
|
|
3248
|
+
{
|
|
3249
|
+
name: 'AgentConnectionUpdateLeaping',
|
|
3250
|
+
required: ['provider'],
|
|
3251
|
+
},
|
|
3252
|
+
{
|
|
3253
|
+
name: 'AgentConnectionUpdateLivekit',
|
|
3254
|
+
required: ['provider'],
|
|
3255
|
+
},
|
|
3256
|
+
{
|
|
3257
|
+
name: 'AgentConnectionUpdateLivekitSelfHosted',
|
|
3258
|
+
required: ['provider'],
|
|
3259
|
+
},
|
|
3260
|
+
{
|
|
3261
|
+
name: 'AgentConnectionUpdatePipecatSelfHosted',
|
|
3262
|
+
required: ['provider'],
|
|
3263
|
+
},
|
|
3264
|
+
{
|
|
3265
|
+
name: 'AgentConnectionUpdatePipecatCloud',
|
|
3266
|
+
required: ['provider'],
|
|
3267
|
+
},
|
|
3268
|
+
{
|
|
3269
|
+
name: 'AgentConnectionUpdateKore',
|
|
3270
|
+
required: ['provider'],
|
|
3271
|
+
},
|
|
3272
|
+
{
|
|
3273
|
+
name: 'AgentConnectionUpdateGoogleCes',
|
|
3274
|
+
required: ['provider'],
|
|
3275
|
+
},
|
|
3276
|
+
],
|
|
3277
|
+
acceptsBody: true,
|
|
3278
|
+
requiresAuth: true,
|
|
3279
|
+
},
|
|
3280
|
+
{
|
|
3281
|
+
commandPath: ['connections', 'calendar', 'calendar', 'list'],
|
|
3282
|
+
clientProperty: 'calendarConnection',
|
|
3283
|
+
methodName: 'listCalendars',
|
|
3284
|
+
httpMethod: 'get',
|
|
3285
|
+
httpPath: '/v1/connections/calendar/{connectionId}/calendars',
|
|
3286
|
+
summary: 'List calendars for bookable targets',
|
|
3287
|
+
description: 'Only for a connection whose `capabilities.roarkOwnsBookingPolicy` is true: on a scheduling system the bookable things already exist and `GET /targets` returns them. Calendars the account can only read are left out rather than listed and refused: one would answer availability perfectly well and then fail the booking, mid-call, with a caller on the line.',
|
|
3288
|
+
positionals: [
|
|
3289
|
+
{
|
|
3290
|
+
name: 'connection-id',
|
|
3291
|
+
paramKey: 'connectionId',
|
|
3292
|
+
description: 'Calendar connection ID',
|
|
3293
|
+
},
|
|
3294
|
+
],
|
|
3295
|
+
flags: [],
|
|
3296
|
+
hasParams: false,
|
|
3297
|
+
paramsAllOptional: true,
|
|
3298
|
+
bodyOpaque: false,
|
|
3299
|
+
bodyVariants: [],
|
|
3300
|
+
acceptsBody: false,
|
|
3301
|
+
requiresAuth: true,
|
|
3302
|
+
},
|
|
3303
|
+
{
|
|
3304
|
+
commandPath: ['connections', 'calendar', 'calendly-oauth', 'start'],
|
|
3305
|
+
clientProperty: 'calendarConnection',
|
|
3306
|
+
methodName: 'startCalendlyOauth',
|
|
3307
|
+
httpMethod: 'post',
|
|
3308
|
+
httpPath: '/v1/connections/calendar/calendly/authorize-url',
|
|
3309
|
+
summary: 'Start connecting a Calendly account',
|
|
3310
|
+
description: 'Returns a URL to open in a browser. Calendly has no credential a request body can carry, so connecting one is two steps: ask for this URL, let the customer consent, and Roark finishes the rest server-side (it exchanges the code, verifies the credential, reads the account’s own timezone when none was given, and stores the connection). Nothing is created until the customer consents, and a link that is not used expires. Read the result with `GET /v1/connections/calendar?provider=CALENDLY`.',
|
|
3311
|
+
positionals: [],
|
|
3312
|
+
flags: [
|
|
3313
|
+
{
|
|
3314
|
+
name: 'calendar-connection-id',
|
|
3315
|
+
path: ['calendarConnectionId'],
|
|
3316
|
+
location: 'body',
|
|
3317
|
+
required: false,
|
|
3318
|
+
description: 'Reconnect an existing connection instead of creating one: the consent screen replaces that connection’s credential in place, so every tool bound to it keeps working. Use this when a connection reports `INVALID_CREDENTIALS`. The connection’s existing name and timezone are kept, so `label` is ignored when this is set.',
|
|
3319
|
+
valueKind: 'string',
|
|
3320
|
+
repeatable: false,
|
|
3321
|
+
},
|
|
3322
|
+
{
|
|
3323
|
+
name: 'label',
|
|
3324
|
+
path: ['label'],
|
|
3325
|
+
location: 'body',
|
|
3326
|
+
required: false,
|
|
3327
|
+
description: 'Customer-facing name for the connection, unique within the project. Required unless `calendarConnectionId` is set, and decided now because the consent screen has nowhere to carry it.',
|
|
3328
|
+
valueKind: 'string',
|
|
3329
|
+
repeatable: false,
|
|
3330
|
+
},
|
|
3331
|
+
{
|
|
3332
|
+
name: 'timezone',
|
|
3333
|
+
path: ['timezone'],
|
|
3334
|
+
location: 'body',
|
|
3335
|
+
required: false,
|
|
3336
|
+
description: 'The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the Calendly account’s own. A fixed offset such as `-08:00` is rejected: it does not observe DST.',
|
|
3337
|
+
valueKind: 'string',
|
|
3338
|
+
repeatable: false,
|
|
3339
|
+
},
|
|
3340
|
+
],
|
|
3341
|
+
hasParams: true,
|
|
3342
|
+
paramsAllOptional: true,
|
|
3343
|
+
bodyOpaque: false,
|
|
3344
|
+
bodyVariants: [],
|
|
3345
|
+
acceptsBody: true,
|
|
3346
|
+
requiresAuth: true,
|
|
3347
|
+
},
|
|
3348
|
+
{
|
|
3349
|
+
commandPath: ['connections', 'calendar', 'check'],
|
|
3350
|
+
clientProperty: 'calendarConnection',
|
|
3351
|
+
methodName: 'check',
|
|
3352
|
+
httpMethod: 'post',
|
|
3353
|
+
httpPath: '/v1/connections/calendar/{connectionId}/check',
|
|
3354
|
+
summary: 'Check a calendar connection',
|
|
3355
|
+
description: 'Re-verifies the stored credential against the provider and records the result on the connection. A credential the provider rejects sets `status` to INVALID_CREDENTIALS. A provider outage is a 500 and leaves the status untouched: being unable to reach the provider is not evidence that the customer’s credential is bad.',
|
|
3356
|
+
positionals: [
|
|
3357
|
+
{
|
|
3358
|
+
name: 'connection-id',
|
|
3359
|
+
paramKey: 'connectionId',
|
|
3360
|
+
description: 'Calendar connection ID',
|
|
3361
|
+
},
|
|
3362
|
+
],
|
|
3363
|
+
flags: [],
|
|
3364
|
+
hasParams: false,
|
|
3365
|
+
paramsAllOptional: true,
|
|
3366
|
+
bodyOpaque: false,
|
|
3367
|
+
bodyVariants: [],
|
|
3368
|
+
acceptsBody: false,
|
|
3369
|
+
requiresAuth: true,
|
|
3370
|
+
},
|
|
3371
|
+
{
|
|
3372
|
+
commandPath: ['connections', 'calendar', 'create'],
|
|
3373
|
+
clientProperty: 'calendarConnection',
|
|
3374
|
+
methodName: 'create',
|
|
3375
|
+
httpMethod: 'post',
|
|
3376
|
+
httpPath: '/v1/connections/calendar',
|
|
3377
|
+
summary: 'Connect a calendar account',
|
|
3378
|
+
description: 'Verifies the credential against the provider and, only if it works, stores it encrypted. A credential the provider rejects is a 400 and no connection is created: a connection that has never worked would next be exercised by an inbound call at 2am, with nobody there to fix it.',
|
|
3379
|
+
positionals: [],
|
|
3380
|
+
flags: [
|
|
3381
|
+
{
|
|
3382
|
+
name: 'provider',
|
|
3383
|
+
path: ['provider'],
|
|
3384
|
+
location: 'body',
|
|
3385
|
+
required: true,
|
|
3386
|
+
description: 'Who holds the calendar. CAL_COM is connected with an API key; GOOGLE and CALENDLY are connected by consent, through `POST /v1/connections/calendar/google/authorize-url` and `POST /v1/connections/calendar/calendly/authorize-url`.',
|
|
3387
|
+
valueKind: 'string',
|
|
3388
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
3389
|
+
repeatable: false,
|
|
3390
|
+
},
|
|
3391
|
+
{
|
|
3392
|
+
name: 'label',
|
|
3393
|
+
path: ['label'],
|
|
3394
|
+
location: 'body',
|
|
3395
|
+
required: true,
|
|
3396
|
+
description: 'Customer-facing name for this account, unique within the project. Required.',
|
|
3397
|
+
valueKind: 'string',
|
|
3398
|
+
repeatable: false,
|
|
3399
|
+
},
|
|
3400
|
+
{
|
|
3401
|
+
name: 'api-key',
|
|
3402
|
+
path: ['apiKey'],
|
|
3403
|
+
location: 'body',
|
|
3404
|
+
required: true,
|
|
3405
|
+
description: 'The provider account’s API key. For CAL_COM, a Cal.com API key (starts with `cal_`). It is verified against the provider before anything is stored, so an invalid key is a 400 and no connection is created. Stored encrypted and never returned.',
|
|
3406
|
+
valueKind: 'string',
|
|
3407
|
+
repeatable: false,
|
|
3408
|
+
},
|
|
3409
|
+
{
|
|
3410
|
+
name: 'timezone',
|
|
3411
|
+
path: ['timezone'],
|
|
3412
|
+
location: 'body',
|
|
3413
|
+
required: false,
|
|
3414
|
+
description: 'The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the provider account’s own timezone. A fixed offset such as `-08:00` is rejected: it does not observe DST.',
|
|
3415
|
+
valueKind: 'string',
|
|
3416
|
+
repeatable: false,
|
|
3417
|
+
},
|
|
3418
|
+
],
|
|
3419
|
+
hasParams: true,
|
|
3420
|
+
paramsAllOptional: false,
|
|
3421
|
+
bodyOpaque: false,
|
|
3422
|
+
bodyVariants: [],
|
|
3423
|
+
acceptsBody: true,
|
|
3424
|
+
requiresAuth: true,
|
|
3425
|
+
},
|
|
3426
|
+
{
|
|
3427
|
+
commandPath: ['connections', 'calendar', 'delete'],
|
|
3428
|
+
clientProperty: 'calendarConnection',
|
|
3429
|
+
methodName: 'delete',
|
|
3430
|
+
httpMethod: 'delete',
|
|
3431
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3432
|
+
summary: 'Delete a calendar connection',
|
|
3433
|
+
description: 'Disconnects the calendar and destroys the stored credential. A credential the customer deleted should stop existing, so this is not an archive. Appointments already recorded against the connection are kept, so a booking stays explainable after the calendar is disconnected. Refused with a 409 while a calendar tool is still bound to the connection, naming the tools: point them at another calendar, or delete them, first. A dangling binding would otherwise be found by whoever next tried to ship the agent, who is not the person who disconnected the calendar.',
|
|
3434
|
+
positionals: [
|
|
3435
|
+
{
|
|
3436
|
+
name: 'connection-id',
|
|
3437
|
+
paramKey: 'connectionId',
|
|
3438
|
+
description: 'Calendar connection ID',
|
|
3439
|
+
},
|
|
3440
|
+
],
|
|
3441
|
+
flags: [],
|
|
3442
|
+
hasParams: false,
|
|
3443
|
+
paramsAllOptional: true,
|
|
3444
|
+
bodyOpaque: false,
|
|
3445
|
+
bodyVariants: [],
|
|
3446
|
+
acceptsBody: false,
|
|
3447
|
+
requiresAuth: true,
|
|
3448
|
+
},
|
|
3449
|
+
{
|
|
3450
|
+
commandPath: ['connections', 'calendar', 'get'],
|
|
3451
|
+
clientProperty: 'calendarConnection',
|
|
3452
|
+
methodName: 'getByID',
|
|
3453
|
+
httpMethod: 'get',
|
|
3454
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3455
|
+
summary: 'Get a calendar connection',
|
|
3456
|
+
description: 'Returns one calendar connection. The stored credential is never included.',
|
|
3457
|
+
positionals: [
|
|
3458
|
+
{
|
|
3459
|
+
name: 'connection-id',
|
|
3460
|
+
paramKey: 'connectionId',
|
|
3461
|
+
description: 'Calendar connection ID',
|
|
3462
|
+
},
|
|
3463
|
+
],
|
|
3464
|
+
flags: [],
|
|
3465
|
+
hasParams: false,
|
|
3466
|
+
paramsAllOptional: true,
|
|
3467
|
+
bodyOpaque: false,
|
|
3468
|
+
bodyVariants: [],
|
|
3469
|
+
acceptsBody: false,
|
|
3470
|
+
requiresAuth: true,
|
|
3471
|
+
},
|
|
3472
|
+
{
|
|
3473
|
+
commandPath: ['connections', 'calendar', 'google-oauth', 'start'],
|
|
3474
|
+
clientProperty: 'calendarConnection',
|
|
3475
|
+
methodName: 'startGoogleOauth',
|
|
3476
|
+
httpMethod: 'post',
|
|
3477
|
+
httpPath: '/v1/connections/calendar/google/authorize-url',
|
|
3478
|
+
summary: 'Start connecting a Google Calendar',
|
|
3479
|
+
description: 'Returns a URL to open in a browser. Google has no credential a request body can carry, so connecting one is two steps: ask for this URL, let the customer consent, and Roark finishes the rest server-side (it exchanges the code, verifies that both calendar permissions were granted, reads the account’s own timezone when none was given, and stores the connection). Nothing is created until the customer consents, and a link that is not used expires. Read the result with `GET /v1/connections/calendar?provider=GOOGLE`.',
|
|
3480
|
+
positionals: [],
|
|
3481
|
+
flags: [
|
|
3482
|
+
{
|
|
3483
|
+
name: 'calendar-connection-id',
|
|
3484
|
+
path: ['calendarConnectionId'],
|
|
3485
|
+
location: 'body',
|
|
3486
|
+
required: false,
|
|
3487
|
+
description: 'Reconnect an existing connection instead of creating one: the consent screen replaces that connection’s credential in place, so every tool bound to it keeps working. Use this when a connection reports `INVALID_CREDENTIALS`. The connection’s existing name and timezone are kept, so `label` is ignored when this is set.',
|
|
3488
|
+
valueKind: 'string',
|
|
3489
|
+
repeatable: false,
|
|
3490
|
+
},
|
|
3491
|
+
{
|
|
3492
|
+
name: 'label',
|
|
3493
|
+
path: ['label'],
|
|
3494
|
+
location: 'body',
|
|
3495
|
+
required: false,
|
|
3496
|
+
description: 'Customer-facing name for the connection, unique within the project. Required unless `calendarConnectionId` is set, and decided now because the consent screen has nowhere to carry it.',
|
|
3497
|
+
valueKind: 'string',
|
|
3498
|
+
repeatable: false,
|
|
3499
|
+
},
|
|
3500
|
+
{
|
|
3501
|
+
name: 'timezone',
|
|
3502
|
+
path: ['timezone'],
|
|
3503
|
+
location: 'body',
|
|
3504
|
+
required: false,
|
|
3505
|
+
description: 'The named IANA timezone to offer slots in, for example `America/Los_Angeles`. Omit to adopt the Google account’s own. A fixed offset such as `-08:00` is rejected: it does not observe DST.',
|
|
3506
|
+
valueKind: 'string',
|
|
3507
|
+
repeatable: false,
|
|
3508
|
+
},
|
|
3509
|
+
{
|
|
3510
|
+
name: 'login-hint',
|
|
3511
|
+
path: ['loginHint'],
|
|
3512
|
+
location: 'body',
|
|
3513
|
+
required: false,
|
|
3514
|
+
description: 'The Google account to preselect on the consent screen. A hint only: it is ignored if the user is signed into another account, and nothing is authorized by it.',
|
|
3515
|
+
valueKind: 'string',
|
|
3516
|
+
repeatable: false,
|
|
3517
|
+
},
|
|
3518
|
+
],
|
|
3519
|
+
hasParams: true,
|
|
3520
|
+
paramsAllOptional: true,
|
|
3521
|
+
bodyOpaque: false,
|
|
3522
|
+
bodyVariants: [],
|
|
3523
|
+
acceptsBody: true,
|
|
3524
|
+
requiresAuth: true,
|
|
3525
|
+
},
|
|
3526
|
+
{
|
|
3527
|
+
commandPath: ['connections', 'calendar', 'list'],
|
|
3528
|
+
clientProperty: 'calendarConnection',
|
|
3529
|
+
methodName: 'list',
|
|
3530
|
+
httpMethod: 'get',
|
|
3531
|
+
httpPath: '/v1/connections/calendar',
|
|
3532
|
+
summary: 'List calendar connections',
|
|
3533
|
+
description: 'Returns every calendar connection in the authenticated project, by label. A project has a handful of these, so the list is not paginated: `pagination.hasMore` is always false.',
|
|
3534
|
+
positionals: [],
|
|
3535
|
+
flags: [
|
|
3536
|
+
{
|
|
3537
|
+
name: 'provider',
|
|
3538
|
+
path: ['provider'],
|
|
3539
|
+
location: 'query',
|
|
3540
|
+
required: false,
|
|
3541
|
+
description: 'Who holds the calendar. CAL_COM is connected with an API key; GOOGLE and CALENDLY are connected by consent, through `POST /v1/connections/calendar/google/authorize-url` and `POST /v1/connections/calendar/calendly/authorize-url`.',
|
|
3542
|
+
valueKind: 'string',
|
|
3543
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
3544
|
+
repeatable: false,
|
|
3545
|
+
},
|
|
3546
|
+
],
|
|
3547
|
+
hasParams: true,
|
|
3548
|
+
paramsAllOptional: true,
|
|
3549
|
+
bodyOpaque: false,
|
|
3550
|
+
bodyVariants: [],
|
|
3551
|
+
acceptsBody: false,
|
|
3552
|
+
requiresAuth: true,
|
|
3553
|
+
},
|
|
3554
|
+
{
|
|
3555
|
+
commandPath: ['connections', 'calendar', 'target', 'create'],
|
|
3556
|
+
clientProperty: 'calendarConnection',
|
|
3557
|
+
methodName: 'createTarget',
|
|
3558
|
+
httpMethod: 'post',
|
|
3559
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets',
|
|
3560
|
+
summary: 'Create a bookable target',
|
|
3561
|
+
description: 'Only for a connection whose `capabilities.roarkOwnsBookingPolicy` is true. A calendar with no scheduling of its own has nothing an agent can be pointed at, so the thing a calendar tool books into is created here: the calendar, how long an appointment runs, and the hours it is offered in. The policy and the hours are written together, because a target with no hours offers nothing. Refused if the calendar is one the account can only read.',
|
|
3562
|
+
positionals: [
|
|
3563
|
+
{
|
|
3564
|
+
name: 'connection-id',
|
|
3565
|
+
paramKey: 'connectionId',
|
|
3566
|
+
description: 'Calendar connection ID',
|
|
3567
|
+
},
|
|
3568
|
+
],
|
|
3569
|
+
flags: [
|
|
3570
|
+
{
|
|
3571
|
+
name: 'name',
|
|
3572
|
+
path: ['name'],
|
|
3573
|
+
location: 'body',
|
|
3574
|
+
required: true,
|
|
3575
|
+
description: 'Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or -.',
|
|
3576
|
+
valueKind: 'string',
|
|
3577
|
+
repeatable: false,
|
|
3578
|
+
},
|
|
3579
|
+
{
|
|
3580
|
+
name: 'calendar-id',
|
|
3581
|
+
path: ['calendarId'],
|
|
3582
|
+
location: 'body',
|
|
3583
|
+
required: true,
|
|
3584
|
+
description: 'The calendar to write appointments to, from `GET /v1/connections/calendar/{connectionId}/calendars`. `primary` is accepted and stored as the account’s own id.',
|
|
3585
|
+
valueKind: 'string',
|
|
3586
|
+
repeatable: false,
|
|
3587
|
+
},
|
|
3588
|
+
{
|
|
3589
|
+
name: 'duration-minutes',
|
|
3590
|
+
path: ['durationMinutes'],
|
|
3591
|
+
location: 'body',
|
|
3592
|
+
required: true,
|
|
3593
|
+
valueKind: 'integer',
|
|
3594
|
+
repeatable: false,
|
|
3595
|
+
},
|
|
3596
|
+
{
|
|
3597
|
+
name: 'buffer-before-minutes',
|
|
3598
|
+
path: ['bufferBeforeMinutes'],
|
|
3599
|
+
location: 'body',
|
|
3600
|
+
required: false,
|
|
3601
|
+
description: 'Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0.',
|
|
3602
|
+
valueKind: 'integer',
|
|
3603
|
+
repeatable: false,
|
|
3604
|
+
},
|
|
3605
|
+
{
|
|
3606
|
+
name: 'buffer-after-minutes',
|
|
3607
|
+
path: ['bufferAfterMinutes'],
|
|
3608
|
+
location: 'body',
|
|
3609
|
+
required: false,
|
|
3610
|
+
valueKind: 'integer',
|
|
3611
|
+
repeatable: false,
|
|
3612
|
+
},
|
|
3613
|
+
{
|
|
3614
|
+
name: 'min-notice-minutes',
|
|
3615
|
+
path: ['minNoticeMinutes'],
|
|
3616
|
+
location: 'body',
|
|
3617
|
+
required: false,
|
|
3618
|
+
description: 'How soon from now an appointment may be made. Defaults to 120.',
|
|
3619
|
+
valueKind: 'integer',
|
|
3620
|
+
repeatable: false,
|
|
3621
|
+
},
|
|
3622
|
+
{
|
|
3623
|
+
name: 'horizon-days',
|
|
3624
|
+
path: ['horizonDays'],
|
|
3625
|
+
location: 'body',
|
|
3626
|
+
required: false,
|
|
3627
|
+
description: 'How far ahead appointments may be made. Defaults to 30.',
|
|
3628
|
+
valueKind: 'integer',
|
|
3629
|
+
repeatable: false,
|
|
3630
|
+
},
|
|
3631
|
+
{
|
|
3632
|
+
name: 'slot-interval-minutes',
|
|
3633
|
+
path: ['slotIntervalMinutes'],
|
|
3634
|
+
location: 'body',
|
|
3635
|
+
required: false,
|
|
3636
|
+
description: 'The grid slots are offered on. Defaults to the duration, which gives back-to-back appointments.',
|
|
3637
|
+
valueKind: 'integer',
|
|
3638
|
+
repeatable: false,
|
|
3639
|
+
},
|
|
3640
|
+
{
|
|
3641
|
+
name: 'all-day-events-block',
|
|
3642
|
+
path: ['allDayEventsBlock'],
|
|
3643
|
+
location: 'body',
|
|
3644
|
+
required: false,
|
|
3645
|
+
description: 'Whether an all-day event closes the day. Defaults to true, because a calendar marks all-day events free unless their creator says otherwise and a public holiday entered as one would otherwise be bookable.',
|
|
3646
|
+
valueKind: 'boolean',
|
|
3647
|
+
repeatable: false,
|
|
3648
|
+
},
|
|
3649
|
+
{
|
|
3650
|
+
name: 'hours',
|
|
3651
|
+
path: ['hours'],
|
|
3652
|
+
location: 'body',
|
|
3653
|
+
required: false,
|
|
3654
|
+
description: 'The windows of the week appointments are offered in. Omit to adopt Monday to Friday, 09:00 to 17:00. A target with no windows offers nothing at all, which reads to a caller as a permanently full diary.',
|
|
3655
|
+
valueKind: 'array',
|
|
3656
|
+
repeatable: false,
|
|
3657
|
+
},
|
|
3658
|
+
],
|
|
3659
|
+
hasParams: true,
|
|
3660
|
+
paramsAllOptional: false,
|
|
3661
|
+
bodyOpaque: false,
|
|
3662
|
+
bodyVariants: [],
|
|
3663
|
+
acceptsBody: true,
|
|
3664
|
+
requiresAuth: true,
|
|
3665
|
+
},
|
|
3666
|
+
{
|
|
3667
|
+
commandPath: ['connections', 'calendar', 'target', 'delete'],
|
|
3668
|
+
clientProperty: 'calendarConnection',
|
|
3669
|
+
methodName: 'deleteTarget',
|
|
3670
|
+
httpMethod: 'delete',
|
|
3671
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3672
|
+
summary: 'Delete a bookable target',
|
|
3673
|
+
description: 'Refused while a calendar tool still books into it, naming the tools. A dangling binding would otherwise be found by whoever next tried to ship the agent, who is not the person who deleted the target. Appointments already recorded against it are kept.',
|
|
3674
|
+
positionals: [
|
|
3675
|
+
{
|
|
3676
|
+
name: 'connection-id',
|
|
3677
|
+
paramKey: 'connectionId',
|
|
3678
|
+
description: 'Calendar connection ID',
|
|
3679
|
+
},
|
|
3680
|
+
{
|
|
3681
|
+
name: 'target-id',
|
|
3682
|
+
paramKey: 'targetId',
|
|
3683
|
+
description: 'Bookable target ID',
|
|
3684
|
+
},
|
|
3685
|
+
],
|
|
3686
|
+
flags: [],
|
|
3687
|
+
hasParams: true,
|
|
3688
|
+
paramsAllOptional: false,
|
|
3689
|
+
bodyOpaque: false,
|
|
3690
|
+
bodyVariants: [],
|
|
3691
|
+
acceptsBody: false,
|
|
3692
|
+
requiresAuth: true,
|
|
3693
|
+
},
|
|
3694
|
+
{
|
|
3695
|
+
commandPath: ['connections', 'calendar', 'target', 'get'],
|
|
3696
|
+
clientProperty: 'calendarConnection',
|
|
3697
|
+
methodName: 'getTarget',
|
|
3698
|
+
httpMethod: 'get',
|
|
3699
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3700
|
+
summary: 'Get a bookable target',
|
|
3701
|
+
description: 'The same entry as the list, plus what it demands of a booker. `requiresAttendeeEmail` is the field that decides an agent’s design: the attendee object itself needs only a name and a timezone, but an event type can declare email required, and an agent that cannot collect one simply cannot book on it. Read this when configuring a calendar tool, not after a caller is already waiting. Costs one provider call more than the list, which is why the list does not fold it in.',
|
|
3702
|
+
positionals: [
|
|
3703
|
+
{
|
|
3704
|
+
name: 'connection-id',
|
|
3705
|
+
paramKey: 'connectionId',
|
|
3706
|
+
description: 'Calendar connection ID',
|
|
3707
|
+
},
|
|
3708
|
+
{
|
|
3709
|
+
name: 'target-id',
|
|
3710
|
+
paramKey: 'targetId',
|
|
3711
|
+
description: 'Target id, as the list returned it',
|
|
3712
|
+
},
|
|
3713
|
+
],
|
|
3714
|
+
flags: [],
|
|
3715
|
+
hasParams: true,
|
|
3716
|
+
paramsAllOptional: false,
|
|
3717
|
+
bodyOpaque: false,
|
|
3718
|
+
bodyVariants: [],
|
|
3719
|
+
acceptsBody: false,
|
|
3720
|
+
requiresAuth: true,
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
commandPath: ['connections', 'calendar', 'target', 'list'],
|
|
3724
|
+
clientProperty: 'calendarConnection',
|
|
3725
|
+
methodName: 'listTargets',
|
|
3726
|
+
httpMethod: 'get',
|
|
3727
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets',
|
|
3728
|
+
summary: 'List bookable targets',
|
|
3729
|
+
description: 'What an agent can be pointed at on this connection: Cal.com event types today, Google calendars when that lands. Read live from the provider, so an event type added since you connected is here without reconnecting. Each entry carries a `target` ready to put on a calendar tool, so nothing has to assemble one by hand.',
|
|
3730
|
+
positionals: [
|
|
3731
|
+
{
|
|
3732
|
+
name: 'connection-id',
|
|
3733
|
+
paramKey: 'connectionId',
|
|
3734
|
+
description: 'Calendar connection ID',
|
|
3735
|
+
},
|
|
3736
|
+
],
|
|
3737
|
+
flags: [],
|
|
3738
|
+
hasParams: false,
|
|
3739
|
+
paramsAllOptional: true,
|
|
3740
|
+
bodyOpaque: false,
|
|
3741
|
+
bodyVariants: [],
|
|
3742
|
+
acceptsBody: false,
|
|
3743
|
+
requiresAuth: true,
|
|
3744
|
+
},
|
|
3745
|
+
{
|
|
3746
|
+
commandPath: ['connections', 'calendar', 'target', 'update'],
|
|
3747
|
+
clientProperty: 'calendarConnection',
|
|
3748
|
+
methodName: 'updateTarget',
|
|
3749
|
+
httpMethod: 'put',
|
|
3750
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3751
|
+
summary: 'Update a bookable target',
|
|
3752
|
+
description: 'Changes what agents ALREADY PUBLISHED against this target book, with no new tool version, the same thing editing a Cal.com event type on cal.com does. `hours` replaces the whole week when present, because a rota is described as a week and a partial update of one window has no meaning anybody would expect. The calendar cannot be changed: it is the target’s identity for the booking ledger, so moving it would orphan every appointment made on the old one.',
|
|
3753
|
+
positionals: [
|
|
3754
|
+
{
|
|
3755
|
+
name: 'connection-id',
|
|
3756
|
+
paramKey: 'connectionId',
|
|
3757
|
+
description: 'Calendar connection ID',
|
|
3758
|
+
},
|
|
3759
|
+
{
|
|
3760
|
+
name: 'target-id',
|
|
3761
|
+
paramKey: 'targetId',
|
|
3762
|
+
description: 'Bookable target ID',
|
|
3763
|
+
},
|
|
3764
|
+
],
|
|
3765
|
+
flags: [
|
|
3766
|
+
{
|
|
3767
|
+
name: 'name',
|
|
3768
|
+
path: ['name'],
|
|
3769
|
+
location: 'body',
|
|
3770
|
+
required: false,
|
|
3771
|
+
description: 'Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or -.',
|
|
3772
|
+
valueKind: 'string',
|
|
3773
|
+
repeatable: false,
|
|
3774
|
+
},
|
|
3775
|
+
{
|
|
3776
|
+
name: 'duration-minutes',
|
|
3777
|
+
path: ['durationMinutes'],
|
|
3778
|
+
location: 'body',
|
|
3779
|
+
required: false,
|
|
3780
|
+
valueKind: 'integer',
|
|
3781
|
+
repeatable: false,
|
|
3782
|
+
},
|
|
3783
|
+
{
|
|
3784
|
+
name: 'buffer-before-minutes',
|
|
3785
|
+
path: ['bufferBeforeMinutes'],
|
|
3786
|
+
location: 'body',
|
|
3787
|
+
required: false,
|
|
3788
|
+
description: 'Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0.',
|
|
3789
|
+
valueKind: 'integer',
|
|
3790
|
+
repeatable: false,
|
|
3791
|
+
},
|
|
3792
|
+
{
|
|
3793
|
+
name: 'buffer-after-minutes',
|
|
3794
|
+
path: ['bufferAfterMinutes'],
|
|
3795
|
+
location: 'body',
|
|
3796
|
+
required: false,
|
|
3797
|
+
valueKind: 'integer',
|
|
3798
|
+
repeatable: false,
|
|
3799
|
+
},
|
|
3800
|
+
{
|
|
3801
|
+
name: 'min-notice-minutes',
|
|
3802
|
+
path: ['minNoticeMinutes'],
|
|
3803
|
+
location: 'body',
|
|
3804
|
+
required: false,
|
|
3805
|
+
description: 'How soon from now an appointment may be made. Defaults to 120.',
|
|
3806
|
+
valueKind: 'integer',
|
|
3807
|
+
repeatable: false,
|
|
3808
|
+
},
|
|
3809
|
+
{
|
|
3810
|
+
name: 'horizon-days',
|
|
3811
|
+
path: ['horizonDays'],
|
|
3812
|
+
location: 'body',
|
|
3813
|
+
required: false,
|
|
3814
|
+
description: 'How far ahead appointments may be made. Defaults to 30.',
|
|
3815
|
+
valueKind: 'integer',
|
|
3816
|
+
repeatable: false,
|
|
3817
|
+
},
|
|
3818
|
+
{
|
|
3819
|
+
name: 'slot-interval-minutes',
|
|
3820
|
+
path: ['slotIntervalMinutes'],
|
|
3821
|
+
location: 'body',
|
|
3822
|
+
required: false,
|
|
3823
|
+
description: 'The grid slots are offered on. Defaults to the duration, which gives back-to-back appointments.',
|
|
3824
|
+
valueKind: 'integer',
|
|
3825
|
+
repeatable: false,
|
|
3826
|
+
},
|
|
3827
|
+
{
|
|
3828
|
+
name: 'all-day-events-block',
|
|
3829
|
+
path: ['allDayEventsBlock'],
|
|
3830
|
+
location: 'body',
|
|
3831
|
+
required: false,
|
|
3832
|
+
description: 'Whether an all-day event closes the day. Defaults to true, because a calendar marks all-day events free unless their creator says otherwise and a public holiday entered as one would otherwise be bookable.',
|
|
3833
|
+
valueKind: 'boolean',
|
|
3834
|
+
repeatable: false,
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
name: 'hours',
|
|
3838
|
+
path: ['hours'],
|
|
3839
|
+
location: 'body',
|
|
3840
|
+
required: false,
|
|
3841
|
+
description: 'The windows of the week appointments are offered in. Omit to adopt Monday to Friday, 09:00 to 17:00. A target with no windows offers nothing at all, which reads to a caller as a permanently full diary.',
|
|
3842
|
+
valueKind: 'array',
|
|
3843
|
+
repeatable: false,
|
|
3844
|
+
},
|
|
3845
|
+
],
|
|
3846
|
+
hasParams: true,
|
|
3847
|
+
paramsAllOptional: false,
|
|
3848
|
+
bodyOpaque: false,
|
|
3849
|
+
bodyVariants: [],
|
|
3850
|
+
acceptsBody: true,
|
|
3851
|
+
requiresAuth: true,
|
|
3852
|
+
},
|
|
3853
|
+
{
|
|
3854
|
+
commandPath: ['connections', 'calendar', 'update'],
|
|
3855
|
+
clientProperty: 'calendarConnection',
|
|
3856
|
+
methodName: 'update',
|
|
3857
|
+
httpMethod: 'patch',
|
|
3858
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3859
|
+
summary: 'Update a calendar connection',
|
|
3860
|
+
description: 'Renames a connection, changes the timezone slots are offered in, or rotates the credential. A rotated credential is verified first, and a verified credential returns the connection to ACTIVE.',
|
|
3861
|
+
positionals: [
|
|
3862
|
+
{
|
|
3863
|
+
name: 'connection-id',
|
|
3864
|
+
paramKey: 'connectionId',
|
|
3865
|
+
description: 'Calendar connection ID',
|
|
3866
|
+
},
|
|
3867
|
+
],
|
|
3868
|
+
flags: [
|
|
3869
|
+
{
|
|
3870
|
+
name: 'label',
|
|
3871
|
+
path: ['label'],
|
|
3872
|
+
location: 'body',
|
|
3873
|
+
required: false,
|
|
3874
|
+
description: 'Rename the connection.',
|
|
3875
|
+
valueKind: 'string',
|
|
3876
|
+
repeatable: false,
|
|
3877
|
+
},
|
|
3878
|
+
{
|
|
3879
|
+
name: 'timezone',
|
|
3880
|
+
path: ['timezone'],
|
|
3881
|
+
location: 'body',
|
|
3882
|
+
required: false,
|
|
3883
|
+
description: 'Change the named IANA timezone slots are offered in.',
|
|
3884
|
+
valueKind: 'string',
|
|
3885
|
+
repeatable: false,
|
|
3886
|
+
},
|
|
3887
|
+
{
|
|
3888
|
+
name: 'api-key',
|
|
3889
|
+
path: ['apiKey'],
|
|
3890
|
+
location: 'body',
|
|
3891
|
+
required: false,
|
|
3892
|
+
description: 'Rotate the credential. The new key is verified before it is stored, and a verified key returns the connection to ACTIVE, which is how a connection recovers from INVALID_CREDENTIALS.',
|
|
3893
|
+
valueKind: 'string',
|
|
3894
|
+
repeatable: false,
|
|
3895
|
+
},
|
|
3896
|
+
],
|
|
3897
|
+
hasParams: true,
|
|
3898
|
+
paramsAllOptional: true,
|
|
3899
|
+
bodyOpaque: false,
|
|
3900
|
+
bodyVariants: [],
|
|
3901
|
+
acceptsBody: true,
|
|
3902
|
+
requiresAuth: true,
|
|
3903
|
+
},
|
|
3904
|
+
{
|
|
3905
|
+
commandPath: ['connections', 'mcp-server', 'create'],
|
|
3906
|
+
clientProperty: 'mcpServer',
|
|
3907
|
+
methodName: 'create',
|
|
3908
|
+
httpMethod: 'post',
|
|
3909
|
+
httpPath: '/v1/connections/mcp-server',
|
|
3910
|
+
summary: 'Connect an MCP server',
|
|
3911
|
+
description: 'Connects to the server, reads its tools, then stores it for the project. A server that does not answer, or refuses the credential, returns 400 and nothing is stored. The credential is encrypted and never returned.',
|
|
3912
|
+
positionals: [],
|
|
3913
|
+
flags: [
|
|
3914
|
+
{
|
|
3915
|
+
name: 'url',
|
|
3916
|
+
path: ['url'],
|
|
3917
|
+
location: 'body',
|
|
3918
|
+
required: true,
|
|
3919
|
+
valueKind: 'string',
|
|
3920
|
+
repeatable: false,
|
|
3921
|
+
},
|
|
3922
|
+
{
|
|
3923
|
+
name: 'transport',
|
|
3924
|
+
path: ['transport'],
|
|
3925
|
+
location: 'body',
|
|
3926
|
+
required: false,
|
|
3927
|
+
valueKind: 'string',
|
|
3928
|
+
enumValues: ['STREAMABLE_HTTP', 'SSE'],
|
|
3929
|
+
repeatable: false,
|
|
3930
|
+
},
|
|
3931
|
+
{
|
|
3932
|
+
name: 'auth',
|
|
3933
|
+
path: ['auth'],
|
|
3934
|
+
location: 'body',
|
|
3935
|
+
required: false,
|
|
3936
|
+
valueKind: 'object',
|
|
3937
|
+
},
|
|
3938
|
+
{
|
|
3939
|
+
name: 'label',
|
|
3940
|
+
path: ['label'],
|
|
3941
|
+
location: 'body',
|
|
3942
|
+
required: true,
|
|
3943
|
+
valueKind: 'string',
|
|
3944
|
+
repeatable: false,
|
|
3945
|
+
},
|
|
3946
|
+
{
|
|
3947
|
+
name: 'directory-key',
|
|
3948
|
+
path: ['directoryKey'],
|
|
3949
|
+
location: 'body',
|
|
3950
|
+
required: false,
|
|
3951
|
+
valueKind: 'string',
|
|
3952
|
+
repeatable: false,
|
|
3953
|
+
},
|
|
3954
|
+
],
|
|
3955
|
+
hasParams: true,
|
|
3956
|
+
paramsAllOptional: false,
|
|
3957
|
+
bodyOpaque: false,
|
|
3958
|
+
bodyVariants: [],
|
|
3959
|
+
acceptsBody: true,
|
|
3960
|
+
requiresAuth: true,
|
|
3961
|
+
},
|
|
3962
|
+
{
|
|
3963
|
+
commandPath: ['connections', 'mcp-server', 'delete'],
|
|
3964
|
+
clientProperty: 'mcpServer',
|
|
3965
|
+
methodName: 'delete',
|
|
3966
|
+
httpMethod: 'delete',
|
|
3967
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
3968
|
+
summary: 'Disconnect an MCP server',
|
|
3969
|
+
description: 'Deletes the server and its stored credential. A server a tool still uses returns 409, naming the tools.',
|
|
3970
|
+
positionals: [
|
|
3971
|
+
{
|
|
3972
|
+
name: 'server-id',
|
|
3973
|
+
paramKey: 'serverId',
|
|
3974
|
+
},
|
|
3975
|
+
],
|
|
3976
|
+
flags: [],
|
|
3977
|
+
hasParams: false,
|
|
3978
|
+
paramsAllOptional: true,
|
|
3979
|
+
bodyOpaque: false,
|
|
3980
|
+
bodyVariants: [],
|
|
3981
|
+
acceptsBody: false,
|
|
3982
|
+
requiresAuth: true,
|
|
3983
|
+
},
|
|
3984
|
+
{
|
|
3985
|
+
commandPath: ['connections', 'mcp-server', 'discover'],
|
|
3986
|
+
clientProperty: 'mcpServer',
|
|
3987
|
+
methodName: 'discover',
|
|
3988
|
+
httpMethod: 'post',
|
|
3989
|
+
httpPath: '/v1/connections/mcp-server/discover',
|
|
3990
|
+
summary: 'Discover an MCP server',
|
|
3991
|
+
description: 'Connects to a server and returns the tools it offers, without storing anything. Use it to check a url and credential before connecting.',
|
|
3992
|
+
positionals: [],
|
|
3993
|
+
flags: [
|
|
3994
|
+
{
|
|
3995
|
+
name: 'url',
|
|
3996
|
+
path: ['url'],
|
|
3997
|
+
location: 'body',
|
|
3998
|
+
required: true,
|
|
3999
|
+
valueKind: 'string',
|
|
4000
|
+
repeatable: false,
|
|
4001
|
+
},
|
|
4002
|
+
{
|
|
4003
|
+
name: 'transport',
|
|
4004
|
+
path: ['transport'],
|
|
4005
|
+
location: 'body',
|
|
4006
|
+
required: false,
|
|
4007
|
+
valueKind: 'string',
|
|
4008
|
+
enumValues: ['STREAMABLE_HTTP', 'SSE'],
|
|
4009
|
+
repeatable: false,
|
|
4010
|
+
},
|
|
4011
|
+
{
|
|
4012
|
+
name: 'auth',
|
|
4013
|
+
path: ['auth'],
|
|
4014
|
+
location: 'body',
|
|
4015
|
+
required: false,
|
|
4016
|
+
valueKind: 'object',
|
|
4017
|
+
},
|
|
4018
|
+
],
|
|
4019
|
+
hasParams: true,
|
|
4020
|
+
paramsAllOptional: false,
|
|
4021
|
+
bodyOpaque: false,
|
|
4022
|
+
bodyVariants: [],
|
|
4023
|
+
acceptsBody: true,
|
|
4024
|
+
requiresAuth: true,
|
|
4025
|
+
},
|
|
4026
|
+
{
|
|
4027
|
+
commandPath: ['connections', 'mcp-server', 'get'],
|
|
4028
|
+
clientProperty: 'mcpServer',
|
|
4029
|
+
methodName: 'getByID',
|
|
4030
|
+
httpMethod: 'get',
|
|
4031
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
4032
|
+
summary: 'Get an MCP server',
|
|
4033
|
+
description: 'One MCP server. The credential is never returned.',
|
|
4034
|
+
positionals: [
|
|
4035
|
+
{
|
|
4036
|
+
name: 'server-id',
|
|
4037
|
+
paramKey: 'serverId',
|
|
4038
|
+
},
|
|
4039
|
+
],
|
|
4040
|
+
flags: [],
|
|
4041
|
+
hasParams: false,
|
|
4042
|
+
paramsAllOptional: true,
|
|
4043
|
+
bodyOpaque: false,
|
|
4044
|
+
bodyVariants: [],
|
|
4045
|
+
acceptsBody: false,
|
|
4046
|
+
requiresAuth: true,
|
|
4047
|
+
},
|
|
4048
|
+
{
|
|
4049
|
+
commandPath: ['connections', 'mcp-server', 'list'],
|
|
4050
|
+
clientProperty: 'mcpServer',
|
|
4051
|
+
methodName: 'list',
|
|
4052
|
+
httpMethod: 'get',
|
|
4053
|
+
httpPath: '/v1/connections/mcp-server',
|
|
4054
|
+
summary: 'List MCP servers',
|
|
4055
|
+
description: "The project's MCP servers, by label, each with the tools it offered when last checked. Credentials are never returned.",
|
|
4056
|
+
positionals: [],
|
|
4057
|
+
flags: [],
|
|
4058
|
+
hasParams: false,
|
|
4059
|
+
paramsAllOptional: true,
|
|
4060
|
+
bodyOpaque: false,
|
|
4061
|
+
bodyVariants: [],
|
|
4062
|
+
acceptsBody: false,
|
|
4063
|
+
requiresAuth: true,
|
|
4064
|
+
},
|
|
4065
|
+
{
|
|
4066
|
+
commandPath: ['connections', 'mcp-server', 'refresh'],
|
|
4067
|
+
clientProperty: 'mcpServer',
|
|
4068
|
+
methodName: 'refresh',
|
|
4069
|
+
httpMethod: 'post',
|
|
4070
|
+
httpPath: '/v1/connections/mcp-server/{serverId}/refresh',
|
|
4071
|
+
summary: 'Refresh an MCP server',
|
|
4072
|
+
description: 'Connects to the server again and records the tools it offers now. Agents keep calling the tools they were given; a new tool reaches an agent only once you add it.',
|
|
4073
|
+
positionals: [
|
|
4074
|
+
{
|
|
4075
|
+
name: 'server-id',
|
|
4076
|
+
paramKey: 'serverId',
|
|
4077
|
+
},
|
|
4078
|
+
],
|
|
4079
|
+
flags: [],
|
|
4080
|
+
hasParams: false,
|
|
4081
|
+
paramsAllOptional: true,
|
|
4082
|
+
bodyOpaque: false,
|
|
4083
|
+
bodyVariants: [],
|
|
4084
|
+
acceptsBody: false,
|
|
4085
|
+
requiresAuth: true,
|
|
4086
|
+
},
|
|
4087
|
+
{
|
|
4088
|
+
commandPath: ['connections', 'mcp-server', 'update'],
|
|
4089
|
+
clientProperty: 'mcpServer',
|
|
4090
|
+
methodName: 'update',
|
|
4091
|
+
httpMethod: 'patch',
|
|
4092
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
4093
|
+
summary: 'Update an MCP server',
|
|
4094
|
+
description: 'Renames the server or replaces its credential. A new credential is checked by connecting with it first; one the server refuses returns 400 and changes nothing.',
|
|
4095
|
+
positionals: [
|
|
4096
|
+
{
|
|
4097
|
+
name: 'server-id',
|
|
4098
|
+
paramKey: 'serverId',
|
|
4099
|
+
},
|
|
4100
|
+
],
|
|
4101
|
+
flags: [
|
|
4102
|
+
{
|
|
4103
|
+
name: 'label',
|
|
4104
|
+
path: ['label'],
|
|
4105
|
+
location: 'body',
|
|
4106
|
+
required: false,
|
|
4107
|
+
valueKind: 'string',
|
|
4108
|
+
repeatable: false,
|
|
4109
|
+
},
|
|
4110
|
+
{
|
|
4111
|
+
name: 'auth',
|
|
4112
|
+
path: ['auth'],
|
|
4113
|
+
location: 'body',
|
|
4114
|
+
required: false,
|
|
4115
|
+
description: 'How the server authenticates. Stored encrypted; never returned.',
|
|
4116
|
+
valueKind: 'string',
|
|
4117
|
+
repeatable: false,
|
|
4118
|
+
},
|
|
4119
|
+
],
|
|
4120
|
+
hasParams: true,
|
|
4121
|
+
paramsAllOptional: true,
|
|
4122
|
+
bodyOpaque: false,
|
|
4123
|
+
bodyVariants: [],
|
|
4124
|
+
acceptsBody: true,
|
|
4125
|
+
requiresAuth: true,
|
|
4126
|
+
},
|
|
4127
|
+
{
|
|
4128
|
+
commandPath: ['conversation', 'get'],
|
|
4129
|
+
clientProperty: 'conversation',
|
|
4130
|
+
methodName: 'getByID',
|
|
4131
|
+
httpMethod: 'get',
|
|
4132
|
+
httpPath: '/v1/conversation/{conversationId}',
|
|
4133
|
+
summary: 'Get a conversation',
|
|
4134
|
+
description: 'Fetches one conversation by its id, whether it is a call or a chat. The same endpoint reads both modalities, and `modality` in the response says which one it is, so you do not need to know it up front. A conversation started with `POST /v1/agent/{agentId}/conversations` reads back from the moment it is created, before it is recorded as a call or chat. For its transcript and metrics, use the call or chat endpoints that match its `modality`.',
|
|
4135
|
+
positionals: [
|
|
4136
|
+
{
|
|
4137
|
+
name: 'conversation-id',
|
|
4138
|
+
paramKey: 'conversationId',
|
|
4139
|
+
},
|
|
4140
|
+
],
|
|
4141
|
+
flags: [],
|
|
4142
|
+
hasParams: false,
|
|
4143
|
+
paramsAllOptional: true,
|
|
4144
|
+
bodyOpaque: false,
|
|
4145
|
+
bodyVariants: [],
|
|
4146
|
+
acceptsBody: false,
|
|
4147
|
+
requiresAuth: true,
|
|
4148
|
+
},
|
|
4149
|
+
{
|
|
4150
|
+
commandPath: ['credential', 'create'],
|
|
4151
|
+
clientProperty: 'me',
|
|
4152
|
+
methodName: 'createAPIKey',
|
|
4153
|
+
httpMethod: 'post',
|
|
4154
|
+
httpPath: '/v1/me/api-keys',
|
|
4155
|
+
summary: 'Create a personal API key',
|
|
4156
|
+
description: 'Requires a personal API key (a project API key is refused) and admin on the project the new key defaults to. Mints a personal API key that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. The new key can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.',
|
|
4157
|
+
positionals: [],
|
|
4158
|
+
flags: [
|
|
4159
|
+
{
|
|
4160
|
+
name: 'name',
|
|
4161
|
+
path: ['name'],
|
|
4162
|
+
location: 'body',
|
|
4163
|
+
required: true,
|
|
4164
|
+
description: 'A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from.',
|
|
4165
|
+
valueKind: 'string',
|
|
4166
|
+
repeatable: false,
|
|
4167
|
+
},
|
|
4168
|
+
{
|
|
4169
|
+
name: 'project-id',
|
|
4170
|
+
path: ['projectId'],
|
|
4171
|
+
location: 'body',
|
|
4172
|
+
required: false,
|
|
4173
|
+
description: "Project the credential assumes when a request sends no X-Roark-Project-Id header. Defaults to the calling credential's own default project. You must be an admin of whichever project is used.",
|
|
4174
|
+
valueKind: 'string',
|
|
4175
|
+
repeatable: false,
|
|
4176
|
+
},
|
|
4177
|
+
{
|
|
4178
|
+
name: 'scopes',
|
|
4179
|
+
path: ['scopes'],
|
|
4180
|
+
location: 'body',
|
|
4181
|
+
required: false,
|
|
4182
|
+
description: "Coarse tier. Defaults to the calling credential's own tier, and can never exceed it: a READ credential cannot mint a WRITE one.",
|
|
4183
|
+
valueKind: 'array',
|
|
4184
|
+
enumValues: ['READ', 'WRITE'],
|
|
4185
|
+
repeatable: true,
|
|
4186
|
+
},
|
|
4187
|
+
{
|
|
4188
|
+
name: 'permissions',
|
|
4189
|
+
path: ['permissions'],
|
|
4190
|
+
location: 'body',
|
|
4191
|
+
required: false,
|
|
4192
|
+
description: "Granular 'resource:action' permissions. Defaults to the calling credential's own set, and can never exceed it. A ceiling, not an entitlement: the holder still only reaches what their project membership allows.",
|
|
4193
|
+
valueKind: 'array',
|
|
4194
|
+
repeatable: true,
|
|
4195
|
+
},
|
|
4196
|
+
{
|
|
4197
|
+
name: 'expires-at',
|
|
4198
|
+
path: ['expiresAt'],
|
|
4199
|
+
location: 'body',
|
|
4200
|
+
required: false,
|
|
4201
|
+
description: "ISO 8601 expiry. Defaults to the calling credential's own expiry (no expiry, for a `roark auth login` credential) and may not outlive it, so a short-lived connector credential cannot mint a permanent one.",
|
|
4202
|
+
valueKind: 'string',
|
|
4203
|
+
repeatable: false,
|
|
4204
|
+
},
|
|
4205
|
+
],
|
|
4206
|
+
hasParams: true,
|
|
4207
|
+
paramsAllOptional: false,
|
|
4208
|
+
bodyOpaque: false,
|
|
4209
|
+
bodyVariants: [],
|
|
4210
|
+
acceptsBody: true,
|
|
4211
|
+
requiresAuth: true,
|
|
4212
|
+
},
|
|
4213
|
+
{
|
|
4214
|
+
commandPath: ['credential', 'list'],
|
|
4215
|
+
clientProperty: 'me',
|
|
4216
|
+
methodName: 'listAPIKeys',
|
|
4217
|
+
httpMethod: 'get',
|
|
4218
|
+
httpPath: '/v1/me/api-keys',
|
|
4219
|
+
summary: 'List personal API keys',
|
|
4220
|
+
description: 'Requires a personal API key; a project API key is refused. Returns the personal API keys that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.',
|
|
4221
|
+
positionals: [],
|
|
4222
|
+
flags: [
|
|
4223
|
+
{
|
|
4224
|
+
name: 'status',
|
|
4225
|
+
path: ['status'],
|
|
4226
|
+
location: 'query',
|
|
4227
|
+
required: false,
|
|
4228
|
+
description: 'Filter by status. Defaults to ACTIVE.',
|
|
4229
|
+
valueKind: 'string',
|
|
4230
|
+
enumValues: ['ACTIVE', 'REVOKED'],
|
|
4231
|
+
repeatable: false,
|
|
4232
|
+
},
|
|
4233
|
+
],
|
|
4234
|
+
hasParams: true,
|
|
4235
|
+
paramsAllOptional: true,
|
|
4236
|
+
bodyOpaque: false,
|
|
4237
|
+
bodyVariants: [],
|
|
4238
|
+
acceptsBody: false,
|
|
4239
|
+
requiresAuth: true,
|
|
4240
|
+
},
|
|
4241
|
+
{
|
|
4242
|
+
commandPath: ['credential', 'revoke'],
|
|
4243
|
+
clientProperty: 'me',
|
|
4244
|
+
methodName: 'revokeAPIKey',
|
|
4245
|
+
httpMethod: 'delete',
|
|
4246
|
+
httpPath: '/v1/me/api-keys/{id}',
|
|
4247
|
+
summary: 'Revoke a personal API key',
|
|
4248
|
+
description: 'Requires a personal API key. Revokes one of your personal API keys; it stops working immediately. A key may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.',
|
|
4249
|
+
positionals: [
|
|
4250
|
+
{
|
|
4251
|
+
name: 'credential-id',
|
|
4252
|
+
paramKey: 'id',
|
|
4253
|
+
},
|
|
4254
|
+
],
|
|
4255
|
+
flags: [],
|
|
4256
|
+
hasParams: false,
|
|
4257
|
+
paramsAllOptional: true,
|
|
4258
|
+
bodyOpaque: false,
|
|
4259
|
+
bodyVariants: [],
|
|
4260
|
+
acceptsBody: false,
|
|
4261
|
+
requiresAuth: true,
|
|
4262
|
+
},
|
|
4263
|
+
{
|
|
4264
|
+
commandPath: ['customer', 'attribute', 'delete'],
|
|
4265
|
+
clientProperty: 'customer',
|
|
4266
|
+
methodName: 'clearAttribute',
|
|
4267
|
+
httpMethod: 'delete',
|
|
4268
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}',
|
|
4269
|
+
summary: 'Clear a field on a customer',
|
|
4270
|
+
description: 'Removes the value and any lock, so a later conversation can fill it again.',
|
|
4271
|
+
positionals: [
|
|
4272
|
+
{
|
|
4273
|
+
name: 'customer-profile-id',
|
|
4274
|
+
paramKey: 'customerProfileId',
|
|
4275
|
+
},
|
|
4276
|
+
{
|
|
4277
|
+
name: 'key',
|
|
4278
|
+
paramKey: 'key',
|
|
4279
|
+
},
|
|
4280
|
+
],
|
|
4281
|
+
flags: [],
|
|
4282
|
+
hasParams: true,
|
|
4283
|
+
paramsAllOptional: false,
|
|
4284
|
+
bodyOpaque: false,
|
|
4285
|
+
bodyVariants: [],
|
|
4286
|
+
acceptsBody: false,
|
|
4287
|
+
requiresAuth: true,
|
|
4288
|
+
},
|
|
4289
|
+
{
|
|
4290
|
+
commandPath: ['customer', 'attribute', 'unlock'],
|
|
4291
|
+
clientProperty: 'customer',
|
|
4292
|
+
methodName: 'unlockAttribute',
|
|
4293
|
+
httpMethod: 'post',
|
|
4294
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}/unlock',
|
|
4295
|
+
summary: 'Unlock a field on a customer',
|
|
4296
|
+
description: 'Lets newer conversations change this field again. The current value stays until one does.',
|
|
4297
|
+
positionals: [
|
|
4298
|
+
{
|
|
4299
|
+
name: 'customer-profile-id',
|
|
4300
|
+
paramKey: 'customerProfileId',
|
|
4301
|
+
},
|
|
4302
|
+
{
|
|
4303
|
+
name: 'key',
|
|
4304
|
+
paramKey: 'key',
|
|
4305
|
+
},
|
|
4306
|
+
],
|
|
4307
|
+
flags: [],
|
|
4308
|
+
hasParams: true,
|
|
4309
|
+
paramsAllOptional: false,
|
|
4310
|
+
bodyOpaque: false,
|
|
4311
|
+
bodyVariants: [],
|
|
4312
|
+
acceptsBody: false,
|
|
4313
|
+
requiresAuth: true,
|
|
4314
|
+
},
|
|
4315
|
+
{
|
|
4316
|
+
commandPath: ['customer', 'attribute', 'update'],
|
|
4317
|
+
clientProperty: 'customer',
|
|
4318
|
+
methodName: 'setAttribute',
|
|
4319
|
+
httpMethod: 'put',
|
|
4320
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}',
|
|
4321
|
+
summary: 'Set a field on a customer',
|
|
4322
|
+
description: 'Sets the value and locks the field, so newer conversations cannot change it.',
|
|
4323
|
+
positionals: [
|
|
4324
|
+
{
|
|
4325
|
+
name: 'customer-profile-id',
|
|
4326
|
+
paramKey: 'customerProfileId',
|
|
4327
|
+
},
|
|
4328
|
+
{
|
|
4329
|
+
name: 'key',
|
|
4330
|
+
paramKey: 'key',
|
|
4331
|
+
},
|
|
4332
|
+
],
|
|
4333
|
+
flags: [
|
|
4334
|
+
{
|
|
4335
|
+
name: 'value',
|
|
4336
|
+
path: ['value'],
|
|
4337
|
+
location: 'body',
|
|
4338
|
+
required: true,
|
|
4339
|
+
description: 'The new value. Setting a field locks it, so newer conversations cannot change it.',
|
|
4340
|
+
valueKind: 'string',
|
|
4341
|
+
repeatable: false,
|
|
4342
|
+
},
|
|
4343
|
+
],
|
|
4344
|
+
hasParams: true,
|
|
4345
|
+
paramsAllOptional: false,
|
|
4346
|
+
bodyOpaque: false,
|
|
4347
|
+
bodyVariants: [],
|
|
4348
|
+
acceptsBody: true,
|
|
4349
|
+
requiresAuth: true,
|
|
4350
|
+
},
|
|
4351
|
+
{
|
|
4352
|
+
commandPath: ['customer', 'conversation', 'list'],
|
|
4353
|
+
clientProperty: 'customer',
|
|
4354
|
+
methodName: 'listConversations',
|
|
4355
|
+
httpMethod: 'get',
|
|
4356
|
+
httpPath: '/v1/customer/{customerProfileId}/conversations',
|
|
4357
|
+
summary: "List a customer's conversations",
|
|
4358
|
+
description: 'Calls and chats with this customer, newest first.',
|
|
4359
|
+
positionals: [
|
|
4360
|
+
{
|
|
4361
|
+
name: 'customer-profile-id',
|
|
4362
|
+
paramKey: 'customerProfileId',
|
|
4363
|
+
},
|
|
4364
|
+
],
|
|
4365
|
+
flags: [
|
|
4366
|
+
{
|
|
4367
|
+
name: 'limit',
|
|
4368
|
+
path: ['limit'],
|
|
4369
|
+
location: 'query',
|
|
4370
|
+
required: false,
|
|
4371
|
+
valueKind: 'integer',
|
|
4372
|
+
repeatable: false,
|
|
4373
|
+
},
|
|
4374
|
+
{
|
|
4375
|
+
name: 'page',
|
|
4376
|
+
path: ['page'],
|
|
4377
|
+
location: 'query',
|
|
3005
4378
|
required: false,
|
|
3006
|
-
|
|
4379
|
+
valueKind: 'integer',
|
|
4380
|
+
repeatable: false,
|
|
4381
|
+
},
|
|
4382
|
+
],
|
|
4383
|
+
hasParams: true,
|
|
4384
|
+
paramsAllOptional: true,
|
|
4385
|
+
bodyOpaque: false,
|
|
4386
|
+
bodyVariants: [],
|
|
4387
|
+
acceptsBody: false,
|
|
4388
|
+
requiresAuth: true,
|
|
4389
|
+
},
|
|
4390
|
+
{
|
|
4391
|
+
commandPath: ['customer', 'delete'],
|
|
4392
|
+
clientProperty: 'customer',
|
|
4393
|
+
methodName: 'delete',
|
|
4394
|
+
httpMethod: 'delete',
|
|
4395
|
+
httpPath: '/v1/customer/{customerProfileId}',
|
|
4396
|
+
summary: 'Erase a customer',
|
|
4397
|
+
description: 'Permanently removes the customer, with their fields, evidence and notes. Conversations are kept. A new conversation from the same identifier starts a new customer.',
|
|
4398
|
+
positionals: [
|
|
4399
|
+
{
|
|
4400
|
+
name: 'customer-profile-id',
|
|
4401
|
+
paramKey: 'customerProfileId',
|
|
4402
|
+
},
|
|
4403
|
+
],
|
|
4404
|
+
flags: [],
|
|
4405
|
+
hasParams: false,
|
|
4406
|
+
paramsAllOptional: true,
|
|
4407
|
+
bodyOpaque: false,
|
|
4408
|
+
bodyVariants: [],
|
|
4409
|
+
acceptsBody: false,
|
|
4410
|
+
requiresAuth: true,
|
|
4411
|
+
},
|
|
4412
|
+
{
|
|
4413
|
+
commandPath: ['customer', 'field', 'create'],
|
|
4414
|
+
clientProperty: 'customer',
|
|
4415
|
+
methodName: 'createField',
|
|
4416
|
+
httpMethod: 'post',
|
|
4417
|
+
httpPath: '/v1/customer/fields',
|
|
4418
|
+
summary: 'Create a customer field',
|
|
4419
|
+
description: "Adds a field of your project's own. With extract on, conversations fill it from what customers say, guided by its description.",
|
|
4420
|
+
positionals: [],
|
|
4421
|
+
flags: [
|
|
4422
|
+
{
|
|
4423
|
+
name: 'key',
|
|
4424
|
+
path: ['key'],
|
|
4425
|
+
location: 'body',
|
|
4426
|
+
required: true,
|
|
4427
|
+
description: 'Starts with a letter; letters, numbers and underscores only. Fixed once created.',
|
|
3007
4428
|
valueKind: 'string',
|
|
3008
4429
|
repeatable: false,
|
|
3009
4430
|
},
|
|
3010
4431
|
{
|
|
3011
|
-
name: '
|
|
3012
|
-
path: ['
|
|
4432
|
+
name: 'label',
|
|
4433
|
+
path: ['label'],
|
|
4434
|
+
location: 'body',
|
|
4435
|
+
required: true,
|
|
4436
|
+
valueKind: 'string',
|
|
4437
|
+
repeatable: false,
|
|
4438
|
+
},
|
|
4439
|
+
{
|
|
4440
|
+
name: 'description',
|
|
4441
|
+
path: ['description'],
|
|
3013
4442
|
location: 'body',
|
|
3014
4443
|
required: false,
|
|
3015
|
-
description:
|
|
3016
|
-
valueKind: '
|
|
3017
|
-
|
|
3018
|
-
repeatable: true,
|
|
4444
|
+
description: 'What the agent listens for in a conversation. Required when extract is true.',
|
|
4445
|
+
valueKind: 'string',
|
|
4446
|
+
repeatable: false,
|
|
3019
4447
|
},
|
|
3020
4448
|
{
|
|
3021
|
-
name: '
|
|
3022
|
-
path: ['
|
|
4449
|
+
name: 'value-type',
|
|
4450
|
+
path: ['valueType'],
|
|
4451
|
+
location: 'body',
|
|
4452
|
+
required: true,
|
|
4453
|
+
valueKind: 'string',
|
|
4454
|
+
enumValues: ['TEXT', 'NUMBER', 'BOOLEAN', 'DATE', 'PHONE_NUMBER', 'EMAIL', 'CURRENCY'],
|
|
4455
|
+
repeatable: false,
|
|
4456
|
+
},
|
|
4457
|
+
{
|
|
4458
|
+
name: 'extract',
|
|
4459
|
+
path: ['extract'],
|
|
4460
|
+
location: 'body',
|
|
4461
|
+
required: true,
|
|
4462
|
+
description: 'Whether conversations fill this field',
|
|
4463
|
+
valueKind: 'boolean',
|
|
4464
|
+
repeatable: false,
|
|
4465
|
+
},
|
|
4466
|
+
],
|
|
4467
|
+
hasParams: true,
|
|
4468
|
+
paramsAllOptional: false,
|
|
4469
|
+
bodyOpaque: false,
|
|
4470
|
+
bodyVariants: [],
|
|
4471
|
+
acceptsBody: true,
|
|
4472
|
+
requiresAuth: true,
|
|
4473
|
+
},
|
|
4474
|
+
{
|
|
4475
|
+
commandPath: ['customer', 'field', 'delete'],
|
|
4476
|
+
clientProperty: 'customer',
|
|
4477
|
+
methodName: 'deleteField',
|
|
4478
|
+
httpMethod: 'delete',
|
|
4479
|
+
httpPath: '/v1/customer/fields/{key}',
|
|
4480
|
+
summary: 'Delete a customer field',
|
|
4481
|
+
description: "Deletes a field of your project's own. Its values stop showing on customers. A built-in field cannot be deleted; turn it off instead.",
|
|
4482
|
+
positionals: [
|
|
4483
|
+
{
|
|
4484
|
+
name: 'key',
|
|
4485
|
+
paramKey: 'key',
|
|
4486
|
+
},
|
|
4487
|
+
],
|
|
4488
|
+
flags: [],
|
|
4489
|
+
hasParams: false,
|
|
4490
|
+
paramsAllOptional: true,
|
|
4491
|
+
bodyOpaque: false,
|
|
4492
|
+
bodyVariants: [],
|
|
4493
|
+
acceptsBody: false,
|
|
4494
|
+
requiresAuth: true,
|
|
4495
|
+
},
|
|
4496
|
+
{
|
|
4497
|
+
commandPath: ['customer', 'field', 'list'],
|
|
4498
|
+
clientProperty: 'customer',
|
|
4499
|
+
methodName: 'listFields',
|
|
4500
|
+
httpMethod: 'get',
|
|
4501
|
+
httpPath: '/v1/customer/fields',
|
|
4502
|
+
summary: 'List customer fields',
|
|
4503
|
+
description: "The fields this project's customers can hold, in display order. Use a field's key to filter, sort and set attributes.",
|
|
4504
|
+
positionals: [],
|
|
4505
|
+
flags: [],
|
|
4506
|
+
hasParams: false,
|
|
4507
|
+
paramsAllOptional: true,
|
|
4508
|
+
bodyOpaque: false,
|
|
4509
|
+
bodyVariants: [],
|
|
4510
|
+
acceptsBody: false,
|
|
4511
|
+
requiresAuth: true,
|
|
4512
|
+
},
|
|
4513
|
+
{
|
|
4514
|
+
commandPath: ['customer', 'field', 'update'],
|
|
4515
|
+
clientProperty: 'customer',
|
|
4516
|
+
methodName: 'updateField',
|
|
4517
|
+
httpMethod: 'patch',
|
|
4518
|
+
httpPath: '/v1/customer/fields/{key}',
|
|
4519
|
+
summary: 'Update a customer field',
|
|
4520
|
+
description: "Changes a field. A built-in field can only be turned on or off for your project; any field of your project's own can change everything but its key.",
|
|
4521
|
+
positionals: [
|
|
4522
|
+
{
|
|
4523
|
+
name: 'key',
|
|
4524
|
+
paramKey: 'key',
|
|
4525
|
+
},
|
|
4526
|
+
],
|
|
4527
|
+
flags: [
|
|
4528
|
+
{
|
|
4529
|
+
name: 'label',
|
|
4530
|
+
path: ['label'],
|
|
3023
4531
|
location: 'body',
|
|
3024
4532
|
required: false,
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
repeatable: true,
|
|
4533
|
+
valueKind: 'string',
|
|
4534
|
+
repeatable: false,
|
|
3028
4535
|
},
|
|
3029
4536
|
{
|
|
3030
|
-
name: '
|
|
3031
|
-
path: ['
|
|
4537
|
+
name: 'description',
|
|
4538
|
+
path: ['description'],
|
|
4539
|
+
location: 'body',
|
|
4540
|
+
required: false,
|
|
4541
|
+
valueKind: 'string',
|
|
4542
|
+
repeatable: false,
|
|
4543
|
+
},
|
|
4544
|
+
{
|
|
4545
|
+
name: 'value-type',
|
|
4546
|
+
path: ['valueType'],
|
|
3032
4547
|
location: 'body',
|
|
3033
4548
|
required: false,
|
|
3034
|
-
description: "ISO 8601 expiry. Defaults to the calling credential's own expiry (no expiry, for a `roark auth login` credential) and may not outlive it, so a short-lived connector credential cannot mint a permanent one.",
|
|
3035
4549
|
valueKind: 'string',
|
|
4550
|
+
enumValues: ['TEXT', 'NUMBER', 'BOOLEAN', 'DATE', 'PHONE_NUMBER', 'EMAIL', 'CURRENCY'],
|
|
4551
|
+
repeatable: false,
|
|
4552
|
+
},
|
|
4553
|
+
{
|
|
4554
|
+
name: 'extract',
|
|
4555
|
+
path: ['extract'],
|
|
4556
|
+
location: 'body',
|
|
4557
|
+
required: false,
|
|
4558
|
+
valueKind: 'boolean',
|
|
3036
4559
|
repeatable: false,
|
|
3037
4560
|
},
|
|
3038
4561
|
],
|
|
3039
4562
|
hasParams: true,
|
|
3040
|
-
paramsAllOptional:
|
|
4563
|
+
paramsAllOptional: true,
|
|
3041
4564
|
bodyOpaque: false,
|
|
3042
4565
|
bodyVariants: [],
|
|
3043
4566
|
acceptsBody: true,
|
|
3044
4567
|
requiresAuth: true,
|
|
3045
4568
|
},
|
|
3046
4569
|
{
|
|
3047
|
-
commandPath: ['
|
|
3048
|
-
clientProperty: '
|
|
3049
|
-
methodName: '
|
|
4570
|
+
commandPath: ['customer', 'get'],
|
|
4571
|
+
clientProperty: 'customer',
|
|
4572
|
+
methodName: 'getByID',
|
|
3050
4573
|
httpMethod: 'get',
|
|
3051
|
-
httpPath: '/v1/
|
|
3052
|
-
summary: '
|
|
3053
|
-
description: '
|
|
4574
|
+
httpPath: '/v1/customer/{customerProfileId}',
|
|
4575
|
+
summary: 'Get a customer',
|
|
4576
|
+
description: 'Get a customer',
|
|
4577
|
+
positionals: [
|
|
4578
|
+
{
|
|
4579
|
+
name: 'customer-profile-id',
|
|
4580
|
+
paramKey: 'customerProfileId',
|
|
4581
|
+
},
|
|
4582
|
+
],
|
|
4583
|
+
flags: [],
|
|
4584
|
+
hasParams: false,
|
|
4585
|
+
paramsAllOptional: true,
|
|
4586
|
+
bodyOpaque: false,
|
|
4587
|
+
bodyVariants: [],
|
|
4588
|
+
acceptsBody: false,
|
|
4589
|
+
requiresAuth: true,
|
|
4590
|
+
},
|
|
4591
|
+
{
|
|
4592
|
+
commandPath: ['customer', 'list'],
|
|
4593
|
+
clientProperty: 'customer',
|
|
4594
|
+
methodName: 'list',
|
|
4595
|
+
httpMethod: 'get',
|
|
4596
|
+
httpPath: '/v1/customer',
|
|
4597
|
+
summary: 'List customers',
|
|
4598
|
+
description: 'Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.',
|
|
3054
4599
|
positionals: [],
|
|
3055
4600
|
flags: [
|
|
3056
4601
|
{
|
|
3057
|
-
name: '
|
|
3058
|
-
path: ['
|
|
4602
|
+
name: 'limit',
|
|
4603
|
+
path: ['limit'],
|
|
4604
|
+
location: 'query',
|
|
4605
|
+
required: false,
|
|
4606
|
+
valueKind: 'integer',
|
|
4607
|
+
repeatable: false,
|
|
4608
|
+
},
|
|
4609
|
+
{
|
|
4610
|
+
name: 'page',
|
|
4611
|
+
path: ['page'],
|
|
4612
|
+
location: 'query',
|
|
4613
|
+
required: false,
|
|
4614
|
+
valueKind: 'integer',
|
|
4615
|
+
repeatable: false,
|
|
4616
|
+
},
|
|
4617
|
+
{
|
|
4618
|
+
name: 'search',
|
|
4619
|
+
path: ['search'],
|
|
4620
|
+
location: 'query',
|
|
4621
|
+
required: false,
|
|
4622
|
+
valueKind: 'string',
|
|
4623
|
+
repeatable: false,
|
|
4624
|
+
},
|
|
4625
|
+
{
|
|
4626
|
+
name: 'agent-id',
|
|
4627
|
+
path: ['agentId'],
|
|
4628
|
+
location: 'query',
|
|
4629
|
+
required: false,
|
|
4630
|
+
valueKind: 'string',
|
|
4631
|
+
repeatable: false,
|
|
4632
|
+
},
|
|
4633
|
+
{
|
|
4634
|
+
name: 'modality',
|
|
4635
|
+
path: ['modality'],
|
|
4636
|
+
location: 'query',
|
|
4637
|
+
required: false,
|
|
4638
|
+
valueKind: 'string',
|
|
4639
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
4640
|
+
repeatable: false,
|
|
4641
|
+
},
|
|
4642
|
+
{
|
|
4643
|
+
name: 'include-no-data',
|
|
4644
|
+
path: ['includeNoData'],
|
|
4645
|
+
location: 'query',
|
|
4646
|
+
required: false,
|
|
4647
|
+
description: 'Include customers we hold nothing about beyond their identifier. Defaults to false.',
|
|
4648
|
+
valueKind: 'string',
|
|
4649
|
+
enumValues: ['true', 'false'],
|
|
4650
|
+
repeatable: false,
|
|
4651
|
+
},
|
|
4652
|
+
{
|
|
4653
|
+
name: 'sort-by',
|
|
4654
|
+
path: ['sortBy'],
|
|
4655
|
+
location: 'query',
|
|
4656
|
+
required: false,
|
|
4657
|
+
description: "lastSeenAt (the default), firstSeenAt, conversationCount, voiceCount, chatCount, talkTimeMs or displayName, or field.<key> (for example field.COMPANY) to sort by a field's value. Field keys come from GET /v1/customer/fields. Customers without a value sort last.",
|
|
4658
|
+
valueKind: 'string',
|
|
4659
|
+
repeatable: false,
|
|
4660
|
+
},
|
|
4661
|
+
{
|
|
4662
|
+
name: 'sort-direction',
|
|
4663
|
+
path: ['sortDirection'],
|
|
4664
|
+
location: 'query',
|
|
4665
|
+
required: false,
|
|
4666
|
+
valueKind: 'string',
|
|
4667
|
+
enumValues: ['asc', 'desc'],
|
|
4668
|
+
repeatable: false,
|
|
4669
|
+
},
|
|
4670
|
+
{
|
|
4671
|
+
name: 'field-key',
|
|
4672
|
+
path: ['fieldKey'],
|
|
4673
|
+
location: 'query',
|
|
4674
|
+
required: false,
|
|
4675
|
+
description: 'Filter by this field, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue.',
|
|
4676
|
+
valueKind: 'string',
|
|
4677
|
+
repeatable: false,
|
|
4678
|
+
},
|
|
4679
|
+
{
|
|
4680
|
+
name: 'field-operator',
|
|
4681
|
+
path: ['fieldOperator'],
|
|
4682
|
+
location: 'query',
|
|
4683
|
+
required: false,
|
|
4684
|
+
description: 'How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field.',
|
|
4685
|
+
valueKind: 'string',
|
|
4686
|
+
enumValues: ['EQUALS', 'NOT_EQUALS', 'CONTAINS', 'STARTS_WITH', 'IS_SET', 'IS_NOT_SET'],
|
|
4687
|
+
repeatable: false,
|
|
4688
|
+
},
|
|
4689
|
+
{
|
|
4690
|
+
name: 'field-value',
|
|
4691
|
+
path: ['fieldValue'],
|
|
3059
4692
|
location: 'query',
|
|
3060
4693
|
required: false,
|
|
3061
|
-
description: 'Filter by status. Defaults to ACTIVE.',
|
|
3062
4694
|
valueKind: 'string',
|
|
3063
|
-
enumValues: ['ACTIVE', 'REVOKED'],
|
|
3064
4695
|
repeatable: false,
|
|
3065
4696
|
},
|
|
3066
4697
|
],
|
|
@@ -3072,25 +4703,35 @@ exports.COMMANDS = [
|
|
|
3072
4703
|
requiresAuth: true,
|
|
3073
4704
|
},
|
|
3074
4705
|
{
|
|
3075
|
-
commandPath: ['
|
|
3076
|
-
clientProperty: '
|
|
3077
|
-
methodName: '
|
|
3078
|
-
httpMethod: '
|
|
3079
|
-
httpPath: '/v1/
|
|
3080
|
-
summary: '
|
|
3081
|
-
description:
|
|
4706
|
+
commandPath: ['customer', 'notes', 'update'],
|
|
4707
|
+
clientProperty: 'customer',
|
|
4708
|
+
methodName: 'updateNotes',
|
|
4709
|
+
httpMethod: 'put',
|
|
4710
|
+
httpPath: '/v1/customer/{customerProfileId}/notes',
|
|
4711
|
+
summary: 'Update the notes on a customer',
|
|
4712
|
+
description: "Replaces your team's shared notes. Null or empty clears them. The last save wins.",
|
|
3082
4713
|
positionals: [
|
|
3083
4714
|
{
|
|
3084
|
-
name: '
|
|
3085
|
-
paramKey: '
|
|
4715
|
+
name: 'customer-profile-id',
|
|
4716
|
+
paramKey: 'customerProfileId',
|
|
3086
4717
|
},
|
|
3087
4718
|
],
|
|
3088
|
-
flags: [
|
|
3089
|
-
|
|
3090
|
-
|
|
4719
|
+
flags: [
|
|
4720
|
+
{
|
|
4721
|
+
name: 'notes',
|
|
4722
|
+
path: ['notes'],
|
|
4723
|
+
location: 'body',
|
|
4724
|
+
required: true,
|
|
4725
|
+
description: 'Replaces the existing notes. Null or empty clears them.',
|
|
4726
|
+
valueKind: 'string',
|
|
4727
|
+
repeatable: false,
|
|
4728
|
+
},
|
|
4729
|
+
],
|
|
4730
|
+
hasParams: true,
|
|
4731
|
+
paramsAllOptional: false,
|
|
3091
4732
|
bodyOpaque: false,
|
|
3092
4733
|
bodyVariants: [],
|
|
3093
|
-
acceptsBody:
|
|
4734
|
+
acceptsBody: true,
|
|
3094
4735
|
requiresAuth: true,
|
|
3095
4736
|
},
|
|
3096
4737
|
{
|
|
@@ -3218,6 +4859,7 @@ exports.COMMANDS = [
|
|
|
3218
4859
|
path: ['prompt'],
|
|
3219
4860
|
location: 'body',
|
|
3220
4861
|
required: false,
|
|
4862
|
+
description: 'The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:<emotion>}`, `#{language:<ISO 639-1 code>}`, `#{noise:<environmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept.',
|
|
3221
4863
|
valueKind: 'string',
|
|
3222
4864
|
repeatable: false,
|
|
3223
4865
|
},
|
|
@@ -3372,6 +5014,7 @@ exports.COMMANDS = [
|
|
|
3372
5014
|
path: ['prompt'],
|
|
3373
5015
|
location: 'body',
|
|
3374
5016
|
required: false,
|
|
5017
|
+
description: 'Improv flows only. The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:<emotion>}`, `#{language:<ISO 639-1 code>}`, `#{noise:<environmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept.',
|
|
3375
5018
|
valueKind: 'string',
|
|
3376
5019
|
repeatable: false,
|
|
3377
5020
|
},
|
|
@@ -3434,13 +5077,111 @@ exports.COMMANDS = [
|
|
|
3434
5077
|
acceptsBody: true,
|
|
3435
5078
|
requiresAuth: true,
|
|
3436
5079
|
},
|
|
5080
|
+
{
|
|
5081
|
+
commandPath: ['customer-flow', 'folder', 'create'],
|
|
5082
|
+
clientProperty: 'customerFlowFolder',
|
|
5083
|
+
methodName: 'create',
|
|
5084
|
+
httpMethod: 'post',
|
|
5085
|
+
httpPath: '/v1/customer-flow/folder',
|
|
5086
|
+
summary: 'Create a customer flow folder',
|
|
5087
|
+
description: 'Creates a folder to group customer flows. File a flow into it by sending its `folderId` when you create or update the flow. Names are unique within a project, ignoring case. Customer flows were previously called scenarios.',
|
|
5088
|
+
positionals: [],
|
|
5089
|
+
flags: [
|
|
5090
|
+
{
|
|
5091
|
+
name: 'name',
|
|
5092
|
+
path: ['name'],
|
|
5093
|
+
location: 'body',
|
|
5094
|
+
required: true,
|
|
5095
|
+
description: 'The folder name. Must be unique in the project.',
|
|
5096
|
+
valueKind: 'string',
|
|
5097
|
+
repeatable: false,
|
|
5098
|
+
},
|
|
5099
|
+
{
|
|
5100
|
+
name: 'color',
|
|
5101
|
+
path: ['color'],
|
|
5102
|
+
location: 'body',
|
|
5103
|
+
required: false,
|
|
5104
|
+
description: 'The color the folder is shown with in the app. Folders share the palette labels use. Defaults to GREY.',
|
|
5105
|
+
valueKind: 'string',
|
|
5106
|
+
enumValues: [
|
|
5107
|
+
'GREEN',
|
|
5108
|
+
'RED',
|
|
5109
|
+
'ORANGE',
|
|
5110
|
+
'PURPLE',
|
|
5111
|
+
'GREY',
|
|
5112
|
+
'BLUE',
|
|
5113
|
+
'PEACH',
|
|
5114
|
+
'TEAL',
|
|
5115
|
+
'INDIGO',
|
|
5116
|
+
'AMBER',
|
|
5117
|
+
'ROSE',
|
|
5118
|
+
'CYAN',
|
|
5119
|
+
],
|
|
5120
|
+
repeatable: false,
|
|
5121
|
+
},
|
|
5122
|
+
{
|
|
5123
|
+
name: 'description',
|
|
5124
|
+
path: ['description'],
|
|
5125
|
+
location: 'body',
|
|
5126
|
+
required: false,
|
|
5127
|
+
description: 'What belongs in this folder.',
|
|
5128
|
+
valueKind: 'string',
|
|
5129
|
+
repeatable: false,
|
|
5130
|
+
},
|
|
5131
|
+
],
|
|
5132
|
+
hasParams: true,
|
|
5133
|
+
paramsAllOptional: false,
|
|
5134
|
+
bodyOpaque: false,
|
|
5135
|
+
bodyVariants: [],
|
|
5136
|
+
acceptsBody: true,
|
|
5137
|
+
requiresAuth: true,
|
|
5138
|
+
},
|
|
5139
|
+
{
|
|
5140
|
+
commandPath: ['customer-flow', 'folder', 'delete'],
|
|
5141
|
+
clientProperty: 'customerFlowFolder',
|
|
5142
|
+
methodName: 'delete',
|
|
5143
|
+
httpMethod: 'delete',
|
|
5144
|
+
httpPath: '/v1/customer-flow/folder/{folderId}',
|
|
5145
|
+
summary: 'Delete a customer flow folder',
|
|
5146
|
+
description: 'Deletes a folder. The flows in it are kept and no longer sit in any folder. Built-in folders cannot be deleted.',
|
|
5147
|
+
positionals: [
|
|
5148
|
+
{
|
|
5149
|
+
name: 'folder-id',
|
|
5150
|
+
paramKey: 'folderId',
|
|
5151
|
+
},
|
|
5152
|
+
],
|
|
5153
|
+
flags: [],
|
|
5154
|
+
hasParams: false,
|
|
5155
|
+
paramsAllOptional: true,
|
|
5156
|
+
bodyOpaque: false,
|
|
5157
|
+
bodyVariants: [],
|
|
5158
|
+
acceptsBody: false,
|
|
5159
|
+
requiresAuth: true,
|
|
5160
|
+
},
|
|
5161
|
+
{
|
|
5162
|
+
commandPath: ['customer-flow', 'folder', 'list'],
|
|
5163
|
+
clientProperty: 'customerFlowFolder',
|
|
5164
|
+
methodName: 'list',
|
|
5165
|
+
httpMethod: 'get',
|
|
5166
|
+
httpPath: '/v1/customer-flow/folder',
|
|
5167
|
+
summary: 'List customer flow folders',
|
|
5168
|
+
description: 'Returns every folder the project groups its customer flows into, with how many flows each holds, in the order the app shows them. Filter the flow list to one folder with `GET /v1/customer-flow?folderId=`. Customer flows were previously called scenarios.',
|
|
5169
|
+
positionals: [],
|
|
5170
|
+
flags: [],
|
|
5171
|
+
hasParams: false,
|
|
5172
|
+
paramsAllOptional: true,
|
|
5173
|
+
bodyOpaque: false,
|
|
5174
|
+
bodyVariants: [],
|
|
5175
|
+
acceptsBody: false,
|
|
5176
|
+
requiresAuth: true,
|
|
5177
|
+
},
|
|
3437
5178
|
{
|
|
3438
5179
|
commandPath: ['customer-flow', 'get'],
|
|
3439
5180
|
clientProperty: 'customerFlow',
|
|
3440
5181
|
methodName: 'getByID',
|
|
3441
5182
|
httpMethod: 'get',
|
|
3442
5183
|
httpPath: '/v1/customer-flow/{flowId}',
|
|
3443
|
-
summary: 'Get customer flow
|
|
5184
|
+
summary: 'Get a customer flow',
|
|
3444
5185
|
description: 'Returns a customer flow with its happy path, edge cases, expectations and linked agents. Scripted flows also carry their step graph.',
|
|
3445
5186
|
positionals: [
|
|
3446
5187
|
{
|
|
@@ -3501,168 +5242,10 @@ exports.COMMANDS = [
|
|
|
3501
5242
|
commandPath: ['customer-flow', 'happy-path', 'update'],
|
|
3502
5243
|
clientProperty: 'customerFlow',
|
|
3503
5244
|
methodName: 'updateHappyPath',
|
|
3504
|
-
httpMethod: 'put',
|
|
3505
|
-
httpPath: '/v1/customer-flow/{flowId}/happy-path',
|
|
3506
|
-
summary: "Update a flow's happy path",
|
|
3507
|
-
description: "Updates the happy path's title, persona, environment, brief or expectations. Omitted fields are left alone; `additionalExpectations` replaces the set wholesale rather than appending. Its persona and environment are what the edge cases inherit, so changing them here changes every edge case that does not name its own.",
|
|
3508
|
-
positionals: [
|
|
3509
|
-
{
|
|
3510
|
-
name: 'flow-id',
|
|
3511
|
-
paramKey: 'flowId',
|
|
3512
|
-
},
|
|
3513
|
-
],
|
|
3514
|
-
flags: [
|
|
3515
|
-
{
|
|
3516
|
-
name: 'title',
|
|
3517
|
-
path: ['title'],
|
|
3518
|
-
location: 'body',
|
|
3519
|
-
required: false,
|
|
3520
|
-
valueKind: 'string',
|
|
3521
|
-
repeatable: false,
|
|
3522
|
-
},
|
|
3523
|
-
{
|
|
3524
|
-
name: 'environment-id',
|
|
3525
|
-
path: ['environmentId'],
|
|
3526
|
-
location: 'body',
|
|
3527
|
-
required: false,
|
|
3528
|
-
valueKind: 'string',
|
|
3529
|
-
repeatable: false,
|
|
3530
|
-
},
|
|
3531
|
-
{
|
|
3532
|
-
name: 'prompt',
|
|
3533
|
-
path: ['prompt'],
|
|
3534
|
-
location: 'body',
|
|
3535
|
-
required: false,
|
|
3536
|
-
valueKind: 'string',
|
|
3537
|
-
repeatable: false,
|
|
3538
|
-
},
|
|
3539
|
-
{
|
|
3540
|
-
name: 'opening-line',
|
|
3541
|
-
path: ['openingLine'],
|
|
3542
|
-
location: 'body',
|
|
3543
|
-
required: false,
|
|
3544
|
-
valueKind: 'string',
|
|
3545
|
-
repeatable: false,
|
|
3546
|
-
},
|
|
3547
|
-
{
|
|
3548
|
-
name: 'preceded-by-customer-flow-id',
|
|
3549
|
-
path: ['precededByCustomerFlowId'],
|
|
3550
|
-
location: 'body',
|
|
3551
|
-
required: false,
|
|
3552
|
-
valueKind: 'string',
|
|
3553
|
-
repeatable: false,
|
|
3554
|
-
},
|
|
3555
|
-
{
|
|
3556
|
-
name: 'preceded-by-customer-flow-variant-id',
|
|
3557
|
-
path: ['precededByCustomerFlowVariantId'],
|
|
3558
|
-
location: 'body',
|
|
3559
|
-
required: false,
|
|
3560
|
-
valueKind: 'string',
|
|
3561
|
-
repeatable: false,
|
|
3562
|
-
},
|
|
3563
|
-
{
|
|
3564
|
-
name: 'include-flow-expectations',
|
|
3565
|
-
path: ['includeFlowExpectations'],
|
|
3566
|
-
location: 'body',
|
|
3567
|
-
required: false,
|
|
3568
|
-
description: "Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.",
|
|
3569
|
-
valueKind: 'boolean',
|
|
3570
|
-
repeatable: false,
|
|
3571
|
-
},
|
|
3572
|
-
{
|
|
3573
|
-
name: 'persona-override-id',
|
|
3574
|
-
path: ['personaOverrideId'],
|
|
3575
|
-
location: 'body',
|
|
3576
|
-
required: false,
|
|
3577
|
-
description: "The persona this runs as. Null on an edge case inherits the happy path's.",
|
|
3578
|
-
valueKind: 'string',
|
|
3579
|
-
repeatable: false,
|
|
3580
|
-
},
|
|
3581
|
-
{
|
|
3582
|
-
name: 'additional-expectations',
|
|
3583
|
-
path: ['additionalExpectations'],
|
|
3584
|
-
location: 'body',
|
|
3585
|
-
required: false,
|
|
3586
|
-
description: "The expectations graded on this variant only, on top of the flow's own. Sent as the complete set: it replaces whatever the variant had, so omit it to leave the set alone and send [] to clear it. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on every graph edit.",
|
|
3587
|
-
valueKind: 'array',
|
|
3588
|
-
repeatable: false,
|
|
3589
|
-
},
|
|
3590
|
-
],
|
|
3591
|
-
hasParams: true,
|
|
3592
|
-
paramsAllOptional: true,
|
|
3593
|
-
bodyOpaque: false,
|
|
3594
|
-
bodyVariants: [],
|
|
3595
|
-
acceptsBody: true,
|
|
3596
|
-
requiresAuth: true,
|
|
3597
|
-
},
|
|
3598
|
-
{
|
|
3599
|
-
commandPath: ['customer-flow', 'list'],
|
|
3600
|
-
clientProperty: 'customerFlow',
|
|
3601
|
-
methodName: 'list',
|
|
3602
|
-
httpMethod: 'get',
|
|
3603
|
-
httpPath: '/v1/customer-flow',
|
|
3604
|
-
summary: 'List customer flows',
|
|
3605
|
-
description: "Returns a paginated list of customer flows with their agents, expectations, happy path and edge cases. The step graph is the one field omitted: reading it walks the project's whole step graph, so it comes back from the single-flow endpoint instead. Customer flows are how a project describes what to test; they replace the older simulation scenarios.",
|
|
3606
|
-
positionals: [],
|
|
3607
|
-
flags: [
|
|
3608
|
-
{
|
|
3609
|
-
name: 'limit',
|
|
3610
|
-
path: ['limit'],
|
|
3611
|
-
location: 'query',
|
|
3612
|
-
required: false,
|
|
3613
|
-
valueKind: 'integer',
|
|
3614
|
-
repeatable: false,
|
|
3615
|
-
},
|
|
3616
|
-
{
|
|
3617
|
-
name: 'after',
|
|
3618
|
-
path: ['after'],
|
|
3619
|
-
location: 'query',
|
|
3620
|
-
required: false,
|
|
3621
|
-
valueKind: 'string',
|
|
3622
|
-
repeatable: false,
|
|
3623
|
-
},
|
|
3624
|
-
{
|
|
3625
|
-
name: 'search-text',
|
|
3626
|
-
path: ['searchText'],
|
|
3627
|
-
location: 'query',
|
|
3628
|
-
required: false,
|
|
3629
|
-
valueKind: 'string',
|
|
3630
|
-
repeatable: false,
|
|
3631
|
-
},
|
|
3632
|
-
{
|
|
3633
|
-
name: 'type',
|
|
3634
|
-
path: ['type'],
|
|
3635
|
-
location: 'query',
|
|
3636
|
-
required: false,
|
|
3637
|
-
valueKind: 'string',
|
|
3638
|
-
enumValues: ['SCRIPTED', 'IMPROV', 'VOICEMAIL'],
|
|
3639
|
-
repeatable: false,
|
|
3640
|
-
},
|
|
3641
|
-
{
|
|
3642
|
-
name: 'include-system',
|
|
3643
|
-
path: ['includeSystem'],
|
|
3644
|
-
location: 'query',
|
|
3645
|
-
required: false,
|
|
3646
|
-
valueKind: 'string',
|
|
3647
|
-
enumValues: ['true', 'false'],
|
|
3648
|
-
repeatable: false,
|
|
3649
|
-
},
|
|
3650
|
-
],
|
|
3651
|
-
hasParams: true,
|
|
3652
|
-
paramsAllOptional: true,
|
|
3653
|
-
bodyOpaque: false,
|
|
3654
|
-
bodyVariants: [],
|
|
3655
|
-
acceptsBody: false,
|
|
3656
|
-
requiresAuth: true,
|
|
3657
|
-
},
|
|
3658
|
-
{
|
|
3659
|
-
commandPath: ['customer-flow', 'update'],
|
|
3660
|
-
clientProperty: 'customerFlow',
|
|
3661
|
-
methodName: 'update',
|
|
3662
|
-
httpMethod: 'put',
|
|
3663
|
-
httpPath: '/v1/customer-flow/{flowId}',
|
|
3664
|
-
summary: 'Update a customer flow',
|
|
3665
|
-
description: "Updates a flow's title, description, branching mode, linked agents or flow-level expectations. The step graph is replaced through PUT /graph.",
|
|
5245
|
+
httpMethod: 'put',
|
|
5246
|
+
httpPath: '/v1/customer-flow/{flowId}/happy-path',
|
|
5247
|
+
summary: "Update a flow's happy path",
|
|
5248
|
+
description: "Updates the happy path's title, persona, environment, brief or expectations. Omitted fields are left alone; `additionalExpectations` replaces the set wholesale rather than appending. Its persona and environment are what the edge cases inherit, so changing them here changes every edge case that does not name its own.",
|
|
3666
5249
|
positionals: [
|
|
3667
5250
|
{
|
|
3668
5251
|
name: 'flow-id',
|
|
@@ -3679,98 +5262,70 @@ exports.COMMANDS = [
|
|
|
3679
5262
|
repeatable: false,
|
|
3680
5263
|
},
|
|
3681
5264
|
{
|
|
3682
|
-
name: '
|
|
3683
|
-
path: ['
|
|
5265
|
+
name: 'environment-id',
|
|
5266
|
+
path: ['environmentId'],
|
|
3684
5267
|
location: 'body',
|
|
3685
5268
|
required: false,
|
|
3686
5269
|
valueKind: 'string',
|
|
3687
5270
|
repeatable: false,
|
|
3688
5271
|
},
|
|
3689
5272
|
{
|
|
3690
|
-
name: '
|
|
3691
|
-
path: ['
|
|
5273
|
+
name: 'prompt',
|
|
5274
|
+
path: ['prompt'],
|
|
3692
5275
|
location: 'body',
|
|
3693
5276
|
required: false,
|
|
3694
|
-
description: '
|
|
5277
|
+
description: 'Improv flows only. The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:<emotion>}`, `#{language:<ISO 639-1 code>}`, `#{noise:<environmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept.',
|
|
3695
5278
|
valueKind: 'string',
|
|
3696
|
-
enumValues: ['LOOSE', 'STRICT'],
|
|
3697
5279
|
repeatable: false,
|
|
3698
5280
|
},
|
|
3699
5281
|
{
|
|
3700
|
-
name: '
|
|
3701
|
-
path: ['
|
|
5282
|
+
name: 'opening-line',
|
|
5283
|
+
path: ['openingLine'],
|
|
3702
5284
|
location: 'body',
|
|
3703
5285
|
required: false,
|
|
3704
|
-
description: 'STRICT only. What the simulated customer does when your agent does not say the expected line. Each unmatched agent utterance is an attempt: `reaction` runs per attempt (STAY_SILENT, REPEAT its last scripted line, RESPOND once in character without moving on, or SAY `sayLine`), and `then` runs when attempts reach `maxAttempts` or your agent stays silent for `waitSeconds` (HANG_UP ends the call with ended reason SCRIPT_DIVERGED, HANG_UP_INVALIDATE ends it the same way and invalidates the run so it is scored by nothing and counted nowhere, MOVE_ON advances anyway, ADAPT hands the rest of the call to loose behaviour). Null: stay silent, 3 attempts, hang up. The default for every agent step; an AGENT_TURN step can carry its own.',
|
|
3705
|
-
valueKind: 'object',
|
|
3706
|
-
},
|
|
3707
|
-
{
|
|
3708
|
-
name: 'off-script-policy.reaction',
|
|
3709
|
-
path: ['offScriptPolicy', 'reaction'],
|
|
3710
|
-
location: 'body',
|
|
3711
|
-
required: true,
|
|
3712
5286
|
valueKind: 'string',
|
|
3713
|
-
enumValues: ['STAY_SILENT', 'REPEAT', 'RESPOND', 'SAY'],
|
|
3714
5287
|
repeatable: false,
|
|
3715
5288
|
},
|
|
3716
5289
|
{
|
|
3717
|
-
name: '
|
|
3718
|
-
path: ['
|
|
5290
|
+
name: 'preceded-by-customer-flow-id',
|
|
5291
|
+
path: ['precededByCustomerFlowId'],
|
|
3719
5292
|
location: 'body',
|
|
3720
5293
|
required: false,
|
|
3721
5294
|
valueKind: 'string',
|
|
3722
5295
|
repeatable: false,
|
|
3723
5296
|
},
|
|
3724
5297
|
{
|
|
3725
|
-
name: '
|
|
3726
|
-
path: ['
|
|
3727
|
-
location: 'body',
|
|
3728
|
-
required: true,
|
|
3729
|
-
valueKind: 'integer',
|
|
3730
|
-
repeatable: false,
|
|
3731
|
-
},
|
|
3732
|
-
{
|
|
3733
|
-
name: 'off-script-policy.then',
|
|
3734
|
-
path: ['offScriptPolicy', 'then'],
|
|
5298
|
+
name: 'preceded-by-customer-flow-variant-id',
|
|
5299
|
+
path: ['precededByCustomerFlowVariantId'],
|
|
3735
5300
|
location: 'body',
|
|
3736
|
-
required:
|
|
5301
|
+
required: false,
|
|
3737
5302
|
valueKind: 'string',
|
|
3738
|
-
enumValues: ['HANG_UP', 'MOVE_ON', 'ADAPT', 'HANG_UP_INVALIDATE'],
|
|
3739
5303
|
repeatable: false,
|
|
3740
5304
|
},
|
|
3741
5305
|
{
|
|
3742
|
-
name: '
|
|
3743
|
-
path: ['
|
|
5306
|
+
name: 'include-flow-expectations',
|
|
5307
|
+
path: ['includeFlowExpectations'],
|
|
3744
5308
|
location: 'body',
|
|
3745
5309
|
required: false,
|
|
3746
|
-
|
|
5310
|
+
description: "Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.",
|
|
5311
|
+
valueKind: 'boolean',
|
|
3747
5312
|
repeatable: false,
|
|
3748
5313
|
},
|
|
3749
5314
|
{
|
|
3750
|
-
name: '
|
|
3751
|
-
path: ['
|
|
5315
|
+
name: 'persona-override-id',
|
|
5316
|
+
path: ['personaOverrideId'],
|
|
3752
5317
|
location: 'body',
|
|
3753
5318
|
required: false,
|
|
3754
|
-
description:
|
|
5319
|
+
description: "The persona this runs as. Null on an edge case inherits the happy path's.",
|
|
3755
5320
|
valueKind: 'string',
|
|
3756
|
-
enumValues: ['DETERMINISTIC', 'ADAPTIVE'],
|
|
3757
5321
|
repeatable: false,
|
|
3758
5322
|
},
|
|
3759
5323
|
{
|
|
3760
|
-
name: '
|
|
3761
|
-
path: ['
|
|
3762
|
-
location: 'body',
|
|
3763
|
-
required: false,
|
|
3764
|
-
description: 'Replaces the linked agents. Omit to leave them unchanged. An improv flow must keep at least one; a scripted flow can be left with none.',
|
|
3765
|
-
valueKind: 'array',
|
|
3766
|
-
repeatable: true,
|
|
3767
|
-
},
|
|
3768
|
-
{
|
|
3769
|
-
name: 'agent-expectations',
|
|
3770
|
-
path: ['agentExpectations'],
|
|
5324
|
+
name: 'additional-expectations',
|
|
5325
|
+
path: ['additionalExpectations'],
|
|
3771
5326
|
location: 'body',
|
|
3772
5327
|
required: false,
|
|
3773
|
-
description:
|
|
5328
|
+
description: "The expectations graded on this variant only, on top of the flow's own. Sent as the complete set: it replaces whatever the variant had, so omit it to leave the set alone and send [] to clear it. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on every graph edit.",
|
|
3774
5329
|
valueKind: 'array',
|
|
3775
5330
|
repeatable: false,
|
|
3776
5331
|
},
|
|
@@ -3783,122 +5338,63 @@ exports.COMMANDS = [
|
|
|
3783
5338
|
requiresAuth: true,
|
|
3784
5339
|
},
|
|
3785
5340
|
{
|
|
3786
|
-
commandPath: ['customer-
|
|
3787
|
-
clientProperty: '
|
|
3788
|
-
methodName: '
|
|
3789
|
-
httpMethod: '
|
|
3790
|
-
httpPath: '/v1/customer-
|
|
3791
|
-
summary: '
|
|
3792
|
-
description:
|
|
3793
|
-
positionals: [
|
|
3794
|
-
|
|
3795
|
-
name: 'customer-profile-id',
|
|
3796
|
-
paramKey: 'customerProfileId',
|
|
3797
|
-
},
|
|
3798
|
-
{
|
|
3799
|
-
name: 'key',
|
|
3800
|
-
paramKey: 'key',
|
|
3801
|
-
},
|
|
3802
|
-
],
|
|
3803
|
-
flags: [],
|
|
3804
|
-
hasParams: true,
|
|
3805
|
-
paramsAllOptional: false,
|
|
3806
|
-
bodyOpaque: false,
|
|
3807
|
-
bodyVariants: [],
|
|
3808
|
-
acceptsBody: false,
|
|
3809
|
-
requiresAuth: true,
|
|
3810
|
-
},
|
|
3811
|
-
{
|
|
3812
|
-
commandPath: ['customer-profile', 'attribute', 'unlock'],
|
|
3813
|
-
clientProperty: 'customerProfile',
|
|
3814
|
-
methodName: 'unlockAttribute',
|
|
3815
|
-
httpMethod: 'post',
|
|
3816
|
-
httpPath: '/v1/customer-profile/{customerProfileId}/attributes/{key}/unlock',
|
|
3817
|
-
summary: 'Unlock a customer profile field',
|
|
3818
|
-
description: 'Lets newer conversations change this field again. The current value stays until one does.',
|
|
3819
|
-
positionals: [
|
|
3820
|
-
{
|
|
3821
|
-
name: 'customer-profile-id',
|
|
3822
|
-
paramKey: 'customerProfileId',
|
|
3823
|
-
},
|
|
3824
|
-
{
|
|
3825
|
-
name: 'key',
|
|
3826
|
-
paramKey: 'key',
|
|
3827
|
-
},
|
|
3828
|
-
],
|
|
3829
|
-
flags: [],
|
|
3830
|
-
hasParams: true,
|
|
3831
|
-
paramsAllOptional: false,
|
|
3832
|
-
bodyOpaque: false,
|
|
3833
|
-
bodyVariants: [],
|
|
3834
|
-
acceptsBody: false,
|
|
3835
|
-
requiresAuth: true,
|
|
3836
|
-
},
|
|
3837
|
-
{
|
|
3838
|
-
commandPath: ['customer-profile', 'attribute', 'update'],
|
|
3839
|
-
clientProperty: 'customerProfile',
|
|
3840
|
-
methodName: 'setAttribute',
|
|
3841
|
-
httpMethod: 'put',
|
|
3842
|
-
httpPath: '/v1/customer-profile/{customerProfileId}/attributes/{key}',
|
|
3843
|
-
summary: 'Set a customer profile field',
|
|
3844
|
-
description: 'Sets the value and locks the field, so newer conversations cannot change it.',
|
|
3845
|
-
positionals: [
|
|
5341
|
+
commandPath: ['customer-flow', 'list'],
|
|
5342
|
+
clientProperty: 'customerFlow',
|
|
5343
|
+
methodName: 'list',
|
|
5344
|
+
httpMethod: 'get',
|
|
5345
|
+
httpPath: '/v1/customer-flow',
|
|
5346
|
+
summary: 'List customer flows',
|
|
5347
|
+
description: "Returns a paginated list of customer flows with their agents, expectations, happy path and edge cases. The step graph is the one field omitted: reading it walks the project's whole step graph, so it comes back from the single-flow endpoint instead. Customer flows are how a project describes what to test; they replace the older simulation scenarios.",
|
|
5348
|
+
positionals: [],
|
|
5349
|
+
flags: [
|
|
3846
5350
|
{
|
|
3847
|
-
name: '
|
|
3848
|
-
|
|
5351
|
+
name: 'limit',
|
|
5352
|
+
path: ['limit'],
|
|
5353
|
+
location: 'query',
|
|
5354
|
+
required: false,
|
|
5355
|
+
valueKind: 'integer',
|
|
5356
|
+
repeatable: false,
|
|
3849
5357
|
},
|
|
3850
5358
|
{
|
|
3851
|
-
name: '
|
|
3852
|
-
|
|
5359
|
+
name: 'after',
|
|
5360
|
+
path: ['after'],
|
|
5361
|
+
location: 'query',
|
|
5362
|
+
required: false,
|
|
5363
|
+
valueKind: 'string',
|
|
5364
|
+
repeatable: false,
|
|
3853
5365
|
},
|
|
3854
|
-
],
|
|
3855
|
-
flags: [
|
|
3856
5366
|
{
|
|
3857
|
-
name: '
|
|
3858
|
-
path: ['
|
|
3859
|
-
location: '
|
|
3860
|
-
required:
|
|
3861
|
-
description: 'The new value. Setting a field locks it, so newer conversations cannot change it.',
|
|
5367
|
+
name: 'search-text',
|
|
5368
|
+
path: ['searchText'],
|
|
5369
|
+
location: 'query',
|
|
5370
|
+
required: false,
|
|
3862
5371
|
valueKind: 'string',
|
|
3863
5372
|
repeatable: false,
|
|
3864
5373
|
},
|
|
3865
|
-
],
|
|
3866
|
-
hasParams: true,
|
|
3867
|
-
paramsAllOptional: false,
|
|
3868
|
-
bodyOpaque: false,
|
|
3869
|
-
bodyVariants: [],
|
|
3870
|
-
acceptsBody: true,
|
|
3871
|
-
requiresAuth: true,
|
|
3872
|
-
},
|
|
3873
|
-
{
|
|
3874
|
-
commandPath: ['customer-profile', 'conversation', 'list'],
|
|
3875
|
-
clientProperty: 'customerProfile',
|
|
3876
|
-
methodName: 'listConversations',
|
|
3877
|
-
httpMethod: 'get',
|
|
3878
|
-
httpPath: '/v1/customer-profile/{customerProfileId}/conversations',
|
|
3879
|
-
summary: "List a customer's conversations",
|
|
3880
|
-
description: 'Calls and chats with this customer, newest first.',
|
|
3881
|
-
positionals: [
|
|
3882
5374
|
{
|
|
3883
|
-
name: '
|
|
3884
|
-
|
|
5375
|
+
name: 'type',
|
|
5376
|
+
path: ['type'],
|
|
5377
|
+
location: 'query',
|
|
5378
|
+
required: false,
|
|
5379
|
+
valueKind: 'string',
|
|
5380
|
+
enumValues: ['SCRIPTED', 'IMPROV', 'VOICEMAIL'],
|
|
5381
|
+
repeatable: false,
|
|
3885
5382
|
},
|
|
3886
|
-
],
|
|
3887
|
-
flags: [
|
|
3888
5383
|
{
|
|
3889
|
-
name: '
|
|
3890
|
-
path: ['
|
|
5384
|
+
name: 'folder-id',
|
|
5385
|
+
path: ['folderId'],
|
|
3891
5386
|
location: 'query',
|
|
3892
5387
|
required: false,
|
|
3893
|
-
valueKind: '
|
|
5388
|
+
valueKind: 'string',
|
|
3894
5389
|
repeatable: false,
|
|
3895
5390
|
},
|
|
3896
5391
|
{
|
|
3897
|
-
name: '
|
|
3898
|
-
path: ['
|
|
5392
|
+
name: 'include-system',
|
|
5393
|
+
path: ['includeSystem'],
|
|
3899
5394
|
location: 'query',
|
|
3900
5395
|
required: false,
|
|
3901
|
-
valueKind: '
|
|
5396
|
+
valueKind: 'string',
|
|
5397
|
+
enumValues: ['true', 'false'],
|
|
3902
5398
|
repeatable: false,
|
|
3903
5399
|
},
|
|
3904
5400
|
],
|
|
@@ -3910,229 +5406,136 @@ exports.COMMANDS = [
|
|
|
3910
5406
|
requiresAuth: true,
|
|
3911
5407
|
},
|
|
3912
5408
|
{
|
|
3913
|
-
commandPath: ['customer-
|
|
3914
|
-
clientProperty: '
|
|
3915
|
-
methodName: '
|
|
3916
|
-
httpMethod: '
|
|
3917
|
-
httpPath: '/v1/customer-
|
|
3918
|
-
summary: '
|
|
3919
|
-
description:
|
|
3920
|
-
positionals: [
|
|
3921
|
-
{
|
|
3922
|
-
name: 'customer-profile-id',
|
|
3923
|
-
paramKey: 'customerProfileId',
|
|
3924
|
-
},
|
|
3925
|
-
],
|
|
3926
|
-
flags: [],
|
|
3927
|
-
hasParams: false,
|
|
3928
|
-
paramsAllOptional: true,
|
|
3929
|
-
bodyOpaque: false,
|
|
3930
|
-
bodyVariants: [],
|
|
3931
|
-
acceptsBody: false,
|
|
3932
|
-
requiresAuth: true,
|
|
3933
|
-
},
|
|
3934
|
-
{
|
|
3935
|
-
commandPath: ['customer-profile', 'get'],
|
|
3936
|
-
clientProperty: 'customerProfile',
|
|
3937
|
-
methodName: 'getByID',
|
|
3938
|
-
httpMethod: 'get',
|
|
3939
|
-
httpPath: '/v1/customer-profile/{customerProfileId}',
|
|
3940
|
-
summary: 'Get a customer profile',
|
|
3941
|
-
description: 'Get a customer profile',
|
|
5409
|
+
commandPath: ['customer-flow', 'update'],
|
|
5410
|
+
clientProperty: 'customerFlow',
|
|
5411
|
+
methodName: 'update',
|
|
5412
|
+
httpMethod: 'put',
|
|
5413
|
+
httpPath: '/v1/customer-flow/{flowId}',
|
|
5414
|
+
summary: 'Update a customer flow',
|
|
5415
|
+
description: "Updates a flow's title, description, branching mode, linked agents, flow-level expectations or folder. The step graph is replaced through PUT /graph.",
|
|
3942
5416
|
positionals: [
|
|
3943
5417
|
{
|
|
3944
|
-
name: '
|
|
3945
|
-
paramKey: '
|
|
5418
|
+
name: 'flow-id',
|
|
5419
|
+
paramKey: 'flowId',
|
|
3946
5420
|
},
|
|
3947
5421
|
],
|
|
3948
|
-
flags: [],
|
|
3949
|
-
hasParams: false,
|
|
3950
|
-
paramsAllOptional: true,
|
|
3951
|
-
bodyOpaque: false,
|
|
3952
|
-
bodyVariants: [],
|
|
3953
|
-
acceptsBody: false,
|
|
3954
|
-
requiresAuth: true,
|
|
3955
|
-
},
|
|
3956
|
-
{
|
|
3957
|
-
commandPath: ['customer-profile', 'list'],
|
|
3958
|
-
clientProperty: 'customerProfile',
|
|
3959
|
-
methodName: 'list',
|
|
3960
|
-
httpMethod: 'get',
|
|
3961
|
-
httpPath: '/v1/customer-profile',
|
|
3962
|
-
summary: 'List customer profiles',
|
|
3963
|
-
description: 'Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.',
|
|
3964
|
-
positionals: [],
|
|
3965
5422
|
flags: [
|
|
3966
5423
|
{
|
|
3967
|
-
name: '
|
|
3968
|
-
path: ['
|
|
3969
|
-
location: '
|
|
3970
|
-
required: false,
|
|
3971
|
-
valueKind: 'integer',
|
|
3972
|
-
repeatable: false,
|
|
3973
|
-
},
|
|
3974
|
-
{
|
|
3975
|
-
name: 'page',
|
|
3976
|
-
path: ['page'],
|
|
3977
|
-
location: 'query',
|
|
5424
|
+
name: 'title',
|
|
5425
|
+
path: ['title'],
|
|
5426
|
+
location: 'body',
|
|
3978
5427
|
required: false,
|
|
3979
|
-
valueKind: '
|
|
5428
|
+
valueKind: 'string',
|
|
3980
5429
|
repeatable: false,
|
|
3981
5430
|
},
|
|
3982
5431
|
{
|
|
3983
|
-
name: '
|
|
3984
|
-
path: ['
|
|
3985
|
-
location: '
|
|
5432
|
+
name: 'description',
|
|
5433
|
+
path: ['description'],
|
|
5434
|
+
location: 'body',
|
|
3986
5435
|
required: false,
|
|
3987
5436
|
valueKind: 'string',
|
|
3988
5437
|
repeatable: false,
|
|
3989
5438
|
},
|
|
3990
5439
|
{
|
|
3991
|
-
name: '
|
|
3992
|
-
path: ['
|
|
3993
|
-
location: '
|
|
5440
|
+
name: 'script-adherence',
|
|
5441
|
+
path: ['scriptAdherence'],
|
|
5442
|
+
location: 'body',
|
|
3994
5443
|
required: false,
|
|
5444
|
+
description: 'Scripted flows only. How closely a run follows the script. LOOSE (default) hands the whole script to the simulated customer as one prompt; it keeps the call moving whatever your agent says. STRICT runs the script as a state machine on the agent service: at every agent step the simulated customer waits, silent, until your agent has said the expected line, and only then moves on. Scripted flows only; STRICT needs the agent-service transport and is not available on realtime models.',
|
|
3995
5445
|
valueKind: 'string',
|
|
5446
|
+
enumValues: ['LOOSE', 'STRICT'],
|
|
3996
5447
|
repeatable: false,
|
|
3997
5448
|
},
|
|
3998
5449
|
{
|
|
3999
|
-
name: '
|
|
4000
|
-
path: ['
|
|
4001
|
-
location: '
|
|
5450
|
+
name: 'off-script-policy',
|
|
5451
|
+
path: ['offScriptPolicy'],
|
|
5452
|
+
location: 'body',
|
|
4002
5453
|
required: false,
|
|
5454
|
+
description: 'STRICT only. What the simulated customer does when your agent does not say the expected line. Each unmatched agent utterance is an attempt: `reaction` runs per attempt (STAY_SILENT, REPEAT its last scripted line, RESPOND once in character without moving on, or SAY `sayLine`), and `then` runs when attempts reach `maxAttempts` or your agent stays silent for `waitSeconds` (HANG_UP ends the call with ended reason SCRIPT_DIVERGED, HANG_UP_INVALIDATE ends it the same way and invalidates the run so it is scored by nothing and counted nowhere, MOVE_ON advances anyway, ADAPT hands the rest of the call to loose behaviour). Null: stay silent, 3 attempts, hang up. The default for every agent step; an AGENT_TURN step can carry its own.',
|
|
5455
|
+
valueKind: 'object',
|
|
5456
|
+
},
|
|
5457
|
+
{
|
|
5458
|
+
name: 'off-script-policy.reaction',
|
|
5459
|
+
path: ['offScriptPolicy', 'reaction'],
|
|
5460
|
+
location: 'body',
|
|
5461
|
+
required: true,
|
|
4003
5462
|
valueKind: 'string',
|
|
4004
|
-
enumValues: ['
|
|
5463
|
+
enumValues: ['STAY_SILENT', 'REPEAT', 'RESPOND', 'SAY'],
|
|
4005
5464
|
repeatable: false,
|
|
4006
5465
|
},
|
|
4007
5466
|
{
|
|
4008
|
-
name: '
|
|
4009
|
-
path: ['
|
|
4010
|
-
location: '
|
|
5467
|
+
name: 'off-script-policy.say-line',
|
|
5468
|
+
path: ['offScriptPolicy', 'sayLine'],
|
|
5469
|
+
location: 'body',
|
|
4011
5470
|
required: false,
|
|
4012
|
-
description: 'Include customers we hold nothing about beyond their identifier. Defaults to false.',
|
|
4013
5471
|
valueKind: 'string',
|
|
4014
|
-
enumValues: ['true', 'false'],
|
|
4015
5472
|
repeatable: false,
|
|
4016
5473
|
},
|
|
4017
5474
|
{
|
|
4018
|
-
name: '
|
|
4019
|
-
path: ['
|
|
4020
|
-
location: '
|
|
4021
|
-
required:
|
|
4022
|
-
|
|
4023
|
-
valueKind: 'string',
|
|
4024
|
-
enumValues: [
|
|
4025
|
-
'lastSeenAt',
|
|
4026
|
-
'firstSeenAt',
|
|
4027
|
-
'conversationCount',
|
|
4028
|
-
'voiceCount',
|
|
4029
|
-
'chatCount',
|
|
4030
|
-
'talkTimeMs',
|
|
4031
|
-
'displayName',
|
|
4032
|
-
'field.FULL_NAME',
|
|
4033
|
-
'field.PREFERRED_NAME',
|
|
4034
|
-
'field.ACCOUNT_ID',
|
|
4035
|
-
'field.COMPANY',
|
|
4036
|
-
'field.JOB_TITLE',
|
|
4037
|
-
'field.EMAIL',
|
|
4038
|
-
'field.ALTERNATE_PHONE',
|
|
4039
|
-
'field.AGE',
|
|
4040
|
-
'field.GENDER',
|
|
4041
|
-
'field.LANGUAGE',
|
|
4042
|
-
'field.LOCATION',
|
|
4043
|
-
'field.TIMEZONE',
|
|
4044
|
-
'field.BEST_TIME_TO_REACH',
|
|
4045
|
-
'field.PREFERRED_CHANNEL',
|
|
4046
|
-
],
|
|
5475
|
+
name: 'off-script-policy.max-attempts',
|
|
5476
|
+
path: ['offScriptPolicy', 'maxAttempts'],
|
|
5477
|
+
location: 'body',
|
|
5478
|
+
required: true,
|
|
5479
|
+
valueKind: 'integer',
|
|
4047
5480
|
repeatable: false,
|
|
4048
5481
|
},
|
|
4049
5482
|
{
|
|
4050
|
-
name: '
|
|
4051
|
-
path: ['
|
|
4052
|
-
location: '
|
|
4053
|
-
required:
|
|
5483
|
+
name: 'off-script-policy.then',
|
|
5484
|
+
path: ['offScriptPolicy', 'then'],
|
|
5485
|
+
location: 'body',
|
|
5486
|
+
required: true,
|
|
4054
5487
|
valueKind: 'string',
|
|
4055
|
-
enumValues: ['
|
|
5488
|
+
enumValues: ['HANG_UP', 'MOVE_ON', 'ADAPT', 'HANG_UP_INVALIDATE'],
|
|
4056
5489
|
repeatable: false,
|
|
4057
5490
|
},
|
|
4058
5491
|
{
|
|
4059
|
-
name: '
|
|
4060
|
-
path: ['
|
|
4061
|
-
location: '
|
|
5492
|
+
name: 'off-script-policy.wait-seconds',
|
|
5493
|
+
path: ['offScriptPolicy', 'waitSeconds'],
|
|
5494
|
+
location: 'body',
|
|
4062
5495
|
required: false,
|
|
4063
|
-
|
|
4064
|
-
valueKind: 'string',
|
|
4065
|
-
enumValues: [
|
|
4066
|
-
'FULL_NAME',
|
|
4067
|
-
'PREFERRED_NAME',
|
|
4068
|
-
'ACCOUNT_ID',
|
|
4069
|
-
'COMPANY',
|
|
4070
|
-
'JOB_TITLE',
|
|
4071
|
-
'EMAIL',
|
|
4072
|
-
'ALTERNATE_PHONE',
|
|
4073
|
-
'AGE',
|
|
4074
|
-
'GENDER',
|
|
4075
|
-
'LANGUAGE',
|
|
4076
|
-
'LOCATION',
|
|
4077
|
-
'TIMEZONE',
|
|
4078
|
-
'BEST_TIME_TO_REACH',
|
|
4079
|
-
'PREFERRED_CHANNEL',
|
|
4080
|
-
],
|
|
5496
|
+
valueKind: 'integer',
|
|
4081
5497
|
repeatable: false,
|
|
4082
5498
|
},
|
|
4083
5499
|
{
|
|
4084
|
-
name: '
|
|
4085
|
-
path: ['
|
|
4086
|
-
location: '
|
|
5500
|
+
name: 'branching-mode',
|
|
5501
|
+
path: ['branchingMode'],
|
|
5502
|
+
location: 'body',
|
|
4087
5503
|
required: false,
|
|
4088
|
-
description: 'How
|
|
5504
|
+
description: 'Scripted flows only. How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app) places one call per variant, each following its path exactly whatever the agent says. ADAPTIVE ("Adapt to your agent") collapses the paths into one call PER PERSONA, on which the simulated customer picks a branch from what the agent actually said. Both modes speak the exact authored lines, and neither changes how metrics or expectations grade.',
|
|
4089
5505
|
valueKind: 'string',
|
|
4090
|
-
enumValues: ['
|
|
5506
|
+
enumValues: ['DETERMINISTIC', 'ADAPTIVE'],
|
|
4091
5507
|
repeatable: false,
|
|
4092
5508
|
},
|
|
4093
5509
|
{
|
|
4094
|
-
name: '
|
|
4095
|
-
path: ['
|
|
4096
|
-
location: '
|
|
5510
|
+
name: 'agent-ids',
|
|
5511
|
+
path: ['agentIds'],
|
|
5512
|
+
location: 'body',
|
|
4097
5513
|
required: false,
|
|
4098
|
-
|
|
4099
|
-
|
|
5514
|
+
description: 'Replaces the linked agents. Omit to leave them unchanged. An improv flow must keep at least one; a scripted flow can be left with none.',
|
|
5515
|
+
valueKind: 'array',
|
|
5516
|
+
repeatable: true,
|
|
4100
5517
|
},
|
|
4101
|
-
],
|
|
4102
|
-
hasParams: true,
|
|
4103
|
-
paramsAllOptional: true,
|
|
4104
|
-
bodyOpaque: false,
|
|
4105
|
-
bodyVariants: [],
|
|
4106
|
-
acceptsBody: false,
|
|
4107
|
-
requiresAuth: true,
|
|
4108
|
-
},
|
|
4109
|
-
{
|
|
4110
|
-
commandPath: ['customer-profile', 'notes', 'update'],
|
|
4111
|
-
clientProperty: 'customerProfile',
|
|
4112
|
-
methodName: 'updateNotes',
|
|
4113
|
-
httpMethod: 'put',
|
|
4114
|
-
httpPath: '/v1/customer-profile/{customerProfileId}/notes',
|
|
4115
|
-
summary: 'Update the notes on a customer profile',
|
|
4116
|
-
description: "Replaces your team's shared notes. Null or empty clears them. The last save wins.",
|
|
4117
|
-
positionals: [
|
|
4118
5518
|
{
|
|
4119
|
-
name: '
|
|
4120
|
-
|
|
5519
|
+
name: 'agent-expectations',
|
|
5520
|
+
path: ['agentExpectations'],
|
|
5521
|
+
location: 'body',
|
|
5522
|
+
required: false,
|
|
5523
|
+
description: 'Replaces the flow-level expectations. Omit to leave them unchanged.',
|
|
5524
|
+
valueKind: 'array',
|
|
5525
|
+
repeatable: false,
|
|
4121
5526
|
},
|
|
4122
|
-
],
|
|
4123
|
-
flags: [
|
|
4124
5527
|
{
|
|
4125
|
-
name: '
|
|
4126
|
-
path: ['
|
|
5528
|
+
name: 'folder-id',
|
|
5529
|
+
path: ['folderId'],
|
|
4127
5530
|
location: 'body',
|
|
4128
|
-
required:
|
|
4129
|
-
description: '
|
|
5531
|
+
required: false,
|
|
5532
|
+
description: 'Moves the flow into this folder. Null takes it out of its folder; omit to leave it where it is.',
|
|
4130
5533
|
valueKind: 'string',
|
|
4131
5534
|
repeatable: false,
|
|
4132
5535
|
},
|
|
4133
5536
|
],
|
|
4134
5537
|
hasParams: true,
|
|
4135
|
-
paramsAllOptional:
|
|
5538
|
+
paramsAllOptional: true,
|
|
4136
5539
|
bodyOpaque: false,
|
|
4137
5540
|
bodyVariants: [],
|
|
4138
5541
|
acceptsBody: true,
|
|
@@ -4308,7 +5711,7 @@ exports.COMMANDS = [
|
|
|
4308
5711
|
httpMethod: 'get',
|
|
4309
5712
|
httpPath: '/v1/dashboard',
|
|
4310
5713
|
summary: 'List dashboards',
|
|
4311
|
-
description: "Lists the project's dashboards, the default first. GET /v1/dashboard/{dashboardId} returns the widgets.",
|
|
5714
|
+
description: "Lists the project's dashboards, the default first. `GET /v1/dashboard/{dashboardId}` returns the widgets.",
|
|
4312
5715
|
positionals: [],
|
|
4313
5716
|
flags: [],
|
|
4314
5717
|
hasParams: false,
|
|
@@ -4325,7 +5728,7 @@ exports.COMMANDS = [
|
|
|
4325
5728
|
httpMethod: 'put',
|
|
4326
5729
|
httpPath: '/v1/dashboard/{dashboardId}',
|
|
4327
5730
|
summary: 'Update a dashboard',
|
|
4328
|
-
description: 'Edits a dashboard. Omitted fields keep their current value. `widgets`, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, PUT /v1/dashboard/{dashboardId}/widget/{widgetId}
|
|
5731
|
+
description: 'Edits a dashboard. Omitted fields keep their current value. `widgets`, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, `PUT /v1/dashboard/{dashboardId}/widget/{widgetId}`.',
|
|
4329
5732
|
positionals: [
|
|
4330
5733
|
{
|
|
4331
5734
|
name: 'dashboard-id',
|
|
@@ -4717,7 +6120,7 @@ exports.COMMANDS = [
|
|
|
4717
6120
|
methodName: 'create',
|
|
4718
6121
|
httpMethod: 'post',
|
|
4719
6122
|
httpPath: '/v1/http-request-definition',
|
|
4720
|
-
summary: 'Create HTTP request definition',
|
|
6123
|
+
summary: 'Create an HTTP request definition',
|
|
4721
6124
|
description: 'Creates a new HTTP request definition. The signing secret is only returned in this response and cannot be retrieved later.',
|
|
4722
6125
|
positionals: [],
|
|
4723
6126
|
flags: [
|
|
@@ -4791,7 +6194,7 @@ exports.COMMANDS = [
|
|
|
4791
6194
|
methodName: 'getByID',
|
|
4792
6195
|
httpMethod: 'get',
|
|
4793
6196
|
httpPath: '/v1/http-request-definition/{definitionId}',
|
|
4794
|
-
summary: 'Get HTTP request definition
|
|
6197
|
+
summary: 'Get an HTTP request definition',
|
|
4795
6198
|
description: 'Returns a specific HTTP request definition by its ID.',
|
|
4796
6199
|
positionals: [
|
|
4797
6200
|
{
|
|
@@ -4850,7 +6253,7 @@ exports.COMMANDS = [
|
|
|
4850
6253
|
methodName: 'update',
|
|
4851
6254
|
httpMethod: 'put',
|
|
4852
6255
|
httpPath: '/v1/http-request-definition/{definitionId}',
|
|
4853
|
-
summary: 'Update HTTP request definition',
|
|
6256
|
+
summary: 'Update an HTTP request definition',
|
|
4854
6257
|
description: 'Updates an existing HTTP request definition.',
|
|
4855
6258
|
positionals: [
|
|
4856
6259
|
{
|
|
@@ -5465,7 +6868,7 @@ exports.COMMANDS = [
|
|
|
5465
6868
|
methodName: 'getByID',
|
|
5466
6869
|
httpMethod: 'get',
|
|
5467
6870
|
httpPath: '/v1/metric/collection-jobs/{jobId}',
|
|
5468
|
-
summary: 'Get metric collection job
|
|
6871
|
+
summary: 'Get a metric collection job',
|
|
5469
6872
|
description: 'Returns a specific metric collection job with progress information.',
|
|
5470
6873
|
positionals: [
|
|
5471
6874
|
{
|
|
@@ -5534,7 +6937,7 @@ exports.COMMANDS = [
|
|
|
5534
6937
|
methodName: 'createDefinition',
|
|
5535
6938
|
httpMethod: 'post',
|
|
5536
6939
|
httpPath: '/v1/metric/definitions',
|
|
5537
|
-
summary: 'Create
|
|
6940
|
+
summary: 'Create a metric definition',
|
|
5538
6941
|
description: 'Create a new metric definition. The `calculationType` field selects the variant: LLM_JUDGE (LLM-evaluated), FORMULA (computed from a math expression over other metrics), or PATTERN (detects a trigger→outcome pattern within a window). To create a threshold on top of an existing metric, use `POST /metric/definitions/{idOrSlug}/thresholds` instead.',
|
|
5539
6942
|
positionals: [],
|
|
5540
6943
|
flags: [],
|
|
@@ -5626,7 +7029,7 @@ exports.COMMANDS = [
|
|
|
5626
7029
|
path: ['llmPrompt'],
|
|
5627
7030
|
location: 'body',
|
|
5628
7031
|
required: false,
|
|
5629
|
-
description: 'New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable)',
|
|
7032
|
+
description: 'New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable). A custom metric prompt must include a transcript variable such as `{{transcript}}` and `{{world_context}}`, which gives the judge the current date and time when it grades.',
|
|
5630
7033
|
valueKind: 'string',
|
|
5631
7034
|
repeatable: false,
|
|
5632
7035
|
},
|
|
@@ -5923,9 +7326,9 @@ exports.COMMANDS = [
|
|
|
5923
7326
|
path: ['modality'],
|
|
5924
7327
|
location: 'body',
|
|
5925
7328
|
required: true,
|
|
5926
|
-
description: 'Modality this policy targets. A policy fires for exactly one modality and can only reference metrics that support that modality.',
|
|
7329
|
+
description: 'Modality this policy targets: `voice` or `chat` (`call` is still accepted for `voice`). A policy fires for exactly one modality and can only reference metrics that support that modality.',
|
|
5927
7330
|
valueKind: 'string',
|
|
5928
|
-
enumValues: ['
|
|
7331
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
5929
7332
|
repeatable: false,
|
|
5930
7333
|
},
|
|
5931
7334
|
{
|
|
@@ -5983,7 +7386,7 @@ exports.COMMANDS = [
|
|
|
5983
7386
|
methodName: 'getByID',
|
|
5984
7387
|
httpMethod: 'get',
|
|
5985
7388
|
httpPath: '/v1/metric/policies/{policyId}',
|
|
5986
|
-
summary: 'Get metric policy
|
|
7389
|
+
summary: 'Get a metric policy',
|
|
5987
7390
|
description: 'Returns a specific metric policy with its conditions and metrics.',
|
|
5988
7391
|
positionals: [
|
|
5989
7392
|
{
|
|
@@ -6202,7 +7605,7 @@ exports.COMMANDS = [
|
|
|
6202
7605
|
methodName: 'list',
|
|
6203
7606
|
httpMethod: 'get',
|
|
6204
7607
|
httpPath: '/v1/metric/definitions/{idOrSlug}/variants',
|
|
6205
|
-
summary:
|
|
7608
|
+
summary: "List a metric's variants",
|
|
6206
7609
|
description: 'Every configuration of this metric your organization can use: Roark’s own variants and any your organization has added or forked. `isDefault` marks the one the metric is scored with when nothing pins another; pass any variant’s `id` as `sourceVariantId` to pin it on a derived metric. Auto-managed variants (the ones a package materializes for you) are not listed: they are engine state, not configuration you author.',
|
|
6207
7610
|
positionals: [
|
|
6208
7611
|
{
|
|
@@ -6254,7 +7657,7 @@ exports.COMMANDS = [
|
|
|
6254
7657
|
path: ['llmPrompt'],
|
|
6255
7658
|
location: 'body',
|
|
6256
7659
|
required: false,
|
|
6257
|
-
description: 'The rubric this variant applies. LLM judge metrics only.',
|
|
7660
|
+
description: 'The rubric this variant applies. LLM judge metrics only. A custom metric prompt must include a transcript variable such as `{{transcript}}` and `{{world_context}}`, which gives the judge the current date and time when it grades.',
|
|
6258
7661
|
valueKind: 'string',
|
|
6259
7662
|
repeatable: false,
|
|
6260
7663
|
},
|
|
@@ -6626,7 +8029,7 @@ exports.COMMANDS = [
|
|
|
6626
8029
|
methodName: 'list',
|
|
6627
8030
|
httpMethod: 'get',
|
|
6628
8031
|
httpPath: '/v1/projects',
|
|
6629
|
-
summary: 'List projects
|
|
8032
|
+
summary: 'List accessible projects',
|
|
6630
8033
|
description: 'Returns every project the calling credential may act on, with the permissions it holds in each. A project-scoped API key returns the single project it is bound to. A user-scoped credential returns the projects in its organization where the holder is an active member. Use the returned id in the X-Roark-Project-Id header.',
|
|
6631
8034
|
positionals: [],
|
|
6632
8035
|
flags: [],
|
|
@@ -6714,6 +8117,42 @@ exports.COMMANDS = [
|
|
|
6714
8117
|
valueKind: 'number',
|
|
6715
8118
|
repeatable: false,
|
|
6716
8119
|
},
|
|
8120
|
+
{
|
|
8121
|
+
name: 'line-quality',
|
|
8122
|
+
path: ['lineQuality'],
|
|
8123
|
+
location: 'body',
|
|
8124
|
+
required: false,
|
|
8125
|
+
description: 'The phone line the simulated caller is on: packet loss applied to its 20 ms audio packets, per direction. The loss pattern is seeded per call, so a redial loses the same packets. CLEAR: No loss. MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways. ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM: the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with a mean burst of up to 10 packets (omit it for random loss). Defaults to CLEAR.',
|
|
8126
|
+
valueKind: 'string',
|
|
8127
|
+
enumValues: ['CLEAR', 'MINOR_LOSS', 'CELL_EDGE', 'POOR_CONNECTION', 'ONE_WAY_DEGRADED', 'CUSTOM'],
|
|
8128
|
+
repeatable: false,
|
|
8129
|
+
},
|
|
8130
|
+
{
|
|
8131
|
+
name: 'line-custom',
|
|
8132
|
+
path: ['lineCustom'],
|
|
8133
|
+
location: 'body',
|
|
8134
|
+
required: false,
|
|
8135
|
+
description: 'The per-direction loss of a CUSTOM line.',
|
|
8136
|
+
valueKind: 'object',
|
|
8137
|
+
},
|
|
8138
|
+
{
|
|
8139
|
+
name: 'line-custom.to-agent',
|
|
8140
|
+
path: ['lineCustom', 'toAgent'],
|
|
8141
|
+
location: 'body',
|
|
8142
|
+
required: false,
|
|
8143
|
+
description: "The caller's audio on its way to the agent: what the agent hears. Omit for no loss.",
|
|
8144
|
+
valueKind: 'object',
|
|
8145
|
+
repeatable: false,
|
|
8146
|
+
},
|
|
8147
|
+
{
|
|
8148
|
+
name: 'line-custom.from-agent',
|
|
8149
|
+
path: ['lineCustom', 'fromAgent'],
|
|
8150
|
+
location: 'body',
|
|
8151
|
+
required: false,
|
|
8152
|
+
description: "The agent's audio on its way to the caller: what the caller hears. Omit for no loss.",
|
|
8153
|
+
valueKind: 'object',
|
|
8154
|
+
repeatable: false,
|
|
8155
|
+
},
|
|
6717
8156
|
],
|
|
6718
8157
|
hasParams: true,
|
|
6719
8158
|
paramsAllOptional: false,
|
|
@@ -6750,7 +8189,7 @@ exports.COMMANDS = [
|
|
|
6750
8189
|
methodName: 'getByID',
|
|
6751
8190
|
httpMethod: 'get',
|
|
6752
8191
|
httpPath: '/v1/simulation/environment/{environmentId}',
|
|
6753
|
-
summary: 'Get environment
|
|
8192
|
+
summary: 'Get an environment',
|
|
6754
8193
|
description: 'Returns a single environment by its ID.',
|
|
6755
8194
|
positionals: [
|
|
6756
8195
|
{
|
|
@@ -6865,6 +8304,42 @@ exports.COMMANDS = [
|
|
|
6865
8304
|
valueKind: 'number',
|
|
6866
8305
|
repeatable: false,
|
|
6867
8306
|
},
|
|
8307
|
+
{
|
|
8308
|
+
name: 'line-quality',
|
|
8309
|
+
path: ['lineQuality'],
|
|
8310
|
+
location: 'body',
|
|
8311
|
+
required: false,
|
|
8312
|
+
description: 'The phone line the simulated caller is on: packet loss applied to its 20 ms audio packets, per direction. The loss pattern is seeded per call, so a redial loses the same packets. CLEAR: No loss. MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways. ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM: the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with a mean burst of up to 10 packets (omit it for random loss). Defaults to CLEAR.',
|
|
8313
|
+
valueKind: 'string',
|
|
8314
|
+
enumValues: ['CLEAR', 'MINOR_LOSS', 'CELL_EDGE', 'POOR_CONNECTION', 'ONE_WAY_DEGRADED', 'CUSTOM'],
|
|
8315
|
+
repeatable: false,
|
|
8316
|
+
},
|
|
8317
|
+
{
|
|
8318
|
+
name: 'line-custom',
|
|
8319
|
+
path: ['lineCustom'],
|
|
8320
|
+
location: 'body',
|
|
8321
|
+
required: false,
|
|
8322
|
+
description: 'The per-direction loss of a CUSTOM line.',
|
|
8323
|
+
valueKind: 'object',
|
|
8324
|
+
},
|
|
8325
|
+
{
|
|
8326
|
+
name: 'line-custom.to-agent',
|
|
8327
|
+
path: ['lineCustom', 'toAgent'],
|
|
8328
|
+
location: 'body',
|
|
8329
|
+
required: false,
|
|
8330
|
+
description: "The caller's audio on its way to the agent: what the agent hears. Omit for no loss.",
|
|
8331
|
+
valueKind: 'object',
|
|
8332
|
+
repeatable: false,
|
|
8333
|
+
},
|
|
8334
|
+
{
|
|
8335
|
+
name: 'line-custom.from-agent',
|
|
8336
|
+
path: ['lineCustom', 'fromAgent'],
|
|
8337
|
+
location: 'body',
|
|
8338
|
+
required: false,
|
|
8339
|
+
description: "The agent's audio on its way to the caller: what the caller hears. Omit for no loss.",
|
|
8340
|
+
valueKind: 'object',
|
|
8341
|
+
repeatable: false,
|
|
8342
|
+
},
|
|
6868
8343
|
],
|
|
6869
8344
|
hasParams: true,
|
|
6870
8345
|
paramsAllOptional: true,
|
|
@@ -6879,8 +8354,8 @@ exports.COMMANDS = [
|
|
|
6879
8354
|
methodName: 'create',
|
|
6880
8355
|
httpMethod: 'post',
|
|
6881
8356
|
httpPath: '/v1/simulation/group',
|
|
6882
|
-
summary: 'Create a
|
|
6883
|
-
description: 'Saves a named set of plans to run together, again and again. Nothing runs yet: POST /v1/simulation/group/{groupId}/run starts one run of every plan and groups them into a run group with one combined report. Slack channels need Slack connected to the project. Email is on by default.',
|
|
8357
|
+
summary: 'Create a plan group',
|
|
8358
|
+
description: 'Saves a named set of plans to run together, again and again. Nothing runs yet: `POST /v1/simulation/group/{groupId}/run` starts one run of every plan and groups them into a run group with one combined report. Slack channels need Slack connected to the project. Email is on by default.',
|
|
6884
8359
|
positionals: [],
|
|
6885
8360
|
flags: [
|
|
6886
8361
|
{
|
|
@@ -6949,7 +8424,7 @@ exports.COMMANDS = [
|
|
|
6949
8424
|
methodName: 'delete',
|
|
6950
8425
|
httpMethod: 'delete',
|
|
6951
8426
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
6952
|
-
summary: 'Delete a
|
|
8427
|
+
summary: 'Delete a plan group',
|
|
6953
8428
|
description: 'Deletes a saved simulation group and any schedules that run it. Run groups it already started, and their reports, stay. A group managed by config as code returns 409.',
|
|
6954
8429
|
positionals: [
|
|
6955
8430
|
{
|
|
@@ -6972,7 +8447,7 @@ exports.COMMANDS = [
|
|
|
6972
8447
|
methodName: 'getByID',
|
|
6973
8448
|
httpMethod: 'get',
|
|
6974
8449
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
6975
|
-
summary: 'Get a
|
|
8450
|
+
summary: 'Get a plan group',
|
|
6976
8451
|
description: 'Returns a saved simulation group with its plans in run order and notification settings.',
|
|
6977
8452
|
positionals: [
|
|
6978
8453
|
{
|
|
@@ -6995,7 +8470,7 @@ exports.COMMANDS = [
|
|
|
6995
8470
|
methodName: 'list',
|
|
6996
8471
|
httpMethod: 'get',
|
|
6997
8472
|
httpPath: '/v1/simulation/group',
|
|
6998
|
-
summary: 'List
|
|
8473
|
+
summary: 'List plan groups',
|
|
6999
8474
|
description: 'Returns the saved simulation groups in the project, most recently edited first, each with its plans in run order and notification settings.',
|
|
7000
8475
|
positionals: [],
|
|
7001
8476
|
flags: [
|
|
@@ -7031,8 +8506,8 @@ exports.COMMANDS = [
|
|
|
7031
8506
|
methodName: 'run',
|
|
7032
8507
|
httpMethod: 'post',
|
|
7033
8508
|
httpPath: '/v1/simulation/group/{groupId}/run',
|
|
7034
|
-
summary: 'Run a
|
|
7035
|
-
description: "Starts one run of every plan in the group, exactly as POST /v1/simulation/plan/{planId}/job would for each, and groups the runs into a run group whose combined report is announced through the group's notification settings once it is ready. This places real calls. Config-managed groups can be run here too. Returns the run group. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY. If a plan cannot start after others did, the runs that started are still grouped and the 400 names the run group id.",
|
|
8509
|
+
summary: 'Run a plan group',
|
|
8510
|
+
description: "Starts one run of every plan in the group, exactly as `POST /v1/simulation/plan/{planId}/job` would for each, and groups the runs into a run group whose combined report is announced through the group's notification settings once it is ready. This places real calls. Config-managed groups can be run here too. Returns the run group. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY. If a plan cannot start after others did, the runs that started are still grouped and the 400 names the run group id.",
|
|
7036
8511
|
positionals: [
|
|
7037
8512
|
{
|
|
7038
8513
|
name: 'group-id',
|
|
@@ -7054,7 +8529,7 @@ exports.COMMANDS = [
|
|
|
7054
8529
|
methodName: 'update',
|
|
7055
8530
|
httpMethod: 'put',
|
|
7056
8531
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
7057
|
-
summary: 'Update a
|
|
8532
|
+
summary: 'Update a plan group',
|
|
7058
8533
|
description: 'Edits a saved simulation group. Omitted fields keep their current value; `notifications`, when sent, replaces the settings as a whole. Run groups it already started keep theirs. A group managed by config as code (`configManaged: true`) returns 409: change it in the config file.',
|
|
7059
8534
|
positionals: [
|
|
7060
8535
|
{
|
|
@@ -7129,7 +8604,7 @@ exports.COMMANDS = [
|
|
|
7129
8604
|
methodName: 'getByID',
|
|
7130
8605
|
httpMethod: 'get',
|
|
7131
8606
|
httpPath: '/v1/simulation/job/{jobId}',
|
|
7132
|
-
summary: 'Get
|
|
8607
|
+
summary: 'Get a simulated call',
|
|
7133
8608
|
description: 'Get a individual simulation run directly by its ID. This is generally part of a larger simulation run plan job.',
|
|
7134
8609
|
positionals: [
|
|
7135
8610
|
{
|
|
@@ -7152,7 +8627,7 @@ exports.COMMANDS = [
|
|
|
7152
8627
|
methodName: 'lookup',
|
|
7153
8628
|
httpMethod: 'get',
|
|
7154
8629
|
httpPath: '/v1/simulation/job/lookup',
|
|
7155
|
-
summary: '
|
|
8630
|
+
summary: 'Find a simulated call by phone number',
|
|
7156
8631
|
description: 'Find the matching simulation using the number used by the Roark simulation agent.',
|
|
7157
8632
|
positionals: [],
|
|
7158
8633
|
flags: [
|
|
@@ -7211,7 +8686,7 @@ exports.COMMANDS = [
|
|
|
7211
8686
|
methodName: 'create',
|
|
7212
8687
|
httpMethod: 'post',
|
|
7213
8688
|
httpPath: '/v1/persona',
|
|
7214
|
-
summary: 'Create a
|
|
8689
|
+
summary: 'Create a persona',
|
|
7215
8690
|
description: 'Creates a new persona for the authenticated project.',
|
|
7216
8691
|
positionals: [],
|
|
7217
8692
|
flags: [
|
|
@@ -7555,7 +9030,7 @@ exports.COMMANDS = [
|
|
|
7555
9030
|
methodName: 'getByID',
|
|
7556
9031
|
httpMethod: 'get',
|
|
7557
9032
|
httpPath: '/v1/persona/{personaId}',
|
|
7558
|
-
summary: 'Get persona
|
|
9033
|
+
summary: 'Get a persona',
|
|
7559
9034
|
description: 'Returns a specific persona by its ID.',
|
|
7560
9035
|
positionals: [
|
|
7561
9036
|
{
|
|
@@ -7897,7 +9372,7 @@ exports.COMMANDS = [
|
|
|
7897
9372
|
path: ['interruption'],
|
|
7898
9373
|
location: 'body',
|
|
7899
9374
|
required: false,
|
|
7900
|
-
description: 'How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL
|
|
9375
|
+
description: 'How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level.',
|
|
7901
9376
|
valueKind: 'string',
|
|
7902
9377
|
enumValues: ['OFF', 'BACKCHANNEL', 'OCCASIONAL', 'HEAVY'],
|
|
7903
9378
|
repeatable: false,
|
|
@@ -8019,7 +9494,7 @@ exports.COMMANDS = [
|
|
|
8019
9494
|
methodName: 'getByID',
|
|
8020
9495
|
httpMethod: 'get',
|
|
8021
9496
|
httpPath: '/v1/simulation/plan/{planId}',
|
|
8022
|
-
summary: 'Get run plan
|
|
9497
|
+
summary: 'Get a run plan',
|
|
8023
9498
|
description: 'Returns a specific simulation run plan by its ID.',
|
|
8024
9499
|
positionals: [
|
|
8025
9500
|
{
|
|
@@ -8042,7 +9517,7 @@ exports.COMMANDS = [
|
|
|
8042
9517
|
methodName: 'cancel',
|
|
8043
9518
|
httpMethod: 'post',
|
|
8044
9519
|
httpPath: '/v1/simulation/plan/job/{jobId}/cancel',
|
|
8045
|
-
summary: 'Cancel a simulation
|
|
9520
|
+
summary: 'Cancel a simulation run',
|
|
8046
9521
|
description: 'Stops a run that has not finished yet. Already-finished runs are left alone. Intended for CI: when a pipeline is cancelled or superseded, cancelling the run stops it placing calls you no longer need. Safe to call more than once.',
|
|
8047
9522
|
positionals: [
|
|
8048
9523
|
{
|
|
@@ -8065,7 +9540,7 @@ exports.COMMANDS = [
|
|
|
8065
9540
|
methodName: 'getCost',
|
|
8066
9541
|
httpMethod: 'get',
|
|
8067
9542
|
httpPath: '/v1/simulation/plan/job/{jobId}/cost',
|
|
8068
|
-
summary:
|
|
9543
|
+
summary: "Get a simulation run's cost",
|
|
8069
9544
|
description: 'The billable spend for one simulation run (run plan job), split by cost type, with the spend of each simulated call in it. Safe to call while the run is in progress: totals reflect the costs recorded so far. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.',
|
|
8070
9545
|
positionals: [
|
|
8071
9546
|
{
|
|
@@ -8087,7 +9562,7 @@ exports.COMMANDS = [
|
|
|
8087
9562
|
methodName: 'createDebrief',
|
|
8088
9563
|
httpMethod: 'post',
|
|
8089
9564
|
httpPath: '/v1/simulation/plan/job/{jobId}/debrief',
|
|
8090
|
-
summary: 'Generate simulation run debrief',
|
|
9565
|
+
summary: 'Generate a simulation run debrief',
|
|
8091
9566
|
description: 'Request the written debrief for a settled run: executive summary, failure themes and recommendations. Runs with graded calls get one automatically, so this is for regenerating one (`regenerate: true`) or retrying one that failed. Returns immediately. Generation takes a few minutes: poll GET /v1/simulation/plan/job/{jobId}/results until `debrief.status` is READY or FAILED. Without `regenerate`, a debrief that is ready or already being written is returned as-is.',
|
|
8092
9567
|
positionals: [
|
|
8093
9568
|
{
|
|
@@ -8119,7 +9594,7 @@ exports.COMMANDS = [
|
|
|
8119
9594
|
methodName: 'delete',
|
|
8120
9595
|
httpMethod: 'delete',
|
|
8121
9596
|
httpPath: '/v1/simulation/plan/job/{jobId}',
|
|
8122
|
-
summary: 'Delete a simulation
|
|
9597
|
+
summary: 'Delete a simulation run',
|
|
8123
9598
|
description: 'Removes a finished run from the run history (a soft delete). The run stops appearing in run lists, counts and plan run histories, and reading it by ID returns 404. A run that is still in progress is refused with 409: cancel it first.',
|
|
8124
9599
|
positionals: [
|
|
8125
9600
|
{
|
|
@@ -8142,7 +9617,7 @@ exports.COMMANDS = [
|
|
|
8142
9617
|
methodName: 'getByID',
|
|
8143
9618
|
httpMethod: 'get',
|
|
8144
9619
|
httpPath: '/v1/simulation/plan/job/{jobId}',
|
|
8145
|
-
summary: 'Get simulation
|
|
9620
|
+
summary: 'Get a simulation run',
|
|
8146
9621
|
description: 'Retrieve details of a simulation plan job including all associated simulation jobs (calls)',
|
|
8147
9622
|
positionals: [
|
|
8148
9623
|
{
|
|
@@ -8165,7 +9640,7 @@ exports.COMMANDS = [
|
|
|
8165
9640
|
methodName: 'list',
|
|
8166
9641
|
httpMethod: 'get',
|
|
8167
9642
|
httpPath: '/v1/simulation/plan/jobs',
|
|
8168
|
-
summary: 'List simulation
|
|
9643
|
+
summary: 'List simulation runs',
|
|
8169
9644
|
description: 'Returns a paginated list of simulation run plan jobs. Filter by status, plan ID, or label to find specific simulation batches.',
|
|
8170
9645
|
positionals: [],
|
|
8171
9646
|
flags: [
|
|
@@ -8251,7 +9726,7 @@ exports.COMMANDS = [
|
|
|
8251
9726
|
methodName: 'getResults',
|
|
8252
9727
|
httpMethod: 'get',
|
|
8253
9728
|
httpPath: '/v1/simulation/plan/job/{jobId}/results',
|
|
8254
|
-
summary:
|
|
9729
|
+
summary: "Get a simulation run's results",
|
|
8255
9730
|
description: 'Everything the run report shows, in one request: the summary and score, the pass/fail verdict, per-metric aggregates, every simulation with its check results, breakdowns by agent and persona, the comparison against the previous run (or `compareToJobId`), the sweep attribution, and the written debrief with its executive summary, failure themes and recommendations. Safe to call while the run is in progress: counts reflect what has landed so far. `verdict` and `sweepAttribution` stay null until the run ends. The debrief is generated automatically a few minutes after a run with graded calls settles; poll until `debrief.status` is READY, or request one with POST /v1/simulation/plan/job/{jobId}/debrief.',
|
|
8256
9731
|
positionals: [
|
|
8257
9732
|
{
|
|
@@ -8471,6 +9946,24 @@ exports.COMMANDS = [
|
|
|
8471
9946
|
valueKind: 'integer',
|
|
8472
9947
|
repeatable: false,
|
|
8473
9948
|
},
|
|
9949
|
+
{
|
|
9950
|
+
name: 'calls-per-second',
|
|
9951
|
+
path: ['callsPerSecond'],
|
|
9952
|
+
location: 'body',
|
|
9953
|
+
required: false,
|
|
9954
|
+
description: "The most simulations a run starts per second (0.01-10), fractional allowed: 0.2 starts one every 5 seconds. Omitted or `null` starts them as fast as `maxConcurrentJobs` allows. The concurrency limit still applies on top, so a run holds the rate only while calls last under `maxConcurrentJobs` / `callsPerSecond` seconds. A run reports the rate it achieved as `dialRate.achievedCallsPerSecond`. A rate above the project's concurrency limit / 30 is refused with 400: that limit could only hold it with calls under 30 seconds. Send `null` to remove the rate; omit to leave it unchanged.",
|
|
9955
|
+
valueKind: 'number',
|
|
9956
|
+
repeatable: false,
|
|
9957
|
+
},
|
|
9958
|
+
{
|
|
9959
|
+
name: 'ramp-up-seconds',
|
|
9960
|
+
path: ['rampUpSeconds'],
|
|
9961
|
+
location: 'body',
|
|
9962
|
+
required: false,
|
|
9963
|
+
description: 'Seconds over which the rate climbs linearly from 0 to `callsPerSecond` (0-3600). Omitted, `null` or 0 starts at the full rate. Only used with `callsPerSecond`. Send `null` to remove the ramp; omit to leave it unchanged.',
|
|
9964
|
+
valueKind: 'integer',
|
|
9965
|
+
repeatable: false,
|
|
9966
|
+
},
|
|
8474
9967
|
{
|
|
8475
9968
|
name: 'end-call-phrases',
|
|
8476
9969
|
path: ['endCallPhrases'],
|
|
@@ -8589,6 +10082,7 @@ exports.COMMANDS = [
|
|
|
8589
10082
|
'INTENT_CLARITY',
|
|
8590
10083
|
'LANGUAGE',
|
|
8591
10084
|
'INTERRUPTION',
|
|
10085
|
+
'LINE_QUALITY',
|
|
8592
10086
|
'MEMORY_RELIABILITY',
|
|
8593
10087
|
'RESPONSE_TIMING',
|
|
8594
10088
|
'SPEECH_CLARITY',
|
|
@@ -8597,56 +10091,338 @@ exports.COMMANDS = [
|
|
|
8597
10091
|
repeatable: false,
|
|
8598
10092
|
},
|
|
8599
10093
|
{
|
|
8600
|
-
name: 'comparison-baseline',
|
|
8601
|
-
path: ['comparisonBaseline'],
|
|
10094
|
+
name: 'comparison-baseline',
|
|
10095
|
+
path: ['comparisonBaseline'],
|
|
10096
|
+
location: 'body',
|
|
10097
|
+
required: false,
|
|
10098
|
+
description: 'The reference value, shown first in the results. See `POST /v1/simulation/plan`. A real value cannot be sent on its own: the property it belongs to decides which values are legal, and an omitted property means "leave unchanged", which this endpoint cannot check a baseline against. Send `comparisonProperty` with it, or get a `400`. `null` on its own IS allowed, and clears just the baseline while leaving the property set. Nothing needs validating when clearing, and a property with no baseline is a real state: the report falls back to that property\'s own norm, and `GENDER` has no norm to fall back to.',
|
|
10099
|
+
valueKind: 'string',
|
|
10100
|
+
repeatable: false,
|
|
10101
|
+
},
|
|
10102
|
+
{
|
|
10103
|
+
name: 'comparison-values',
|
|
10104
|
+
path: ['comparisonValues'],
|
|
10105
|
+
location: 'body',
|
|
10106
|
+
required: false,
|
|
10107
|
+
description: 'The arms to run. See `POST /v1/simulation/plan`. Omitting it keeps the arms the plan already has, pins included, so an edit that only renames the plan never widens a sweep you deliberately narrowed, and never multiplies what it costs. Send it with `comparisonProperty` and `flows`, which the arms are rebuilt from.',
|
|
10108
|
+
valueKind: 'array',
|
|
10109
|
+
repeatable: false,
|
|
10110
|
+
},
|
|
10111
|
+
{
|
|
10112
|
+
name: 'notifications',
|
|
10113
|
+
path: ['notifications'],
|
|
10114
|
+
location: 'body',
|
|
10115
|
+
required: false,
|
|
10116
|
+
description: "Where each run's report announces itself once it is ready.",
|
|
10117
|
+
valueKind: 'object',
|
|
10118
|
+
},
|
|
10119
|
+
{
|
|
10120
|
+
name: 'notifications.email',
|
|
10121
|
+
path: ['notifications', 'email'],
|
|
10122
|
+
location: 'body',
|
|
10123
|
+
required: false,
|
|
10124
|
+
valueKind: 'object',
|
|
10125
|
+
repeatable: false,
|
|
10126
|
+
},
|
|
10127
|
+
{
|
|
10128
|
+
name: 'notifications.slack',
|
|
10129
|
+
path: ['notifications', 'slack'],
|
|
10130
|
+
location: 'body',
|
|
10131
|
+
required: false,
|
|
10132
|
+
description: "Channels in the project's connected Slack workspace to post the report to (at most 10). Slack must be connected to the project first.",
|
|
10133
|
+
valueKind: 'array',
|
|
10134
|
+
repeatable: false,
|
|
10135
|
+
},
|
|
10136
|
+
],
|
|
10137
|
+
hasParams: true,
|
|
10138
|
+
paramsAllOptional: true,
|
|
10139
|
+
bodyOpaque: false,
|
|
10140
|
+
bodyVariants: [],
|
|
10141
|
+
acceptsBody: true,
|
|
10142
|
+
requiresAuth: true,
|
|
10143
|
+
},
|
|
10144
|
+
{
|
|
10145
|
+
commandPath: ['simulation', 'resource', 'generate'],
|
|
10146
|
+
clientProperty: 'simulation',
|
|
10147
|
+
methodName: 'generateResources',
|
|
10148
|
+
httpMethod: 'post',
|
|
10149
|
+
httpPath: '/v1/simulation/generations/resources',
|
|
10150
|
+
summary: 'Generate simulation resources',
|
|
10151
|
+
description: "Works out what to test for an existing agent, then creates the customer flows, metrics and checks to simulate it, and a run plan that runs them. It does not create or change the agent. It also reads the agent's recent production calls and open issues. Run it again and it builds on what earlier generations made, adding only what changed; when nothing has, it finishes straight away and says so. Runs in the background: watch the `simulation.resource_generation.completed` webhook, or poll `GET /v1/simulation/generations/resources/{generationId}`. Takes one agent for now. Refused while another generation for the agent is running. Needs the 'simulation:create' and 'metric:create' permissions. Exploration also needs 'simulation:run', and is turned off for keys without it unless explore.enabled is set.",
|
|
10152
|
+
positionals: [],
|
|
10153
|
+
flags: [
|
|
10154
|
+
{
|
|
10155
|
+
name: 'agent-ids',
|
|
10156
|
+
path: ['agentIds'],
|
|
10157
|
+
location: 'body',
|
|
10158
|
+
required: true,
|
|
10159
|
+
description: 'The agents to generate simulation resources for. One agent per generation for now.',
|
|
10160
|
+
valueKind: 'array',
|
|
10161
|
+
repeatable: true,
|
|
10162
|
+
},
|
|
10163
|
+
{
|
|
10164
|
+
name: 'industry',
|
|
10165
|
+
path: ['industry'],
|
|
10166
|
+
location: 'body',
|
|
10167
|
+
required: false,
|
|
10168
|
+
description: 'The industry the agent serves.',
|
|
10169
|
+
valueKind: 'string',
|
|
10170
|
+
enumValues: [
|
|
10171
|
+
'HEALTHCARE',
|
|
10172
|
+
'FINANCIAL_SERVICES',
|
|
10173
|
+
'INSURANCE',
|
|
10174
|
+
'DEBT_COLLECTION',
|
|
10175
|
+
'RETAIL',
|
|
10176
|
+
'TRAVEL_AND_HOSPITALITY',
|
|
10177
|
+
'TELECOMMUNICATIONS',
|
|
10178
|
+
'TECHNOLOGY',
|
|
10179
|
+
'PUBLIC_SECTOR',
|
|
10180
|
+
'UTILITIES',
|
|
10181
|
+
'LOGISTICS',
|
|
10182
|
+
'AUTOMOTIVE',
|
|
10183
|
+
'HOME_SERVICES',
|
|
10184
|
+
'RESTAURANTS',
|
|
10185
|
+
'EDUCATION',
|
|
10186
|
+
'OTHER',
|
|
10187
|
+
],
|
|
10188
|
+
repeatable: false,
|
|
10189
|
+
},
|
|
10190
|
+
{
|
|
10191
|
+
name: 'website-url',
|
|
10192
|
+
path: ['websiteUrl'],
|
|
10193
|
+
location: 'body',
|
|
10194
|
+
required: false,
|
|
10195
|
+
description: 'A page Roark reads to learn about the business.',
|
|
10196
|
+
valueKind: 'string',
|
|
10197
|
+
repeatable: false,
|
|
10198
|
+
},
|
|
10199
|
+
{
|
|
10200
|
+
name: 'testing-instructions',
|
|
10201
|
+
path: ['testingInstructions'],
|
|
8602
10202
|
location: 'body',
|
|
8603
10203
|
required: false,
|
|
8604
|
-
description: '
|
|
10204
|
+
description: 'What you want tested, in your own words. Each scenario you describe becomes a flow.',
|
|
8605
10205
|
valueKind: 'string',
|
|
8606
10206
|
repeatable: false,
|
|
8607
10207
|
},
|
|
8608
10208
|
{
|
|
8609
|
-
name: '
|
|
8610
|
-
path: ['
|
|
10209
|
+
name: 'capabilities',
|
|
10210
|
+
path: ['capabilities'],
|
|
8611
10211
|
location: 'body',
|
|
8612
10212
|
required: false,
|
|
8613
|
-
description: 'The
|
|
10213
|
+
description: 'The capabilities to test. Omit to let Roark work them out from the agent.',
|
|
8614
10214
|
valueKind: 'array',
|
|
10215
|
+
enumValues: [
|
|
10216
|
+
'APPOINTMENT_BOOKING',
|
|
10217
|
+
'FAQ',
|
|
10218
|
+
'IDENTITY_VERIFICATION',
|
|
10219
|
+
'ACCOUNT_MANAGEMENT',
|
|
10220
|
+
'BILLING_AND_PAYMENTS',
|
|
10221
|
+
'ORDER_MANAGEMENT',
|
|
10222
|
+
'TROUBLESHOOTING',
|
|
10223
|
+
'CALL_ROUTING',
|
|
10224
|
+
'LEAD_QUALIFICATION',
|
|
10225
|
+
'COLLECTIONS',
|
|
10226
|
+
'OUTBOUND_CALLING',
|
|
10227
|
+
],
|
|
10228
|
+
repeatable: true,
|
|
10229
|
+
},
|
|
10230
|
+
{
|
|
10231
|
+
name: 'agent-endpoint-id',
|
|
10232
|
+
path: ['agentEndpointId'],
|
|
10233
|
+
location: 'body',
|
|
10234
|
+
required: false,
|
|
10235
|
+
description: "The endpoint the run plan calls. Defaults to the agent's newest endpoint.",
|
|
10236
|
+
valueKind: 'string',
|
|
8615
10237
|
repeatable: false,
|
|
8616
10238
|
},
|
|
8617
10239
|
{
|
|
8618
|
-
name: '
|
|
8619
|
-
path: ['
|
|
10240
|
+
name: 'explore',
|
|
10241
|
+
path: ['explore'],
|
|
8620
10242
|
location: 'body',
|
|
8621
10243
|
required: false,
|
|
8622
|
-
description:
|
|
10244
|
+
description: 'Exploration settings',
|
|
8623
10245
|
valueKind: 'object',
|
|
8624
10246
|
},
|
|
8625
10247
|
{
|
|
8626
|
-
name: '
|
|
8627
|
-
path: ['
|
|
10248
|
+
name: 'explore.enabled',
|
|
10249
|
+
path: ['explore', 'enabled'],
|
|
8628
10250
|
location: 'body',
|
|
8629
10251
|
required: false,
|
|
8630
|
-
|
|
10252
|
+
description: 'Whether Roark calls the agent to discover what it does before finishing the generation. Exploration calls are billed.',
|
|
10253
|
+
valueKind: 'boolean',
|
|
8631
10254
|
repeatable: false,
|
|
8632
10255
|
},
|
|
8633
10256
|
{
|
|
8634
|
-
name: '
|
|
8635
|
-
path: ['
|
|
10257
|
+
name: 'explore.max-conversations',
|
|
10258
|
+
path: ['explore', 'maxConversations'],
|
|
8636
10259
|
location: 'body',
|
|
8637
10260
|
required: false,
|
|
8638
|
-
description:
|
|
8639
|
-
valueKind: '
|
|
10261
|
+
description: 'The most exploration calls Roark places.',
|
|
10262
|
+
valueKind: 'integer',
|
|
10263
|
+
repeatable: false,
|
|
10264
|
+
},
|
|
10265
|
+
{
|
|
10266
|
+
name: 'explore.max-conversation-minutes',
|
|
10267
|
+
path: ['explore', 'maxConversationMinutes'],
|
|
10268
|
+
location: 'body',
|
|
10269
|
+
required: false,
|
|
10270
|
+
description: 'The longest a single exploration call may last, in minutes.',
|
|
10271
|
+
valueKind: 'integer',
|
|
10272
|
+
repeatable: false,
|
|
10273
|
+
},
|
|
10274
|
+
],
|
|
10275
|
+
hasParams: true,
|
|
10276
|
+
paramsAllOptional: false,
|
|
10277
|
+
bodyOpaque: false,
|
|
10278
|
+
bodyVariants: [],
|
|
10279
|
+
acceptsBody: true,
|
|
10280
|
+
requiresAuth: true,
|
|
10281
|
+
},
|
|
10282
|
+
{
|
|
10283
|
+
commandPath: ['simulation', 'resource-generation', 'answer'],
|
|
10284
|
+
clientProperty: 'simulation',
|
|
10285
|
+
methodName: 'answerResourceGeneration',
|
|
10286
|
+
httpMethod: 'post',
|
|
10287
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/answer',
|
|
10288
|
+
summary: "Answer a simulation resource generation's question",
|
|
10289
|
+
description: 'Answers the question a simulation resource generation is waiting on (status NEEDS_INPUT). If nobody answers within 15 minutes, it goes ahead with its default.',
|
|
10290
|
+
positionals: [
|
|
10291
|
+
{
|
|
10292
|
+
name: 'generation-id',
|
|
10293
|
+
paramKey: 'generationId',
|
|
10294
|
+
},
|
|
10295
|
+
],
|
|
10296
|
+
flags: [
|
|
10297
|
+
{
|
|
10298
|
+
name: 'text',
|
|
10299
|
+
path: ['text'],
|
|
10300
|
+
location: 'body',
|
|
10301
|
+
required: true,
|
|
10302
|
+
description: 'What you want the generation to know',
|
|
10303
|
+
valueKind: 'string',
|
|
8640
10304
|
repeatable: false,
|
|
8641
10305
|
},
|
|
8642
10306
|
],
|
|
8643
10307
|
hasParams: true,
|
|
10308
|
+
paramsAllOptional: false,
|
|
10309
|
+
bodyOpaque: false,
|
|
10310
|
+
bodyVariants: [],
|
|
10311
|
+
acceptsBody: true,
|
|
10312
|
+
requiresAuth: true,
|
|
10313
|
+
},
|
|
10314
|
+
{
|
|
10315
|
+
commandPath: ['simulation', 'resource-generation', 'cancel'],
|
|
10316
|
+
clientProperty: 'simulation',
|
|
10317
|
+
methodName: 'cancelResourceGeneration',
|
|
10318
|
+
httpMethod: 'post',
|
|
10319
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/cancel',
|
|
10320
|
+
summary: 'Cancel a running simulation resource generation',
|
|
10321
|
+
description: 'Stops a running simulation resource generation. Flows and metrics it already created are kept; no run plan is made. Refused once the generation has finished.',
|
|
10322
|
+
positionals: [
|
|
10323
|
+
{
|
|
10324
|
+
name: 'generation-id',
|
|
10325
|
+
paramKey: 'generationId',
|
|
10326
|
+
},
|
|
10327
|
+
],
|
|
10328
|
+
flags: [],
|
|
10329
|
+
hasParams: false,
|
|
10330
|
+
paramsAllOptional: true,
|
|
10331
|
+
bodyOpaque: false,
|
|
10332
|
+
bodyVariants: [],
|
|
10333
|
+
acceptsBody: false,
|
|
10334
|
+
requiresAuth: true,
|
|
10335
|
+
},
|
|
10336
|
+
{
|
|
10337
|
+
commandPath: ['simulation', 'resource-generation', 'get'],
|
|
10338
|
+
clientProperty: 'simulation',
|
|
10339
|
+
methodName: 'getResourceGeneration',
|
|
10340
|
+
httpMethod: 'get',
|
|
10341
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}',
|
|
10342
|
+
summary: 'Get a simulation resource generation',
|
|
10343
|
+
description: 'Returns one simulation resource generation, for example the one a webhook named.',
|
|
10344
|
+
positionals: [
|
|
10345
|
+
{
|
|
10346
|
+
name: 'generation-id',
|
|
10347
|
+
paramKey: 'generationId',
|
|
10348
|
+
},
|
|
10349
|
+
],
|
|
10350
|
+
flags: [],
|
|
10351
|
+
hasParams: false,
|
|
8644
10352
|
paramsAllOptional: true,
|
|
8645
10353
|
bodyOpaque: false,
|
|
8646
10354
|
bodyVariants: [],
|
|
10355
|
+
acceptsBody: false,
|
|
10356
|
+
requiresAuth: true,
|
|
10357
|
+
},
|
|
10358
|
+
{
|
|
10359
|
+
commandPath: ['simulation', 'resource-generation', 'guidance', 'send'],
|
|
10360
|
+
clientProperty: 'simulation',
|
|
10361
|
+
methodName: 'guideResourceGeneration',
|
|
10362
|
+
httpMethod: 'post',
|
|
10363
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/guidance',
|
|
10364
|
+
summary: 'Guide a running simulation resource generation',
|
|
10365
|
+
description: 'Tells a running simulation resource generation what to focus on or avoid, in your own words. It reads it on its next turn and it outranks its own plan. Refused once the generation has finished.',
|
|
10366
|
+
positionals: [
|
|
10367
|
+
{
|
|
10368
|
+
name: 'generation-id',
|
|
10369
|
+
paramKey: 'generationId',
|
|
10370
|
+
},
|
|
10371
|
+
],
|
|
10372
|
+
flags: [
|
|
10373
|
+
{
|
|
10374
|
+
name: 'text',
|
|
10375
|
+
path: ['text'],
|
|
10376
|
+
location: 'body',
|
|
10377
|
+
required: true,
|
|
10378
|
+
description: 'What you want the generation to know',
|
|
10379
|
+
valueKind: 'string',
|
|
10380
|
+
repeatable: false,
|
|
10381
|
+
},
|
|
10382
|
+
],
|
|
10383
|
+
hasParams: true,
|
|
10384
|
+
paramsAllOptional: false,
|
|
10385
|
+
bodyOpaque: false,
|
|
10386
|
+
bodyVariants: [],
|
|
8647
10387
|
acceptsBody: true,
|
|
8648
10388
|
requiresAuth: true,
|
|
8649
10389
|
},
|
|
10390
|
+
{
|
|
10391
|
+
commandPath: ['simulation', 'resource-generation', 'list'],
|
|
10392
|
+
clientProperty: 'simulation',
|
|
10393
|
+
methodName: 'listResourceGenerations',
|
|
10394
|
+
httpMethod: 'get',
|
|
10395
|
+
httpPath: '/v1/simulation/generations/resources',
|
|
10396
|
+
summary: 'List simulation resource generations',
|
|
10397
|
+
description: "Returns the project's simulation resource generations, newest first, optionally only for some agents: each one's progress, the run plan it created, and every flow, metric and check it added or left out, with the reason and the source it came from.",
|
|
10398
|
+
positionals: [],
|
|
10399
|
+
flags: [
|
|
10400
|
+
{
|
|
10401
|
+
name: 'agent-ids',
|
|
10402
|
+
path: ['agentIds'],
|
|
10403
|
+
location: 'query',
|
|
10404
|
+
required: false,
|
|
10405
|
+
description: 'Only generations for these agents, comma-separated, at most 100. Omit for every agent.',
|
|
10406
|
+
valueKind: 'string',
|
|
10407
|
+
repeatable: false,
|
|
10408
|
+
},
|
|
10409
|
+
{
|
|
10410
|
+
name: 'limit',
|
|
10411
|
+
path: ['limit'],
|
|
10412
|
+
location: 'query',
|
|
10413
|
+
required: false,
|
|
10414
|
+
description: 'How many to return, newest first. Default 20, max 50.',
|
|
10415
|
+
valueKind: 'integer',
|
|
10416
|
+
repeatable: false,
|
|
10417
|
+
},
|
|
10418
|
+
],
|
|
10419
|
+
hasParams: true,
|
|
10420
|
+
paramsAllOptional: true,
|
|
10421
|
+
bodyOpaque: false,
|
|
10422
|
+
bodyVariants: [],
|
|
10423
|
+
acceptsBody: false,
|
|
10424
|
+
requiresAuth: true,
|
|
10425
|
+
},
|
|
8650
10426
|
{
|
|
8651
10427
|
commandPath: ['simulation', 'run'],
|
|
8652
10428
|
clientProperty: 'simulation',
|
|
@@ -8779,7 +10555,7 @@ exports.COMMANDS = [
|
|
|
8779
10555
|
httpMethod: 'get',
|
|
8780
10556
|
httpPath: '/v1/simulation/run-group',
|
|
8781
10557
|
summary: 'List run groups',
|
|
8782
|
-
description: 'Returns the run groups in the project, newest first, with their runs and where each group report stands. Read a report document from GET /v1/simulation/run-group/{groupId}
|
|
10558
|
+
description: 'Returns the run groups in the project, newest first, with their runs and where each group report stands. Read a report document from `GET /v1/simulation/run-group/{groupId}`.',
|
|
8783
10559
|
positionals: [],
|
|
8784
10560
|
flags: [
|
|
8785
10561
|
{
|
|
@@ -9077,7 +10853,7 @@ exports.COMMANDS = [
|
|
|
9077
10853
|
httpMethod: 'post',
|
|
9078
10854
|
httpPath: '/v1/tool',
|
|
9079
10855
|
summary: 'Create a tool',
|
|
9080
|
-
description: 'Creates a tool and declares its first version. A tool only recorded from calls under the same name is adopted; one already declared returns 409. Give it a `runtime` for a hosted agent to call your endpoint. Header values are returned on read, so keep secrets out of them.',
|
|
10856
|
+
description: 'Creates a tool and declares its first version. A tool only recorded from calls under the same name is adopted; one already declared returns 409. Give it a `runtime` for a hosted agent to call your endpoint, a `calendar` for it to book on a calendar connected to the project, or `mcp` for it to call a tool on an MCP server connected to the project. Header values are returned on read, so keep secrets out of them.',
|
|
9081
10857
|
positionals: [],
|
|
9082
10858
|
flags: [
|
|
9083
10859
|
{
|
|
@@ -9169,6 +10945,88 @@ exports.COMMANDS = [
|
|
|
9169
10945
|
valueKind: 'object',
|
|
9170
10946
|
repeatable: false,
|
|
9171
10947
|
},
|
|
10948
|
+
{
|
|
10949
|
+
name: 'calendar',
|
|
10950
|
+
path: ['calendar'],
|
|
10951
|
+
location: 'body',
|
|
10952
|
+
required: false,
|
|
10953
|
+
description: 'Makes this a calendar tool, which Roark runs against a connected calendar: it takes no runtime and no inputs. Omit or null for any other tool; on update, omitting it makes the tool an ordinary one.',
|
|
10954
|
+
valueKind: 'object',
|
|
10955
|
+
},
|
|
10956
|
+
{
|
|
10957
|
+
name: 'calendar.calendar-connection-id',
|
|
10958
|
+
path: ['calendar', 'calendarConnectionId'],
|
|
10959
|
+
location: 'body',
|
|
10960
|
+
required: true,
|
|
10961
|
+
valueKind: 'string',
|
|
10962
|
+
repeatable: false,
|
|
10963
|
+
},
|
|
10964
|
+
{
|
|
10965
|
+
name: 'calendar.operation',
|
|
10966
|
+
path: ['calendar', 'operation'],
|
|
10967
|
+
location: 'body',
|
|
10968
|
+
required: true,
|
|
10969
|
+
valueKind: 'string',
|
|
10970
|
+
enumValues: ['CHECK_AVAILABILITY', 'BOOK', 'LOOKUP_BOOKING', 'RESCHEDULE', 'CANCEL', 'LIST_BOOKINGS'],
|
|
10971
|
+
repeatable: false,
|
|
10972
|
+
},
|
|
10973
|
+
{
|
|
10974
|
+
name: 'calendar.appointment-types',
|
|
10975
|
+
path: ['calendar', 'appointmentTypes'],
|
|
10976
|
+
location: 'body',
|
|
10977
|
+
required: true,
|
|
10978
|
+
valueKind: 'array',
|
|
10979
|
+
repeatable: false,
|
|
10980
|
+
},
|
|
10981
|
+
{
|
|
10982
|
+
name: 'calendar.simulate',
|
|
10983
|
+
path: ['calendar', 'simulate'],
|
|
10984
|
+
location: 'body',
|
|
10985
|
+
required: false,
|
|
10986
|
+
valueKind: 'boolean',
|
|
10987
|
+
repeatable: false,
|
|
10988
|
+
},
|
|
10989
|
+
{
|
|
10990
|
+
name: 'calendar.messages',
|
|
10991
|
+
path: ['calendar', 'messages'],
|
|
10992
|
+
location: 'body',
|
|
10993
|
+
required: false,
|
|
10994
|
+
valueKind: 'object',
|
|
10995
|
+
repeatable: false,
|
|
10996
|
+
},
|
|
10997
|
+
{
|
|
10998
|
+
name: 'mcp',
|
|
10999
|
+
path: ['mcp'],
|
|
11000
|
+
location: 'body',
|
|
11001
|
+
required: false,
|
|
11002
|
+
description: "Makes this a tool on one of the project's MCP servers: it takes no runtime, no inputs and no calendar, and the description replaces the server's own. On update, omitting it makes the tool an ordinary one.",
|
|
11003
|
+
valueKind: 'object',
|
|
11004
|
+
},
|
|
11005
|
+
{
|
|
11006
|
+
name: 'mcp.mcp-server-id',
|
|
11007
|
+
path: ['mcp', 'mcpServerId'],
|
|
11008
|
+
location: 'body',
|
|
11009
|
+
required: true,
|
|
11010
|
+
valueKind: 'string',
|
|
11011
|
+
repeatable: false,
|
|
11012
|
+
},
|
|
11013
|
+
{
|
|
11014
|
+
name: 'mcp.tool',
|
|
11015
|
+
path: ['mcp', 'tool'],
|
|
11016
|
+
location: 'body',
|
|
11017
|
+
required: true,
|
|
11018
|
+
description: 'The tool as the server names it',
|
|
11019
|
+
valueKind: 'string',
|
|
11020
|
+
repeatable: false,
|
|
11021
|
+
},
|
|
11022
|
+
{
|
|
11023
|
+
name: 'mcp.messages',
|
|
11024
|
+
path: ['mcp', 'messages'],
|
|
11025
|
+
location: 'body',
|
|
11026
|
+
required: false,
|
|
11027
|
+
valueKind: 'object',
|
|
11028
|
+
repeatable: false,
|
|
11029
|
+
},
|
|
9172
11030
|
],
|
|
9173
11031
|
hasParams: true,
|
|
9174
11032
|
paramsAllOptional: false,
|
|
@@ -9265,7 +11123,7 @@ exports.COMMANDS = [
|
|
|
9265
11123
|
httpMethod: 'put',
|
|
9266
11124
|
httpPath: '/v1/tool/{toolId}',
|
|
9267
11125
|
summary: 'Update a tool',
|
|
9268
|
-
description: 'Replaces the tool: its name, scope, inputs, description, grading hints and
|
|
11126
|
+
description: 'Replaces the tool: its name, scope, inputs, description, grading hints, runtime, calendar and MCP tool. A field left out is cleared, so omitting agentId makes the tool project-wide and omitting calendar or mcp makes it an ordinary tool. A change declares a new version; agent versions pinned to an older one keep it. A tool managed by config-as-code returns 409.',
|
|
9269
11127
|
positionals: [
|
|
9270
11128
|
{
|
|
9271
11129
|
name: 'tool-id',
|
|
@@ -9362,6 +11220,88 @@ exports.COMMANDS = [
|
|
|
9362
11220
|
valueKind: 'object',
|
|
9363
11221
|
repeatable: false,
|
|
9364
11222
|
},
|
|
11223
|
+
{
|
|
11224
|
+
name: 'calendar',
|
|
11225
|
+
path: ['calendar'],
|
|
11226
|
+
location: 'body',
|
|
11227
|
+
required: false,
|
|
11228
|
+
description: 'Makes this a calendar tool, which Roark runs against a connected calendar: it takes no runtime and no inputs. Omit or null for any other tool; on update, omitting it makes the tool an ordinary one.',
|
|
11229
|
+
valueKind: 'object',
|
|
11230
|
+
},
|
|
11231
|
+
{
|
|
11232
|
+
name: 'calendar.calendar-connection-id',
|
|
11233
|
+
path: ['calendar', 'calendarConnectionId'],
|
|
11234
|
+
location: 'body',
|
|
11235
|
+
required: true,
|
|
11236
|
+
valueKind: 'string',
|
|
11237
|
+
repeatable: false,
|
|
11238
|
+
},
|
|
11239
|
+
{
|
|
11240
|
+
name: 'calendar.operation',
|
|
11241
|
+
path: ['calendar', 'operation'],
|
|
11242
|
+
location: 'body',
|
|
11243
|
+
required: true,
|
|
11244
|
+
valueKind: 'string',
|
|
11245
|
+
enumValues: ['CHECK_AVAILABILITY', 'BOOK', 'LOOKUP_BOOKING', 'RESCHEDULE', 'CANCEL', 'LIST_BOOKINGS'],
|
|
11246
|
+
repeatable: false,
|
|
11247
|
+
},
|
|
11248
|
+
{
|
|
11249
|
+
name: 'calendar.appointment-types',
|
|
11250
|
+
path: ['calendar', 'appointmentTypes'],
|
|
11251
|
+
location: 'body',
|
|
11252
|
+
required: true,
|
|
11253
|
+
valueKind: 'array',
|
|
11254
|
+
repeatable: false,
|
|
11255
|
+
},
|
|
11256
|
+
{
|
|
11257
|
+
name: 'calendar.simulate',
|
|
11258
|
+
path: ['calendar', 'simulate'],
|
|
11259
|
+
location: 'body',
|
|
11260
|
+
required: false,
|
|
11261
|
+
valueKind: 'boolean',
|
|
11262
|
+
repeatable: false,
|
|
11263
|
+
},
|
|
11264
|
+
{
|
|
11265
|
+
name: 'calendar.messages',
|
|
11266
|
+
path: ['calendar', 'messages'],
|
|
11267
|
+
location: 'body',
|
|
11268
|
+
required: false,
|
|
11269
|
+
valueKind: 'object',
|
|
11270
|
+
repeatable: false,
|
|
11271
|
+
},
|
|
11272
|
+
{
|
|
11273
|
+
name: 'mcp',
|
|
11274
|
+
path: ['mcp'],
|
|
11275
|
+
location: 'body',
|
|
11276
|
+
required: false,
|
|
11277
|
+
description: "Makes this a tool on one of the project's MCP servers: it takes no runtime, no inputs and no calendar, and the description replaces the server's own. On update, omitting it makes the tool an ordinary one.",
|
|
11278
|
+
valueKind: 'object',
|
|
11279
|
+
},
|
|
11280
|
+
{
|
|
11281
|
+
name: 'mcp.mcp-server-id',
|
|
11282
|
+
path: ['mcp', 'mcpServerId'],
|
|
11283
|
+
location: 'body',
|
|
11284
|
+
required: true,
|
|
11285
|
+
valueKind: 'string',
|
|
11286
|
+
repeatable: false,
|
|
11287
|
+
},
|
|
11288
|
+
{
|
|
11289
|
+
name: 'mcp.tool',
|
|
11290
|
+
path: ['mcp', 'tool'],
|
|
11291
|
+
location: 'body',
|
|
11292
|
+
required: true,
|
|
11293
|
+
description: 'The tool as the server names it',
|
|
11294
|
+
valueKind: 'string',
|
|
11295
|
+
repeatable: false,
|
|
11296
|
+
},
|
|
11297
|
+
{
|
|
11298
|
+
name: 'mcp.messages',
|
|
11299
|
+
path: ['mcp', 'messages'],
|
|
11300
|
+
location: 'body',
|
|
11301
|
+
required: false,
|
|
11302
|
+
valueKind: 'object',
|
|
11303
|
+
repeatable: false,
|
|
11304
|
+
},
|
|
9365
11305
|
],
|
|
9366
11306
|
hasParams: true,
|
|
9367
11307
|
paramsAllOptional: false,
|
|
@@ -9376,7 +11316,7 @@ exports.COMMANDS = [
|
|
|
9376
11316
|
methodName: 'get',
|
|
9377
11317
|
httpMethod: 'get',
|
|
9378
11318
|
httpPath: '/v1/usage',
|
|
9379
|
-
summary: 'Get usage
|
|
11319
|
+
summary: 'Get usage and cost',
|
|
9380
11320
|
description: "Report billable usage and cost for the organization over a time window, broken down by project (highest spend first). Pass `from`/`to` as ISO 8601 timestamps; optionally pass `projectId` to scope the report to one project. Amounts are billable spend only (what we absorb is never included). Authenticated by either an organization API key with the `usage:read` permission (any project in the organization), or a project API key with the `billing:read` permission (that key's own project only; any other `projectId` is a 403).",
|
|
9381
11321
|
positionals: [],
|
|
9382
11322
|
flags: [
|
|
@@ -9421,7 +11361,7 @@ exports.COMMANDS = [
|
|
|
9421
11361
|
methodName: 'create',
|
|
9422
11362
|
httpMethod: 'post',
|
|
9423
11363
|
httpPath: '/v1/webhook',
|
|
9424
|
-
summary: 'Create webhook',
|
|
11364
|
+
summary: 'Create a webhook',
|
|
9425
11365
|
description: 'Creates a new webhook with event subscriptions. The signing secret is only returned in this response.',
|
|
9426
11366
|
positionals: [],
|
|
9427
11367
|
flags: [
|
|
@@ -9479,6 +11419,8 @@ exports.COMMANDS = [
|
|
|
9479
11419
|
'CHAT_ANALYSIS_FAILED',
|
|
9480
11420
|
'ISSUE_OPENED',
|
|
9481
11421
|
'ISSUE_RESOLVED',
|
|
11422
|
+
'SIMULATION_RESOURCE_GENERATION_COMPLETED',
|
|
11423
|
+
'SIMULATION_RESOURCE_GENERATION_FAILED',
|
|
9482
11424
|
],
|
|
9483
11425
|
repeatable: true,
|
|
9484
11426
|
},
|
|
@@ -9496,7 +11438,7 @@ exports.COMMANDS = [
|
|
|
9496
11438
|
methodName: 'delete',
|
|
9497
11439
|
httpMethod: 'delete',
|
|
9498
11440
|
httpPath: '/v1/webhook/{webhookId}',
|
|
9499
|
-
summary: 'Delete webhook',
|
|
11441
|
+
summary: 'Delete a webhook',
|
|
9500
11442
|
description: 'Deletes a webhook and all its event subscriptions.',
|
|
9501
11443
|
positionals: [
|
|
9502
11444
|
{
|
|
@@ -9519,7 +11461,7 @@ exports.COMMANDS = [
|
|
|
9519
11461
|
methodName: 'getByID',
|
|
9520
11462
|
httpMethod: 'get',
|
|
9521
11463
|
httpPath: '/v1/webhook/{webhookId}',
|
|
9522
|
-
summary: 'Get webhook
|
|
11464
|
+
summary: 'Get a webhook',
|
|
9523
11465
|
description: 'Returns a specific webhook with its event subscriptions.',
|
|
9524
11466
|
positionals: [
|
|
9525
11467
|
{
|
|
@@ -9578,7 +11520,7 @@ exports.COMMANDS = [
|
|
|
9578
11520
|
methodName: 'get',
|
|
9579
11521
|
httpMethod: 'get',
|
|
9580
11522
|
httpPath: '/v1/me',
|
|
9581
|
-
summary: '
|
|
11523
|
+
summary: 'Get the current credential',
|
|
9582
11524
|
description: 'Returns the scope of the credential making the request, the organization it acts in, its default project (if any) and the permissions it was granted. Works for both project-scoped API keys and user-scoped credentials from the CLI or an MCP connector.',
|
|
9583
11525
|
positionals: [],
|
|
9584
11526
|
flags: [],
|