@roarkanalytics/cli 0.72.1 → 0.74.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 +25 -0
- package/README.md +191 -135
- package/commands.js +2764 -471
- 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-create.1 +3 -0
- 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-attribute-delete.1 +96 -0
- package/man/roark-customer-attribute-unlock.1 +96 -0
- package/man/roark-customer-attribute-update.1 +100 -0
- package/man/roark-customer-conversation-list.1 +100 -0
- package/man/roark-customer-delete.1 +93 -0
- 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-get.1 +93 -0
- package/man/roark-customer-list.1 +123 -0
- package/man/roark-customer-notes-update.1 +97 -0
- 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 -70
- package/npm-shrinkwrap.json +6 -6
- package/package.json +56 -10
- 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,9 +38,26 @@ 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
63
|
dashboard: 'Manage dashboards',
|
|
@@ -72,6 +88,9 @@ exports.GROUPS = {
|
|
|
72
88
|
'simulation plan job cost': 'Read simulation plan job cost',
|
|
73
89
|
'simulation plan job debrief': 'Manage simulation plan job debrief',
|
|
74
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',
|
|
75
94
|
'simulation run-group': 'Manage simulation run groups',
|
|
76
95
|
'simulation run-group report': 'Read simulation run group report',
|
|
77
96
|
'simulation template': 'Read simulation templates',
|
|
@@ -134,7 +153,7 @@ exports.COMMANDS = [
|
|
|
134
153
|
required: true,
|
|
135
154
|
description: 'Text-to-speech provider, for example ELEVENLABS',
|
|
136
155
|
valueKind: 'string',
|
|
137
|
-
enumValues: ['CARTESIA', 'ELEVENLABS', 'OPENAI', 'RIME'],
|
|
156
|
+
enumValues: ['CARTESIA', 'ELEVENLABS', 'OPENAI', 'RIME', 'ASSEMBLYAI', 'DEEPGRAM', 'FISH_AUDIO'],
|
|
138
157
|
repeatable: false,
|
|
139
158
|
},
|
|
140
159
|
{
|
|
@@ -170,7 +189,7 @@ exports.COMMANDS = [
|
|
|
170
189
|
required: true,
|
|
171
190
|
description: 'Speech-to-text provider, for example DEEPGRAM',
|
|
172
191
|
valueKind: 'string',
|
|
173
|
-
enumValues: ['DEEPGRAM', 'OPENAI_WHISPER', 'SPEECHMATICS', 'ASSEMBLYAI', 'ELEVENLABS'],
|
|
192
|
+
enumValues: ['DEEPGRAM', 'OPENAI_WHISPER', 'SPEECHMATICS', 'ASSEMBLYAI', 'ELEVENLABS', 'SONIOX'],
|
|
174
193
|
repeatable: false,
|
|
175
194
|
},
|
|
176
195
|
{
|
|
@@ -197,7 +216,19 @@ exports.COMMANDS = [
|
|
|
197
216
|
required: true,
|
|
198
217
|
description: 'Text model provider, for example OPENAI',
|
|
199
218
|
valueKind: 'string',
|
|
200
|
-
enumValues: [
|
|
219
|
+
enumValues: [
|
|
220
|
+
'OPENAI',
|
|
221
|
+
'ANTHROPIC',
|
|
222
|
+
'GOOGLE',
|
|
223
|
+
'XAI',
|
|
224
|
+
'ULTRAVOX',
|
|
225
|
+
'AWS',
|
|
226
|
+
'ELEVENLABS',
|
|
227
|
+
'GROQ',
|
|
228
|
+
'META',
|
|
229
|
+
'RIME',
|
|
230
|
+
'PHONIC',
|
|
231
|
+
],
|
|
201
232
|
repeatable: false,
|
|
202
233
|
},
|
|
203
234
|
{
|
|
@@ -217,13 +248,74 @@ exports.COMMANDS = [
|
|
|
217
248
|
acceptsBody: true,
|
|
218
249
|
requiresAuth: true,
|
|
219
250
|
},
|
|
251
|
+
{
|
|
252
|
+
commandPath: ['agent', 'conversation', 'create'],
|
|
253
|
+
clientProperty: 'agentConversation',
|
|
254
|
+
methodName: 'create',
|
|
255
|
+
httpMethod: 'post',
|
|
256
|
+
httpPath: '/v1/agent/{agentId}/conversations',
|
|
257
|
+
summary: 'Start a conversation with an agent',
|
|
258
|
+
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.',
|
|
259
|
+
positionals: [
|
|
260
|
+
{
|
|
261
|
+
name: 'agent-id',
|
|
262
|
+
paramKey: 'agentId',
|
|
263
|
+
},
|
|
264
|
+
],
|
|
265
|
+
flags: [
|
|
266
|
+
{
|
|
267
|
+
name: 'modality',
|
|
268
|
+
path: ['modality'],
|
|
269
|
+
location: 'body',
|
|
270
|
+
required: true,
|
|
271
|
+
description: '`voice` or `chat`. The agent must have that modality turned on.',
|
|
272
|
+
valueKind: 'string',
|
|
273
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
274
|
+
repeatable: false,
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
name: 'channel',
|
|
278
|
+
path: ['channel'],
|
|
279
|
+
location: 'body',
|
|
280
|
+
required: true,
|
|
281
|
+
description: 'How it is reached. `web`: in a browser on one of `allowedOrigins`, joined with the web SDK.',
|
|
282
|
+
valueKind: 'string',
|
|
283
|
+
enumValues: ['web'],
|
|
284
|
+
repeatable: false,
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
name: 'allowed-origins',
|
|
288
|
+
path: ['allowedOrigins'],
|
|
289
|
+
location: 'body',
|
|
290
|
+
required: true,
|
|
291
|
+
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.',
|
|
292
|
+
valueKind: 'array',
|
|
293
|
+
repeatable: true,
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
name: 'client-token-ttl-seconds',
|
|
297
|
+
path: ['clientTokenTtlSeconds'],
|
|
298
|
+
location: 'body',
|
|
299
|
+
required: false,
|
|
300
|
+
description: 'How long the browser has to join, in seconds. Default 120.',
|
|
301
|
+
valueKind: 'integer',
|
|
302
|
+
repeatable: false,
|
|
303
|
+
},
|
|
304
|
+
],
|
|
305
|
+
hasParams: true,
|
|
306
|
+
paramsAllOptional: false,
|
|
307
|
+
bodyOpaque: false,
|
|
308
|
+
bodyVariants: [],
|
|
309
|
+
acceptsBody: true,
|
|
310
|
+
requiresAuth: true,
|
|
311
|
+
},
|
|
220
312
|
{
|
|
221
313
|
commandPath: ['agent', 'create'],
|
|
222
314
|
clientProperty: 'agent',
|
|
223
315
|
methodName: 'create',
|
|
224
316
|
httpMethod: 'post',
|
|
225
317
|
httpPath: '/v1/agent',
|
|
226
|
-
summary: 'Create
|
|
318
|
+
summary: 'Create an agent',
|
|
227
319
|
description: 'Creates a new agent for the authenticated project.',
|
|
228
320
|
positionals: [],
|
|
229
321
|
flags: [
|
|
@@ -250,7 +342,98 @@ exports.COMMANDS = [
|
|
|
250
342
|
path: ['customId'],
|
|
251
343
|
location: 'body',
|
|
252
344
|
required: false,
|
|
253
|
-
description: 'Custom identifier for the agent',
|
|
345
|
+
description: 'Custom identifier for the agent. Must be unique in the project.',
|
|
346
|
+
valueKind: 'string',
|
|
347
|
+
repeatable: false,
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
name: 'industry',
|
|
351
|
+
path: ['industry'],
|
|
352
|
+
location: 'body',
|
|
353
|
+
required: false,
|
|
354
|
+
description: 'The industry the agent serves.',
|
|
355
|
+
valueKind: 'string',
|
|
356
|
+
enumValues: [
|
|
357
|
+
'HEALTHCARE',
|
|
358
|
+
'FINANCIAL_SERVICES',
|
|
359
|
+
'INSURANCE',
|
|
360
|
+
'DEBT_COLLECTION',
|
|
361
|
+
'RETAIL',
|
|
362
|
+
'TRAVEL_AND_HOSPITALITY',
|
|
363
|
+
'TELECOMMUNICATIONS',
|
|
364
|
+
'TECHNOLOGY',
|
|
365
|
+
'PUBLIC_SECTOR',
|
|
366
|
+
'UTILITIES',
|
|
367
|
+
'LOGISTICS',
|
|
368
|
+
'AUTOMOTIVE',
|
|
369
|
+
'HOME_SERVICES',
|
|
370
|
+
'RESTAURANTS',
|
|
371
|
+
'EDUCATION',
|
|
372
|
+
'OTHER',
|
|
373
|
+
],
|
|
374
|
+
repeatable: false,
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
name: 'prompt',
|
|
378
|
+
path: ['prompt'],
|
|
379
|
+
location: 'body',
|
|
380
|
+
required: false,
|
|
381
|
+
description: "The agent's system prompt.",
|
|
382
|
+
valueKind: 'string',
|
|
383
|
+
repeatable: false,
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
name: 'endpoint',
|
|
387
|
+
path: ['endpoint'],
|
|
388
|
+
location: 'body',
|
|
389
|
+
required: false,
|
|
390
|
+
description: 'The phone number or connection Roark calls to test the agent',
|
|
391
|
+
valueKind: 'object',
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
name: 'endpoint.value',
|
|
395
|
+
path: ['endpoint', 'value'],
|
|
396
|
+
location: 'body',
|
|
397
|
+
required: false,
|
|
398
|
+
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.',
|
|
399
|
+
valueKind: 'string',
|
|
400
|
+
repeatable: false,
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
name: 'endpoint.environment',
|
|
404
|
+
path: ['endpoint', 'environment'],
|
|
405
|
+
location: 'body',
|
|
406
|
+
required: false,
|
|
407
|
+
description: 'Environment name (default: production)',
|
|
408
|
+
valueKind: 'string',
|
|
409
|
+
repeatable: false,
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
name: 'endpoint.direction',
|
|
413
|
+
path: ['endpoint', 'direction'],
|
|
414
|
+
location: 'body',
|
|
415
|
+
required: true,
|
|
416
|
+
description: 'Call direction: INCOMING, OUTGOING, or INCOMING_AND_OUTGOING',
|
|
417
|
+
valueKind: 'string',
|
|
418
|
+
enumValues: ['INCOMING', 'OUTGOING', 'INCOMING_AND_OUTGOING'],
|
|
419
|
+
repeatable: false,
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
name: 'endpoint.outbound-dial-type',
|
|
423
|
+
path: ['endpoint', 'outboundDialType'],
|
|
424
|
+
location: 'body',
|
|
425
|
+
required: false,
|
|
426
|
+
description: 'Outbound dial type: NONE or HTTP_REQUEST (default: NONE)',
|
|
427
|
+
valueKind: 'string',
|
|
428
|
+
enumValues: ['NONE', 'HTTP_REQUEST'],
|
|
429
|
+
repeatable: false,
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
name: 'endpoint.outbound-dial-http-request-definition-id',
|
|
433
|
+
path: ['endpoint', 'outboundDialHttpRequestDefinitionId'],
|
|
434
|
+
location: 'body',
|
|
435
|
+
required: false,
|
|
436
|
+
description: 'ID of the HTTP request definition for outbound dialing (required when outboundDialType is HTTP_REQUEST)',
|
|
254
437
|
valueKind: 'string',
|
|
255
438
|
repeatable: false,
|
|
256
439
|
},
|
|
@@ -417,7 +600,7 @@ exports.COMMANDS = [
|
|
|
417
600
|
location: 'body',
|
|
418
601
|
required: false,
|
|
419
602
|
valueKind: 'array',
|
|
420
|
-
enumValues: ['
|
|
603
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
421
604
|
repeatable: true,
|
|
422
605
|
},
|
|
423
606
|
{
|
|
@@ -478,6 +661,14 @@ exports.COMMANDS = [
|
|
|
478
661
|
valueKind: 'number',
|
|
479
662
|
repeatable: false,
|
|
480
663
|
},
|
|
664
|
+
{
|
|
665
|
+
name: 'settings.vad-max-silence-secs',
|
|
666
|
+
path: ['settings', 'vadMaxSilenceSecs'],
|
|
667
|
+
location: 'body',
|
|
668
|
+
required: false,
|
|
669
|
+
valueKind: 'number',
|
|
670
|
+
repeatable: false,
|
|
671
|
+
},
|
|
481
672
|
{
|
|
482
673
|
name: 'settings.call-max-duration-seconds',
|
|
483
674
|
path: ['settings', 'callMaxDurationSeconds'],
|
|
@@ -618,19 +809,10 @@ exports.COMMANDS = [
|
|
|
618
809
|
methodName: 'create',
|
|
619
810
|
httpMethod: 'post',
|
|
620
811
|
httpPath: '/v1/agent/endpoint',
|
|
621
|
-
summary: 'Create
|
|
812
|
+
summary: 'Create an agent endpoint',
|
|
622
813
|
description: 'Creates a new agent endpoint for the authenticated project.',
|
|
623
814
|
positionals: [],
|
|
624
815
|
flags: [
|
|
625
|
-
{
|
|
626
|
-
name: 'agent-id',
|
|
627
|
-
path: ['agentId'],
|
|
628
|
-
location: 'body',
|
|
629
|
-
required: true,
|
|
630
|
-
description: 'Agent ID to associate this endpoint with',
|
|
631
|
-
valueKind: 'string',
|
|
632
|
-
repeatable: false,
|
|
633
|
-
},
|
|
634
816
|
{
|
|
635
817
|
name: 'value',
|
|
636
818
|
path: ['value'],
|
|
@@ -678,6 +860,15 @@ exports.COMMANDS = [
|
|
|
678
860
|
valueKind: 'string',
|
|
679
861
|
repeatable: false,
|
|
680
862
|
},
|
|
863
|
+
{
|
|
864
|
+
name: 'agent-id',
|
|
865
|
+
path: ['agentId'],
|
|
866
|
+
location: 'body',
|
|
867
|
+
required: true,
|
|
868
|
+
description: 'Agent ID to associate this endpoint with',
|
|
869
|
+
valueKind: 'string',
|
|
870
|
+
repeatable: false,
|
|
871
|
+
},
|
|
681
872
|
],
|
|
682
873
|
hasParams: true,
|
|
683
874
|
paramsAllOptional: false,
|
|
@@ -692,7 +883,7 @@ exports.COMMANDS = [
|
|
|
692
883
|
methodName: 'getByID',
|
|
693
884
|
httpMethod: 'get',
|
|
694
885
|
httpPath: '/v1/agent/endpoint/{endpointId}',
|
|
695
|
-
summary: 'Get agent endpoint
|
|
886
|
+
summary: 'Get an agent endpoint',
|
|
696
887
|
description: 'Returns a specific agent endpoint by its ID.',
|
|
697
888
|
positionals: [
|
|
698
889
|
{
|
|
@@ -821,7 +1012,7 @@ exports.COMMANDS = [
|
|
|
821
1012
|
methodName: 'getByID',
|
|
822
1013
|
httpMethod: 'get',
|
|
823
1014
|
httpPath: '/v1/agent/{agentId}',
|
|
824
|
-
summary: 'Get agent
|
|
1015
|
+
summary: 'Get an agent',
|
|
825
1016
|
description: 'Returns a specific agent by its ID.',
|
|
826
1017
|
positionals: [
|
|
827
1018
|
{
|
|
@@ -1468,7 +1659,7 @@ exports.COMMANDS = [
|
|
|
1468
1659
|
methodName: 'cancel',
|
|
1469
1660
|
httpMethod: 'post',
|
|
1470
1661
|
httpPath: '/v1/autoimprove/job/{jobId}/cancel',
|
|
1471
|
-
summary: 'Cancel
|
|
1662
|
+
summary: 'Cancel an Autoimprove job',
|
|
1472
1663
|
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.',
|
|
1473
1664
|
positionals: [
|
|
1474
1665
|
{
|
|
@@ -1589,7 +1780,7 @@ exports.COMMANDS = [
|
|
|
1589
1780
|
methodName: 'dismiss',
|
|
1590
1781
|
httpMethod: 'post',
|
|
1591
1782
|
httpPath: '/v1/autoimprove/job/{jobId}/dismiss',
|
|
1592
|
-
summary: 'Dismiss
|
|
1783
|
+
summary: 'Dismiss an Autoimprove job',
|
|
1593
1784
|
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.',
|
|
1594
1785
|
positionals: [
|
|
1595
1786
|
{
|
|
@@ -1633,7 +1824,7 @@ exports.COMMANDS = [
|
|
|
1633
1824
|
methodName: 'sendGuidance',
|
|
1634
1825
|
httpMethod: 'post',
|
|
1635
1826
|
httpPath: '/v1/autoimprove/job/{jobId}/guidance',
|
|
1636
|
-
summary: '
|
|
1827
|
+
summary: 'Guide a running Autoimprove job',
|
|
1637
1828
|
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.',
|
|
1638
1829
|
positionals: [
|
|
1639
1830
|
{
|
|
@@ -1682,7 +1873,7 @@ exports.COMMANDS = [
|
|
|
1682
1873
|
methodName: 'promote',
|
|
1683
1874
|
httpMethod: 'post',
|
|
1684
1875
|
httpPath: '/v1/autoimprove/job/{jobId}/promote',
|
|
1685
|
-
summary: 'Promote
|
|
1876
|
+
summary: 'Promote an Autoimprove job to production',
|
|
1686
1877
|
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.',
|
|
1687
1878
|
positionals: [
|
|
1688
1879
|
{
|
|
@@ -1888,7 +2079,7 @@ exports.COMMANDS = [
|
|
|
1888
2079
|
methodName: 'listTargetHistory',
|
|
1889
2080
|
httpMethod: 'get',
|
|
1890
2081
|
httpPath: '/v1/benchmark/target/{targetKey}/history',
|
|
1891
|
-
summary:
|
|
2082
|
+
summary: "List a benchmark target's published generations",
|
|
1892
2083
|
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.',
|
|
1893
2084
|
positionals: [
|
|
1894
2085
|
{
|
|
@@ -2013,18 +2204,44 @@ exports.COMMANDS = [
|
|
|
2013
2204
|
requiresAuth: true,
|
|
2014
2205
|
},
|
|
2015
2206
|
{
|
|
2016
|
-
commandPath: ['
|
|
2017
|
-
clientProperty: '
|
|
2018
|
-
methodName: '
|
|
2207
|
+
commandPath: ['call', 'batch', 'delete'],
|
|
2208
|
+
clientProperty: 'call',
|
|
2209
|
+
methodName: 'batchDelete',
|
|
2019
2210
|
httpMethod: 'post',
|
|
2020
|
-
httpPath: '/v1/
|
|
2021
|
-
summary: '
|
|
2022
|
-
description: '
|
|
2211
|
+
httpPath: '/v1/call/batch-delete',
|
|
2212
|
+
summary: 'Delete calls in batch',
|
|
2213
|
+
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.',
|
|
2214
|
+
positionals: [],
|
|
2215
|
+
flags: [
|
|
2216
|
+
{
|
|
2217
|
+
name: 'call-ids',
|
|
2218
|
+
path: ['callIds'],
|
|
2219
|
+
location: 'body',
|
|
2220
|
+
required: true,
|
|
2221
|
+
description: 'IDs of the calls to delete, at most 100. Repeated IDs are counted once.',
|
|
2222
|
+
valueKind: 'array',
|
|
2223
|
+
repeatable: true,
|
|
2224
|
+
},
|
|
2225
|
+
],
|
|
2226
|
+
hasParams: true,
|
|
2227
|
+
paramsAllOptional: false,
|
|
2228
|
+
bodyOpaque: false,
|
|
2229
|
+
bodyVariants: [],
|
|
2230
|
+
acceptsBody: true,
|
|
2231
|
+
requiresAuth: true,
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
commandPath: ['call', 'cost', 'get'],
|
|
2235
|
+
clientProperty: 'call',
|
|
2236
|
+
methodName: 'getCost',
|
|
2237
|
+
httpMethod: 'get',
|
|
2238
|
+
httpPath: '/v1/call/{callId}/cost',
|
|
2239
|
+
summary: 'Get call cost',
|
|
2240
|
+
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.',
|
|
2023
2241
|
positionals: [
|
|
2024
2242
|
{
|
|
2025
|
-
name: '
|
|
2026
|
-
paramKey: '
|
|
2027
|
-
description: 'Calendar connection ID',
|
|
2243
|
+
name: 'call-id',
|
|
2244
|
+
paramKey: 'callId',
|
|
2028
2245
|
},
|
|
2029
2246
|
],
|
|
2030
2247
|
flags: [],
|
|
@@ -2036,341 +2253,61 @@ exports.COMMANDS = [
|
|
|
2036
2253
|
requiresAuth: true,
|
|
2037
2254
|
},
|
|
2038
2255
|
{
|
|
2039
|
-
commandPath: ['
|
|
2040
|
-
clientProperty: '
|
|
2256
|
+
commandPath: ['call', 'create'],
|
|
2257
|
+
clientProperty: 'call',
|
|
2041
2258
|
methodName: 'create',
|
|
2042
2259
|
httpMethod: 'post',
|
|
2043
|
-
httpPath: '/v1/
|
|
2044
|
-
summary: '
|
|
2045
|
-
description: '
|
|
2260
|
+
httpPath: '/v1/call',
|
|
2261
|
+
summary: 'Create a call',
|
|
2262
|
+
description: 'Create a new call with recording, transcript, agents, and customers',
|
|
2046
2263
|
positionals: [],
|
|
2047
2264
|
flags: [
|
|
2048
2265
|
{
|
|
2049
|
-
name: '
|
|
2050
|
-
path: ['
|
|
2266
|
+
name: 'recording-url',
|
|
2267
|
+
path: ['recordingUrl'],
|
|
2051
2268
|
location: 'body',
|
|
2052
2269
|
required: true,
|
|
2053
|
-
description: '
|
|
2270
|
+
description: 'URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.',
|
|
2054
2271
|
valueKind: 'string',
|
|
2055
|
-
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2056
2272
|
repeatable: false,
|
|
2057
2273
|
},
|
|
2058
2274
|
{
|
|
2059
|
-
name: '
|
|
2060
|
-
path: ['
|
|
2275
|
+
name: 'stereo-recording-url',
|
|
2276
|
+
path: ['stereoRecordingUrl'],
|
|
2061
2277
|
location: 'body',
|
|
2062
|
-
required:
|
|
2063
|
-
description: '
|
|
2278
|
+
required: false,
|
|
2279
|
+
description: 'URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.',
|
|
2064
2280
|
valueKind: 'string',
|
|
2065
2281
|
repeatable: false,
|
|
2066
2282
|
},
|
|
2067
2283
|
{
|
|
2068
|
-
name: '
|
|
2069
|
-
path: ['
|
|
2284
|
+
name: 'started-at',
|
|
2285
|
+
path: ['startedAt'],
|
|
2070
2286
|
location: 'body',
|
|
2071
2287
|
required: true,
|
|
2072
|
-
description: '
|
|
2288
|
+
description: 'When the call started (ISO 8601 format)',
|
|
2073
2289
|
valueKind: 'string',
|
|
2074
2290
|
repeatable: false,
|
|
2075
2291
|
},
|
|
2076
2292
|
{
|
|
2077
|
-
name: '
|
|
2078
|
-
path: ['
|
|
2293
|
+
name: 'interface-type',
|
|
2294
|
+
path: ['interfaceType'],
|
|
2079
2295
|
location: 'body',
|
|
2080
|
-
required:
|
|
2081
|
-
description: '
|
|
2296
|
+
required: true,
|
|
2297
|
+
description: 'Interface type of the call (PHONE or WEB)',
|
|
2082
2298
|
valueKind: 'string',
|
|
2299
|
+
enumValues: ['PHONE', 'WEB'],
|
|
2083
2300
|
repeatable: false,
|
|
2084
2301
|
},
|
|
2085
|
-
],
|
|
2086
|
-
hasParams: true,
|
|
2087
|
-
paramsAllOptional: false,
|
|
2088
|
-
bodyOpaque: false,
|
|
2089
|
-
bodyVariants: [],
|
|
2090
|
-
acceptsBody: true,
|
|
2091
|
-
requiresAuth: true,
|
|
2092
|
-
},
|
|
2093
|
-
{
|
|
2094
|
-
commandPath: ['calendar-connection', 'delete'],
|
|
2095
|
-
clientProperty: 'calendarConnection',
|
|
2096
|
-
methodName: 'delete',
|
|
2097
|
-
httpMethod: 'delete',
|
|
2098
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2099
|
-
summary: 'Delete a calendar connection',
|
|
2100
|
-
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.',
|
|
2101
|
-
positionals: [
|
|
2102
2302
|
{
|
|
2103
|
-
name: '
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
bodyOpaque: false,
|
|
2112
|
-
bodyVariants: [],
|
|
2113
|
-
acceptsBody: false,
|
|
2114
|
-
requiresAuth: true,
|
|
2115
|
-
},
|
|
2116
|
-
{
|
|
2117
|
-
commandPath: ['calendar-connection', 'get'],
|
|
2118
|
-
clientProperty: 'calendarConnection',
|
|
2119
|
-
methodName: 'getByID',
|
|
2120
|
-
httpMethod: 'get',
|
|
2121
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2122
|
-
summary: 'Get a calendar connection',
|
|
2123
|
-
description: 'Returns one calendar connection. The stored credential is never included.',
|
|
2124
|
-
positionals: [
|
|
2125
|
-
{
|
|
2126
|
-
name: 'connection-id',
|
|
2127
|
-
paramKey: 'connectionId',
|
|
2128
|
-
description: 'Calendar connection ID',
|
|
2129
|
-
},
|
|
2130
|
-
],
|
|
2131
|
-
flags: [],
|
|
2132
|
-
hasParams: false,
|
|
2133
|
-
paramsAllOptional: true,
|
|
2134
|
-
bodyOpaque: false,
|
|
2135
|
-
bodyVariants: [],
|
|
2136
|
-
acceptsBody: false,
|
|
2137
|
-
requiresAuth: true,
|
|
2138
|
-
},
|
|
2139
|
-
{
|
|
2140
|
-
commandPath: ['calendar-connection', 'list'],
|
|
2141
|
-
clientProperty: 'calendarConnection',
|
|
2142
|
-
methodName: 'list',
|
|
2143
|
-
httpMethod: 'get',
|
|
2144
|
-
httpPath: '/v1/calendar-connection',
|
|
2145
|
-
summary: 'List calendar connections',
|
|
2146
|
-
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.',
|
|
2147
|
-
positionals: [],
|
|
2148
|
-
flags: [
|
|
2149
|
-
{
|
|
2150
|
-
name: 'provider',
|
|
2151
|
-
path: ['provider'],
|
|
2152
|
-
location: 'query',
|
|
2153
|
-
required: false,
|
|
2154
|
-
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.',
|
|
2155
|
-
valueKind: 'string',
|
|
2156
|
-
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2157
|
-
repeatable: false,
|
|
2158
|
-
},
|
|
2159
|
-
],
|
|
2160
|
-
hasParams: true,
|
|
2161
|
-
paramsAllOptional: true,
|
|
2162
|
-
bodyOpaque: false,
|
|
2163
|
-
bodyVariants: [],
|
|
2164
|
-
acceptsBody: false,
|
|
2165
|
-
requiresAuth: true,
|
|
2166
|
-
},
|
|
2167
|
-
{
|
|
2168
|
-
commandPath: ['calendar-connection', 'target', 'get'],
|
|
2169
|
-
clientProperty: 'calendarConnection',
|
|
2170
|
-
methodName: 'getTarget',
|
|
2171
|
-
httpMethod: 'get',
|
|
2172
|
-
httpPath: '/v1/calendar-connection/{connectionId}/targets/{targetId}',
|
|
2173
|
-
summary: 'Read one bookable target',
|
|
2174
|
-
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.',
|
|
2175
|
-
positionals: [
|
|
2176
|
-
{
|
|
2177
|
-
name: 'connection-id',
|
|
2178
|
-
paramKey: 'connectionId',
|
|
2179
|
-
description: 'Calendar connection ID',
|
|
2180
|
-
},
|
|
2181
|
-
{
|
|
2182
|
-
name: 'target-id',
|
|
2183
|
-
paramKey: 'targetId',
|
|
2184
|
-
description: 'Target id, as the list returned it',
|
|
2185
|
-
},
|
|
2186
|
-
],
|
|
2187
|
-
flags: [],
|
|
2188
|
-
hasParams: true,
|
|
2189
|
-
paramsAllOptional: false,
|
|
2190
|
-
bodyOpaque: false,
|
|
2191
|
-
bodyVariants: [],
|
|
2192
|
-
acceptsBody: false,
|
|
2193
|
-
requiresAuth: true,
|
|
2194
|
-
},
|
|
2195
|
-
{
|
|
2196
|
-
commandPath: ['calendar-connection', 'target', 'list'],
|
|
2197
|
-
clientProperty: 'calendarConnection',
|
|
2198
|
-
methodName: 'listTargets',
|
|
2199
|
-
httpMethod: 'get',
|
|
2200
|
-
httpPath: '/v1/calendar-connection/{connectionId}/targets',
|
|
2201
|
-
summary: 'List what can be booked on a calendar',
|
|
2202
|
-
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.',
|
|
2203
|
-
positionals: [
|
|
2204
|
-
{
|
|
2205
|
-
name: 'connection-id',
|
|
2206
|
-
paramKey: 'connectionId',
|
|
2207
|
-
description: 'Calendar connection ID',
|
|
2208
|
-
},
|
|
2209
|
-
],
|
|
2210
|
-
flags: [],
|
|
2211
|
-
hasParams: false,
|
|
2212
|
-
paramsAllOptional: true,
|
|
2213
|
-
bodyOpaque: false,
|
|
2214
|
-
bodyVariants: [],
|
|
2215
|
-
acceptsBody: false,
|
|
2216
|
-
requiresAuth: true,
|
|
2217
|
-
},
|
|
2218
|
-
{
|
|
2219
|
-
commandPath: ['calendar-connection', 'update'],
|
|
2220
|
-
clientProperty: 'calendarConnection',
|
|
2221
|
-
methodName: 'update',
|
|
2222
|
-
httpMethod: 'patch',
|
|
2223
|
-
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2224
|
-
summary: 'Update a calendar connection',
|
|
2225
|
-
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.',
|
|
2226
|
-
positionals: [
|
|
2227
|
-
{
|
|
2228
|
-
name: 'connection-id',
|
|
2229
|
-
paramKey: 'connectionId',
|
|
2230
|
-
description: 'Calendar connection ID',
|
|
2231
|
-
},
|
|
2232
|
-
],
|
|
2233
|
-
flags: [
|
|
2234
|
-
{
|
|
2235
|
-
name: 'label',
|
|
2236
|
-
path: ['label'],
|
|
2237
|
-
location: 'body',
|
|
2238
|
-
required: false,
|
|
2239
|
-
description: 'Rename the connection.',
|
|
2240
|
-
valueKind: 'string',
|
|
2241
|
-
repeatable: false,
|
|
2242
|
-
},
|
|
2243
|
-
{
|
|
2244
|
-
name: 'timezone',
|
|
2245
|
-
path: ['timezone'],
|
|
2246
|
-
location: 'body',
|
|
2247
|
-
required: false,
|
|
2248
|
-
description: 'Change the named IANA timezone slots are offered in.',
|
|
2249
|
-
valueKind: 'string',
|
|
2250
|
-
repeatable: false,
|
|
2251
|
-
},
|
|
2252
|
-
{
|
|
2253
|
-
name: 'api-key',
|
|
2254
|
-
path: ['apiKey'],
|
|
2255
|
-
location: 'body',
|
|
2256
|
-
required: false,
|
|
2257
|
-
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.',
|
|
2258
|
-
valueKind: 'string',
|
|
2259
|
-
repeatable: false,
|
|
2260
|
-
},
|
|
2261
|
-
],
|
|
2262
|
-
hasParams: true,
|
|
2263
|
-
paramsAllOptional: true,
|
|
2264
|
-
bodyOpaque: false,
|
|
2265
|
-
bodyVariants: [],
|
|
2266
|
-
acceptsBody: true,
|
|
2267
|
-
requiresAuth: true,
|
|
2268
|
-
},
|
|
2269
|
-
{
|
|
2270
|
-
commandPath: ['call', 'batch', 'delete'],
|
|
2271
|
-
clientProperty: 'call',
|
|
2272
|
-
methodName: 'batchDelete',
|
|
2273
|
-
httpMethod: 'post',
|
|
2274
|
-
httpPath: '/v1/call/batch-delete',
|
|
2275
|
-
summary: 'Delete calls in batch',
|
|
2276
|
-
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.',
|
|
2277
|
-
positionals: [],
|
|
2278
|
-
flags: [
|
|
2279
|
-
{
|
|
2280
|
-
name: 'call-ids',
|
|
2281
|
-
path: ['callIds'],
|
|
2282
|
-
location: 'body',
|
|
2283
|
-
required: true,
|
|
2284
|
-
description: 'IDs of the calls to delete, at most 100. Repeated IDs are counted once.',
|
|
2285
|
-
valueKind: 'array',
|
|
2286
|
-
repeatable: true,
|
|
2287
|
-
},
|
|
2288
|
-
],
|
|
2289
|
-
hasParams: true,
|
|
2290
|
-
paramsAllOptional: false,
|
|
2291
|
-
bodyOpaque: false,
|
|
2292
|
-
bodyVariants: [],
|
|
2293
|
-
acceptsBody: true,
|
|
2294
|
-
requiresAuth: true,
|
|
2295
|
-
},
|
|
2296
|
-
{
|
|
2297
|
-
commandPath: ['call', 'cost', 'get'],
|
|
2298
|
-
clientProperty: 'call',
|
|
2299
|
-
methodName: 'getCost',
|
|
2300
|
-
httpMethod: 'get',
|
|
2301
|
-
httpPath: '/v1/call/{callId}/cost',
|
|
2302
|
-
summary: 'Get call cost',
|
|
2303
|
-
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.',
|
|
2304
|
-
positionals: [
|
|
2305
|
-
{
|
|
2306
|
-
name: 'call-id',
|
|
2307
|
-
paramKey: 'callId',
|
|
2308
|
-
},
|
|
2309
|
-
],
|
|
2310
|
-
flags: [],
|
|
2311
|
-
hasParams: false,
|
|
2312
|
-
paramsAllOptional: true,
|
|
2313
|
-
bodyOpaque: false,
|
|
2314
|
-
bodyVariants: [],
|
|
2315
|
-
acceptsBody: false,
|
|
2316
|
-
requiresAuth: true,
|
|
2317
|
-
},
|
|
2318
|
-
{
|
|
2319
|
-
commandPath: ['call', 'create'],
|
|
2320
|
-
clientProperty: 'call',
|
|
2321
|
-
methodName: 'create',
|
|
2322
|
-
httpMethod: 'post',
|
|
2323
|
-
httpPath: '/v1/call',
|
|
2324
|
-
summary: 'Create a call',
|
|
2325
|
-
description: 'Create a new call with recording, transcript, agents, and customers',
|
|
2326
|
-
positionals: [],
|
|
2327
|
-
flags: [
|
|
2328
|
-
{
|
|
2329
|
-
name: 'recording-url',
|
|
2330
|
-
path: ['recordingUrl'],
|
|
2331
|
-
location: 'body',
|
|
2332
|
-
required: true,
|
|
2333
|
-
description: 'URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.',
|
|
2334
|
-
valueKind: 'string',
|
|
2335
|
-
repeatable: false,
|
|
2336
|
-
},
|
|
2337
|
-
{
|
|
2338
|
-
name: 'stereo-recording-url',
|
|
2339
|
-
path: ['stereoRecordingUrl'],
|
|
2340
|
-
location: 'body',
|
|
2341
|
-
required: false,
|
|
2342
|
-
description: 'URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.',
|
|
2343
|
-
valueKind: 'string',
|
|
2344
|
-
repeatable: false,
|
|
2345
|
-
},
|
|
2346
|
-
{
|
|
2347
|
-
name: 'started-at',
|
|
2348
|
-
path: ['startedAt'],
|
|
2349
|
-
location: 'body',
|
|
2350
|
-
required: true,
|
|
2351
|
-
description: 'When the call started (ISO 8601 format)',
|
|
2352
|
-
valueKind: 'string',
|
|
2353
|
-
repeatable: false,
|
|
2354
|
-
},
|
|
2355
|
-
{
|
|
2356
|
-
name: 'interface-type',
|
|
2357
|
-
path: ['interfaceType'],
|
|
2358
|
-
location: 'body',
|
|
2359
|
-
required: true,
|
|
2360
|
-
description: 'Interface type of the call (PHONE or WEB)',
|
|
2361
|
-
valueKind: 'string',
|
|
2362
|
-
enumValues: ['PHONE', 'WEB'],
|
|
2363
|
-
repeatable: false,
|
|
2364
|
-
},
|
|
2365
|
-
{
|
|
2366
|
-
name: 'call-direction',
|
|
2367
|
-
path: ['callDirection'],
|
|
2368
|
-
location: 'body',
|
|
2369
|
-
required: true,
|
|
2370
|
-
description: 'Direction of the call (INBOUND or OUTBOUND)',
|
|
2371
|
-
valueKind: 'string',
|
|
2372
|
-
enumValues: ['INBOUND', 'OUTBOUND'],
|
|
2373
|
-
repeatable: false,
|
|
2303
|
+
name: 'call-direction',
|
|
2304
|
+
path: ['callDirection'],
|
|
2305
|
+
location: 'body',
|
|
2306
|
+
required: true,
|
|
2307
|
+
description: 'Direction of the call (INBOUND or OUTBOUND)',
|
|
2308
|
+
valueKind: 'string',
|
|
2309
|
+
enumValues: ['INBOUND', 'OUTBOUND'],
|
|
2310
|
+
repeatable: false,
|
|
2374
2311
|
},
|
|
2375
2312
|
{
|
|
2376
2313
|
name: 'ended-status',
|
|
@@ -2518,6 +2455,15 @@ exports.COMMANDS = [
|
|
|
2518
2455
|
valueKind: 'string',
|
|
2519
2456
|
repeatable: false,
|
|
2520
2457
|
},
|
|
2458
|
+
{
|
|
2459
|
+
name: 'customer.external-id',
|
|
2460
|
+
path: ['customer', 'externalId'],
|
|
2461
|
+
location: 'body',
|
|
2462
|
+
required: false,
|
|
2463
|
+
description: 'Your own stable id for this person. Links conversations to one customer profile where there is no phone number, such as web calls.',
|
|
2464
|
+
valueKind: 'string',
|
|
2465
|
+
repeatable: false,
|
|
2466
|
+
},
|
|
2521
2467
|
{
|
|
2522
2468
|
name: 'customers',
|
|
2523
2469
|
path: ['customers'],
|
|
@@ -2563,7 +2509,7 @@ exports.COMMANDS = [
|
|
|
2563
2509
|
methodName: 'getByID',
|
|
2564
2510
|
httpMethod: 'get',
|
|
2565
2511
|
httpPath: '/v1/call/{callId}',
|
|
2566
|
-
summary: 'Get a call
|
|
2512
|
+
summary: 'Get a call',
|
|
2567
2513
|
description: 'Retrieve an existing call by its unique identifier',
|
|
2568
2514
|
positionals: [
|
|
2569
2515
|
{
|
|
@@ -2967,87 +2913,1767 @@ exports.COMMANDS = [
|
|
|
2967
2913
|
requiresAuth: true,
|
|
2968
2914
|
},
|
|
2969
2915
|
{
|
|
2970
|
-
commandPath: ['
|
|
2971
|
-
clientProperty: '
|
|
2972
|
-
methodName: '
|
|
2916
|
+
commandPath: ['connections', 'agent', 'backfill', 'cancel'],
|
|
2917
|
+
clientProperty: 'agentConnection',
|
|
2918
|
+
methodName: 'cancelBackfill',
|
|
2973
2919
|
httpMethod: 'post',
|
|
2974
|
-
httpPath: '/v1/
|
|
2975
|
-
summary: '
|
|
2976
|
-
description: '
|
|
2977
|
-
positionals: [
|
|
2978
|
-
flags: [
|
|
2920
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills/{backfillId}/cancel',
|
|
2921
|
+
summary: 'Cancel a backfill',
|
|
2922
|
+
description: 'Stops a running backfill. Calls it already imported stay.',
|
|
2923
|
+
positionals: [
|
|
2979
2924
|
{
|
|
2980
|
-
name: '
|
|
2981
|
-
|
|
2982
|
-
location: 'body',
|
|
2983
|
-
required: true,
|
|
2984
|
-
description: 'A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from.',
|
|
2985
|
-
valueKind: 'string',
|
|
2986
|
-
repeatable: false,
|
|
2925
|
+
name: 'connection-id',
|
|
2926
|
+
paramKey: 'connectionId',
|
|
2987
2927
|
},
|
|
2988
2928
|
{
|
|
2989
|
-
name: '
|
|
2929
|
+
name: 'backfill-id',
|
|
2930
|
+
paramKey: 'backfillId',
|
|
2931
|
+
},
|
|
2932
|
+
],
|
|
2933
|
+
flags: [],
|
|
2934
|
+
hasParams: true,
|
|
2935
|
+
paramsAllOptional: false,
|
|
2936
|
+
bodyOpaque: false,
|
|
2937
|
+
bodyVariants: [],
|
|
2938
|
+
acceptsBody: false,
|
|
2939
|
+
requiresAuth: true,
|
|
2940
|
+
},
|
|
2941
|
+
{
|
|
2942
|
+
commandPath: ['connections', 'agent', 'backfill', 'create'],
|
|
2943
|
+
clientProperty: 'agentConnection',
|
|
2944
|
+
methodName: 'createBackfill',
|
|
2945
|
+
httpMethod: 'post',
|
|
2946
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills',
|
|
2947
|
+
summary: 'Import past calls',
|
|
2948
|
+
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.',
|
|
2949
|
+
positionals: [
|
|
2950
|
+
{
|
|
2951
|
+
name: 'connection-id',
|
|
2952
|
+
paramKey: 'connectionId',
|
|
2953
|
+
},
|
|
2954
|
+
],
|
|
2955
|
+
flags: [
|
|
2956
|
+
{
|
|
2957
|
+
name: 'max-calls',
|
|
2958
|
+
path: ['maxCalls'],
|
|
2959
|
+
location: 'body',
|
|
2960
|
+
required: true,
|
|
2961
|
+
description: 'How many of the most recent past calls to import, up to 1000.',
|
|
2962
|
+
valueKind: 'integer',
|
|
2963
|
+
repeatable: false,
|
|
2964
|
+
},
|
|
2965
|
+
],
|
|
2966
|
+
hasParams: true,
|
|
2967
|
+
paramsAllOptional: false,
|
|
2968
|
+
bodyOpaque: false,
|
|
2969
|
+
bodyVariants: [],
|
|
2970
|
+
acceptsBody: true,
|
|
2971
|
+
requiresAuth: true,
|
|
2972
|
+
},
|
|
2973
|
+
{
|
|
2974
|
+
commandPath: ['connections', 'agent', 'backfill', 'list'],
|
|
2975
|
+
clientProperty: 'agentConnection',
|
|
2976
|
+
methodName: 'listBackfills',
|
|
2977
|
+
httpMethod: 'get',
|
|
2978
|
+
httpPath: '/v1/connections/agent/{connectionId}/backfills',
|
|
2979
|
+
summary: 'List backfills',
|
|
2980
|
+
description: "A connection's imports of past calls, newest first.",
|
|
2981
|
+
positionals: [
|
|
2982
|
+
{
|
|
2983
|
+
name: 'connection-id',
|
|
2984
|
+
paramKey: 'connectionId',
|
|
2985
|
+
},
|
|
2986
|
+
],
|
|
2987
|
+
flags: [],
|
|
2988
|
+
hasParams: false,
|
|
2989
|
+
paramsAllOptional: true,
|
|
2990
|
+
bodyOpaque: false,
|
|
2991
|
+
bodyVariants: [],
|
|
2992
|
+
acceptsBody: false,
|
|
2993
|
+
requiresAuth: true,
|
|
2994
|
+
},
|
|
2995
|
+
{
|
|
2996
|
+
commandPath: ['connections', 'agent', 'create'],
|
|
2997
|
+
clientProperty: 'agentConnection',
|
|
2998
|
+
methodName: 'create',
|
|
2999
|
+
httpMethod: 'post',
|
|
3000
|
+
httpPath: '/v1/connections/agent',
|
|
3001
|
+
summary: 'Connect an agent',
|
|
3002
|
+
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.',
|
|
3003
|
+
positionals: [],
|
|
3004
|
+
flags: [],
|
|
3005
|
+
hasParams: true,
|
|
3006
|
+
paramsAllOptional: false,
|
|
3007
|
+
bodyOpaque: true,
|
|
3008
|
+
bodyVariants: [
|
|
3009
|
+
{
|
|
3010
|
+
name: 'AgentConnectionCreateRetell',
|
|
3011
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
name: 'AgentConnectionCreateVapi',
|
|
3015
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3016
|
+
},
|
|
3017
|
+
{
|
|
3018
|
+
name: 'AgentConnectionCreateElevenLabs',
|
|
3019
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3020
|
+
},
|
|
3021
|
+
{
|
|
3022
|
+
name: 'AgentConnectionCreateBland',
|
|
3023
|
+
required: ['provider', 'name', 'apiKey'],
|
|
3024
|
+
},
|
|
3025
|
+
{
|
|
3026
|
+
name: 'AgentConnectionCreateLeaping',
|
|
3027
|
+
required: ['provider', 'name', 'apiKey', 'agentIds'],
|
|
3028
|
+
},
|
|
3029
|
+
{
|
|
3030
|
+
name: 'AgentConnectionCreateLivekit',
|
|
3031
|
+
required: ['provider', 'name', 'url', 'apiKey', 'apiSecret'],
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
name: 'AgentConnectionCreateLivekitSelfHosted',
|
|
3035
|
+
required: ['provider', 'name'],
|
|
3036
|
+
},
|
|
3037
|
+
{
|
|
3038
|
+
name: 'AgentConnectionCreatePipecatSelfHosted',
|
|
3039
|
+
required: ['provider', 'name'],
|
|
3040
|
+
},
|
|
3041
|
+
{
|
|
3042
|
+
name: 'AgentConnectionCreatePipecatCloud',
|
|
3043
|
+
required: ['provider', 'name'],
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
name: 'AgentConnectionCreateKore',
|
|
3047
|
+
required: ['provider', 'name', 'apiKey', 'appId', 'envName'],
|
|
3048
|
+
},
|
|
3049
|
+
{
|
|
3050
|
+
name: 'AgentConnectionCreateGoogleCes',
|
|
3051
|
+
required: ['provider', 'name', 'wifConfig', 'location', 'appId', 'deploymentId'],
|
|
3052
|
+
},
|
|
3053
|
+
],
|
|
3054
|
+
acceptsBody: true,
|
|
3055
|
+
requiresAuth: true,
|
|
3056
|
+
},
|
|
3057
|
+
{
|
|
3058
|
+
commandPath: ['connections', 'agent', 'delete'],
|
|
3059
|
+
clientProperty: 'agentConnection',
|
|
3060
|
+
methodName: 'delete',
|
|
3061
|
+
httpMethod: 'delete',
|
|
3062
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3063
|
+
summary: 'Disconnect an agent connection',
|
|
3064
|
+
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.',
|
|
3065
|
+
positionals: [
|
|
3066
|
+
{
|
|
3067
|
+
name: 'connection-id',
|
|
3068
|
+
paramKey: 'connectionId',
|
|
3069
|
+
},
|
|
3070
|
+
],
|
|
3071
|
+
flags: [],
|
|
3072
|
+
hasParams: false,
|
|
3073
|
+
paramsAllOptional: true,
|
|
3074
|
+
bodyOpaque: false,
|
|
3075
|
+
bodyVariants: [],
|
|
3076
|
+
acceptsBody: false,
|
|
3077
|
+
requiresAuth: true,
|
|
3078
|
+
},
|
|
3079
|
+
{
|
|
3080
|
+
commandPath: ['connections', 'agent', 'discover'],
|
|
3081
|
+
clientProperty: 'agentConnection',
|
|
3082
|
+
methodName: 'discover',
|
|
3083
|
+
httpMethod: 'post',
|
|
3084
|
+
httpPath: '/v1/connections/agent/discover',
|
|
3085
|
+
summary: 'Discover agents with a platform API key',
|
|
3086
|
+
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.',
|
|
3087
|
+
positionals: [],
|
|
3088
|
+
flags: [
|
|
3089
|
+
{
|
|
3090
|
+
name: 'provider',
|
|
3091
|
+
path: ['provider'],
|
|
3092
|
+
location: 'body',
|
|
3093
|
+
required: true,
|
|
3094
|
+
description: 'Platforms whose agents can be listed with a key.',
|
|
3095
|
+
valueKind: 'string',
|
|
3096
|
+
enumValues: ['RETELL', 'VAPI', 'ELEVEN_LABS', 'BLAND'],
|
|
3097
|
+
repeatable: false,
|
|
3098
|
+
},
|
|
3099
|
+
{
|
|
3100
|
+
name: 'api-key',
|
|
3101
|
+
path: ['apiKey'],
|
|
3102
|
+
location: 'body',
|
|
3103
|
+
required: true,
|
|
3104
|
+
description: 'The platform API key to list agents with. Stored nowhere.',
|
|
3105
|
+
valueKind: 'string',
|
|
3106
|
+
repeatable: false,
|
|
3107
|
+
},
|
|
3108
|
+
],
|
|
3109
|
+
hasParams: true,
|
|
3110
|
+
paramsAllOptional: false,
|
|
3111
|
+
bodyOpaque: false,
|
|
3112
|
+
bodyVariants: [],
|
|
3113
|
+
acceptsBody: true,
|
|
3114
|
+
requiresAuth: true,
|
|
3115
|
+
},
|
|
3116
|
+
{
|
|
3117
|
+
commandPath: ['connections', 'agent', 'get'],
|
|
3118
|
+
clientProperty: 'agentConnection',
|
|
3119
|
+
methodName: 'getByID',
|
|
3120
|
+
httpMethod: 'get',
|
|
3121
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3122
|
+
summary: 'Get an agent connection',
|
|
3123
|
+
description: 'One connection, with its settings and latest sync. Credentials are never returned.',
|
|
3124
|
+
positionals: [
|
|
3125
|
+
{
|
|
3126
|
+
name: 'connection-id',
|
|
3127
|
+
paramKey: 'connectionId',
|
|
3128
|
+
},
|
|
3129
|
+
],
|
|
3130
|
+
flags: [],
|
|
3131
|
+
hasParams: false,
|
|
3132
|
+
paramsAllOptional: true,
|
|
3133
|
+
bodyOpaque: false,
|
|
3134
|
+
bodyVariants: [],
|
|
3135
|
+
acceptsBody: false,
|
|
3136
|
+
requiresAuth: true,
|
|
3137
|
+
},
|
|
3138
|
+
{
|
|
3139
|
+
commandPath: ['connections', 'agent', 'list'],
|
|
3140
|
+
clientProperty: 'agentConnection',
|
|
3141
|
+
methodName: 'list',
|
|
3142
|
+
httpMethod: 'get',
|
|
3143
|
+
httpPath: '/v1/connections/agent',
|
|
3144
|
+
summary: 'List agent connections',
|
|
3145
|
+
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.",
|
|
3146
|
+
positionals: [],
|
|
3147
|
+
flags: [
|
|
3148
|
+
{
|
|
3149
|
+
name: 'provider',
|
|
3150
|
+
path: ['provider'],
|
|
3151
|
+
location: 'query',
|
|
3152
|
+
required: false,
|
|
3153
|
+
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.',
|
|
3154
|
+
valueKind: 'string',
|
|
3155
|
+
enumValues: [
|
|
3156
|
+
'RETELL',
|
|
3157
|
+
'VAPI',
|
|
3158
|
+
'ELEVEN_LABS',
|
|
3159
|
+
'BLAND',
|
|
3160
|
+
'LEAPING',
|
|
3161
|
+
'LIVEKIT',
|
|
3162
|
+
'LIVEKIT_SELF_HOSTED',
|
|
3163
|
+
'PIPECAT_CLOUD_INTEGRATION',
|
|
3164
|
+
'PIPECAT_SELF_HOSTED_INTEGRATION',
|
|
3165
|
+
'KORE',
|
|
3166
|
+
'GOOGLE_CES',
|
|
3167
|
+
],
|
|
3168
|
+
repeatable: false,
|
|
3169
|
+
},
|
|
3170
|
+
],
|
|
3171
|
+
hasParams: true,
|
|
3172
|
+
paramsAllOptional: true,
|
|
3173
|
+
bodyOpaque: false,
|
|
3174
|
+
bodyVariants: [],
|
|
3175
|
+
acceptsBody: false,
|
|
3176
|
+
requiresAuth: true,
|
|
3177
|
+
},
|
|
3178
|
+
{
|
|
3179
|
+
commandPath: ['connections', 'agent', 'provider', 'list'],
|
|
3180
|
+
clientProperty: 'agentConnection',
|
|
3181
|
+
methodName: 'listProviders',
|
|
3182
|
+
httpMethod: 'get',
|
|
3183
|
+
httpPath: '/v1/connections/agent/providers',
|
|
3184
|
+
summary: 'List agent connection providers',
|
|
3185
|
+
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.',
|
|
3186
|
+
positionals: [],
|
|
3187
|
+
flags: [],
|
|
3188
|
+
hasParams: false,
|
|
3189
|
+
paramsAllOptional: true,
|
|
3190
|
+
bodyOpaque: false,
|
|
3191
|
+
bodyVariants: [],
|
|
3192
|
+
acceptsBody: false,
|
|
3193
|
+
requiresAuth: true,
|
|
3194
|
+
},
|
|
3195
|
+
{
|
|
3196
|
+
commandPath: ['connections', 'agent', 'update'],
|
|
3197
|
+
clientProperty: 'agentConnection',
|
|
3198
|
+
methodName: 'update',
|
|
3199
|
+
httpMethod: 'patch',
|
|
3200
|
+
httpPath: '/v1/connections/agent/{connectionId}',
|
|
3201
|
+
summary: 'Update an agent connection',
|
|
3202
|
+
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.',
|
|
3203
|
+
positionals: [
|
|
3204
|
+
{
|
|
3205
|
+
name: 'connection-id',
|
|
3206
|
+
paramKey: 'connectionId',
|
|
3207
|
+
},
|
|
3208
|
+
],
|
|
3209
|
+
flags: [],
|
|
3210
|
+
hasParams: true,
|
|
3211
|
+
paramsAllOptional: false,
|
|
3212
|
+
bodyOpaque: true,
|
|
3213
|
+
bodyVariants: [
|
|
3214
|
+
{
|
|
3215
|
+
name: 'AgentConnectionUpdateRetell',
|
|
3216
|
+
required: ['provider'],
|
|
3217
|
+
},
|
|
3218
|
+
{
|
|
3219
|
+
name: 'AgentConnectionUpdateVapi',
|
|
3220
|
+
required: ['provider'],
|
|
3221
|
+
},
|
|
3222
|
+
{
|
|
3223
|
+
name: 'AgentConnectionUpdateElevenLabs',
|
|
3224
|
+
required: ['provider'],
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
name: 'AgentConnectionUpdateBland',
|
|
3228
|
+
required: ['provider'],
|
|
3229
|
+
},
|
|
3230
|
+
{
|
|
3231
|
+
name: 'AgentConnectionUpdateLeaping',
|
|
3232
|
+
required: ['provider'],
|
|
3233
|
+
},
|
|
3234
|
+
{
|
|
3235
|
+
name: 'AgentConnectionUpdateLivekit',
|
|
3236
|
+
required: ['provider'],
|
|
3237
|
+
},
|
|
3238
|
+
{
|
|
3239
|
+
name: 'AgentConnectionUpdateLivekitSelfHosted',
|
|
3240
|
+
required: ['provider'],
|
|
3241
|
+
},
|
|
3242
|
+
{
|
|
3243
|
+
name: 'AgentConnectionUpdatePipecatSelfHosted',
|
|
3244
|
+
required: ['provider'],
|
|
3245
|
+
},
|
|
3246
|
+
{
|
|
3247
|
+
name: 'AgentConnectionUpdatePipecatCloud',
|
|
3248
|
+
required: ['provider'],
|
|
3249
|
+
},
|
|
3250
|
+
{
|
|
3251
|
+
name: 'AgentConnectionUpdateKore',
|
|
3252
|
+
required: ['provider'],
|
|
3253
|
+
},
|
|
3254
|
+
{
|
|
3255
|
+
name: 'AgentConnectionUpdateGoogleCes',
|
|
3256
|
+
required: ['provider'],
|
|
3257
|
+
},
|
|
3258
|
+
],
|
|
3259
|
+
acceptsBody: true,
|
|
3260
|
+
requiresAuth: true,
|
|
3261
|
+
},
|
|
3262
|
+
{
|
|
3263
|
+
commandPath: ['connections', 'calendar', 'calendar', 'list'],
|
|
3264
|
+
clientProperty: 'calendarConnection',
|
|
3265
|
+
methodName: 'listCalendars',
|
|
3266
|
+
httpMethod: 'get',
|
|
3267
|
+
httpPath: '/v1/connections/calendar/{connectionId}/calendars',
|
|
3268
|
+
summary: 'List calendars for bookable targets',
|
|
3269
|
+
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.',
|
|
3270
|
+
positionals: [
|
|
3271
|
+
{
|
|
3272
|
+
name: 'connection-id',
|
|
3273
|
+
paramKey: 'connectionId',
|
|
3274
|
+
description: 'Calendar connection ID',
|
|
3275
|
+
},
|
|
3276
|
+
],
|
|
3277
|
+
flags: [],
|
|
3278
|
+
hasParams: false,
|
|
3279
|
+
paramsAllOptional: true,
|
|
3280
|
+
bodyOpaque: false,
|
|
3281
|
+
bodyVariants: [],
|
|
3282
|
+
acceptsBody: false,
|
|
3283
|
+
requiresAuth: true,
|
|
3284
|
+
},
|
|
3285
|
+
{
|
|
3286
|
+
commandPath: ['connections', 'calendar', 'calendly-oauth', 'start'],
|
|
3287
|
+
clientProperty: 'calendarConnection',
|
|
3288
|
+
methodName: 'startCalendlyOauth',
|
|
3289
|
+
httpMethod: 'post',
|
|
3290
|
+
httpPath: '/v1/connections/calendar/calendly/authorize-url',
|
|
3291
|
+
summary: 'Start connecting a Calendly account',
|
|
3292
|
+
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`.',
|
|
3293
|
+
positionals: [],
|
|
3294
|
+
flags: [
|
|
3295
|
+
{
|
|
3296
|
+
name: 'calendar-connection-id',
|
|
3297
|
+
path: ['calendarConnectionId'],
|
|
3298
|
+
location: 'body',
|
|
3299
|
+
required: false,
|
|
3300
|
+
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.',
|
|
3301
|
+
valueKind: 'string',
|
|
3302
|
+
repeatable: false,
|
|
3303
|
+
},
|
|
3304
|
+
{
|
|
3305
|
+
name: 'label',
|
|
3306
|
+
path: ['label'],
|
|
3307
|
+
location: 'body',
|
|
3308
|
+
required: false,
|
|
3309
|
+
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.',
|
|
3310
|
+
valueKind: 'string',
|
|
3311
|
+
repeatable: false,
|
|
3312
|
+
},
|
|
3313
|
+
{
|
|
3314
|
+
name: 'timezone',
|
|
3315
|
+
path: ['timezone'],
|
|
3316
|
+
location: 'body',
|
|
3317
|
+
required: false,
|
|
3318
|
+
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.',
|
|
3319
|
+
valueKind: 'string',
|
|
3320
|
+
repeatable: false,
|
|
3321
|
+
},
|
|
3322
|
+
],
|
|
3323
|
+
hasParams: true,
|
|
3324
|
+
paramsAllOptional: true,
|
|
3325
|
+
bodyOpaque: false,
|
|
3326
|
+
bodyVariants: [],
|
|
3327
|
+
acceptsBody: true,
|
|
3328
|
+
requiresAuth: true,
|
|
3329
|
+
},
|
|
3330
|
+
{
|
|
3331
|
+
commandPath: ['connections', 'calendar', 'check'],
|
|
3332
|
+
clientProperty: 'calendarConnection',
|
|
3333
|
+
methodName: 'check',
|
|
3334
|
+
httpMethod: 'post',
|
|
3335
|
+
httpPath: '/v1/connections/calendar/{connectionId}/check',
|
|
3336
|
+
summary: 'Check a calendar connection',
|
|
3337
|
+
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.',
|
|
3338
|
+
positionals: [
|
|
3339
|
+
{
|
|
3340
|
+
name: 'connection-id',
|
|
3341
|
+
paramKey: 'connectionId',
|
|
3342
|
+
description: 'Calendar connection ID',
|
|
3343
|
+
},
|
|
3344
|
+
],
|
|
3345
|
+
flags: [],
|
|
3346
|
+
hasParams: false,
|
|
3347
|
+
paramsAllOptional: true,
|
|
3348
|
+
bodyOpaque: false,
|
|
3349
|
+
bodyVariants: [],
|
|
3350
|
+
acceptsBody: false,
|
|
3351
|
+
requiresAuth: true,
|
|
3352
|
+
},
|
|
3353
|
+
{
|
|
3354
|
+
commandPath: ['connections', 'calendar', 'create'],
|
|
3355
|
+
clientProperty: 'calendarConnection',
|
|
3356
|
+
methodName: 'create',
|
|
3357
|
+
httpMethod: 'post',
|
|
3358
|
+
httpPath: '/v1/connections/calendar',
|
|
3359
|
+
summary: 'Connect a calendar account',
|
|
3360
|
+
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.',
|
|
3361
|
+
positionals: [],
|
|
3362
|
+
flags: [
|
|
3363
|
+
{
|
|
3364
|
+
name: 'provider',
|
|
3365
|
+
path: ['provider'],
|
|
3366
|
+
location: 'body',
|
|
3367
|
+
required: true,
|
|
3368
|
+
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`.',
|
|
3369
|
+
valueKind: 'string',
|
|
3370
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
3371
|
+
repeatable: false,
|
|
3372
|
+
},
|
|
3373
|
+
{
|
|
3374
|
+
name: 'label',
|
|
3375
|
+
path: ['label'],
|
|
3376
|
+
location: 'body',
|
|
3377
|
+
required: true,
|
|
3378
|
+
description: 'Customer-facing name for this account, unique within the project. Required.',
|
|
3379
|
+
valueKind: 'string',
|
|
3380
|
+
repeatable: false,
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
name: 'api-key',
|
|
3384
|
+
path: ['apiKey'],
|
|
3385
|
+
location: 'body',
|
|
3386
|
+
required: true,
|
|
3387
|
+
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.',
|
|
3388
|
+
valueKind: 'string',
|
|
3389
|
+
repeatable: false,
|
|
3390
|
+
},
|
|
3391
|
+
{
|
|
3392
|
+
name: 'timezone',
|
|
3393
|
+
path: ['timezone'],
|
|
3394
|
+
location: 'body',
|
|
3395
|
+
required: false,
|
|
3396
|
+
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.',
|
|
3397
|
+
valueKind: 'string',
|
|
3398
|
+
repeatable: false,
|
|
3399
|
+
},
|
|
3400
|
+
],
|
|
3401
|
+
hasParams: true,
|
|
3402
|
+
paramsAllOptional: false,
|
|
3403
|
+
bodyOpaque: false,
|
|
3404
|
+
bodyVariants: [],
|
|
3405
|
+
acceptsBody: true,
|
|
3406
|
+
requiresAuth: true,
|
|
3407
|
+
},
|
|
3408
|
+
{
|
|
3409
|
+
commandPath: ['connections', 'calendar', 'delete'],
|
|
3410
|
+
clientProperty: 'calendarConnection',
|
|
3411
|
+
methodName: 'delete',
|
|
3412
|
+
httpMethod: 'delete',
|
|
3413
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3414
|
+
summary: 'Delete a calendar connection',
|
|
3415
|
+
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.',
|
|
3416
|
+
positionals: [
|
|
3417
|
+
{
|
|
3418
|
+
name: 'connection-id',
|
|
3419
|
+
paramKey: 'connectionId',
|
|
3420
|
+
description: 'Calendar connection ID',
|
|
3421
|
+
},
|
|
3422
|
+
],
|
|
3423
|
+
flags: [],
|
|
3424
|
+
hasParams: false,
|
|
3425
|
+
paramsAllOptional: true,
|
|
3426
|
+
bodyOpaque: false,
|
|
3427
|
+
bodyVariants: [],
|
|
3428
|
+
acceptsBody: false,
|
|
3429
|
+
requiresAuth: true,
|
|
3430
|
+
},
|
|
3431
|
+
{
|
|
3432
|
+
commandPath: ['connections', 'calendar', 'get'],
|
|
3433
|
+
clientProperty: 'calendarConnection',
|
|
3434
|
+
methodName: 'getByID',
|
|
3435
|
+
httpMethod: 'get',
|
|
3436
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3437
|
+
summary: 'Get a calendar connection',
|
|
3438
|
+
description: 'Returns one calendar connection. The stored credential is never included.',
|
|
3439
|
+
positionals: [
|
|
3440
|
+
{
|
|
3441
|
+
name: 'connection-id',
|
|
3442
|
+
paramKey: 'connectionId',
|
|
3443
|
+
description: 'Calendar connection ID',
|
|
3444
|
+
},
|
|
3445
|
+
],
|
|
3446
|
+
flags: [],
|
|
3447
|
+
hasParams: false,
|
|
3448
|
+
paramsAllOptional: true,
|
|
3449
|
+
bodyOpaque: false,
|
|
3450
|
+
bodyVariants: [],
|
|
3451
|
+
acceptsBody: false,
|
|
3452
|
+
requiresAuth: true,
|
|
3453
|
+
},
|
|
3454
|
+
{
|
|
3455
|
+
commandPath: ['connections', 'calendar', 'google-oauth', 'start'],
|
|
3456
|
+
clientProperty: 'calendarConnection',
|
|
3457
|
+
methodName: 'startGoogleOauth',
|
|
3458
|
+
httpMethod: 'post',
|
|
3459
|
+
httpPath: '/v1/connections/calendar/google/authorize-url',
|
|
3460
|
+
summary: 'Start connecting a Google Calendar',
|
|
3461
|
+
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`.',
|
|
3462
|
+
positionals: [],
|
|
3463
|
+
flags: [
|
|
3464
|
+
{
|
|
3465
|
+
name: 'calendar-connection-id',
|
|
3466
|
+
path: ['calendarConnectionId'],
|
|
3467
|
+
location: 'body',
|
|
3468
|
+
required: false,
|
|
3469
|
+
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.',
|
|
3470
|
+
valueKind: 'string',
|
|
3471
|
+
repeatable: false,
|
|
3472
|
+
},
|
|
3473
|
+
{
|
|
3474
|
+
name: 'label',
|
|
3475
|
+
path: ['label'],
|
|
3476
|
+
location: 'body',
|
|
3477
|
+
required: false,
|
|
3478
|
+
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.',
|
|
3479
|
+
valueKind: 'string',
|
|
3480
|
+
repeatable: false,
|
|
3481
|
+
},
|
|
3482
|
+
{
|
|
3483
|
+
name: 'timezone',
|
|
3484
|
+
path: ['timezone'],
|
|
3485
|
+
location: 'body',
|
|
3486
|
+
required: false,
|
|
3487
|
+
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.',
|
|
3488
|
+
valueKind: 'string',
|
|
3489
|
+
repeatable: false,
|
|
3490
|
+
},
|
|
3491
|
+
{
|
|
3492
|
+
name: 'login-hint',
|
|
3493
|
+
path: ['loginHint'],
|
|
3494
|
+
location: 'body',
|
|
3495
|
+
required: false,
|
|
3496
|
+
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.',
|
|
3497
|
+
valueKind: 'string',
|
|
3498
|
+
repeatable: false,
|
|
3499
|
+
},
|
|
3500
|
+
],
|
|
3501
|
+
hasParams: true,
|
|
3502
|
+
paramsAllOptional: true,
|
|
3503
|
+
bodyOpaque: false,
|
|
3504
|
+
bodyVariants: [],
|
|
3505
|
+
acceptsBody: true,
|
|
3506
|
+
requiresAuth: true,
|
|
3507
|
+
},
|
|
3508
|
+
{
|
|
3509
|
+
commandPath: ['connections', 'calendar', 'list'],
|
|
3510
|
+
clientProperty: 'calendarConnection',
|
|
3511
|
+
methodName: 'list',
|
|
3512
|
+
httpMethod: 'get',
|
|
3513
|
+
httpPath: '/v1/connections/calendar',
|
|
3514
|
+
summary: 'List calendar connections',
|
|
3515
|
+
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.',
|
|
3516
|
+
positionals: [],
|
|
3517
|
+
flags: [
|
|
3518
|
+
{
|
|
3519
|
+
name: 'provider',
|
|
3520
|
+
path: ['provider'],
|
|
3521
|
+
location: 'query',
|
|
3522
|
+
required: false,
|
|
3523
|
+
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`.',
|
|
3524
|
+
valueKind: 'string',
|
|
3525
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
3526
|
+
repeatable: false,
|
|
3527
|
+
},
|
|
3528
|
+
],
|
|
3529
|
+
hasParams: true,
|
|
3530
|
+
paramsAllOptional: true,
|
|
3531
|
+
bodyOpaque: false,
|
|
3532
|
+
bodyVariants: [],
|
|
3533
|
+
acceptsBody: false,
|
|
3534
|
+
requiresAuth: true,
|
|
3535
|
+
},
|
|
3536
|
+
{
|
|
3537
|
+
commandPath: ['connections', 'calendar', 'target', 'create'],
|
|
3538
|
+
clientProperty: 'calendarConnection',
|
|
3539
|
+
methodName: 'createTarget',
|
|
3540
|
+
httpMethod: 'post',
|
|
3541
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets',
|
|
3542
|
+
summary: 'Create a bookable target',
|
|
3543
|
+
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.',
|
|
3544
|
+
positionals: [
|
|
3545
|
+
{
|
|
3546
|
+
name: 'connection-id',
|
|
3547
|
+
paramKey: 'connectionId',
|
|
3548
|
+
description: 'Calendar connection ID',
|
|
3549
|
+
},
|
|
3550
|
+
],
|
|
3551
|
+
flags: [
|
|
3552
|
+
{
|
|
3553
|
+
name: 'name',
|
|
3554
|
+
path: ['name'],
|
|
3555
|
+
location: 'body',
|
|
3556
|
+
required: true,
|
|
3557
|
+
description: 'Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or -.',
|
|
3558
|
+
valueKind: 'string',
|
|
3559
|
+
repeatable: false,
|
|
3560
|
+
},
|
|
3561
|
+
{
|
|
3562
|
+
name: 'calendar-id',
|
|
3563
|
+
path: ['calendarId'],
|
|
3564
|
+
location: 'body',
|
|
3565
|
+
required: true,
|
|
3566
|
+
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.',
|
|
3567
|
+
valueKind: 'string',
|
|
3568
|
+
repeatable: false,
|
|
3569
|
+
},
|
|
3570
|
+
{
|
|
3571
|
+
name: 'duration-minutes',
|
|
3572
|
+
path: ['durationMinutes'],
|
|
3573
|
+
location: 'body',
|
|
3574
|
+
required: true,
|
|
3575
|
+
valueKind: 'integer',
|
|
3576
|
+
repeatable: false,
|
|
3577
|
+
},
|
|
3578
|
+
{
|
|
3579
|
+
name: 'buffer-before-minutes',
|
|
3580
|
+
path: ['bufferBeforeMinutes'],
|
|
3581
|
+
location: 'body',
|
|
3582
|
+
required: false,
|
|
3583
|
+
description: 'Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0.',
|
|
3584
|
+
valueKind: 'integer',
|
|
3585
|
+
repeatable: false,
|
|
3586
|
+
},
|
|
3587
|
+
{
|
|
3588
|
+
name: 'buffer-after-minutes',
|
|
3589
|
+
path: ['bufferAfterMinutes'],
|
|
3590
|
+
location: 'body',
|
|
3591
|
+
required: false,
|
|
3592
|
+
valueKind: 'integer',
|
|
3593
|
+
repeatable: false,
|
|
3594
|
+
},
|
|
3595
|
+
{
|
|
3596
|
+
name: 'min-notice-minutes',
|
|
3597
|
+
path: ['minNoticeMinutes'],
|
|
3598
|
+
location: 'body',
|
|
3599
|
+
required: false,
|
|
3600
|
+
description: 'How soon from now an appointment may be made. Defaults to 120.',
|
|
3601
|
+
valueKind: 'integer',
|
|
3602
|
+
repeatable: false,
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
name: 'horizon-days',
|
|
3606
|
+
path: ['horizonDays'],
|
|
3607
|
+
location: 'body',
|
|
3608
|
+
required: false,
|
|
3609
|
+
description: 'How far ahead appointments may be made. Defaults to 30.',
|
|
3610
|
+
valueKind: 'integer',
|
|
3611
|
+
repeatable: false,
|
|
3612
|
+
},
|
|
3613
|
+
{
|
|
3614
|
+
name: 'slot-interval-minutes',
|
|
3615
|
+
path: ['slotIntervalMinutes'],
|
|
3616
|
+
location: 'body',
|
|
3617
|
+
required: false,
|
|
3618
|
+
description: 'The grid slots are offered on. Defaults to the duration, which gives back-to-back appointments.',
|
|
3619
|
+
valueKind: 'integer',
|
|
3620
|
+
repeatable: false,
|
|
3621
|
+
},
|
|
3622
|
+
{
|
|
3623
|
+
name: 'all-day-events-block',
|
|
3624
|
+
path: ['allDayEventsBlock'],
|
|
3625
|
+
location: 'body',
|
|
3626
|
+
required: false,
|
|
3627
|
+
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.',
|
|
3628
|
+
valueKind: 'boolean',
|
|
3629
|
+
repeatable: false,
|
|
3630
|
+
},
|
|
3631
|
+
{
|
|
3632
|
+
name: 'hours',
|
|
3633
|
+
path: ['hours'],
|
|
3634
|
+
location: 'body',
|
|
3635
|
+
required: false,
|
|
3636
|
+
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.',
|
|
3637
|
+
valueKind: 'array',
|
|
3638
|
+
repeatable: false,
|
|
3639
|
+
},
|
|
3640
|
+
],
|
|
3641
|
+
hasParams: true,
|
|
3642
|
+
paramsAllOptional: false,
|
|
3643
|
+
bodyOpaque: false,
|
|
3644
|
+
bodyVariants: [],
|
|
3645
|
+
acceptsBody: true,
|
|
3646
|
+
requiresAuth: true,
|
|
3647
|
+
},
|
|
3648
|
+
{
|
|
3649
|
+
commandPath: ['connections', 'calendar', 'target', 'delete'],
|
|
3650
|
+
clientProperty: 'calendarConnection',
|
|
3651
|
+
methodName: 'deleteTarget',
|
|
3652
|
+
httpMethod: 'delete',
|
|
3653
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3654
|
+
summary: 'Delete a bookable target',
|
|
3655
|
+
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.',
|
|
3656
|
+
positionals: [
|
|
3657
|
+
{
|
|
3658
|
+
name: 'connection-id',
|
|
3659
|
+
paramKey: 'connectionId',
|
|
3660
|
+
description: 'Calendar connection ID',
|
|
3661
|
+
},
|
|
3662
|
+
{
|
|
3663
|
+
name: 'target-id',
|
|
3664
|
+
paramKey: 'targetId',
|
|
3665
|
+
description: 'Bookable target ID',
|
|
3666
|
+
},
|
|
3667
|
+
],
|
|
3668
|
+
flags: [],
|
|
3669
|
+
hasParams: true,
|
|
3670
|
+
paramsAllOptional: false,
|
|
3671
|
+
bodyOpaque: false,
|
|
3672
|
+
bodyVariants: [],
|
|
3673
|
+
acceptsBody: false,
|
|
3674
|
+
requiresAuth: true,
|
|
3675
|
+
},
|
|
3676
|
+
{
|
|
3677
|
+
commandPath: ['connections', 'calendar', 'target', 'get'],
|
|
3678
|
+
clientProperty: 'calendarConnection',
|
|
3679
|
+
methodName: 'getTarget',
|
|
3680
|
+
httpMethod: 'get',
|
|
3681
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3682
|
+
summary: 'Get a bookable target',
|
|
3683
|
+
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.',
|
|
3684
|
+
positionals: [
|
|
3685
|
+
{
|
|
3686
|
+
name: 'connection-id',
|
|
3687
|
+
paramKey: 'connectionId',
|
|
3688
|
+
description: 'Calendar connection ID',
|
|
3689
|
+
},
|
|
3690
|
+
{
|
|
3691
|
+
name: 'target-id',
|
|
3692
|
+
paramKey: 'targetId',
|
|
3693
|
+
description: 'Target id, as the list returned it',
|
|
3694
|
+
},
|
|
3695
|
+
],
|
|
3696
|
+
flags: [],
|
|
3697
|
+
hasParams: true,
|
|
3698
|
+
paramsAllOptional: false,
|
|
3699
|
+
bodyOpaque: false,
|
|
3700
|
+
bodyVariants: [],
|
|
3701
|
+
acceptsBody: false,
|
|
3702
|
+
requiresAuth: true,
|
|
3703
|
+
},
|
|
3704
|
+
{
|
|
3705
|
+
commandPath: ['connections', 'calendar', 'target', 'list'],
|
|
3706
|
+
clientProperty: 'calendarConnection',
|
|
3707
|
+
methodName: 'listTargets',
|
|
3708
|
+
httpMethod: 'get',
|
|
3709
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets',
|
|
3710
|
+
summary: 'List bookable targets',
|
|
3711
|
+
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.',
|
|
3712
|
+
positionals: [
|
|
3713
|
+
{
|
|
3714
|
+
name: 'connection-id',
|
|
3715
|
+
paramKey: 'connectionId',
|
|
3716
|
+
description: 'Calendar connection ID',
|
|
3717
|
+
},
|
|
3718
|
+
],
|
|
3719
|
+
flags: [],
|
|
3720
|
+
hasParams: false,
|
|
3721
|
+
paramsAllOptional: true,
|
|
3722
|
+
bodyOpaque: false,
|
|
3723
|
+
bodyVariants: [],
|
|
3724
|
+
acceptsBody: false,
|
|
3725
|
+
requiresAuth: true,
|
|
3726
|
+
},
|
|
3727
|
+
{
|
|
3728
|
+
commandPath: ['connections', 'calendar', 'target', 'update'],
|
|
3729
|
+
clientProperty: 'calendarConnection',
|
|
3730
|
+
methodName: 'updateTarget',
|
|
3731
|
+
httpMethod: 'put',
|
|
3732
|
+
httpPath: '/v1/connections/calendar/{connectionId}/targets/{targetId}',
|
|
3733
|
+
summary: 'Update a bookable target',
|
|
3734
|
+
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.',
|
|
3735
|
+
positionals: [
|
|
3736
|
+
{
|
|
3737
|
+
name: 'connection-id',
|
|
3738
|
+
paramKey: 'connectionId',
|
|
3739
|
+
description: 'Calendar connection ID',
|
|
3740
|
+
},
|
|
3741
|
+
{
|
|
3742
|
+
name: 'target-id',
|
|
3743
|
+
paramKey: 'targetId',
|
|
3744
|
+
description: 'Bookable target ID',
|
|
3745
|
+
},
|
|
3746
|
+
],
|
|
3747
|
+
flags: [
|
|
3748
|
+
{
|
|
3749
|
+
name: 'name',
|
|
3750
|
+
path: ['name'],
|
|
3751
|
+
location: 'body',
|
|
3752
|
+
required: false,
|
|
3753
|
+
description: 'Unique within the connection, and how a config file refers to this target. Letters, digits, spaces, _ or -.',
|
|
3754
|
+
valueKind: 'string',
|
|
3755
|
+
repeatable: false,
|
|
3756
|
+
},
|
|
3757
|
+
{
|
|
3758
|
+
name: 'duration-minutes',
|
|
3759
|
+
path: ['durationMinutes'],
|
|
3760
|
+
location: 'body',
|
|
3761
|
+
required: false,
|
|
3762
|
+
valueKind: 'integer',
|
|
3763
|
+
repeatable: false,
|
|
3764
|
+
},
|
|
3765
|
+
{
|
|
3766
|
+
name: 'buffer-before-minutes',
|
|
3767
|
+
path: ['bufferBeforeMinutes'],
|
|
3768
|
+
location: 'body',
|
|
3769
|
+
required: false,
|
|
3770
|
+
description: 'Dead time before an appointment, counted as busy when a slot is offered. Defaults to 0.',
|
|
3771
|
+
valueKind: 'integer',
|
|
3772
|
+
repeatable: false,
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
name: 'buffer-after-minutes',
|
|
3776
|
+
path: ['bufferAfterMinutes'],
|
|
3777
|
+
location: 'body',
|
|
3778
|
+
required: false,
|
|
3779
|
+
valueKind: 'integer',
|
|
3780
|
+
repeatable: false,
|
|
3781
|
+
},
|
|
3782
|
+
{
|
|
3783
|
+
name: 'min-notice-minutes',
|
|
3784
|
+
path: ['minNoticeMinutes'],
|
|
3785
|
+
location: 'body',
|
|
3786
|
+
required: false,
|
|
3787
|
+
description: 'How soon from now an appointment may be made. Defaults to 120.',
|
|
3788
|
+
valueKind: 'integer',
|
|
3789
|
+
repeatable: false,
|
|
3790
|
+
},
|
|
3791
|
+
{
|
|
3792
|
+
name: 'horizon-days',
|
|
3793
|
+
path: ['horizonDays'],
|
|
3794
|
+
location: 'body',
|
|
3795
|
+
required: false,
|
|
3796
|
+
description: 'How far ahead appointments may be made. Defaults to 30.',
|
|
3797
|
+
valueKind: 'integer',
|
|
3798
|
+
repeatable: false,
|
|
3799
|
+
},
|
|
3800
|
+
{
|
|
3801
|
+
name: 'slot-interval-minutes',
|
|
3802
|
+
path: ['slotIntervalMinutes'],
|
|
3803
|
+
location: 'body',
|
|
3804
|
+
required: false,
|
|
3805
|
+
description: 'The grid slots are offered on. Defaults to the duration, which gives back-to-back appointments.',
|
|
3806
|
+
valueKind: 'integer',
|
|
3807
|
+
repeatable: false,
|
|
3808
|
+
},
|
|
3809
|
+
{
|
|
3810
|
+
name: 'all-day-events-block',
|
|
3811
|
+
path: ['allDayEventsBlock'],
|
|
3812
|
+
location: 'body',
|
|
3813
|
+
required: false,
|
|
3814
|
+
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.',
|
|
3815
|
+
valueKind: 'boolean',
|
|
3816
|
+
repeatable: false,
|
|
3817
|
+
},
|
|
3818
|
+
{
|
|
3819
|
+
name: 'hours',
|
|
3820
|
+
path: ['hours'],
|
|
3821
|
+
location: 'body',
|
|
3822
|
+
required: false,
|
|
3823
|
+
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.',
|
|
3824
|
+
valueKind: 'array',
|
|
3825
|
+
repeatable: false,
|
|
3826
|
+
},
|
|
3827
|
+
],
|
|
3828
|
+
hasParams: true,
|
|
3829
|
+
paramsAllOptional: false,
|
|
3830
|
+
bodyOpaque: false,
|
|
3831
|
+
bodyVariants: [],
|
|
3832
|
+
acceptsBody: true,
|
|
3833
|
+
requiresAuth: true,
|
|
3834
|
+
},
|
|
3835
|
+
{
|
|
3836
|
+
commandPath: ['connections', 'calendar', 'update'],
|
|
3837
|
+
clientProperty: 'calendarConnection',
|
|
3838
|
+
methodName: 'update',
|
|
3839
|
+
httpMethod: 'patch',
|
|
3840
|
+
httpPath: '/v1/connections/calendar/{connectionId}',
|
|
3841
|
+
summary: 'Update a calendar connection',
|
|
3842
|
+
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.',
|
|
3843
|
+
positionals: [
|
|
3844
|
+
{
|
|
3845
|
+
name: 'connection-id',
|
|
3846
|
+
paramKey: 'connectionId',
|
|
3847
|
+
description: 'Calendar connection ID',
|
|
3848
|
+
},
|
|
3849
|
+
],
|
|
3850
|
+
flags: [
|
|
3851
|
+
{
|
|
3852
|
+
name: 'label',
|
|
3853
|
+
path: ['label'],
|
|
3854
|
+
location: 'body',
|
|
3855
|
+
required: false,
|
|
3856
|
+
description: 'Rename the connection.',
|
|
3857
|
+
valueKind: 'string',
|
|
3858
|
+
repeatable: false,
|
|
3859
|
+
},
|
|
3860
|
+
{
|
|
3861
|
+
name: 'timezone',
|
|
3862
|
+
path: ['timezone'],
|
|
3863
|
+
location: 'body',
|
|
3864
|
+
required: false,
|
|
3865
|
+
description: 'Change the named IANA timezone slots are offered in.',
|
|
3866
|
+
valueKind: 'string',
|
|
3867
|
+
repeatable: false,
|
|
3868
|
+
},
|
|
3869
|
+
{
|
|
3870
|
+
name: 'api-key',
|
|
3871
|
+
path: ['apiKey'],
|
|
3872
|
+
location: 'body',
|
|
3873
|
+
required: false,
|
|
3874
|
+
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.',
|
|
3875
|
+
valueKind: 'string',
|
|
3876
|
+
repeatable: false,
|
|
3877
|
+
},
|
|
3878
|
+
],
|
|
3879
|
+
hasParams: true,
|
|
3880
|
+
paramsAllOptional: true,
|
|
3881
|
+
bodyOpaque: false,
|
|
3882
|
+
bodyVariants: [],
|
|
3883
|
+
acceptsBody: true,
|
|
3884
|
+
requiresAuth: true,
|
|
3885
|
+
},
|
|
3886
|
+
{
|
|
3887
|
+
commandPath: ['connections', 'mcp-server', 'create'],
|
|
3888
|
+
clientProperty: 'mcpServer',
|
|
3889
|
+
methodName: 'create',
|
|
3890
|
+
httpMethod: 'post',
|
|
3891
|
+
httpPath: '/v1/connections/mcp-server',
|
|
3892
|
+
summary: 'Connect an MCP server',
|
|
3893
|
+
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.',
|
|
3894
|
+
positionals: [],
|
|
3895
|
+
flags: [
|
|
3896
|
+
{
|
|
3897
|
+
name: 'url',
|
|
3898
|
+
path: ['url'],
|
|
3899
|
+
location: 'body',
|
|
3900
|
+
required: true,
|
|
3901
|
+
valueKind: 'string',
|
|
3902
|
+
repeatable: false,
|
|
3903
|
+
},
|
|
3904
|
+
{
|
|
3905
|
+
name: 'transport',
|
|
3906
|
+
path: ['transport'],
|
|
3907
|
+
location: 'body',
|
|
3908
|
+
required: false,
|
|
3909
|
+
valueKind: 'string',
|
|
3910
|
+
enumValues: ['STREAMABLE_HTTP', 'SSE'],
|
|
3911
|
+
repeatable: false,
|
|
3912
|
+
},
|
|
3913
|
+
{
|
|
3914
|
+
name: 'auth',
|
|
3915
|
+
path: ['auth'],
|
|
3916
|
+
location: 'body',
|
|
3917
|
+
required: false,
|
|
3918
|
+
valueKind: 'object',
|
|
3919
|
+
},
|
|
3920
|
+
{
|
|
3921
|
+
name: 'label',
|
|
3922
|
+
path: ['label'],
|
|
3923
|
+
location: 'body',
|
|
3924
|
+
required: true,
|
|
3925
|
+
valueKind: 'string',
|
|
3926
|
+
repeatable: false,
|
|
3927
|
+
},
|
|
3928
|
+
{
|
|
3929
|
+
name: 'directory-key',
|
|
3930
|
+
path: ['directoryKey'],
|
|
3931
|
+
location: 'body',
|
|
3932
|
+
required: false,
|
|
3933
|
+
valueKind: 'string',
|
|
3934
|
+
repeatable: false,
|
|
3935
|
+
},
|
|
3936
|
+
],
|
|
3937
|
+
hasParams: true,
|
|
3938
|
+
paramsAllOptional: false,
|
|
3939
|
+
bodyOpaque: false,
|
|
3940
|
+
bodyVariants: [],
|
|
3941
|
+
acceptsBody: true,
|
|
3942
|
+
requiresAuth: true,
|
|
3943
|
+
},
|
|
3944
|
+
{
|
|
3945
|
+
commandPath: ['connections', 'mcp-server', 'delete'],
|
|
3946
|
+
clientProperty: 'mcpServer',
|
|
3947
|
+
methodName: 'delete',
|
|
3948
|
+
httpMethod: 'delete',
|
|
3949
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
3950
|
+
summary: 'Disconnect an MCP server',
|
|
3951
|
+
description: 'Deletes the server and its stored credential. A server a tool still uses returns 409, naming the tools.',
|
|
3952
|
+
positionals: [
|
|
3953
|
+
{
|
|
3954
|
+
name: 'server-id',
|
|
3955
|
+
paramKey: 'serverId',
|
|
3956
|
+
},
|
|
3957
|
+
],
|
|
3958
|
+
flags: [],
|
|
3959
|
+
hasParams: false,
|
|
3960
|
+
paramsAllOptional: true,
|
|
3961
|
+
bodyOpaque: false,
|
|
3962
|
+
bodyVariants: [],
|
|
3963
|
+
acceptsBody: false,
|
|
3964
|
+
requiresAuth: true,
|
|
3965
|
+
},
|
|
3966
|
+
{
|
|
3967
|
+
commandPath: ['connections', 'mcp-server', 'discover'],
|
|
3968
|
+
clientProperty: 'mcpServer',
|
|
3969
|
+
methodName: 'discover',
|
|
3970
|
+
httpMethod: 'post',
|
|
3971
|
+
httpPath: '/v1/connections/mcp-server/discover',
|
|
3972
|
+
summary: 'Discover an MCP server',
|
|
3973
|
+
description: 'Connects to a server and returns the tools it offers, without storing anything. Use it to check a url and credential before connecting.',
|
|
3974
|
+
positionals: [],
|
|
3975
|
+
flags: [
|
|
3976
|
+
{
|
|
3977
|
+
name: 'url',
|
|
3978
|
+
path: ['url'],
|
|
3979
|
+
location: 'body',
|
|
3980
|
+
required: true,
|
|
3981
|
+
valueKind: 'string',
|
|
3982
|
+
repeatable: false,
|
|
3983
|
+
},
|
|
3984
|
+
{
|
|
3985
|
+
name: 'transport',
|
|
3986
|
+
path: ['transport'],
|
|
3987
|
+
location: 'body',
|
|
3988
|
+
required: false,
|
|
3989
|
+
valueKind: 'string',
|
|
3990
|
+
enumValues: ['STREAMABLE_HTTP', 'SSE'],
|
|
3991
|
+
repeatable: false,
|
|
3992
|
+
},
|
|
3993
|
+
{
|
|
3994
|
+
name: 'auth',
|
|
3995
|
+
path: ['auth'],
|
|
3996
|
+
location: 'body',
|
|
3997
|
+
required: false,
|
|
3998
|
+
valueKind: 'object',
|
|
3999
|
+
},
|
|
4000
|
+
],
|
|
4001
|
+
hasParams: true,
|
|
4002
|
+
paramsAllOptional: false,
|
|
4003
|
+
bodyOpaque: false,
|
|
4004
|
+
bodyVariants: [],
|
|
4005
|
+
acceptsBody: true,
|
|
4006
|
+
requiresAuth: true,
|
|
4007
|
+
},
|
|
4008
|
+
{
|
|
4009
|
+
commandPath: ['connections', 'mcp-server', 'get'],
|
|
4010
|
+
clientProperty: 'mcpServer',
|
|
4011
|
+
methodName: 'getByID',
|
|
4012
|
+
httpMethod: 'get',
|
|
4013
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
4014
|
+
summary: 'Get an MCP server',
|
|
4015
|
+
description: 'One MCP server. The credential is never returned.',
|
|
4016
|
+
positionals: [
|
|
4017
|
+
{
|
|
4018
|
+
name: 'server-id',
|
|
4019
|
+
paramKey: 'serverId',
|
|
4020
|
+
},
|
|
4021
|
+
],
|
|
4022
|
+
flags: [],
|
|
4023
|
+
hasParams: false,
|
|
4024
|
+
paramsAllOptional: true,
|
|
4025
|
+
bodyOpaque: false,
|
|
4026
|
+
bodyVariants: [],
|
|
4027
|
+
acceptsBody: false,
|
|
4028
|
+
requiresAuth: true,
|
|
4029
|
+
},
|
|
4030
|
+
{
|
|
4031
|
+
commandPath: ['connections', 'mcp-server', 'list'],
|
|
4032
|
+
clientProperty: 'mcpServer',
|
|
4033
|
+
methodName: 'list',
|
|
4034
|
+
httpMethod: 'get',
|
|
4035
|
+
httpPath: '/v1/connections/mcp-server',
|
|
4036
|
+
summary: 'List MCP servers',
|
|
4037
|
+
description: "The project's MCP servers, by label, each with the tools it offered when last checked. Credentials are never returned.",
|
|
4038
|
+
positionals: [],
|
|
4039
|
+
flags: [],
|
|
4040
|
+
hasParams: false,
|
|
4041
|
+
paramsAllOptional: true,
|
|
4042
|
+
bodyOpaque: false,
|
|
4043
|
+
bodyVariants: [],
|
|
4044
|
+
acceptsBody: false,
|
|
4045
|
+
requiresAuth: true,
|
|
4046
|
+
},
|
|
4047
|
+
{
|
|
4048
|
+
commandPath: ['connections', 'mcp-server', 'refresh'],
|
|
4049
|
+
clientProperty: 'mcpServer',
|
|
4050
|
+
methodName: 'refresh',
|
|
4051
|
+
httpMethod: 'post',
|
|
4052
|
+
httpPath: '/v1/connections/mcp-server/{serverId}/refresh',
|
|
4053
|
+
summary: 'Refresh an MCP server',
|
|
4054
|
+
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.',
|
|
4055
|
+
positionals: [
|
|
4056
|
+
{
|
|
4057
|
+
name: 'server-id',
|
|
4058
|
+
paramKey: 'serverId',
|
|
4059
|
+
},
|
|
4060
|
+
],
|
|
4061
|
+
flags: [],
|
|
4062
|
+
hasParams: false,
|
|
4063
|
+
paramsAllOptional: true,
|
|
4064
|
+
bodyOpaque: false,
|
|
4065
|
+
bodyVariants: [],
|
|
4066
|
+
acceptsBody: false,
|
|
4067
|
+
requiresAuth: true,
|
|
4068
|
+
},
|
|
4069
|
+
{
|
|
4070
|
+
commandPath: ['connections', 'mcp-server', 'update'],
|
|
4071
|
+
clientProperty: 'mcpServer',
|
|
4072
|
+
methodName: 'update',
|
|
4073
|
+
httpMethod: 'patch',
|
|
4074
|
+
httpPath: '/v1/connections/mcp-server/{serverId}',
|
|
4075
|
+
summary: 'Update an MCP server',
|
|
4076
|
+
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.',
|
|
4077
|
+
positionals: [
|
|
4078
|
+
{
|
|
4079
|
+
name: 'server-id',
|
|
4080
|
+
paramKey: 'serverId',
|
|
4081
|
+
},
|
|
4082
|
+
],
|
|
4083
|
+
flags: [
|
|
4084
|
+
{
|
|
4085
|
+
name: 'label',
|
|
4086
|
+
path: ['label'],
|
|
4087
|
+
location: 'body',
|
|
4088
|
+
required: false,
|
|
4089
|
+
valueKind: 'string',
|
|
4090
|
+
repeatable: false,
|
|
4091
|
+
},
|
|
4092
|
+
{
|
|
4093
|
+
name: 'auth',
|
|
4094
|
+
path: ['auth'],
|
|
4095
|
+
location: 'body',
|
|
4096
|
+
required: false,
|
|
4097
|
+
description: 'How the server authenticates. Stored encrypted; never returned.',
|
|
4098
|
+
valueKind: 'string',
|
|
4099
|
+
repeatable: false,
|
|
4100
|
+
},
|
|
4101
|
+
],
|
|
4102
|
+
hasParams: true,
|
|
4103
|
+
paramsAllOptional: true,
|
|
4104
|
+
bodyOpaque: false,
|
|
4105
|
+
bodyVariants: [],
|
|
4106
|
+
acceptsBody: true,
|
|
4107
|
+
requiresAuth: true,
|
|
4108
|
+
},
|
|
4109
|
+
{
|
|
4110
|
+
commandPath: ['conversation', 'get'],
|
|
4111
|
+
clientProperty: 'conversation',
|
|
4112
|
+
methodName: 'getByID',
|
|
4113
|
+
httpMethod: 'get',
|
|
4114
|
+
httpPath: '/v1/conversation/{conversationId}',
|
|
4115
|
+
summary: 'Get a conversation',
|
|
4116
|
+
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`.',
|
|
4117
|
+
positionals: [
|
|
4118
|
+
{
|
|
4119
|
+
name: 'conversation-id',
|
|
4120
|
+
paramKey: 'conversationId',
|
|
4121
|
+
},
|
|
4122
|
+
],
|
|
4123
|
+
flags: [],
|
|
4124
|
+
hasParams: false,
|
|
4125
|
+
paramsAllOptional: true,
|
|
4126
|
+
bodyOpaque: false,
|
|
4127
|
+
bodyVariants: [],
|
|
4128
|
+
acceptsBody: false,
|
|
4129
|
+
requiresAuth: true,
|
|
4130
|
+
},
|
|
4131
|
+
{
|
|
4132
|
+
commandPath: ['credential', 'create'],
|
|
4133
|
+
clientProperty: 'me',
|
|
4134
|
+
methodName: 'createAPIKey',
|
|
4135
|
+
httpMethod: 'post',
|
|
4136
|
+
httpPath: '/v1/me/api-keys',
|
|
4137
|
+
summary: 'Create a personal API key',
|
|
4138
|
+
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.',
|
|
4139
|
+
positionals: [],
|
|
4140
|
+
flags: [
|
|
4141
|
+
{
|
|
4142
|
+
name: 'name',
|
|
4143
|
+
path: ['name'],
|
|
4144
|
+
location: 'body',
|
|
4145
|
+
required: true,
|
|
4146
|
+
description: 'A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from.',
|
|
4147
|
+
valueKind: 'string',
|
|
4148
|
+
repeatable: false,
|
|
4149
|
+
},
|
|
4150
|
+
{
|
|
4151
|
+
name: 'project-id',
|
|
2990
4152
|
path: ['projectId'],
|
|
2991
4153
|
location: 'body',
|
|
2992
4154
|
required: false,
|
|
2993
|
-
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.",
|
|
4155
|
+
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.",
|
|
4156
|
+
valueKind: 'string',
|
|
4157
|
+
repeatable: false,
|
|
4158
|
+
},
|
|
4159
|
+
{
|
|
4160
|
+
name: 'scopes',
|
|
4161
|
+
path: ['scopes'],
|
|
4162
|
+
location: 'body',
|
|
4163
|
+
required: false,
|
|
4164
|
+
description: "Coarse tier. Defaults to the calling credential's own tier, and can never exceed it: a READ credential cannot mint a WRITE one.",
|
|
4165
|
+
valueKind: 'array',
|
|
4166
|
+
enumValues: ['READ', 'WRITE'],
|
|
4167
|
+
repeatable: true,
|
|
4168
|
+
},
|
|
4169
|
+
{
|
|
4170
|
+
name: 'permissions',
|
|
4171
|
+
path: ['permissions'],
|
|
4172
|
+
location: 'body',
|
|
4173
|
+
required: false,
|
|
4174
|
+
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.",
|
|
4175
|
+
valueKind: 'array',
|
|
4176
|
+
repeatable: true,
|
|
4177
|
+
},
|
|
4178
|
+
{
|
|
4179
|
+
name: 'expires-at',
|
|
4180
|
+
path: ['expiresAt'],
|
|
4181
|
+
location: 'body',
|
|
4182
|
+
required: false,
|
|
4183
|
+
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.",
|
|
4184
|
+
valueKind: 'string',
|
|
4185
|
+
repeatable: false,
|
|
4186
|
+
},
|
|
4187
|
+
],
|
|
4188
|
+
hasParams: true,
|
|
4189
|
+
paramsAllOptional: false,
|
|
4190
|
+
bodyOpaque: false,
|
|
4191
|
+
bodyVariants: [],
|
|
4192
|
+
acceptsBody: true,
|
|
4193
|
+
requiresAuth: true,
|
|
4194
|
+
},
|
|
4195
|
+
{
|
|
4196
|
+
commandPath: ['credential', 'list'],
|
|
4197
|
+
clientProperty: 'me',
|
|
4198
|
+
methodName: 'listAPIKeys',
|
|
4199
|
+
httpMethod: 'get',
|
|
4200
|
+
httpPath: '/v1/me/api-keys',
|
|
4201
|
+
summary: 'List personal API keys',
|
|
4202
|
+
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.',
|
|
4203
|
+
positionals: [],
|
|
4204
|
+
flags: [
|
|
4205
|
+
{
|
|
4206
|
+
name: 'status',
|
|
4207
|
+
path: ['status'],
|
|
4208
|
+
location: 'query',
|
|
4209
|
+
required: false,
|
|
4210
|
+
description: 'Filter by status. Defaults to ACTIVE.',
|
|
4211
|
+
valueKind: 'string',
|
|
4212
|
+
enumValues: ['ACTIVE', 'REVOKED'],
|
|
4213
|
+
repeatable: false,
|
|
4214
|
+
},
|
|
4215
|
+
],
|
|
4216
|
+
hasParams: true,
|
|
4217
|
+
paramsAllOptional: true,
|
|
4218
|
+
bodyOpaque: false,
|
|
4219
|
+
bodyVariants: [],
|
|
4220
|
+
acceptsBody: false,
|
|
4221
|
+
requiresAuth: true,
|
|
4222
|
+
},
|
|
4223
|
+
{
|
|
4224
|
+
commandPath: ['credential', 'revoke'],
|
|
4225
|
+
clientProperty: 'me',
|
|
4226
|
+
methodName: 'revokeAPIKey',
|
|
4227
|
+
httpMethod: 'delete',
|
|
4228
|
+
httpPath: '/v1/me/api-keys/{id}',
|
|
4229
|
+
summary: 'Revoke a personal API key',
|
|
4230
|
+
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.',
|
|
4231
|
+
positionals: [
|
|
4232
|
+
{
|
|
4233
|
+
name: 'credential-id',
|
|
4234
|
+
paramKey: 'id',
|
|
4235
|
+
},
|
|
4236
|
+
],
|
|
4237
|
+
flags: [],
|
|
4238
|
+
hasParams: false,
|
|
4239
|
+
paramsAllOptional: true,
|
|
4240
|
+
bodyOpaque: false,
|
|
4241
|
+
bodyVariants: [],
|
|
4242
|
+
acceptsBody: false,
|
|
4243
|
+
requiresAuth: true,
|
|
4244
|
+
},
|
|
4245
|
+
{
|
|
4246
|
+
commandPath: ['customer', 'attribute', 'delete'],
|
|
4247
|
+
clientProperty: 'customer',
|
|
4248
|
+
methodName: 'clearAttribute',
|
|
4249
|
+
httpMethod: 'delete',
|
|
4250
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}',
|
|
4251
|
+
summary: 'Clear a field on a customer',
|
|
4252
|
+
description: 'Removes the value and any lock, so a later conversation can fill it again.',
|
|
4253
|
+
positionals: [
|
|
4254
|
+
{
|
|
4255
|
+
name: 'customer-profile-id',
|
|
4256
|
+
paramKey: 'customerProfileId',
|
|
4257
|
+
},
|
|
4258
|
+
{
|
|
4259
|
+
name: 'key',
|
|
4260
|
+
paramKey: 'key',
|
|
4261
|
+
},
|
|
4262
|
+
],
|
|
4263
|
+
flags: [],
|
|
4264
|
+
hasParams: true,
|
|
4265
|
+
paramsAllOptional: false,
|
|
4266
|
+
bodyOpaque: false,
|
|
4267
|
+
bodyVariants: [],
|
|
4268
|
+
acceptsBody: false,
|
|
4269
|
+
requiresAuth: true,
|
|
4270
|
+
},
|
|
4271
|
+
{
|
|
4272
|
+
commandPath: ['customer', 'attribute', 'unlock'],
|
|
4273
|
+
clientProperty: 'customer',
|
|
4274
|
+
methodName: 'unlockAttribute',
|
|
4275
|
+
httpMethod: 'post',
|
|
4276
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}/unlock',
|
|
4277
|
+
summary: 'Unlock a field on a customer',
|
|
4278
|
+
description: 'Lets newer conversations change this field again. The current value stays until one does.',
|
|
4279
|
+
positionals: [
|
|
4280
|
+
{
|
|
4281
|
+
name: 'customer-profile-id',
|
|
4282
|
+
paramKey: 'customerProfileId',
|
|
4283
|
+
},
|
|
4284
|
+
{
|
|
4285
|
+
name: 'key',
|
|
4286
|
+
paramKey: 'key',
|
|
4287
|
+
},
|
|
4288
|
+
],
|
|
4289
|
+
flags: [],
|
|
4290
|
+
hasParams: true,
|
|
4291
|
+
paramsAllOptional: false,
|
|
4292
|
+
bodyOpaque: false,
|
|
4293
|
+
bodyVariants: [],
|
|
4294
|
+
acceptsBody: false,
|
|
4295
|
+
requiresAuth: true,
|
|
4296
|
+
},
|
|
4297
|
+
{
|
|
4298
|
+
commandPath: ['customer', 'attribute', 'update'],
|
|
4299
|
+
clientProperty: 'customer',
|
|
4300
|
+
methodName: 'setAttribute',
|
|
4301
|
+
httpMethod: 'put',
|
|
4302
|
+
httpPath: '/v1/customer/{customerProfileId}/attributes/{key}',
|
|
4303
|
+
summary: 'Set a field on a customer',
|
|
4304
|
+
description: 'Sets the value and locks the field, so newer conversations cannot change it.',
|
|
4305
|
+
positionals: [
|
|
4306
|
+
{
|
|
4307
|
+
name: 'customer-profile-id',
|
|
4308
|
+
paramKey: 'customerProfileId',
|
|
4309
|
+
},
|
|
4310
|
+
{
|
|
4311
|
+
name: 'key',
|
|
4312
|
+
paramKey: 'key',
|
|
4313
|
+
},
|
|
4314
|
+
],
|
|
4315
|
+
flags: [
|
|
4316
|
+
{
|
|
4317
|
+
name: 'value',
|
|
4318
|
+
path: ['value'],
|
|
4319
|
+
location: 'body',
|
|
4320
|
+
required: true,
|
|
4321
|
+
description: 'The new value. Setting a field locks it, so newer conversations cannot change it.',
|
|
4322
|
+
valueKind: 'string',
|
|
4323
|
+
repeatable: false,
|
|
4324
|
+
},
|
|
4325
|
+
],
|
|
4326
|
+
hasParams: true,
|
|
4327
|
+
paramsAllOptional: false,
|
|
4328
|
+
bodyOpaque: false,
|
|
4329
|
+
bodyVariants: [],
|
|
4330
|
+
acceptsBody: true,
|
|
4331
|
+
requiresAuth: true,
|
|
4332
|
+
},
|
|
4333
|
+
{
|
|
4334
|
+
commandPath: ['customer', 'conversation', 'list'],
|
|
4335
|
+
clientProperty: 'customer',
|
|
4336
|
+
methodName: 'listConversations',
|
|
4337
|
+
httpMethod: 'get',
|
|
4338
|
+
httpPath: '/v1/customer/{customerProfileId}/conversations',
|
|
4339
|
+
summary: "List a customer's conversations",
|
|
4340
|
+
description: 'Calls and chats with this customer, newest first.',
|
|
4341
|
+
positionals: [
|
|
4342
|
+
{
|
|
4343
|
+
name: 'customer-profile-id',
|
|
4344
|
+
paramKey: 'customerProfileId',
|
|
4345
|
+
},
|
|
4346
|
+
],
|
|
4347
|
+
flags: [
|
|
4348
|
+
{
|
|
4349
|
+
name: 'limit',
|
|
4350
|
+
path: ['limit'],
|
|
4351
|
+
location: 'query',
|
|
4352
|
+
required: false,
|
|
4353
|
+
valueKind: 'integer',
|
|
4354
|
+
repeatable: false,
|
|
4355
|
+
},
|
|
4356
|
+
{
|
|
4357
|
+
name: 'page',
|
|
4358
|
+
path: ['page'],
|
|
4359
|
+
location: 'query',
|
|
4360
|
+
required: false,
|
|
4361
|
+
valueKind: 'integer',
|
|
4362
|
+
repeatable: false,
|
|
4363
|
+
},
|
|
4364
|
+
],
|
|
4365
|
+
hasParams: true,
|
|
4366
|
+
paramsAllOptional: true,
|
|
4367
|
+
bodyOpaque: false,
|
|
4368
|
+
bodyVariants: [],
|
|
4369
|
+
acceptsBody: false,
|
|
4370
|
+
requiresAuth: true,
|
|
4371
|
+
},
|
|
4372
|
+
{
|
|
4373
|
+
commandPath: ['customer', 'delete'],
|
|
4374
|
+
clientProperty: 'customer',
|
|
4375
|
+
methodName: 'delete',
|
|
4376
|
+
httpMethod: 'delete',
|
|
4377
|
+
httpPath: '/v1/customer/{customerProfileId}',
|
|
4378
|
+
summary: 'Erase a customer',
|
|
4379
|
+
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.',
|
|
4380
|
+
positionals: [
|
|
4381
|
+
{
|
|
4382
|
+
name: 'customer-profile-id',
|
|
4383
|
+
paramKey: 'customerProfileId',
|
|
4384
|
+
},
|
|
4385
|
+
],
|
|
4386
|
+
flags: [],
|
|
4387
|
+
hasParams: false,
|
|
4388
|
+
paramsAllOptional: true,
|
|
4389
|
+
bodyOpaque: false,
|
|
4390
|
+
bodyVariants: [],
|
|
4391
|
+
acceptsBody: false,
|
|
4392
|
+
requiresAuth: true,
|
|
4393
|
+
},
|
|
4394
|
+
{
|
|
4395
|
+
commandPath: ['customer', 'field', 'create'],
|
|
4396
|
+
clientProperty: 'customer',
|
|
4397
|
+
methodName: 'createField',
|
|
4398
|
+
httpMethod: 'post',
|
|
4399
|
+
httpPath: '/v1/customer/fields',
|
|
4400
|
+
summary: 'Create a customer field',
|
|
4401
|
+
description: "Adds a field of your project's own. With extract on, conversations fill it from what customers say, guided by its description.",
|
|
4402
|
+
positionals: [],
|
|
4403
|
+
flags: [
|
|
4404
|
+
{
|
|
4405
|
+
name: 'key',
|
|
4406
|
+
path: ['key'],
|
|
4407
|
+
location: 'body',
|
|
4408
|
+
required: true,
|
|
4409
|
+
description: 'Starts with a letter; letters, numbers and underscores only. Fixed once created.',
|
|
4410
|
+
valueKind: 'string',
|
|
4411
|
+
repeatable: false,
|
|
4412
|
+
},
|
|
4413
|
+
{
|
|
4414
|
+
name: 'label',
|
|
4415
|
+
path: ['label'],
|
|
4416
|
+
location: 'body',
|
|
4417
|
+
required: true,
|
|
4418
|
+
valueKind: 'string',
|
|
4419
|
+
repeatable: false,
|
|
4420
|
+
},
|
|
4421
|
+
{
|
|
4422
|
+
name: 'description',
|
|
4423
|
+
path: ['description'],
|
|
4424
|
+
location: 'body',
|
|
4425
|
+
required: false,
|
|
4426
|
+
description: 'What the agent listens for in a conversation. Required when extract is true.',
|
|
2994
4427
|
valueKind: 'string',
|
|
2995
4428
|
repeatable: false,
|
|
2996
4429
|
},
|
|
2997
4430
|
{
|
|
2998
|
-
name: '
|
|
2999
|
-
path: ['
|
|
4431
|
+
name: 'value-type',
|
|
4432
|
+
path: ['valueType'],
|
|
4433
|
+
location: 'body',
|
|
4434
|
+
required: true,
|
|
4435
|
+
valueKind: 'string',
|
|
4436
|
+
enumValues: ['TEXT', 'NUMBER', 'BOOLEAN', 'DATE', 'PHONE_NUMBER', 'EMAIL', 'CURRENCY'],
|
|
4437
|
+
repeatable: false,
|
|
4438
|
+
},
|
|
4439
|
+
{
|
|
4440
|
+
name: 'extract',
|
|
4441
|
+
path: ['extract'],
|
|
4442
|
+
location: 'body',
|
|
4443
|
+
required: true,
|
|
4444
|
+
description: 'Whether conversations fill this field',
|
|
4445
|
+
valueKind: 'boolean',
|
|
4446
|
+
repeatable: false,
|
|
4447
|
+
},
|
|
4448
|
+
],
|
|
4449
|
+
hasParams: true,
|
|
4450
|
+
paramsAllOptional: false,
|
|
4451
|
+
bodyOpaque: false,
|
|
4452
|
+
bodyVariants: [],
|
|
4453
|
+
acceptsBody: true,
|
|
4454
|
+
requiresAuth: true,
|
|
4455
|
+
},
|
|
4456
|
+
{
|
|
4457
|
+
commandPath: ['customer', 'field', 'delete'],
|
|
4458
|
+
clientProperty: 'customer',
|
|
4459
|
+
methodName: 'deleteField',
|
|
4460
|
+
httpMethod: 'delete',
|
|
4461
|
+
httpPath: '/v1/customer/fields/{key}',
|
|
4462
|
+
summary: 'Delete a customer field',
|
|
4463
|
+
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.",
|
|
4464
|
+
positionals: [
|
|
4465
|
+
{
|
|
4466
|
+
name: 'key',
|
|
4467
|
+
paramKey: 'key',
|
|
4468
|
+
},
|
|
4469
|
+
],
|
|
4470
|
+
flags: [],
|
|
4471
|
+
hasParams: false,
|
|
4472
|
+
paramsAllOptional: true,
|
|
4473
|
+
bodyOpaque: false,
|
|
4474
|
+
bodyVariants: [],
|
|
4475
|
+
acceptsBody: false,
|
|
4476
|
+
requiresAuth: true,
|
|
4477
|
+
},
|
|
4478
|
+
{
|
|
4479
|
+
commandPath: ['customer', 'field', 'list'],
|
|
4480
|
+
clientProperty: 'customer',
|
|
4481
|
+
methodName: 'listFields',
|
|
4482
|
+
httpMethod: 'get',
|
|
4483
|
+
httpPath: '/v1/customer/fields',
|
|
4484
|
+
summary: 'List customer fields',
|
|
4485
|
+
description: "The fields this project's customers can hold, in display order. Use a field's key to filter, sort and set attributes.",
|
|
4486
|
+
positionals: [],
|
|
4487
|
+
flags: [],
|
|
4488
|
+
hasParams: false,
|
|
4489
|
+
paramsAllOptional: true,
|
|
4490
|
+
bodyOpaque: false,
|
|
4491
|
+
bodyVariants: [],
|
|
4492
|
+
acceptsBody: false,
|
|
4493
|
+
requiresAuth: true,
|
|
4494
|
+
},
|
|
4495
|
+
{
|
|
4496
|
+
commandPath: ['customer', 'field', 'update'],
|
|
4497
|
+
clientProperty: 'customer',
|
|
4498
|
+
methodName: 'updateField',
|
|
4499
|
+
httpMethod: 'patch',
|
|
4500
|
+
httpPath: '/v1/customer/fields/{key}',
|
|
4501
|
+
summary: 'Update a customer field',
|
|
4502
|
+
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.",
|
|
4503
|
+
positionals: [
|
|
4504
|
+
{
|
|
4505
|
+
name: 'key',
|
|
4506
|
+
paramKey: 'key',
|
|
4507
|
+
},
|
|
4508
|
+
],
|
|
4509
|
+
flags: [
|
|
4510
|
+
{
|
|
4511
|
+
name: 'label',
|
|
4512
|
+
path: ['label'],
|
|
3000
4513
|
location: 'body',
|
|
3001
4514
|
required: false,
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
enumValues: ['READ', 'WRITE'],
|
|
3005
|
-
repeatable: true,
|
|
4515
|
+
valueKind: 'string',
|
|
4516
|
+
repeatable: false,
|
|
3006
4517
|
},
|
|
3007
4518
|
{
|
|
3008
|
-
name: '
|
|
3009
|
-
path: ['
|
|
4519
|
+
name: 'description',
|
|
4520
|
+
path: ['description'],
|
|
3010
4521
|
location: 'body',
|
|
3011
4522
|
required: false,
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
repeatable: true,
|
|
4523
|
+
valueKind: 'string',
|
|
4524
|
+
repeatable: false,
|
|
3015
4525
|
},
|
|
3016
4526
|
{
|
|
3017
|
-
name: '
|
|
3018
|
-
path: ['
|
|
4527
|
+
name: 'value-type',
|
|
4528
|
+
path: ['valueType'],
|
|
4529
|
+
location: 'body',
|
|
4530
|
+
required: false,
|
|
4531
|
+
valueKind: 'string',
|
|
4532
|
+
enumValues: ['TEXT', 'NUMBER', 'BOOLEAN', 'DATE', 'PHONE_NUMBER', 'EMAIL', 'CURRENCY'],
|
|
4533
|
+
repeatable: false,
|
|
4534
|
+
},
|
|
4535
|
+
{
|
|
4536
|
+
name: 'extract',
|
|
4537
|
+
path: ['extract'],
|
|
3019
4538
|
location: 'body',
|
|
3020
4539
|
required: false,
|
|
3021
|
-
|
|
4540
|
+
valueKind: 'boolean',
|
|
4541
|
+
repeatable: false,
|
|
4542
|
+
},
|
|
4543
|
+
],
|
|
4544
|
+
hasParams: true,
|
|
4545
|
+
paramsAllOptional: true,
|
|
4546
|
+
bodyOpaque: false,
|
|
4547
|
+
bodyVariants: [],
|
|
4548
|
+
acceptsBody: true,
|
|
4549
|
+
requiresAuth: true,
|
|
4550
|
+
},
|
|
4551
|
+
{
|
|
4552
|
+
commandPath: ['customer', 'get'],
|
|
4553
|
+
clientProperty: 'customer',
|
|
4554
|
+
methodName: 'getByID',
|
|
4555
|
+
httpMethod: 'get',
|
|
4556
|
+
httpPath: '/v1/customer/{customerProfileId}',
|
|
4557
|
+
summary: 'Get a customer',
|
|
4558
|
+
description: 'Get a customer',
|
|
4559
|
+
positionals: [
|
|
4560
|
+
{
|
|
4561
|
+
name: 'customer-profile-id',
|
|
4562
|
+
paramKey: 'customerProfileId',
|
|
4563
|
+
},
|
|
4564
|
+
],
|
|
4565
|
+
flags: [],
|
|
4566
|
+
hasParams: false,
|
|
4567
|
+
paramsAllOptional: true,
|
|
4568
|
+
bodyOpaque: false,
|
|
4569
|
+
bodyVariants: [],
|
|
4570
|
+
acceptsBody: false,
|
|
4571
|
+
requiresAuth: true,
|
|
4572
|
+
},
|
|
4573
|
+
{
|
|
4574
|
+
commandPath: ['customer', 'list'],
|
|
4575
|
+
clientProperty: 'customer',
|
|
4576
|
+
methodName: 'list',
|
|
4577
|
+
httpMethod: 'get',
|
|
4578
|
+
httpPath: '/v1/customer',
|
|
4579
|
+
summary: 'List customers',
|
|
4580
|
+
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.',
|
|
4581
|
+
positionals: [],
|
|
4582
|
+
flags: [
|
|
4583
|
+
{
|
|
4584
|
+
name: 'limit',
|
|
4585
|
+
path: ['limit'],
|
|
4586
|
+
location: 'query',
|
|
4587
|
+
required: false,
|
|
4588
|
+
valueKind: 'integer',
|
|
4589
|
+
repeatable: false,
|
|
4590
|
+
},
|
|
4591
|
+
{
|
|
4592
|
+
name: 'page',
|
|
4593
|
+
path: ['page'],
|
|
4594
|
+
location: 'query',
|
|
4595
|
+
required: false,
|
|
4596
|
+
valueKind: 'integer',
|
|
4597
|
+
repeatable: false,
|
|
4598
|
+
},
|
|
4599
|
+
{
|
|
4600
|
+
name: 'search',
|
|
4601
|
+
path: ['search'],
|
|
4602
|
+
location: 'query',
|
|
4603
|
+
required: false,
|
|
4604
|
+
valueKind: 'string',
|
|
4605
|
+
repeatable: false,
|
|
4606
|
+
},
|
|
4607
|
+
{
|
|
4608
|
+
name: 'agent-id',
|
|
4609
|
+
path: ['agentId'],
|
|
4610
|
+
location: 'query',
|
|
4611
|
+
required: false,
|
|
4612
|
+
valueKind: 'string',
|
|
4613
|
+
repeatable: false,
|
|
4614
|
+
},
|
|
4615
|
+
{
|
|
4616
|
+
name: 'modality',
|
|
4617
|
+
path: ['modality'],
|
|
4618
|
+
location: 'query',
|
|
4619
|
+
required: false,
|
|
4620
|
+
valueKind: 'string',
|
|
4621
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
4622
|
+
repeatable: false,
|
|
4623
|
+
},
|
|
4624
|
+
{
|
|
4625
|
+
name: 'include-no-data',
|
|
4626
|
+
path: ['includeNoData'],
|
|
4627
|
+
location: 'query',
|
|
4628
|
+
required: false,
|
|
4629
|
+
description: 'Include customers we hold nothing about beyond their identifier. Defaults to false.',
|
|
4630
|
+
valueKind: 'string',
|
|
4631
|
+
enumValues: ['true', 'false'],
|
|
4632
|
+
repeatable: false,
|
|
4633
|
+
},
|
|
4634
|
+
{
|
|
4635
|
+
name: 'sort-by',
|
|
4636
|
+
path: ['sortBy'],
|
|
4637
|
+
location: 'query',
|
|
4638
|
+
required: false,
|
|
4639
|
+
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.",
|
|
4640
|
+
valueKind: 'string',
|
|
4641
|
+
repeatable: false,
|
|
4642
|
+
},
|
|
4643
|
+
{
|
|
4644
|
+
name: 'sort-direction',
|
|
4645
|
+
path: ['sortDirection'],
|
|
4646
|
+
location: 'query',
|
|
4647
|
+
required: false,
|
|
4648
|
+
valueKind: 'string',
|
|
4649
|
+
enumValues: ['asc', 'desc'],
|
|
4650
|
+
repeatable: false,
|
|
4651
|
+
},
|
|
4652
|
+
{
|
|
4653
|
+
name: 'field-key',
|
|
4654
|
+
path: ['fieldKey'],
|
|
4655
|
+
location: 'query',
|
|
4656
|
+
required: false,
|
|
4657
|
+
description: 'Filter by this field, a key from GET /v1/customer/fields. Use with fieldOperator and, unless checking presence, fieldValue.',
|
|
4658
|
+
valueKind: 'string',
|
|
4659
|
+
repeatable: false,
|
|
4660
|
+
},
|
|
4661
|
+
{
|
|
4662
|
+
name: 'field-operator',
|
|
4663
|
+
path: ['fieldOperator'],
|
|
4664
|
+
location: 'query',
|
|
4665
|
+
required: false,
|
|
4666
|
+
description: 'How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field.',
|
|
3022
4667
|
valueKind: 'string',
|
|
4668
|
+
enumValues: ['EQUALS', 'NOT_EQUALS', 'CONTAINS', 'STARTS_WITH', 'IS_SET', 'IS_NOT_SET'],
|
|
3023
4669
|
repeatable: false,
|
|
3024
4670
|
},
|
|
3025
|
-
],
|
|
3026
|
-
hasParams: true,
|
|
3027
|
-
paramsAllOptional: false,
|
|
3028
|
-
bodyOpaque: false,
|
|
3029
|
-
bodyVariants: [],
|
|
3030
|
-
acceptsBody: true,
|
|
3031
|
-
requiresAuth: true,
|
|
3032
|
-
},
|
|
3033
|
-
{
|
|
3034
|
-
commandPath: ['credential', 'list'],
|
|
3035
|
-
clientProperty: 'me',
|
|
3036
|
-
methodName: 'listAPIKeys',
|
|
3037
|
-
httpMethod: 'get',
|
|
3038
|
-
httpPath: '/v1/me/api-keys',
|
|
3039
|
-
summary: 'List your personal credentials',
|
|
3040
|
-
description: 'Returns the credentials that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Requires a personal credential; a project API key is refused. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.',
|
|
3041
|
-
positionals: [],
|
|
3042
|
-
flags: [
|
|
3043
4671
|
{
|
|
3044
|
-
name: '
|
|
3045
|
-
path: ['
|
|
4672
|
+
name: 'field-value',
|
|
4673
|
+
path: ['fieldValue'],
|
|
3046
4674
|
location: 'query',
|
|
3047
4675
|
required: false,
|
|
3048
|
-
description: 'Filter by status. Defaults to ACTIVE.',
|
|
3049
4676
|
valueKind: 'string',
|
|
3050
|
-
enumValues: ['ACTIVE', 'REVOKED'],
|
|
3051
4677
|
repeatable: false,
|
|
3052
4678
|
},
|
|
3053
4679
|
],
|
|
@@ -3059,25 +4685,35 @@ exports.COMMANDS = [
|
|
|
3059
4685
|
requiresAuth: true,
|
|
3060
4686
|
},
|
|
3061
4687
|
{
|
|
3062
|
-
commandPath: ['
|
|
3063
|
-
clientProperty: '
|
|
3064
|
-
methodName: '
|
|
3065
|
-
httpMethod: '
|
|
3066
|
-
httpPath: '/v1/
|
|
3067
|
-
summary: '
|
|
3068
|
-
description:
|
|
4688
|
+
commandPath: ['customer', 'notes', 'update'],
|
|
4689
|
+
clientProperty: 'customer',
|
|
4690
|
+
methodName: 'updateNotes',
|
|
4691
|
+
httpMethod: 'put',
|
|
4692
|
+
httpPath: '/v1/customer/{customerProfileId}/notes',
|
|
4693
|
+
summary: 'Update the notes on a customer',
|
|
4694
|
+
description: "Replaces your team's shared notes. Null or empty clears them. The last save wins.",
|
|
3069
4695
|
positionals: [
|
|
3070
4696
|
{
|
|
3071
|
-
name: '
|
|
3072
|
-
paramKey: '
|
|
4697
|
+
name: 'customer-profile-id',
|
|
4698
|
+
paramKey: 'customerProfileId',
|
|
3073
4699
|
},
|
|
3074
4700
|
],
|
|
3075
|
-
flags: [
|
|
3076
|
-
|
|
3077
|
-
|
|
4701
|
+
flags: [
|
|
4702
|
+
{
|
|
4703
|
+
name: 'notes',
|
|
4704
|
+
path: ['notes'],
|
|
4705
|
+
location: 'body',
|
|
4706
|
+
required: true,
|
|
4707
|
+
description: 'Replaces the existing notes. Null or empty clears them.',
|
|
4708
|
+
valueKind: 'string',
|
|
4709
|
+
repeatable: false,
|
|
4710
|
+
},
|
|
4711
|
+
],
|
|
4712
|
+
hasParams: true,
|
|
4713
|
+
paramsAllOptional: false,
|
|
3078
4714
|
bodyOpaque: false,
|
|
3079
4715
|
bodyVariants: [],
|
|
3080
|
-
acceptsBody:
|
|
4716
|
+
acceptsBody: true,
|
|
3081
4717
|
requiresAuth: true,
|
|
3082
4718
|
},
|
|
3083
4719
|
{
|
|
@@ -3205,6 +4841,7 @@ exports.COMMANDS = [
|
|
|
3205
4841
|
path: ['prompt'],
|
|
3206
4842
|
location: 'body',
|
|
3207
4843
|
required: false,
|
|
4844
|
+
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.',
|
|
3208
4845
|
valueKind: 'string',
|
|
3209
4846
|
repeatable: false,
|
|
3210
4847
|
},
|
|
@@ -3359,6 +4996,7 @@ exports.COMMANDS = [
|
|
|
3359
4996
|
path: ['prompt'],
|
|
3360
4997
|
location: 'body',
|
|
3361
4998
|
required: false,
|
|
4999
|
+
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.',
|
|
3362
5000
|
valueKind: 'string',
|
|
3363
5001
|
repeatable: false,
|
|
3364
5002
|
},
|
|
@@ -3421,13 +5059,111 @@ exports.COMMANDS = [
|
|
|
3421
5059
|
acceptsBody: true,
|
|
3422
5060
|
requiresAuth: true,
|
|
3423
5061
|
},
|
|
5062
|
+
{
|
|
5063
|
+
commandPath: ['customer-flow', 'folder', 'create'],
|
|
5064
|
+
clientProperty: 'customerFlowFolder',
|
|
5065
|
+
methodName: 'create',
|
|
5066
|
+
httpMethod: 'post',
|
|
5067
|
+
httpPath: '/v1/customer-flow/folder',
|
|
5068
|
+
summary: 'Create a customer flow folder',
|
|
5069
|
+
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.',
|
|
5070
|
+
positionals: [],
|
|
5071
|
+
flags: [
|
|
5072
|
+
{
|
|
5073
|
+
name: 'name',
|
|
5074
|
+
path: ['name'],
|
|
5075
|
+
location: 'body',
|
|
5076
|
+
required: true,
|
|
5077
|
+
description: 'The folder name. Must be unique in the project.',
|
|
5078
|
+
valueKind: 'string',
|
|
5079
|
+
repeatable: false,
|
|
5080
|
+
},
|
|
5081
|
+
{
|
|
5082
|
+
name: 'color',
|
|
5083
|
+
path: ['color'],
|
|
5084
|
+
location: 'body',
|
|
5085
|
+
required: false,
|
|
5086
|
+
description: 'The color the folder is shown with in the app. Folders share the palette labels use. Defaults to GREY.',
|
|
5087
|
+
valueKind: 'string',
|
|
5088
|
+
enumValues: [
|
|
5089
|
+
'GREEN',
|
|
5090
|
+
'RED',
|
|
5091
|
+
'ORANGE',
|
|
5092
|
+
'PURPLE',
|
|
5093
|
+
'GREY',
|
|
5094
|
+
'BLUE',
|
|
5095
|
+
'PEACH',
|
|
5096
|
+
'TEAL',
|
|
5097
|
+
'INDIGO',
|
|
5098
|
+
'AMBER',
|
|
5099
|
+
'ROSE',
|
|
5100
|
+
'CYAN',
|
|
5101
|
+
],
|
|
5102
|
+
repeatable: false,
|
|
5103
|
+
},
|
|
5104
|
+
{
|
|
5105
|
+
name: 'description',
|
|
5106
|
+
path: ['description'],
|
|
5107
|
+
location: 'body',
|
|
5108
|
+
required: false,
|
|
5109
|
+
description: 'What belongs in this folder.',
|
|
5110
|
+
valueKind: 'string',
|
|
5111
|
+
repeatable: false,
|
|
5112
|
+
},
|
|
5113
|
+
],
|
|
5114
|
+
hasParams: true,
|
|
5115
|
+
paramsAllOptional: false,
|
|
5116
|
+
bodyOpaque: false,
|
|
5117
|
+
bodyVariants: [],
|
|
5118
|
+
acceptsBody: true,
|
|
5119
|
+
requiresAuth: true,
|
|
5120
|
+
},
|
|
5121
|
+
{
|
|
5122
|
+
commandPath: ['customer-flow', 'folder', 'delete'],
|
|
5123
|
+
clientProperty: 'customerFlowFolder',
|
|
5124
|
+
methodName: 'delete',
|
|
5125
|
+
httpMethod: 'delete',
|
|
5126
|
+
httpPath: '/v1/customer-flow/folder/{folderId}',
|
|
5127
|
+
summary: 'Delete a customer flow folder',
|
|
5128
|
+
description: 'Deletes a folder. The flows in it are kept and no longer sit in any folder. Built-in folders cannot be deleted.',
|
|
5129
|
+
positionals: [
|
|
5130
|
+
{
|
|
5131
|
+
name: 'folder-id',
|
|
5132
|
+
paramKey: 'folderId',
|
|
5133
|
+
},
|
|
5134
|
+
],
|
|
5135
|
+
flags: [],
|
|
5136
|
+
hasParams: false,
|
|
5137
|
+
paramsAllOptional: true,
|
|
5138
|
+
bodyOpaque: false,
|
|
5139
|
+
bodyVariants: [],
|
|
5140
|
+
acceptsBody: false,
|
|
5141
|
+
requiresAuth: true,
|
|
5142
|
+
},
|
|
5143
|
+
{
|
|
5144
|
+
commandPath: ['customer-flow', 'folder', 'list'],
|
|
5145
|
+
clientProperty: 'customerFlowFolder',
|
|
5146
|
+
methodName: 'list',
|
|
5147
|
+
httpMethod: 'get',
|
|
5148
|
+
httpPath: '/v1/customer-flow/folder',
|
|
5149
|
+
summary: 'List customer flow folders',
|
|
5150
|
+
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.',
|
|
5151
|
+
positionals: [],
|
|
5152
|
+
flags: [],
|
|
5153
|
+
hasParams: false,
|
|
5154
|
+
paramsAllOptional: true,
|
|
5155
|
+
bodyOpaque: false,
|
|
5156
|
+
bodyVariants: [],
|
|
5157
|
+
acceptsBody: false,
|
|
5158
|
+
requiresAuth: true,
|
|
5159
|
+
},
|
|
3424
5160
|
{
|
|
3425
5161
|
commandPath: ['customer-flow', 'get'],
|
|
3426
5162
|
clientProperty: 'customerFlow',
|
|
3427
5163
|
methodName: 'getByID',
|
|
3428
5164
|
httpMethod: 'get',
|
|
3429
5165
|
httpPath: '/v1/customer-flow/{flowId}',
|
|
3430
|
-
summary: 'Get customer flow
|
|
5166
|
+
summary: 'Get a customer flow',
|
|
3431
5167
|
description: 'Returns a customer flow with its happy path, edge cases, expectations and linked agents. Scripted flows also carry their step graph.',
|
|
3432
5168
|
positionals: [
|
|
3433
5169
|
{
|
|
@@ -3520,6 +5256,7 @@ exports.COMMANDS = [
|
|
|
3520
5256
|
path: ['prompt'],
|
|
3521
5257
|
location: 'body',
|
|
3522
5258
|
required: false,
|
|
5259
|
+
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.',
|
|
3523
5260
|
valueKind: 'string',
|
|
3524
5261
|
repeatable: false,
|
|
3525
5262
|
},
|
|
@@ -3625,6 +5362,14 @@ exports.COMMANDS = [
|
|
|
3625
5362
|
enumValues: ['SCRIPTED', 'IMPROV', 'VOICEMAIL'],
|
|
3626
5363
|
repeatable: false,
|
|
3627
5364
|
},
|
|
5365
|
+
{
|
|
5366
|
+
name: 'folder-id',
|
|
5367
|
+
path: ['folderId'],
|
|
5368
|
+
location: 'query',
|
|
5369
|
+
required: false,
|
|
5370
|
+
valueKind: 'string',
|
|
5371
|
+
repeatable: false,
|
|
5372
|
+
},
|
|
3628
5373
|
{
|
|
3629
5374
|
name: 'include-system',
|
|
3630
5375
|
path: ['includeSystem'],
|
|
@@ -3649,7 +5394,7 @@ exports.COMMANDS = [
|
|
|
3649
5394
|
httpMethod: 'put',
|
|
3650
5395
|
httpPath: '/v1/customer-flow/{flowId}',
|
|
3651
5396
|
summary: 'Update a customer flow',
|
|
3652
|
-
description: "Updates a flow's title, description, branching mode, linked agents
|
|
5397
|
+
description: "Updates a flow's title, description, branching mode, linked agents, flow-level expectations or folder. The step graph is replaced through PUT /graph.",
|
|
3653
5398
|
positionals: [
|
|
3654
5399
|
{
|
|
3655
5400
|
name: 'flow-id',
|
|
@@ -3761,6 +5506,15 @@ exports.COMMANDS = [
|
|
|
3761
5506
|
valueKind: 'array',
|
|
3762
5507
|
repeatable: false,
|
|
3763
5508
|
},
|
|
5509
|
+
{
|
|
5510
|
+
name: 'folder-id',
|
|
5511
|
+
path: ['folderId'],
|
|
5512
|
+
location: 'body',
|
|
5513
|
+
required: false,
|
|
5514
|
+
description: 'Moves the flow into this folder. Null takes it out of its folder; omit to leave it where it is.',
|
|
5515
|
+
valueKind: 'string',
|
|
5516
|
+
repeatable: false,
|
|
5517
|
+
},
|
|
3764
5518
|
],
|
|
3765
5519
|
hasParams: true,
|
|
3766
5520
|
paramsAllOptional: true,
|
|
@@ -3939,7 +5693,7 @@ exports.COMMANDS = [
|
|
|
3939
5693
|
httpMethod: 'get',
|
|
3940
5694
|
httpPath: '/v1/dashboard',
|
|
3941
5695
|
summary: 'List dashboards',
|
|
3942
|
-
description: "Lists the project's dashboards, the default first. GET /v1/dashboard/{dashboardId} returns the widgets.",
|
|
5696
|
+
description: "Lists the project's dashboards, the default first. `GET /v1/dashboard/{dashboardId}` returns the widgets.",
|
|
3943
5697
|
positionals: [],
|
|
3944
5698
|
flags: [],
|
|
3945
5699
|
hasParams: false,
|
|
@@ -3956,7 +5710,7 @@ exports.COMMANDS = [
|
|
|
3956
5710
|
httpMethod: 'put',
|
|
3957
5711
|
httpPath: '/v1/dashboard/{dashboardId}',
|
|
3958
5712
|
summary: 'Update a dashboard',
|
|
3959
|
-
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}
|
|
5713
|
+
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}`.',
|
|
3960
5714
|
positionals: [
|
|
3961
5715
|
{
|
|
3962
5716
|
name: 'dashboard-id',
|
|
@@ -4348,7 +6102,7 @@ exports.COMMANDS = [
|
|
|
4348
6102
|
methodName: 'create',
|
|
4349
6103
|
httpMethod: 'post',
|
|
4350
6104
|
httpPath: '/v1/http-request-definition',
|
|
4351
|
-
summary: 'Create HTTP request definition',
|
|
6105
|
+
summary: 'Create an HTTP request definition',
|
|
4352
6106
|
description: 'Creates a new HTTP request definition. The signing secret is only returned in this response and cannot be retrieved later.',
|
|
4353
6107
|
positionals: [],
|
|
4354
6108
|
flags: [
|
|
@@ -4422,7 +6176,7 @@ exports.COMMANDS = [
|
|
|
4422
6176
|
methodName: 'getByID',
|
|
4423
6177
|
httpMethod: 'get',
|
|
4424
6178
|
httpPath: '/v1/http-request-definition/{definitionId}',
|
|
4425
|
-
summary: 'Get HTTP request definition
|
|
6179
|
+
summary: 'Get an HTTP request definition',
|
|
4426
6180
|
description: 'Returns a specific HTTP request definition by its ID.',
|
|
4427
6181
|
positionals: [
|
|
4428
6182
|
{
|
|
@@ -4481,7 +6235,7 @@ exports.COMMANDS = [
|
|
|
4481
6235
|
methodName: 'update',
|
|
4482
6236
|
httpMethod: 'put',
|
|
4483
6237
|
httpPath: '/v1/http-request-definition/{definitionId}',
|
|
4484
|
-
summary: 'Update HTTP request definition',
|
|
6238
|
+
summary: 'Update an HTTP request definition',
|
|
4485
6239
|
description: 'Updates an existing HTTP request definition.',
|
|
4486
6240
|
positionals: [
|
|
4487
6241
|
{
|
|
@@ -5096,7 +6850,7 @@ exports.COMMANDS = [
|
|
|
5096
6850
|
methodName: 'getByID',
|
|
5097
6851
|
httpMethod: 'get',
|
|
5098
6852
|
httpPath: '/v1/metric/collection-jobs/{jobId}',
|
|
5099
|
-
summary: 'Get metric collection job
|
|
6853
|
+
summary: 'Get a metric collection job',
|
|
5100
6854
|
description: 'Returns a specific metric collection job with progress information.',
|
|
5101
6855
|
positionals: [
|
|
5102
6856
|
{
|
|
@@ -5165,7 +6919,7 @@ exports.COMMANDS = [
|
|
|
5165
6919
|
methodName: 'createDefinition',
|
|
5166
6920
|
httpMethod: 'post',
|
|
5167
6921
|
httpPath: '/v1/metric/definitions',
|
|
5168
|
-
summary: 'Create
|
|
6922
|
+
summary: 'Create a metric definition',
|
|
5169
6923
|
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.',
|
|
5170
6924
|
positionals: [],
|
|
5171
6925
|
flags: [],
|
|
@@ -5257,7 +7011,7 @@ exports.COMMANDS = [
|
|
|
5257
7011
|
path: ['llmPrompt'],
|
|
5258
7012
|
location: 'body',
|
|
5259
7013
|
required: false,
|
|
5260
|
-
description: 'New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable)',
|
|
7014
|
+
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.',
|
|
5261
7015
|
valueKind: 'string',
|
|
5262
7016
|
repeatable: false,
|
|
5263
7017
|
},
|
|
@@ -5554,9 +7308,9 @@ exports.COMMANDS = [
|
|
|
5554
7308
|
path: ['modality'],
|
|
5555
7309
|
location: 'body',
|
|
5556
7310
|
required: true,
|
|
5557
|
-
description: 'Modality this policy targets. A policy fires for exactly one modality and can only reference metrics that support that modality.',
|
|
7311
|
+
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.',
|
|
5558
7312
|
valueKind: 'string',
|
|
5559
|
-
enumValues: ['
|
|
7313
|
+
enumValues: ['voice', 'chat', 'call'],
|
|
5560
7314
|
repeatable: false,
|
|
5561
7315
|
},
|
|
5562
7316
|
{
|
|
@@ -5614,7 +7368,7 @@ exports.COMMANDS = [
|
|
|
5614
7368
|
methodName: 'getByID',
|
|
5615
7369
|
httpMethod: 'get',
|
|
5616
7370
|
httpPath: '/v1/metric/policies/{policyId}',
|
|
5617
|
-
summary: 'Get metric policy
|
|
7371
|
+
summary: 'Get a metric policy',
|
|
5618
7372
|
description: 'Returns a specific metric policy with its conditions and metrics.',
|
|
5619
7373
|
positionals: [
|
|
5620
7374
|
{
|
|
@@ -5833,7 +7587,7 @@ exports.COMMANDS = [
|
|
|
5833
7587
|
methodName: 'list',
|
|
5834
7588
|
httpMethod: 'get',
|
|
5835
7589
|
httpPath: '/v1/metric/definitions/{idOrSlug}/variants',
|
|
5836
|
-
summary:
|
|
7590
|
+
summary: "List a metric's variants",
|
|
5837
7591
|
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.',
|
|
5838
7592
|
positionals: [
|
|
5839
7593
|
{
|
|
@@ -5885,7 +7639,7 @@ exports.COMMANDS = [
|
|
|
5885
7639
|
path: ['llmPrompt'],
|
|
5886
7640
|
location: 'body',
|
|
5887
7641
|
required: false,
|
|
5888
|
-
description: 'The rubric this variant applies. LLM judge metrics only.',
|
|
7642
|
+
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.',
|
|
5889
7643
|
valueKind: 'string',
|
|
5890
7644
|
repeatable: false,
|
|
5891
7645
|
},
|
|
@@ -6257,7 +8011,7 @@ exports.COMMANDS = [
|
|
|
6257
8011
|
methodName: 'list',
|
|
6258
8012
|
httpMethod: 'get',
|
|
6259
8013
|
httpPath: '/v1/projects',
|
|
6260
|
-
summary: 'List projects
|
|
8014
|
+
summary: 'List accessible projects',
|
|
6261
8015
|
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.',
|
|
6262
8016
|
positionals: [],
|
|
6263
8017
|
flags: [],
|
|
@@ -6345,6 +8099,42 @@ exports.COMMANDS = [
|
|
|
6345
8099
|
valueKind: 'number',
|
|
6346
8100
|
repeatable: false,
|
|
6347
8101
|
},
|
|
8102
|
+
{
|
|
8103
|
+
name: 'line-quality',
|
|
8104
|
+
path: ['lineQuality'],
|
|
8105
|
+
location: 'body',
|
|
8106
|
+
required: false,
|
|
8107
|
+
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.',
|
|
8108
|
+
valueKind: 'string',
|
|
8109
|
+
enumValues: ['CLEAR', 'MINOR_LOSS', 'CELL_EDGE', 'POOR_CONNECTION', 'ONE_WAY_DEGRADED', 'CUSTOM'],
|
|
8110
|
+
repeatable: false,
|
|
8111
|
+
},
|
|
8112
|
+
{
|
|
8113
|
+
name: 'line-custom',
|
|
8114
|
+
path: ['lineCustom'],
|
|
8115
|
+
location: 'body',
|
|
8116
|
+
required: false,
|
|
8117
|
+
description: 'The per-direction loss of a CUSTOM line.',
|
|
8118
|
+
valueKind: 'object',
|
|
8119
|
+
},
|
|
8120
|
+
{
|
|
8121
|
+
name: 'line-custom.to-agent',
|
|
8122
|
+
path: ['lineCustom', 'toAgent'],
|
|
8123
|
+
location: 'body',
|
|
8124
|
+
required: false,
|
|
8125
|
+
description: "The caller's audio on its way to the agent: what the agent hears. Omit for no loss.",
|
|
8126
|
+
valueKind: 'object',
|
|
8127
|
+
repeatable: false,
|
|
8128
|
+
},
|
|
8129
|
+
{
|
|
8130
|
+
name: 'line-custom.from-agent',
|
|
8131
|
+
path: ['lineCustom', 'fromAgent'],
|
|
8132
|
+
location: 'body',
|
|
8133
|
+
required: false,
|
|
8134
|
+
description: "The agent's audio on its way to the caller: what the caller hears. Omit for no loss.",
|
|
8135
|
+
valueKind: 'object',
|
|
8136
|
+
repeatable: false,
|
|
8137
|
+
},
|
|
6348
8138
|
],
|
|
6349
8139
|
hasParams: true,
|
|
6350
8140
|
paramsAllOptional: false,
|
|
@@ -6381,7 +8171,7 @@ exports.COMMANDS = [
|
|
|
6381
8171
|
methodName: 'getByID',
|
|
6382
8172
|
httpMethod: 'get',
|
|
6383
8173
|
httpPath: '/v1/simulation/environment/{environmentId}',
|
|
6384
|
-
summary: 'Get environment
|
|
8174
|
+
summary: 'Get an environment',
|
|
6385
8175
|
description: 'Returns a single environment by its ID.',
|
|
6386
8176
|
positionals: [
|
|
6387
8177
|
{
|
|
@@ -6496,6 +8286,42 @@ exports.COMMANDS = [
|
|
|
6496
8286
|
valueKind: 'number',
|
|
6497
8287
|
repeatable: false,
|
|
6498
8288
|
},
|
|
8289
|
+
{
|
|
8290
|
+
name: 'line-quality',
|
|
8291
|
+
path: ['lineQuality'],
|
|
8292
|
+
location: 'body',
|
|
8293
|
+
required: false,
|
|
8294
|
+
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.',
|
|
8295
|
+
valueKind: 'string',
|
|
8296
|
+
enumValues: ['CLEAR', 'MINOR_LOSS', 'CELL_EDGE', 'POOR_CONNECTION', 'ONE_WAY_DEGRADED', 'CUSTOM'],
|
|
8297
|
+
repeatable: false,
|
|
8298
|
+
},
|
|
8299
|
+
{
|
|
8300
|
+
name: 'line-custom',
|
|
8301
|
+
path: ['lineCustom'],
|
|
8302
|
+
location: 'body',
|
|
8303
|
+
required: false,
|
|
8304
|
+
description: 'The per-direction loss of a CUSTOM line.',
|
|
8305
|
+
valueKind: 'object',
|
|
8306
|
+
},
|
|
8307
|
+
{
|
|
8308
|
+
name: 'line-custom.to-agent',
|
|
8309
|
+
path: ['lineCustom', 'toAgent'],
|
|
8310
|
+
location: 'body',
|
|
8311
|
+
required: false,
|
|
8312
|
+
description: "The caller's audio on its way to the agent: what the agent hears. Omit for no loss.",
|
|
8313
|
+
valueKind: 'object',
|
|
8314
|
+
repeatable: false,
|
|
8315
|
+
},
|
|
8316
|
+
{
|
|
8317
|
+
name: 'line-custom.from-agent',
|
|
8318
|
+
path: ['lineCustom', 'fromAgent'],
|
|
8319
|
+
location: 'body',
|
|
8320
|
+
required: false,
|
|
8321
|
+
description: "The agent's audio on its way to the caller: what the caller hears. Omit for no loss.",
|
|
8322
|
+
valueKind: 'object',
|
|
8323
|
+
repeatable: false,
|
|
8324
|
+
},
|
|
6499
8325
|
],
|
|
6500
8326
|
hasParams: true,
|
|
6501
8327
|
paramsAllOptional: true,
|
|
@@ -6510,8 +8336,8 @@ exports.COMMANDS = [
|
|
|
6510
8336
|
methodName: 'create',
|
|
6511
8337
|
httpMethod: 'post',
|
|
6512
8338
|
httpPath: '/v1/simulation/group',
|
|
6513
|
-
summary: 'Create a
|
|
6514
|
-
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.',
|
|
8339
|
+
summary: 'Create a plan group',
|
|
8340
|
+
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.',
|
|
6515
8341
|
positionals: [],
|
|
6516
8342
|
flags: [
|
|
6517
8343
|
{
|
|
@@ -6580,7 +8406,7 @@ exports.COMMANDS = [
|
|
|
6580
8406
|
methodName: 'delete',
|
|
6581
8407
|
httpMethod: 'delete',
|
|
6582
8408
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
6583
|
-
summary: 'Delete a
|
|
8409
|
+
summary: 'Delete a plan group',
|
|
6584
8410
|
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.',
|
|
6585
8411
|
positionals: [
|
|
6586
8412
|
{
|
|
@@ -6603,7 +8429,7 @@ exports.COMMANDS = [
|
|
|
6603
8429
|
methodName: 'getByID',
|
|
6604
8430
|
httpMethod: 'get',
|
|
6605
8431
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
6606
|
-
summary: 'Get a
|
|
8432
|
+
summary: 'Get a plan group',
|
|
6607
8433
|
description: 'Returns a saved simulation group with its plans in run order and notification settings.',
|
|
6608
8434
|
positionals: [
|
|
6609
8435
|
{
|
|
@@ -6626,7 +8452,7 @@ exports.COMMANDS = [
|
|
|
6626
8452
|
methodName: 'list',
|
|
6627
8453
|
httpMethod: 'get',
|
|
6628
8454
|
httpPath: '/v1/simulation/group',
|
|
6629
|
-
summary: 'List
|
|
8455
|
+
summary: 'List plan groups',
|
|
6630
8456
|
description: 'Returns the saved simulation groups in the project, most recently edited first, each with its plans in run order and notification settings.',
|
|
6631
8457
|
positionals: [],
|
|
6632
8458
|
flags: [
|
|
@@ -6662,8 +8488,8 @@ exports.COMMANDS = [
|
|
|
6662
8488
|
methodName: 'run',
|
|
6663
8489
|
httpMethod: 'post',
|
|
6664
8490
|
httpPath: '/v1/simulation/group/{groupId}/run',
|
|
6665
|
-
summary: 'Run a
|
|
6666
|
-
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.",
|
|
8491
|
+
summary: 'Run a plan group',
|
|
8492
|
+
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.",
|
|
6667
8493
|
positionals: [
|
|
6668
8494
|
{
|
|
6669
8495
|
name: 'group-id',
|
|
@@ -6685,7 +8511,7 @@ exports.COMMANDS = [
|
|
|
6685
8511
|
methodName: 'update',
|
|
6686
8512
|
httpMethod: 'put',
|
|
6687
8513
|
httpPath: '/v1/simulation/group/{groupId}',
|
|
6688
|
-
summary: 'Update a
|
|
8514
|
+
summary: 'Update a plan group',
|
|
6689
8515
|
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.',
|
|
6690
8516
|
positionals: [
|
|
6691
8517
|
{
|
|
@@ -6760,7 +8586,7 @@ exports.COMMANDS = [
|
|
|
6760
8586
|
methodName: 'getByID',
|
|
6761
8587
|
httpMethod: 'get',
|
|
6762
8588
|
httpPath: '/v1/simulation/job/{jobId}',
|
|
6763
|
-
summary: 'Get
|
|
8589
|
+
summary: 'Get a simulated call',
|
|
6764
8590
|
description: 'Get a individual simulation run directly by its ID. This is generally part of a larger simulation run plan job.',
|
|
6765
8591
|
positionals: [
|
|
6766
8592
|
{
|
|
@@ -6783,7 +8609,7 @@ exports.COMMANDS = [
|
|
|
6783
8609
|
methodName: 'lookup',
|
|
6784
8610
|
httpMethod: 'get',
|
|
6785
8611
|
httpPath: '/v1/simulation/job/lookup',
|
|
6786
|
-
summary: '
|
|
8612
|
+
summary: 'Find a simulated call by phone number',
|
|
6787
8613
|
description: 'Find the matching simulation using the number used by the Roark simulation agent.',
|
|
6788
8614
|
positionals: [],
|
|
6789
8615
|
flags: [
|
|
@@ -6842,7 +8668,7 @@ exports.COMMANDS = [
|
|
|
6842
8668
|
methodName: 'create',
|
|
6843
8669
|
httpMethod: 'post',
|
|
6844
8670
|
httpPath: '/v1/persona',
|
|
6845
|
-
summary: 'Create a
|
|
8671
|
+
summary: 'Create a persona',
|
|
6846
8672
|
description: 'Creates a new persona for the authenticated project.',
|
|
6847
8673
|
positionals: [],
|
|
6848
8674
|
flags: [
|
|
@@ -7186,7 +9012,7 @@ exports.COMMANDS = [
|
|
|
7186
9012
|
methodName: 'getByID',
|
|
7187
9013
|
httpMethod: 'get',
|
|
7188
9014
|
httpPath: '/v1/persona/{personaId}',
|
|
7189
|
-
summary: 'Get persona
|
|
9015
|
+
summary: 'Get a persona',
|
|
7190
9016
|
description: 'Returns a specific persona by its ID.',
|
|
7191
9017
|
positionals: [
|
|
7192
9018
|
{
|
|
@@ -7528,7 +9354,7 @@ exports.COMMANDS = [
|
|
|
7528
9354
|
path: ['interruption'],
|
|
7529
9355
|
location: 'body',
|
|
7530
9356
|
required: false,
|
|
7531
|
-
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
|
|
9357
|
+
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.',
|
|
7532
9358
|
valueKind: 'string',
|
|
7533
9359
|
enumValues: ['OFF', 'BACKCHANNEL', 'OCCASIONAL', 'HEAVY'],
|
|
7534
9360
|
repeatable: false,
|
|
@@ -7650,7 +9476,7 @@ exports.COMMANDS = [
|
|
|
7650
9476
|
methodName: 'getByID',
|
|
7651
9477
|
httpMethod: 'get',
|
|
7652
9478
|
httpPath: '/v1/simulation/plan/{planId}',
|
|
7653
|
-
summary: 'Get run plan
|
|
9479
|
+
summary: 'Get a run plan',
|
|
7654
9480
|
description: 'Returns a specific simulation run plan by its ID.',
|
|
7655
9481
|
positionals: [
|
|
7656
9482
|
{
|
|
@@ -7673,7 +9499,7 @@ exports.COMMANDS = [
|
|
|
7673
9499
|
methodName: 'cancel',
|
|
7674
9500
|
httpMethod: 'post',
|
|
7675
9501
|
httpPath: '/v1/simulation/plan/job/{jobId}/cancel',
|
|
7676
|
-
summary: 'Cancel a simulation
|
|
9502
|
+
summary: 'Cancel a simulation run',
|
|
7677
9503
|
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.',
|
|
7678
9504
|
positionals: [
|
|
7679
9505
|
{
|
|
@@ -7696,7 +9522,7 @@ exports.COMMANDS = [
|
|
|
7696
9522
|
methodName: 'getCost',
|
|
7697
9523
|
httpMethod: 'get',
|
|
7698
9524
|
httpPath: '/v1/simulation/plan/job/{jobId}/cost',
|
|
7699
|
-
summary:
|
|
9525
|
+
summary: "Get a simulation run's cost",
|
|
7700
9526
|
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.',
|
|
7701
9527
|
positionals: [
|
|
7702
9528
|
{
|
|
@@ -7718,7 +9544,7 @@ exports.COMMANDS = [
|
|
|
7718
9544
|
methodName: 'createDebrief',
|
|
7719
9545
|
httpMethod: 'post',
|
|
7720
9546
|
httpPath: '/v1/simulation/plan/job/{jobId}/debrief',
|
|
7721
|
-
summary: 'Generate simulation run debrief',
|
|
9547
|
+
summary: 'Generate a simulation run debrief',
|
|
7722
9548
|
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.',
|
|
7723
9549
|
positionals: [
|
|
7724
9550
|
{
|
|
@@ -7750,7 +9576,7 @@ exports.COMMANDS = [
|
|
|
7750
9576
|
methodName: 'delete',
|
|
7751
9577
|
httpMethod: 'delete',
|
|
7752
9578
|
httpPath: '/v1/simulation/plan/job/{jobId}',
|
|
7753
|
-
summary: 'Delete a simulation
|
|
9579
|
+
summary: 'Delete a simulation run',
|
|
7754
9580
|
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.',
|
|
7755
9581
|
positionals: [
|
|
7756
9582
|
{
|
|
@@ -7773,7 +9599,7 @@ exports.COMMANDS = [
|
|
|
7773
9599
|
methodName: 'getByID',
|
|
7774
9600
|
httpMethod: 'get',
|
|
7775
9601
|
httpPath: '/v1/simulation/plan/job/{jobId}',
|
|
7776
|
-
summary: 'Get simulation
|
|
9602
|
+
summary: 'Get a simulation run',
|
|
7777
9603
|
description: 'Retrieve details of a simulation plan job including all associated simulation jobs (calls)',
|
|
7778
9604
|
positionals: [
|
|
7779
9605
|
{
|
|
@@ -7796,7 +9622,7 @@ exports.COMMANDS = [
|
|
|
7796
9622
|
methodName: 'list',
|
|
7797
9623
|
httpMethod: 'get',
|
|
7798
9624
|
httpPath: '/v1/simulation/plan/jobs',
|
|
7799
|
-
summary: 'List simulation
|
|
9625
|
+
summary: 'List simulation runs',
|
|
7800
9626
|
description: 'Returns a paginated list of simulation run plan jobs. Filter by status, plan ID, or label to find specific simulation batches.',
|
|
7801
9627
|
positionals: [],
|
|
7802
9628
|
flags: [
|
|
@@ -7882,7 +9708,7 @@ exports.COMMANDS = [
|
|
|
7882
9708
|
methodName: 'getResults',
|
|
7883
9709
|
httpMethod: 'get',
|
|
7884
9710
|
httpPath: '/v1/simulation/plan/job/{jobId}/results',
|
|
7885
|
-
summary:
|
|
9711
|
+
summary: "Get a simulation run's results",
|
|
7886
9712
|
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.',
|
|
7887
9713
|
positionals: [
|
|
7888
9714
|
{
|
|
@@ -8102,6 +9928,24 @@ exports.COMMANDS = [
|
|
|
8102
9928
|
valueKind: 'integer',
|
|
8103
9929
|
repeatable: false,
|
|
8104
9930
|
},
|
|
9931
|
+
{
|
|
9932
|
+
name: 'calls-per-second',
|
|
9933
|
+
path: ['callsPerSecond'],
|
|
9934
|
+
location: 'body',
|
|
9935
|
+
required: false,
|
|
9936
|
+
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.",
|
|
9937
|
+
valueKind: 'number',
|
|
9938
|
+
repeatable: false,
|
|
9939
|
+
},
|
|
9940
|
+
{
|
|
9941
|
+
name: 'ramp-up-seconds',
|
|
9942
|
+
path: ['rampUpSeconds'],
|
|
9943
|
+
location: 'body',
|
|
9944
|
+
required: false,
|
|
9945
|
+
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.',
|
|
9946
|
+
valueKind: 'integer',
|
|
9947
|
+
repeatable: false,
|
|
9948
|
+
},
|
|
8105
9949
|
{
|
|
8106
9950
|
name: 'end-call-phrases',
|
|
8107
9951
|
path: ['endCallPhrases'],
|
|
@@ -8220,6 +10064,7 @@ exports.COMMANDS = [
|
|
|
8220
10064
|
'INTENT_CLARITY',
|
|
8221
10065
|
'LANGUAGE',
|
|
8222
10066
|
'INTERRUPTION',
|
|
10067
|
+
'LINE_QUALITY',
|
|
8223
10068
|
'MEMORY_RELIABILITY',
|
|
8224
10069
|
'RESPONSE_TIMING',
|
|
8225
10070
|
'SPEECH_CLARITY',
|
|
@@ -8228,56 +10073,338 @@ exports.COMMANDS = [
|
|
|
8228
10073
|
repeatable: false,
|
|
8229
10074
|
},
|
|
8230
10075
|
{
|
|
8231
|
-
name: 'comparison-baseline',
|
|
8232
|
-
path: ['comparisonBaseline'],
|
|
10076
|
+
name: 'comparison-baseline',
|
|
10077
|
+
path: ['comparisonBaseline'],
|
|
10078
|
+
location: 'body',
|
|
10079
|
+
required: false,
|
|
10080
|
+
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.',
|
|
10081
|
+
valueKind: 'string',
|
|
10082
|
+
repeatable: false,
|
|
10083
|
+
},
|
|
10084
|
+
{
|
|
10085
|
+
name: 'comparison-values',
|
|
10086
|
+
path: ['comparisonValues'],
|
|
10087
|
+
location: 'body',
|
|
10088
|
+
required: false,
|
|
10089
|
+
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.',
|
|
10090
|
+
valueKind: 'array',
|
|
10091
|
+
repeatable: false,
|
|
10092
|
+
},
|
|
10093
|
+
{
|
|
10094
|
+
name: 'notifications',
|
|
10095
|
+
path: ['notifications'],
|
|
10096
|
+
location: 'body',
|
|
10097
|
+
required: false,
|
|
10098
|
+
description: "Where each run's report announces itself once it is ready.",
|
|
10099
|
+
valueKind: 'object',
|
|
10100
|
+
},
|
|
10101
|
+
{
|
|
10102
|
+
name: 'notifications.email',
|
|
10103
|
+
path: ['notifications', 'email'],
|
|
10104
|
+
location: 'body',
|
|
10105
|
+
required: false,
|
|
10106
|
+
valueKind: 'object',
|
|
10107
|
+
repeatable: false,
|
|
10108
|
+
},
|
|
10109
|
+
{
|
|
10110
|
+
name: 'notifications.slack',
|
|
10111
|
+
path: ['notifications', 'slack'],
|
|
10112
|
+
location: 'body',
|
|
10113
|
+
required: false,
|
|
10114
|
+
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.",
|
|
10115
|
+
valueKind: 'array',
|
|
10116
|
+
repeatable: false,
|
|
10117
|
+
},
|
|
10118
|
+
],
|
|
10119
|
+
hasParams: true,
|
|
10120
|
+
paramsAllOptional: true,
|
|
10121
|
+
bodyOpaque: false,
|
|
10122
|
+
bodyVariants: [],
|
|
10123
|
+
acceptsBody: true,
|
|
10124
|
+
requiresAuth: true,
|
|
10125
|
+
},
|
|
10126
|
+
{
|
|
10127
|
+
commandPath: ['simulation', 'resource', 'generate'],
|
|
10128
|
+
clientProperty: 'simulation',
|
|
10129
|
+
methodName: 'generateResources',
|
|
10130
|
+
httpMethod: 'post',
|
|
10131
|
+
httpPath: '/v1/simulation/generations/resources',
|
|
10132
|
+
summary: 'Generate simulation resources',
|
|
10133
|
+
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.",
|
|
10134
|
+
positionals: [],
|
|
10135
|
+
flags: [
|
|
10136
|
+
{
|
|
10137
|
+
name: 'agent-ids',
|
|
10138
|
+
path: ['agentIds'],
|
|
10139
|
+
location: 'body',
|
|
10140
|
+
required: true,
|
|
10141
|
+
description: 'The agents to generate simulation resources for. One agent per generation for now.',
|
|
10142
|
+
valueKind: 'array',
|
|
10143
|
+
repeatable: true,
|
|
10144
|
+
},
|
|
10145
|
+
{
|
|
10146
|
+
name: 'industry',
|
|
10147
|
+
path: ['industry'],
|
|
10148
|
+
location: 'body',
|
|
10149
|
+
required: false,
|
|
10150
|
+
description: 'The industry the agent serves.',
|
|
10151
|
+
valueKind: 'string',
|
|
10152
|
+
enumValues: [
|
|
10153
|
+
'HEALTHCARE',
|
|
10154
|
+
'FINANCIAL_SERVICES',
|
|
10155
|
+
'INSURANCE',
|
|
10156
|
+
'DEBT_COLLECTION',
|
|
10157
|
+
'RETAIL',
|
|
10158
|
+
'TRAVEL_AND_HOSPITALITY',
|
|
10159
|
+
'TELECOMMUNICATIONS',
|
|
10160
|
+
'TECHNOLOGY',
|
|
10161
|
+
'PUBLIC_SECTOR',
|
|
10162
|
+
'UTILITIES',
|
|
10163
|
+
'LOGISTICS',
|
|
10164
|
+
'AUTOMOTIVE',
|
|
10165
|
+
'HOME_SERVICES',
|
|
10166
|
+
'RESTAURANTS',
|
|
10167
|
+
'EDUCATION',
|
|
10168
|
+
'OTHER',
|
|
10169
|
+
],
|
|
10170
|
+
repeatable: false,
|
|
10171
|
+
},
|
|
10172
|
+
{
|
|
10173
|
+
name: 'website-url',
|
|
10174
|
+
path: ['websiteUrl'],
|
|
10175
|
+
location: 'body',
|
|
10176
|
+
required: false,
|
|
10177
|
+
description: 'A page Roark reads to learn about the business.',
|
|
10178
|
+
valueKind: 'string',
|
|
10179
|
+
repeatable: false,
|
|
10180
|
+
},
|
|
10181
|
+
{
|
|
10182
|
+
name: 'testing-instructions',
|
|
10183
|
+
path: ['testingInstructions'],
|
|
8233
10184
|
location: 'body',
|
|
8234
10185
|
required: false,
|
|
8235
|
-
description: '
|
|
10186
|
+
description: 'What you want tested, in your own words. Each scenario you describe becomes a flow.',
|
|
8236
10187
|
valueKind: 'string',
|
|
8237
10188
|
repeatable: false,
|
|
8238
10189
|
},
|
|
8239
10190
|
{
|
|
8240
|
-
name: '
|
|
8241
|
-
path: ['
|
|
10191
|
+
name: 'capabilities',
|
|
10192
|
+
path: ['capabilities'],
|
|
8242
10193
|
location: 'body',
|
|
8243
10194
|
required: false,
|
|
8244
|
-
description: 'The
|
|
10195
|
+
description: 'The capabilities to test. Omit to let Roark work them out from the agent.',
|
|
8245
10196
|
valueKind: 'array',
|
|
10197
|
+
enumValues: [
|
|
10198
|
+
'APPOINTMENT_BOOKING',
|
|
10199
|
+
'FAQ',
|
|
10200
|
+
'IDENTITY_VERIFICATION',
|
|
10201
|
+
'ACCOUNT_MANAGEMENT',
|
|
10202
|
+
'BILLING_AND_PAYMENTS',
|
|
10203
|
+
'ORDER_MANAGEMENT',
|
|
10204
|
+
'TROUBLESHOOTING',
|
|
10205
|
+
'CALL_ROUTING',
|
|
10206
|
+
'LEAD_QUALIFICATION',
|
|
10207
|
+
'COLLECTIONS',
|
|
10208
|
+
'OUTBOUND_CALLING',
|
|
10209
|
+
],
|
|
10210
|
+
repeatable: true,
|
|
10211
|
+
},
|
|
10212
|
+
{
|
|
10213
|
+
name: 'agent-endpoint-id',
|
|
10214
|
+
path: ['agentEndpointId'],
|
|
10215
|
+
location: 'body',
|
|
10216
|
+
required: false,
|
|
10217
|
+
description: "The endpoint the run plan calls. Defaults to the agent's newest endpoint.",
|
|
10218
|
+
valueKind: 'string',
|
|
8246
10219
|
repeatable: false,
|
|
8247
10220
|
},
|
|
8248
10221
|
{
|
|
8249
|
-
name: '
|
|
8250
|
-
path: ['
|
|
10222
|
+
name: 'explore',
|
|
10223
|
+
path: ['explore'],
|
|
8251
10224
|
location: 'body',
|
|
8252
10225
|
required: false,
|
|
8253
|
-
description:
|
|
10226
|
+
description: 'Exploration settings',
|
|
8254
10227
|
valueKind: 'object',
|
|
8255
10228
|
},
|
|
8256
10229
|
{
|
|
8257
|
-
name: '
|
|
8258
|
-
path: ['
|
|
10230
|
+
name: 'explore.enabled',
|
|
10231
|
+
path: ['explore', 'enabled'],
|
|
8259
10232
|
location: 'body',
|
|
8260
10233
|
required: false,
|
|
8261
|
-
|
|
10234
|
+
description: 'Whether Roark calls the agent to discover what it does before finishing the generation. Exploration calls are billed.',
|
|
10235
|
+
valueKind: 'boolean',
|
|
8262
10236
|
repeatable: false,
|
|
8263
10237
|
},
|
|
8264
10238
|
{
|
|
8265
|
-
name: '
|
|
8266
|
-
path: ['
|
|
10239
|
+
name: 'explore.max-conversations',
|
|
10240
|
+
path: ['explore', 'maxConversations'],
|
|
8267
10241
|
location: 'body',
|
|
8268
10242
|
required: false,
|
|
8269
|
-
description:
|
|
8270
|
-
valueKind: '
|
|
10243
|
+
description: 'The most exploration calls Roark places.',
|
|
10244
|
+
valueKind: 'integer',
|
|
10245
|
+
repeatable: false,
|
|
10246
|
+
},
|
|
10247
|
+
{
|
|
10248
|
+
name: 'explore.max-conversation-minutes',
|
|
10249
|
+
path: ['explore', 'maxConversationMinutes'],
|
|
10250
|
+
location: 'body',
|
|
10251
|
+
required: false,
|
|
10252
|
+
description: 'The longest a single exploration call may last, in minutes.',
|
|
10253
|
+
valueKind: 'integer',
|
|
10254
|
+
repeatable: false,
|
|
10255
|
+
},
|
|
10256
|
+
],
|
|
10257
|
+
hasParams: true,
|
|
10258
|
+
paramsAllOptional: false,
|
|
10259
|
+
bodyOpaque: false,
|
|
10260
|
+
bodyVariants: [],
|
|
10261
|
+
acceptsBody: true,
|
|
10262
|
+
requiresAuth: true,
|
|
10263
|
+
},
|
|
10264
|
+
{
|
|
10265
|
+
commandPath: ['simulation', 'resource-generation', 'answer'],
|
|
10266
|
+
clientProperty: 'simulation',
|
|
10267
|
+
methodName: 'answerResourceGeneration',
|
|
10268
|
+
httpMethod: 'post',
|
|
10269
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/answer',
|
|
10270
|
+
summary: "Answer a simulation resource generation's question",
|
|
10271
|
+
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.',
|
|
10272
|
+
positionals: [
|
|
10273
|
+
{
|
|
10274
|
+
name: 'generation-id',
|
|
10275
|
+
paramKey: 'generationId',
|
|
10276
|
+
},
|
|
10277
|
+
],
|
|
10278
|
+
flags: [
|
|
10279
|
+
{
|
|
10280
|
+
name: 'text',
|
|
10281
|
+
path: ['text'],
|
|
10282
|
+
location: 'body',
|
|
10283
|
+
required: true,
|
|
10284
|
+
description: 'What you want the generation to know',
|
|
10285
|
+
valueKind: 'string',
|
|
8271
10286
|
repeatable: false,
|
|
8272
10287
|
},
|
|
8273
10288
|
],
|
|
8274
10289
|
hasParams: true,
|
|
10290
|
+
paramsAllOptional: false,
|
|
10291
|
+
bodyOpaque: false,
|
|
10292
|
+
bodyVariants: [],
|
|
10293
|
+
acceptsBody: true,
|
|
10294
|
+
requiresAuth: true,
|
|
10295
|
+
},
|
|
10296
|
+
{
|
|
10297
|
+
commandPath: ['simulation', 'resource-generation', 'cancel'],
|
|
10298
|
+
clientProperty: 'simulation',
|
|
10299
|
+
methodName: 'cancelResourceGeneration',
|
|
10300
|
+
httpMethod: 'post',
|
|
10301
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/cancel',
|
|
10302
|
+
summary: 'Cancel a running simulation resource generation',
|
|
10303
|
+
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.',
|
|
10304
|
+
positionals: [
|
|
10305
|
+
{
|
|
10306
|
+
name: 'generation-id',
|
|
10307
|
+
paramKey: 'generationId',
|
|
10308
|
+
},
|
|
10309
|
+
],
|
|
10310
|
+
flags: [],
|
|
10311
|
+
hasParams: false,
|
|
10312
|
+
paramsAllOptional: true,
|
|
10313
|
+
bodyOpaque: false,
|
|
10314
|
+
bodyVariants: [],
|
|
10315
|
+
acceptsBody: false,
|
|
10316
|
+
requiresAuth: true,
|
|
10317
|
+
},
|
|
10318
|
+
{
|
|
10319
|
+
commandPath: ['simulation', 'resource-generation', 'get'],
|
|
10320
|
+
clientProperty: 'simulation',
|
|
10321
|
+
methodName: 'getResourceGeneration',
|
|
10322
|
+
httpMethod: 'get',
|
|
10323
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}',
|
|
10324
|
+
summary: 'Get a simulation resource generation',
|
|
10325
|
+
description: 'Returns one simulation resource generation, for example the one a webhook named.',
|
|
10326
|
+
positionals: [
|
|
10327
|
+
{
|
|
10328
|
+
name: 'generation-id',
|
|
10329
|
+
paramKey: 'generationId',
|
|
10330
|
+
},
|
|
10331
|
+
],
|
|
10332
|
+
flags: [],
|
|
10333
|
+
hasParams: false,
|
|
8275
10334
|
paramsAllOptional: true,
|
|
8276
10335
|
bodyOpaque: false,
|
|
8277
10336
|
bodyVariants: [],
|
|
10337
|
+
acceptsBody: false,
|
|
10338
|
+
requiresAuth: true,
|
|
10339
|
+
},
|
|
10340
|
+
{
|
|
10341
|
+
commandPath: ['simulation', 'resource-generation', 'guidance', 'send'],
|
|
10342
|
+
clientProperty: 'simulation',
|
|
10343
|
+
methodName: 'guideResourceGeneration',
|
|
10344
|
+
httpMethod: 'post',
|
|
10345
|
+
httpPath: '/v1/simulation/generations/resources/{generationId}/guidance',
|
|
10346
|
+
summary: 'Guide a running simulation resource generation',
|
|
10347
|
+
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.',
|
|
10348
|
+
positionals: [
|
|
10349
|
+
{
|
|
10350
|
+
name: 'generation-id',
|
|
10351
|
+
paramKey: 'generationId',
|
|
10352
|
+
},
|
|
10353
|
+
],
|
|
10354
|
+
flags: [
|
|
10355
|
+
{
|
|
10356
|
+
name: 'text',
|
|
10357
|
+
path: ['text'],
|
|
10358
|
+
location: 'body',
|
|
10359
|
+
required: true,
|
|
10360
|
+
description: 'What you want the generation to know',
|
|
10361
|
+
valueKind: 'string',
|
|
10362
|
+
repeatable: false,
|
|
10363
|
+
},
|
|
10364
|
+
],
|
|
10365
|
+
hasParams: true,
|
|
10366
|
+
paramsAllOptional: false,
|
|
10367
|
+
bodyOpaque: false,
|
|
10368
|
+
bodyVariants: [],
|
|
8278
10369
|
acceptsBody: true,
|
|
8279
10370
|
requiresAuth: true,
|
|
8280
10371
|
},
|
|
10372
|
+
{
|
|
10373
|
+
commandPath: ['simulation', 'resource-generation', 'list'],
|
|
10374
|
+
clientProperty: 'simulation',
|
|
10375
|
+
methodName: 'listResourceGenerations',
|
|
10376
|
+
httpMethod: 'get',
|
|
10377
|
+
httpPath: '/v1/simulation/generations/resources',
|
|
10378
|
+
summary: 'List simulation resource generations',
|
|
10379
|
+
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.",
|
|
10380
|
+
positionals: [],
|
|
10381
|
+
flags: [
|
|
10382
|
+
{
|
|
10383
|
+
name: 'agent-ids',
|
|
10384
|
+
path: ['agentIds'],
|
|
10385
|
+
location: 'query',
|
|
10386
|
+
required: false,
|
|
10387
|
+
description: 'Only generations for these agents, comma-separated, at most 100. Omit for every agent.',
|
|
10388
|
+
valueKind: 'string',
|
|
10389
|
+
repeatable: false,
|
|
10390
|
+
},
|
|
10391
|
+
{
|
|
10392
|
+
name: 'limit',
|
|
10393
|
+
path: ['limit'],
|
|
10394
|
+
location: 'query',
|
|
10395
|
+
required: false,
|
|
10396
|
+
description: 'How many to return, newest first. Default 20, max 50.',
|
|
10397
|
+
valueKind: 'integer',
|
|
10398
|
+
repeatable: false,
|
|
10399
|
+
},
|
|
10400
|
+
],
|
|
10401
|
+
hasParams: true,
|
|
10402
|
+
paramsAllOptional: true,
|
|
10403
|
+
bodyOpaque: false,
|
|
10404
|
+
bodyVariants: [],
|
|
10405
|
+
acceptsBody: false,
|
|
10406
|
+
requiresAuth: true,
|
|
10407
|
+
},
|
|
8281
10408
|
{
|
|
8282
10409
|
commandPath: ['simulation', 'run'],
|
|
8283
10410
|
clientProperty: 'simulation',
|
|
@@ -8410,7 +10537,7 @@ exports.COMMANDS = [
|
|
|
8410
10537
|
httpMethod: 'get',
|
|
8411
10538
|
httpPath: '/v1/simulation/run-group',
|
|
8412
10539
|
summary: 'List run groups',
|
|
8413
|
-
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}
|
|
10540
|
+
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}`.',
|
|
8414
10541
|
positionals: [],
|
|
8415
10542
|
flags: [
|
|
8416
10543
|
{
|
|
@@ -8708,7 +10835,7 @@ exports.COMMANDS = [
|
|
|
8708
10835
|
httpMethod: 'post',
|
|
8709
10836
|
httpPath: '/v1/tool',
|
|
8710
10837
|
summary: 'Create a tool',
|
|
8711
|
-
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.',
|
|
10838
|
+
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.',
|
|
8712
10839
|
positionals: [],
|
|
8713
10840
|
flags: [
|
|
8714
10841
|
{
|
|
@@ -8800,6 +10927,88 @@ exports.COMMANDS = [
|
|
|
8800
10927
|
valueKind: 'object',
|
|
8801
10928
|
repeatable: false,
|
|
8802
10929
|
},
|
|
10930
|
+
{
|
|
10931
|
+
name: 'calendar',
|
|
10932
|
+
path: ['calendar'],
|
|
10933
|
+
location: 'body',
|
|
10934
|
+
required: false,
|
|
10935
|
+
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.',
|
|
10936
|
+
valueKind: 'object',
|
|
10937
|
+
},
|
|
10938
|
+
{
|
|
10939
|
+
name: 'calendar.calendar-connection-id',
|
|
10940
|
+
path: ['calendar', 'calendarConnectionId'],
|
|
10941
|
+
location: 'body',
|
|
10942
|
+
required: true,
|
|
10943
|
+
valueKind: 'string',
|
|
10944
|
+
repeatable: false,
|
|
10945
|
+
},
|
|
10946
|
+
{
|
|
10947
|
+
name: 'calendar.operation',
|
|
10948
|
+
path: ['calendar', 'operation'],
|
|
10949
|
+
location: 'body',
|
|
10950
|
+
required: true,
|
|
10951
|
+
valueKind: 'string',
|
|
10952
|
+
enumValues: ['CHECK_AVAILABILITY', 'BOOK', 'LOOKUP_BOOKING', 'RESCHEDULE', 'CANCEL', 'LIST_BOOKINGS'],
|
|
10953
|
+
repeatable: false,
|
|
10954
|
+
},
|
|
10955
|
+
{
|
|
10956
|
+
name: 'calendar.appointment-types',
|
|
10957
|
+
path: ['calendar', 'appointmentTypes'],
|
|
10958
|
+
location: 'body',
|
|
10959
|
+
required: true,
|
|
10960
|
+
valueKind: 'array',
|
|
10961
|
+
repeatable: false,
|
|
10962
|
+
},
|
|
10963
|
+
{
|
|
10964
|
+
name: 'calendar.simulate',
|
|
10965
|
+
path: ['calendar', 'simulate'],
|
|
10966
|
+
location: 'body',
|
|
10967
|
+
required: false,
|
|
10968
|
+
valueKind: 'boolean',
|
|
10969
|
+
repeatable: false,
|
|
10970
|
+
},
|
|
10971
|
+
{
|
|
10972
|
+
name: 'calendar.messages',
|
|
10973
|
+
path: ['calendar', 'messages'],
|
|
10974
|
+
location: 'body',
|
|
10975
|
+
required: false,
|
|
10976
|
+
valueKind: 'object',
|
|
10977
|
+
repeatable: false,
|
|
10978
|
+
},
|
|
10979
|
+
{
|
|
10980
|
+
name: 'mcp',
|
|
10981
|
+
path: ['mcp'],
|
|
10982
|
+
location: 'body',
|
|
10983
|
+
required: false,
|
|
10984
|
+
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.",
|
|
10985
|
+
valueKind: 'object',
|
|
10986
|
+
},
|
|
10987
|
+
{
|
|
10988
|
+
name: 'mcp.mcp-server-id',
|
|
10989
|
+
path: ['mcp', 'mcpServerId'],
|
|
10990
|
+
location: 'body',
|
|
10991
|
+
required: true,
|
|
10992
|
+
valueKind: 'string',
|
|
10993
|
+
repeatable: false,
|
|
10994
|
+
},
|
|
10995
|
+
{
|
|
10996
|
+
name: 'mcp.tool',
|
|
10997
|
+
path: ['mcp', 'tool'],
|
|
10998
|
+
location: 'body',
|
|
10999
|
+
required: true,
|
|
11000
|
+
description: 'The tool as the server names it',
|
|
11001
|
+
valueKind: 'string',
|
|
11002
|
+
repeatable: false,
|
|
11003
|
+
},
|
|
11004
|
+
{
|
|
11005
|
+
name: 'mcp.messages',
|
|
11006
|
+
path: ['mcp', 'messages'],
|
|
11007
|
+
location: 'body',
|
|
11008
|
+
required: false,
|
|
11009
|
+
valueKind: 'object',
|
|
11010
|
+
repeatable: false,
|
|
11011
|
+
},
|
|
8803
11012
|
],
|
|
8804
11013
|
hasParams: true,
|
|
8805
11014
|
paramsAllOptional: false,
|
|
@@ -8896,7 +11105,7 @@ exports.COMMANDS = [
|
|
|
8896
11105
|
httpMethod: 'put',
|
|
8897
11106
|
httpPath: '/v1/tool/{toolId}',
|
|
8898
11107
|
summary: 'Update a tool',
|
|
8899
|
-
description: 'Replaces the tool: its name, scope, inputs, description, grading hints and
|
|
11108
|
+
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.',
|
|
8900
11109
|
positionals: [
|
|
8901
11110
|
{
|
|
8902
11111
|
name: 'tool-id',
|
|
@@ -8993,6 +11202,88 @@ exports.COMMANDS = [
|
|
|
8993
11202
|
valueKind: 'object',
|
|
8994
11203
|
repeatable: false,
|
|
8995
11204
|
},
|
|
11205
|
+
{
|
|
11206
|
+
name: 'calendar',
|
|
11207
|
+
path: ['calendar'],
|
|
11208
|
+
location: 'body',
|
|
11209
|
+
required: false,
|
|
11210
|
+
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.',
|
|
11211
|
+
valueKind: 'object',
|
|
11212
|
+
},
|
|
11213
|
+
{
|
|
11214
|
+
name: 'calendar.calendar-connection-id',
|
|
11215
|
+
path: ['calendar', 'calendarConnectionId'],
|
|
11216
|
+
location: 'body',
|
|
11217
|
+
required: true,
|
|
11218
|
+
valueKind: 'string',
|
|
11219
|
+
repeatable: false,
|
|
11220
|
+
},
|
|
11221
|
+
{
|
|
11222
|
+
name: 'calendar.operation',
|
|
11223
|
+
path: ['calendar', 'operation'],
|
|
11224
|
+
location: 'body',
|
|
11225
|
+
required: true,
|
|
11226
|
+
valueKind: 'string',
|
|
11227
|
+
enumValues: ['CHECK_AVAILABILITY', 'BOOK', 'LOOKUP_BOOKING', 'RESCHEDULE', 'CANCEL', 'LIST_BOOKINGS'],
|
|
11228
|
+
repeatable: false,
|
|
11229
|
+
},
|
|
11230
|
+
{
|
|
11231
|
+
name: 'calendar.appointment-types',
|
|
11232
|
+
path: ['calendar', 'appointmentTypes'],
|
|
11233
|
+
location: 'body',
|
|
11234
|
+
required: true,
|
|
11235
|
+
valueKind: 'array',
|
|
11236
|
+
repeatable: false,
|
|
11237
|
+
},
|
|
11238
|
+
{
|
|
11239
|
+
name: 'calendar.simulate',
|
|
11240
|
+
path: ['calendar', 'simulate'],
|
|
11241
|
+
location: 'body',
|
|
11242
|
+
required: false,
|
|
11243
|
+
valueKind: 'boolean',
|
|
11244
|
+
repeatable: false,
|
|
11245
|
+
},
|
|
11246
|
+
{
|
|
11247
|
+
name: 'calendar.messages',
|
|
11248
|
+
path: ['calendar', 'messages'],
|
|
11249
|
+
location: 'body',
|
|
11250
|
+
required: false,
|
|
11251
|
+
valueKind: 'object',
|
|
11252
|
+
repeatable: false,
|
|
11253
|
+
},
|
|
11254
|
+
{
|
|
11255
|
+
name: 'mcp',
|
|
11256
|
+
path: ['mcp'],
|
|
11257
|
+
location: 'body',
|
|
11258
|
+
required: false,
|
|
11259
|
+
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.",
|
|
11260
|
+
valueKind: 'object',
|
|
11261
|
+
},
|
|
11262
|
+
{
|
|
11263
|
+
name: 'mcp.mcp-server-id',
|
|
11264
|
+
path: ['mcp', 'mcpServerId'],
|
|
11265
|
+
location: 'body',
|
|
11266
|
+
required: true,
|
|
11267
|
+
valueKind: 'string',
|
|
11268
|
+
repeatable: false,
|
|
11269
|
+
},
|
|
11270
|
+
{
|
|
11271
|
+
name: 'mcp.tool',
|
|
11272
|
+
path: ['mcp', 'tool'],
|
|
11273
|
+
location: 'body',
|
|
11274
|
+
required: true,
|
|
11275
|
+
description: 'The tool as the server names it',
|
|
11276
|
+
valueKind: 'string',
|
|
11277
|
+
repeatable: false,
|
|
11278
|
+
},
|
|
11279
|
+
{
|
|
11280
|
+
name: 'mcp.messages',
|
|
11281
|
+
path: ['mcp', 'messages'],
|
|
11282
|
+
location: 'body',
|
|
11283
|
+
required: false,
|
|
11284
|
+
valueKind: 'object',
|
|
11285
|
+
repeatable: false,
|
|
11286
|
+
},
|
|
8996
11287
|
],
|
|
8997
11288
|
hasParams: true,
|
|
8998
11289
|
paramsAllOptional: false,
|
|
@@ -9007,7 +11298,7 @@ exports.COMMANDS = [
|
|
|
9007
11298
|
methodName: 'get',
|
|
9008
11299
|
httpMethod: 'get',
|
|
9009
11300
|
httpPath: '/v1/usage',
|
|
9010
|
-
summary: 'Get usage
|
|
11301
|
+
summary: 'Get usage and cost',
|
|
9011
11302
|
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).",
|
|
9012
11303
|
positionals: [],
|
|
9013
11304
|
flags: [
|
|
@@ -9052,7 +11343,7 @@ exports.COMMANDS = [
|
|
|
9052
11343
|
methodName: 'create',
|
|
9053
11344
|
httpMethod: 'post',
|
|
9054
11345
|
httpPath: '/v1/webhook',
|
|
9055
|
-
summary: 'Create webhook',
|
|
11346
|
+
summary: 'Create a webhook',
|
|
9056
11347
|
description: 'Creates a new webhook with event subscriptions. The signing secret is only returned in this response.',
|
|
9057
11348
|
positionals: [],
|
|
9058
11349
|
flags: [
|
|
@@ -9110,6 +11401,8 @@ exports.COMMANDS = [
|
|
|
9110
11401
|
'CHAT_ANALYSIS_FAILED',
|
|
9111
11402
|
'ISSUE_OPENED',
|
|
9112
11403
|
'ISSUE_RESOLVED',
|
|
11404
|
+
'SIMULATION_RESOURCE_GENERATION_COMPLETED',
|
|
11405
|
+
'SIMULATION_RESOURCE_GENERATION_FAILED',
|
|
9113
11406
|
],
|
|
9114
11407
|
repeatable: true,
|
|
9115
11408
|
},
|
|
@@ -9127,7 +11420,7 @@ exports.COMMANDS = [
|
|
|
9127
11420
|
methodName: 'delete',
|
|
9128
11421
|
httpMethod: 'delete',
|
|
9129
11422
|
httpPath: '/v1/webhook/{webhookId}',
|
|
9130
|
-
summary: 'Delete webhook',
|
|
11423
|
+
summary: 'Delete a webhook',
|
|
9131
11424
|
description: 'Deletes a webhook and all its event subscriptions.',
|
|
9132
11425
|
positionals: [
|
|
9133
11426
|
{
|
|
@@ -9150,7 +11443,7 @@ exports.COMMANDS = [
|
|
|
9150
11443
|
methodName: 'getByID',
|
|
9151
11444
|
httpMethod: 'get',
|
|
9152
11445
|
httpPath: '/v1/webhook/{webhookId}',
|
|
9153
|
-
summary: 'Get webhook
|
|
11446
|
+
summary: 'Get a webhook',
|
|
9154
11447
|
description: 'Returns a specific webhook with its event subscriptions.',
|
|
9155
11448
|
positionals: [
|
|
9156
11449
|
{
|
|
@@ -9209,7 +11502,7 @@ exports.COMMANDS = [
|
|
|
9209
11502
|
methodName: 'get',
|
|
9210
11503
|
httpMethod: 'get',
|
|
9211
11504
|
httpPath: '/v1/me',
|
|
9212
|
-
summary: '
|
|
11505
|
+
summary: 'Get the current credential',
|
|
9213
11506
|
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.',
|
|
9214
11507
|
positionals: [],
|
|
9215
11508
|
flags: [],
|