@roarkanalytics/cli 0.59.1 → 0.61.1
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 +35 -22
- package/commands.js +552 -109
- package/completions.js +4 -4
- package/man/roark-agent-build.1 +22 -1
- package/man/roark-agent-draft-update.1 +2 -38
- package/man/{roark-agent-version-restore.1 → roark-agent-version-rollback.1} +7 -7
- package/man/roark-call-list.1 +5 -2
- package/man/roark-live-report-create.1 +135 -0
- package/man/roark-live-report-delete.1 +93 -0
- package/man/roark-live-report-document-get.1 +96 -0
- package/man/roark-live-report-document-list.1 +100 -0
- package/man/roark-live-report-get.1 +93 -0
- package/man/roark-live-report-list.1 +96 -0
- package/man/roark-live-report-run.1 +100 -0
- package/man/roark-live-report-update.1 +136 -0
- package/man/roark.1 +26 -2
- package/npm-shrinkwrap.json +6 -6
- package/package.json +11 -3
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/commands.js
CHANGED
|
@@ -47,6 +47,8 @@ exports.GROUPS = {
|
|
|
47
47
|
'dashboard widget': 'Manage dashboard widgets',
|
|
48
48
|
'dashboard widget-data': 'Read dashboard widget data',
|
|
49
49
|
'http-request-definition': 'Manage HTTP request definitions',
|
|
50
|
+
'live-report': 'Manage live reports',
|
|
51
|
+
'live-report document': 'Read live report documents',
|
|
50
52
|
metric: 'Manage metrics',
|
|
51
53
|
'metric collection-job': 'Manage metric collection jobs',
|
|
52
54
|
'metric definition': 'Manage metric definitions',
|
|
@@ -140,6 +142,69 @@ exports.COMMANDS = [
|
|
|
140
142
|
valueKind: 'string',
|
|
141
143
|
repeatable: false,
|
|
142
144
|
},
|
|
145
|
+
{
|
|
146
|
+
name: 'tts.model',
|
|
147
|
+
path: ['tts', 'model'],
|
|
148
|
+
location: 'body',
|
|
149
|
+
required: false,
|
|
150
|
+
description: "The provider's voice model, for example eleven_flash_v2_5. Its current one when omitted",
|
|
151
|
+
valueKind: 'string',
|
|
152
|
+
repeatable: false,
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
name: 'stt',
|
|
156
|
+
path: ['stt'],
|
|
157
|
+
location: 'body',
|
|
158
|
+
required: false,
|
|
159
|
+
description: "Optional transcriber the hosted agent hears with. Roark's default when omitted",
|
|
160
|
+
valueKind: 'object',
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
name: 'stt.provider',
|
|
164
|
+
path: ['stt', 'provider'],
|
|
165
|
+
location: 'body',
|
|
166
|
+
required: true,
|
|
167
|
+
description: 'Speech-to-text provider, for example DEEPGRAM',
|
|
168
|
+
valueKind: 'string',
|
|
169
|
+
enumValues: ['DEEPGRAM', 'OPENAI_WHISPER', 'SPEECHMATICS', 'ASSEMBLYAI', 'ELEVENLABS'],
|
|
170
|
+
repeatable: false,
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
name: 'stt.model',
|
|
174
|
+
path: ['stt', 'model'],
|
|
175
|
+
location: 'body',
|
|
176
|
+
required: true,
|
|
177
|
+
description: "The provider's model id, for example nova-3",
|
|
178
|
+
valueKind: 'string',
|
|
179
|
+
repeatable: false,
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
name: 'llm',
|
|
183
|
+
path: ['llm'],
|
|
184
|
+
location: 'body',
|
|
185
|
+
required: false,
|
|
186
|
+
description: "Optional text model the hosted agent thinks with. Roark's default when omitted",
|
|
187
|
+
valueKind: 'object',
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
name: 'llm.provider',
|
|
191
|
+
path: ['llm', 'provider'],
|
|
192
|
+
location: 'body',
|
|
193
|
+
required: true,
|
|
194
|
+
description: 'Text model provider, for example OPENAI',
|
|
195
|
+
valueKind: 'string',
|
|
196
|
+
enumValues: ['OPENAI', 'ANTHROPIC', 'GOOGLE', 'XAI', 'ULTRAVOX', 'AWS', 'ELEVENLABS'],
|
|
197
|
+
repeatable: false,
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
name: 'llm.model',
|
|
201
|
+
path: ['llm', 'model'],
|
|
202
|
+
location: 'body',
|
|
203
|
+
required: true,
|
|
204
|
+
description: "The provider's model id, for example gpt-4.1",
|
|
205
|
+
valueKind: 'string',
|
|
206
|
+
repeatable: false,
|
|
207
|
+
},
|
|
143
208
|
],
|
|
144
209
|
hasParams: true,
|
|
145
210
|
paramsAllOptional: false,
|
|
@@ -314,7 +379,7 @@ exports.COMMANDS = [
|
|
|
314
379
|
commandPath: ['agent', 'draft', 'update'],
|
|
315
380
|
clientProperty: 'agentDraft',
|
|
316
381
|
methodName: 'update',
|
|
317
|
-
httpMethod: '
|
|
382
|
+
httpMethod: 'put',
|
|
318
383
|
httpPath: '/v1/agent/{agentId}/draft',
|
|
319
384
|
summary: 'Edit the draft',
|
|
320
385
|
description: 'Changes settings on the draft. Omitted settings stay as they are. Pass the revision you read as expectedRevision to fail with 409 if anyone edited the draft since, instead of applying on top of their edit.',
|
|
@@ -339,7 +404,7 @@ exports.COMMANDS = [
|
|
|
339
404
|
path: ['settings'],
|
|
340
405
|
location: 'body',
|
|
341
406
|
required: true,
|
|
342
|
-
description: 'The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker and must include `main
|
|
407
|
+
description: 'The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker, model configs included, and must include `main`; in a model config, omitted fields use the runtime default.',
|
|
343
408
|
valueKind: 'object',
|
|
344
409
|
},
|
|
345
410
|
{
|
|
@@ -384,105 +449,6 @@ exports.COMMANDS = [
|
|
|
384
449
|
valueKind: 'string',
|
|
385
450
|
repeatable: false,
|
|
386
451
|
},
|
|
387
|
-
{
|
|
388
|
-
name: 'settings.llm-provider',
|
|
389
|
-
path: ['settings', 'llmProvider'],
|
|
390
|
-
location: 'body',
|
|
391
|
-
required: false,
|
|
392
|
-
valueKind: 'string',
|
|
393
|
-
enumValues: ['OPENAI', 'ANTHROPIC', 'GOOGLE', 'XAI', 'ULTRAVOX', 'AWS', 'ELEVENLABS'],
|
|
394
|
-
repeatable: false,
|
|
395
|
-
},
|
|
396
|
-
{
|
|
397
|
-
name: 'settings.llm-model',
|
|
398
|
-
path: ['settings', 'llmModel'],
|
|
399
|
-
location: 'body',
|
|
400
|
-
required: false,
|
|
401
|
-
valueKind: 'string',
|
|
402
|
-
repeatable: false,
|
|
403
|
-
},
|
|
404
|
-
{
|
|
405
|
-
name: 'settings.llm-temperature',
|
|
406
|
-
path: ['settings', 'llmTemperature'],
|
|
407
|
-
location: 'body',
|
|
408
|
-
required: false,
|
|
409
|
-
valueKind: 'number',
|
|
410
|
-
repeatable: false,
|
|
411
|
-
},
|
|
412
|
-
{
|
|
413
|
-
name: 'settings.llm-max-tokens',
|
|
414
|
-
path: ['settings', 'llmMaxTokens'],
|
|
415
|
-
location: 'body',
|
|
416
|
-
required: false,
|
|
417
|
-
valueKind: 'integer',
|
|
418
|
-
repeatable: false,
|
|
419
|
-
},
|
|
420
|
-
{
|
|
421
|
-
name: 'settings.llm-backend-model',
|
|
422
|
-
path: ['settings', 'llmBackendModel'],
|
|
423
|
-
location: 'body',
|
|
424
|
-
required: false,
|
|
425
|
-
valueKind: 'string',
|
|
426
|
-
repeatable: false,
|
|
427
|
-
},
|
|
428
|
-
{
|
|
429
|
-
name: 'settings.llm-voice',
|
|
430
|
-
path: ['settings', 'llmVoice'],
|
|
431
|
-
location: 'body',
|
|
432
|
-
required: false,
|
|
433
|
-
valueKind: 'string',
|
|
434
|
-
repeatable: false,
|
|
435
|
-
},
|
|
436
|
-
{
|
|
437
|
-
name: 'settings.stt-provider',
|
|
438
|
-
path: ['settings', 'sttProvider'],
|
|
439
|
-
location: 'body',
|
|
440
|
-
required: false,
|
|
441
|
-
valueKind: 'string',
|
|
442
|
-
enumValues: ['DEEPGRAM', 'OPENAI_WHISPER', 'SPEECHMATICS', 'ASSEMBLYAI', 'ELEVENLABS'],
|
|
443
|
-
repeatable: false,
|
|
444
|
-
},
|
|
445
|
-
{
|
|
446
|
-
name: 'settings.stt-model',
|
|
447
|
-
path: ['settings', 'sttModel'],
|
|
448
|
-
location: 'body',
|
|
449
|
-
required: false,
|
|
450
|
-
valueKind: 'string',
|
|
451
|
-
repeatable: false,
|
|
452
|
-
},
|
|
453
|
-
{
|
|
454
|
-
name: 'settings.stt-keyterms',
|
|
455
|
-
path: ['settings', 'sttKeyterms'],
|
|
456
|
-
location: 'body',
|
|
457
|
-
required: false,
|
|
458
|
-
valueKind: 'array',
|
|
459
|
-
repeatable: true,
|
|
460
|
-
},
|
|
461
|
-
{
|
|
462
|
-
name: 'settings.stt-smart-format',
|
|
463
|
-
path: ['settings', 'sttSmartFormat'],
|
|
464
|
-
location: 'body',
|
|
465
|
-
required: false,
|
|
466
|
-
valueKind: 'boolean',
|
|
467
|
-
repeatable: false,
|
|
468
|
-
},
|
|
469
|
-
{
|
|
470
|
-
name: 'settings.stt-endpointing-ms',
|
|
471
|
-
path: ['settings', 'sttEndpointingMs'],
|
|
472
|
-
location: 'body',
|
|
473
|
-
required: false,
|
|
474
|
-
valueKind: 'integer',
|
|
475
|
-
repeatable: false,
|
|
476
|
-
},
|
|
477
|
-
{
|
|
478
|
-
name: 'settings.stt-turn-detection',
|
|
479
|
-
path: ['settings', 'sttTurnDetection'],
|
|
480
|
-
location: 'body',
|
|
481
|
-
required: false,
|
|
482
|
-
valueKind: 'string',
|
|
483
|
-
enumValues: ['pipeline', 'provider'],
|
|
484
|
-
repeatable: false,
|
|
485
|
-
},
|
|
486
452
|
{
|
|
487
453
|
name: 'settings.interruption-mode',
|
|
488
454
|
path: ['settings', 'interruptionMode'],
|
|
@@ -1098,13 +1064,13 @@ exports.COMMANDS = [
|
|
|
1098
1064
|
requiresAuth: true,
|
|
1099
1065
|
},
|
|
1100
1066
|
{
|
|
1101
|
-
commandPath: ['agent', 'version', '
|
|
1067
|
+
commandPath: ['agent', 'version', 'rollback'],
|
|
1102
1068
|
clientProperty: 'agentVersion',
|
|
1103
|
-
methodName: '
|
|
1069
|
+
methodName: 'rollback',
|
|
1104
1070
|
httpMethod: 'post',
|
|
1105
|
-
httpPath: '/v1/agent/{agentId}/versions/{versionId}/
|
|
1106
|
-
summary: '
|
|
1107
|
-
description: "
|
|
1071
|
+
httpPath: '/v1/agent/{agentId}/versions/{versionId}/rollback',
|
|
1072
|
+
summary: 'Roll an agent back to a version',
|
|
1073
|
+
description: "Publishes a new version, numbered after the latest, with this version's settings and makes it live. History stays append-only. An open draft started before this is kept but can no longer be published (409 `agent_draft_base_changed`); discard it or start a new one. Pass `expectedLiveVersionId` to be refused (409 `agent_live_version_changed`) if another version went live since you read it.",
|
|
1108
1074
|
positionals: [
|
|
1109
1075
|
{
|
|
1110
1076
|
name: 'agent-id',
|
|
@@ -1129,7 +1095,7 @@ exports.COMMANDS = [
|
|
|
1129
1095
|
path: ['expectedLiveVersionId'],
|
|
1130
1096
|
location: 'body',
|
|
1131
1097
|
required: false,
|
|
1132
|
-
description: 'The live version when you decided to
|
|
1098
|
+
description: 'The live version when you decided to roll back. When sent, the rollback is refused with 409 if another version went live since.',
|
|
1133
1099
|
valueKind: 'string',
|
|
1134
1100
|
repeatable: false,
|
|
1135
1101
|
},
|
|
@@ -2362,7 +2328,7 @@ exports.COMMANDS = [
|
|
|
2362
2328
|
httpMethod: 'get',
|
|
2363
2329
|
httpPath: '/v1/call',
|
|
2364
2330
|
summary: 'List calls',
|
|
2365
|
-
description: 'Returns a paginated list of calls for the authenticated project.',
|
|
2331
|
+
description: 'Returns a paginated list of calls for the authenticated project. Pass agentId to keep calls for specific agents, or properties[agent_name][eq] when you only have the agent name. sortBy and sortDirection apply together with those filters.',
|
|
2366
2332
|
positionals: [],
|
|
2367
2333
|
flags: [
|
|
2368
2334
|
{
|
|
@@ -2422,6 +2388,15 @@ exports.COMMANDS = [
|
|
|
2422
2388
|
valueKind: 'string',
|
|
2423
2389
|
repeatable: false,
|
|
2424
2390
|
},
|
|
2391
|
+
{
|
|
2392
|
+
name: 'agent-id',
|
|
2393
|
+
path: ['agentId'],
|
|
2394
|
+
location: 'query',
|
|
2395
|
+
required: false,
|
|
2396
|
+
description: 'Calls that include any of these agents. One id, or several separated by commas, at most 100. A call with more than one agent matches when any of them is listed. An id that is not an agent on a call in this project matches nothing. Combines with the other filters, including sortBy and sortDirection.',
|
|
2397
|
+
valueKind: 'string',
|
|
2398
|
+
repeatable: false,
|
|
2399
|
+
},
|
|
2425
2400
|
{
|
|
2426
2401
|
name: 'simulation-run-plan-job-id',
|
|
2427
2402
|
path: ['simulationRunPlanJobId'],
|
|
@@ -2474,7 +2449,7 @@ exports.COMMANDS = [
|
|
|
2474
2449
|
path: ['properties'],
|
|
2475
2450
|
location: 'query',
|
|
2476
2451
|
required: false,
|
|
2477
|
-
description: 'Filter on
|
|
2452
|
+
description: 'Filter on properties, one entry per property name. properties[<name>][exists]=true keeps calls that have the property set (whatever the value), properties[<name>][exists]=false keeps calls missing it (never sent, sent as null, or removed). properties[<name>][eq]=<value> keeps calls whose value equals it, ignoring case. agent_name and agent_id are built in and read the agents linked to the call, not a stored snapshot: agent_name matches an agent name, agent_id matches an agent id (a UUID). A call with several agents matches when any of them does. A custom property the project has never stored matches no calls under eq. Names match the way properties are stored, so planTier and plan_tier are one property, and agentName is agent_name. At most 20 properties. A name taken by a built-in call filter, such as status, is rejected with 400. One operator per property.',
|
|
2478
2453
|
valueKind: 'object',
|
|
2479
2454
|
repeatable: false,
|
|
2480
2455
|
},
|
|
@@ -4288,6 +4263,474 @@ exports.COMMANDS = [
|
|
|
4288
4263
|
acceptsBody: true,
|
|
4289
4264
|
requiresAuth: true,
|
|
4290
4265
|
},
|
|
4266
|
+
{
|
|
4267
|
+
commandPath: ['live-report', 'create'],
|
|
4268
|
+
clientProperty: 'liveReport',
|
|
4269
|
+
methodName: 'create',
|
|
4270
|
+
httpMethod: 'post',
|
|
4271
|
+
httpPath: '/v1/live-report',
|
|
4272
|
+
summary: 'Create a live report',
|
|
4273
|
+
description: "Saves a report on the project's live calls. Simulations are never included. Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (`value` is a percentage, 0-100, held AT_LEAST by default); a numeric metric as its average (held AT_MOST by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved. Scheduled reports are written `deliveryHour` hours into the day after each period ends in `timezone` (a week runs Monday to Sunday), then emailed and posted per `notifications`. With `generateNow` (the default) the report for the latest closed period is written right away and not sent.",
|
|
4274
|
+
positionals: [],
|
|
4275
|
+
flags: [
|
|
4276
|
+
{
|
|
4277
|
+
name: 'name',
|
|
4278
|
+
path: ['name'],
|
|
4279
|
+
location: 'body',
|
|
4280
|
+
required: true,
|
|
4281
|
+
valueKind: 'string',
|
|
4282
|
+
repeatable: false,
|
|
4283
|
+
},
|
|
4284
|
+
{
|
|
4285
|
+
name: 'description',
|
|
4286
|
+
path: ['description'],
|
|
4287
|
+
location: 'body',
|
|
4288
|
+
required: false,
|
|
4289
|
+
valueKind: 'string',
|
|
4290
|
+
repeatable: false,
|
|
4291
|
+
},
|
|
4292
|
+
{
|
|
4293
|
+
name: 'agent-id',
|
|
4294
|
+
path: ['agentId'],
|
|
4295
|
+
location: 'body',
|
|
4296
|
+
required: false,
|
|
4297
|
+
valueKind: 'string',
|
|
4298
|
+
repeatable: false,
|
|
4299
|
+
},
|
|
4300
|
+
{
|
|
4301
|
+
name: 'filters',
|
|
4302
|
+
path: ['filters'],
|
|
4303
|
+
location: 'body',
|
|
4304
|
+
required: false,
|
|
4305
|
+
valueKind: 'array',
|
|
4306
|
+
repeatable: false,
|
|
4307
|
+
},
|
|
4308
|
+
{
|
|
4309
|
+
name: 'targets',
|
|
4310
|
+
path: ['targets'],
|
|
4311
|
+
location: 'body',
|
|
4312
|
+
required: false,
|
|
4313
|
+
valueKind: 'array',
|
|
4314
|
+
repeatable: false,
|
|
4315
|
+
},
|
|
4316
|
+
{
|
|
4317
|
+
name: 'dashboard-id',
|
|
4318
|
+
path: ['dashboardId'],
|
|
4319
|
+
location: 'body',
|
|
4320
|
+
required: false,
|
|
4321
|
+
valueKind: 'string',
|
|
4322
|
+
repeatable: false,
|
|
4323
|
+
},
|
|
4324
|
+
{
|
|
4325
|
+
name: 'cadence',
|
|
4326
|
+
path: ['cadence'],
|
|
4327
|
+
location: 'body',
|
|
4328
|
+
required: false,
|
|
4329
|
+
valueKind: 'string',
|
|
4330
|
+
enumValues: ['DAILY', 'WEEKLY', 'MONTHLY'],
|
|
4331
|
+
repeatable: false,
|
|
4332
|
+
},
|
|
4333
|
+
{
|
|
4334
|
+
name: 'timezone',
|
|
4335
|
+
path: ['timezone'],
|
|
4336
|
+
location: 'body',
|
|
4337
|
+
required: false,
|
|
4338
|
+
valueKind: 'string',
|
|
4339
|
+
repeatable: false,
|
|
4340
|
+
},
|
|
4341
|
+
{
|
|
4342
|
+
name: 'delivery-hour',
|
|
4343
|
+
path: ['deliveryHour'],
|
|
4344
|
+
location: 'body',
|
|
4345
|
+
required: false,
|
|
4346
|
+
valueKind: 'integer',
|
|
4347
|
+
repeatable: false,
|
|
4348
|
+
},
|
|
4349
|
+
{
|
|
4350
|
+
name: 'status',
|
|
4351
|
+
path: ['status'],
|
|
4352
|
+
location: 'body',
|
|
4353
|
+
required: false,
|
|
4354
|
+
valueKind: 'string',
|
|
4355
|
+
enumValues: ['ACTIVE', 'PAUSED'],
|
|
4356
|
+
repeatable: false,
|
|
4357
|
+
},
|
|
4358
|
+
{
|
|
4359
|
+
name: 'notifications',
|
|
4360
|
+
path: ['notifications'],
|
|
4361
|
+
location: 'body',
|
|
4362
|
+
required: false,
|
|
4363
|
+
valueKind: 'object',
|
|
4364
|
+
},
|
|
4365
|
+
{
|
|
4366
|
+
name: 'notifications.email',
|
|
4367
|
+
path: ['notifications', 'email'],
|
|
4368
|
+
location: 'body',
|
|
4369
|
+
required: true,
|
|
4370
|
+
valueKind: 'object',
|
|
4371
|
+
repeatable: false,
|
|
4372
|
+
},
|
|
4373
|
+
{
|
|
4374
|
+
name: 'notifications.slack',
|
|
4375
|
+
path: ['notifications', 'slack'],
|
|
4376
|
+
location: 'body',
|
|
4377
|
+
required: true,
|
|
4378
|
+
valueKind: 'array',
|
|
4379
|
+
repeatable: false,
|
|
4380
|
+
},
|
|
4381
|
+
{
|
|
4382
|
+
name: 'include-transcript-excerpts',
|
|
4383
|
+
path: ['includeTranscriptExcerpts'],
|
|
4384
|
+
location: 'body',
|
|
4385
|
+
required: false,
|
|
4386
|
+
valueKind: 'boolean',
|
|
4387
|
+
repeatable: false,
|
|
4388
|
+
},
|
|
4389
|
+
{
|
|
4390
|
+
name: 'generate-now',
|
|
4391
|
+
path: ['generateNow'],
|
|
4392
|
+
location: 'body',
|
|
4393
|
+
required: false,
|
|
4394
|
+
description: 'Write the report for the latest closed period right away. Default true.',
|
|
4395
|
+
valueKind: 'boolean',
|
|
4396
|
+
repeatable: false,
|
|
4397
|
+
},
|
|
4398
|
+
],
|
|
4399
|
+
hasParams: true,
|
|
4400
|
+
paramsAllOptional: false,
|
|
4401
|
+
bodyOpaque: false,
|
|
4402
|
+
bodyVariants: [],
|
|
4403
|
+
acceptsBody: true,
|
|
4404
|
+
requiresAuth: true,
|
|
4405
|
+
},
|
|
4406
|
+
{
|
|
4407
|
+
commandPath: ['live-report', 'delete'],
|
|
4408
|
+
clientProperty: 'liveReport',
|
|
4409
|
+
methodName: 'delete',
|
|
4410
|
+
httpMethod: 'delete',
|
|
4411
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4412
|
+
summary: 'Delete a live report',
|
|
4413
|
+
description: 'Deletes the report and stops its scheduled reports.',
|
|
4414
|
+
positionals: [
|
|
4415
|
+
{
|
|
4416
|
+
name: 'report-id',
|
|
4417
|
+
paramKey: 'reportId',
|
|
4418
|
+
description: 'The live report ID',
|
|
4419
|
+
},
|
|
4420
|
+
],
|
|
4421
|
+
flags: [],
|
|
4422
|
+
hasParams: false,
|
|
4423
|
+
paramsAllOptional: true,
|
|
4424
|
+
bodyOpaque: false,
|
|
4425
|
+
bodyVariants: [],
|
|
4426
|
+
acceptsBody: false,
|
|
4427
|
+
requiresAuth: true,
|
|
4428
|
+
},
|
|
4429
|
+
{
|
|
4430
|
+
commandPath: ['live-report', 'document', 'get'],
|
|
4431
|
+
clientProperty: 'liveReport',
|
|
4432
|
+
methodName: 'getDocument',
|
|
4433
|
+
httpMethod: 'get',
|
|
4434
|
+
httpPath: '/v1/live-report/{reportId}/document/{documentId}',
|
|
4435
|
+
summary: 'Get a report document',
|
|
4436
|
+
description: 'Returns one written report. `document` is null until `status` is READY. Theme excerpts and grader quotes (call transcript text) are included only for keys with transcript:read.',
|
|
4437
|
+
positionals: [
|
|
4438
|
+
{
|
|
4439
|
+
name: 'report-id',
|
|
4440
|
+
paramKey: 'reportId',
|
|
4441
|
+
description: 'The live report ID',
|
|
4442
|
+
},
|
|
4443
|
+
{
|
|
4444
|
+
name: 'document-id',
|
|
4445
|
+
paramKey: 'documentId',
|
|
4446
|
+
description: 'The report document ID',
|
|
4447
|
+
},
|
|
4448
|
+
],
|
|
4449
|
+
flags: [],
|
|
4450
|
+
hasParams: true,
|
|
4451
|
+
paramsAllOptional: false,
|
|
4452
|
+
bodyOpaque: false,
|
|
4453
|
+
bodyVariants: [],
|
|
4454
|
+
acceptsBody: false,
|
|
4455
|
+
requiresAuth: true,
|
|
4456
|
+
},
|
|
4457
|
+
{
|
|
4458
|
+
commandPath: ['live-report', 'document', 'list'],
|
|
4459
|
+
clientProperty: 'liveReport',
|
|
4460
|
+
methodName: 'listDocuments',
|
|
4461
|
+
httpMethod: 'get',
|
|
4462
|
+
httpPath: '/v1/live-report/{reportId}/document',
|
|
4463
|
+
summary: 'List report documents',
|
|
4464
|
+
description: "Lists a report's documents, newest period first.",
|
|
4465
|
+
positionals: [
|
|
4466
|
+
{
|
|
4467
|
+
name: 'report-id',
|
|
4468
|
+
paramKey: 'reportId',
|
|
4469
|
+
},
|
|
4470
|
+
],
|
|
4471
|
+
flags: [
|
|
4472
|
+
{
|
|
4473
|
+
name: 'limit',
|
|
4474
|
+
path: ['limit'],
|
|
4475
|
+
location: 'query',
|
|
4476
|
+
required: false,
|
|
4477
|
+
description: 'Page size, at most 100.',
|
|
4478
|
+
valueKind: 'integer',
|
|
4479
|
+
repeatable: false,
|
|
4480
|
+
},
|
|
4481
|
+
{
|
|
4482
|
+
name: 'offset',
|
|
4483
|
+
path: ['offset'],
|
|
4484
|
+
location: 'query',
|
|
4485
|
+
required: false,
|
|
4486
|
+
valueKind: 'integer',
|
|
4487
|
+
repeatable: false,
|
|
4488
|
+
},
|
|
4489
|
+
],
|
|
4490
|
+
hasParams: true,
|
|
4491
|
+
paramsAllOptional: true,
|
|
4492
|
+
bodyOpaque: false,
|
|
4493
|
+
bodyVariants: [],
|
|
4494
|
+
acceptsBody: false,
|
|
4495
|
+
requiresAuth: true,
|
|
4496
|
+
},
|
|
4497
|
+
{
|
|
4498
|
+
commandPath: ['live-report', 'get'],
|
|
4499
|
+
clientProperty: 'liveReport',
|
|
4500
|
+
methodName: 'getByID',
|
|
4501
|
+
httpMethod: 'get',
|
|
4502
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4503
|
+
summary: 'Get a live report',
|
|
4504
|
+
description: 'Get a live report',
|
|
4505
|
+
positionals: [
|
|
4506
|
+
{
|
|
4507
|
+
name: 'report-id',
|
|
4508
|
+
paramKey: 'reportId',
|
|
4509
|
+
description: 'The live report ID',
|
|
4510
|
+
},
|
|
4511
|
+
],
|
|
4512
|
+
flags: [],
|
|
4513
|
+
hasParams: false,
|
|
4514
|
+
paramsAllOptional: true,
|
|
4515
|
+
bodyOpaque: false,
|
|
4516
|
+
bodyVariants: [],
|
|
4517
|
+
acceptsBody: false,
|
|
4518
|
+
requiresAuth: true,
|
|
4519
|
+
},
|
|
4520
|
+
{
|
|
4521
|
+
commandPath: ['live-report', 'list'],
|
|
4522
|
+
clientProperty: 'liveReport',
|
|
4523
|
+
methodName: 'list',
|
|
4524
|
+
httpMethod: 'get',
|
|
4525
|
+
httpPath: '/v1/live-report',
|
|
4526
|
+
summary: 'List live reports',
|
|
4527
|
+
description: "Lists the project's saved live call reports, newest first.",
|
|
4528
|
+
positionals: [],
|
|
4529
|
+
flags: [
|
|
4530
|
+
{
|
|
4531
|
+
name: 'limit',
|
|
4532
|
+
path: ['limit'],
|
|
4533
|
+
location: 'query',
|
|
4534
|
+
required: false,
|
|
4535
|
+
description: 'Page size, at most 100.',
|
|
4536
|
+
valueKind: 'integer',
|
|
4537
|
+
repeatable: false,
|
|
4538
|
+
},
|
|
4539
|
+
{
|
|
4540
|
+
name: 'offset',
|
|
4541
|
+
path: ['offset'],
|
|
4542
|
+
location: 'query',
|
|
4543
|
+
required: false,
|
|
4544
|
+
valueKind: 'integer',
|
|
4545
|
+
repeatable: false,
|
|
4546
|
+
},
|
|
4547
|
+
],
|
|
4548
|
+
hasParams: true,
|
|
4549
|
+
paramsAllOptional: true,
|
|
4550
|
+
bodyOpaque: false,
|
|
4551
|
+
bodyVariants: [],
|
|
4552
|
+
acceptsBody: false,
|
|
4553
|
+
requiresAuth: true,
|
|
4554
|
+
},
|
|
4555
|
+
{
|
|
4556
|
+
commandPath: ['live-report', 'run'],
|
|
4557
|
+
clientProperty: 'liveReport',
|
|
4558
|
+
methodName: 'run',
|
|
4559
|
+
httpMethod: 'post',
|
|
4560
|
+
httpPath: '/v1/live-report/{reportId}/generate',
|
|
4561
|
+
summary: 'Generate a live report document',
|
|
4562
|
+
description: 'Writes the report now, for its latest closed period or a custom window (`periodStart` + `periodEnd`, at most 92 days, ended). Returns 202 with the document in PENDING; poll GET /v1/live-report/{reportId}/document/{documentId} until `status` is READY or FAILED (typically a few minutes). An identical request already in flight is returned as-is. A generated document is not emailed.',
|
|
4563
|
+
positionals: [
|
|
4564
|
+
{
|
|
4565
|
+
name: 'report-id',
|
|
4566
|
+
paramKey: 'reportId',
|
|
4567
|
+
description: 'The live report ID',
|
|
4568
|
+
},
|
|
4569
|
+
],
|
|
4570
|
+
flags: [
|
|
4571
|
+
{
|
|
4572
|
+
name: 'period-start',
|
|
4573
|
+
path: ['periodStart'],
|
|
4574
|
+
location: 'body',
|
|
4575
|
+
required: false,
|
|
4576
|
+
description: 'ISO 8601 start of a custom window. Omit both for the latest closed period.',
|
|
4577
|
+
valueKind: 'string',
|
|
4578
|
+
repeatable: false,
|
|
4579
|
+
},
|
|
4580
|
+
{
|
|
4581
|
+
name: 'period-end',
|
|
4582
|
+
path: ['periodEnd'],
|
|
4583
|
+
location: 'body',
|
|
4584
|
+
required: false,
|
|
4585
|
+
description: 'ISO 8601 end (exclusive) of a custom window. Requires periodStart.',
|
|
4586
|
+
valueKind: 'string',
|
|
4587
|
+
repeatable: false,
|
|
4588
|
+
},
|
|
4589
|
+
],
|
|
4590
|
+
hasParams: true,
|
|
4591
|
+
paramsAllOptional: true,
|
|
4592
|
+
bodyOpaque: false,
|
|
4593
|
+
bodyVariants: [],
|
|
4594
|
+
acceptsBody: true,
|
|
4595
|
+
requiresAuth: true,
|
|
4596
|
+
},
|
|
4597
|
+
{
|
|
4598
|
+
commandPath: ['live-report', 'update'],
|
|
4599
|
+
clientProperty: 'liveReport',
|
|
4600
|
+
methodName: 'update',
|
|
4601
|
+
httpMethod: 'patch',
|
|
4602
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4603
|
+
summary: 'Update a live report',
|
|
4604
|
+
description: 'Changes the fields sent. Set `status` to PAUSED to stop scheduled reports.',
|
|
4605
|
+
positionals: [
|
|
4606
|
+
{
|
|
4607
|
+
name: 'report-id',
|
|
4608
|
+
paramKey: 'reportId',
|
|
4609
|
+
description: 'The live report ID',
|
|
4610
|
+
},
|
|
4611
|
+
],
|
|
4612
|
+
flags: [
|
|
4613
|
+
{
|
|
4614
|
+
name: 'name',
|
|
4615
|
+
path: ['name'],
|
|
4616
|
+
location: 'body',
|
|
4617
|
+
required: false,
|
|
4618
|
+
valueKind: 'string',
|
|
4619
|
+
repeatable: false,
|
|
4620
|
+
},
|
|
4621
|
+
{
|
|
4622
|
+
name: 'description',
|
|
4623
|
+
path: ['description'],
|
|
4624
|
+
location: 'body',
|
|
4625
|
+
required: false,
|
|
4626
|
+
valueKind: 'string',
|
|
4627
|
+
repeatable: false,
|
|
4628
|
+
},
|
|
4629
|
+
{
|
|
4630
|
+
name: 'agent-id',
|
|
4631
|
+
path: ['agentId'],
|
|
4632
|
+
location: 'body',
|
|
4633
|
+
required: false,
|
|
4634
|
+
valueKind: 'string',
|
|
4635
|
+
repeatable: false,
|
|
4636
|
+
},
|
|
4637
|
+
{
|
|
4638
|
+
name: 'filters',
|
|
4639
|
+
path: ['filters'],
|
|
4640
|
+
location: 'body',
|
|
4641
|
+
required: false,
|
|
4642
|
+
valueKind: 'array',
|
|
4643
|
+
repeatable: false,
|
|
4644
|
+
},
|
|
4645
|
+
{
|
|
4646
|
+
name: 'targets',
|
|
4647
|
+
path: ['targets'],
|
|
4648
|
+
location: 'body',
|
|
4649
|
+
required: false,
|
|
4650
|
+
valueKind: 'array',
|
|
4651
|
+
repeatable: false,
|
|
4652
|
+
},
|
|
4653
|
+
{
|
|
4654
|
+
name: 'dashboard-id',
|
|
4655
|
+
path: ['dashboardId'],
|
|
4656
|
+
location: 'body',
|
|
4657
|
+
required: false,
|
|
4658
|
+
valueKind: 'string',
|
|
4659
|
+
repeatable: false,
|
|
4660
|
+
},
|
|
4661
|
+
{
|
|
4662
|
+
name: 'cadence',
|
|
4663
|
+
path: ['cadence'],
|
|
4664
|
+
location: 'body',
|
|
4665
|
+
required: false,
|
|
4666
|
+
valueKind: 'string',
|
|
4667
|
+
enumValues: ['DAILY', 'WEEKLY', 'MONTHLY'],
|
|
4668
|
+
repeatable: false,
|
|
4669
|
+
},
|
|
4670
|
+
{
|
|
4671
|
+
name: 'timezone',
|
|
4672
|
+
path: ['timezone'],
|
|
4673
|
+
location: 'body',
|
|
4674
|
+
required: false,
|
|
4675
|
+
valueKind: 'string',
|
|
4676
|
+
repeatable: false,
|
|
4677
|
+
},
|
|
4678
|
+
{
|
|
4679
|
+
name: 'delivery-hour',
|
|
4680
|
+
path: ['deliveryHour'],
|
|
4681
|
+
location: 'body',
|
|
4682
|
+
required: false,
|
|
4683
|
+
valueKind: 'integer',
|
|
4684
|
+
repeatable: false,
|
|
4685
|
+
},
|
|
4686
|
+
{
|
|
4687
|
+
name: 'status',
|
|
4688
|
+
path: ['status'],
|
|
4689
|
+
location: 'body',
|
|
4690
|
+
required: false,
|
|
4691
|
+
valueKind: 'string',
|
|
4692
|
+
enumValues: ['ACTIVE', 'PAUSED'],
|
|
4693
|
+
repeatable: false,
|
|
4694
|
+
},
|
|
4695
|
+
{
|
|
4696
|
+
name: 'notifications',
|
|
4697
|
+
path: ['notifications'],
|
|
4698
|
+
location: 'body',
|
|
4699
|
+
required: false,
|
|
4700
|
+
valueKind: 'object',
|
|
4701
|
+
},
|
|
4702
|
+
{
|
|
4703
|
+
name: 'notifications.email',
|
|
4704
|
+
path: ['notifications', 'email'],
|
|
4705
|
+
location: 'body',
|
|
4706
|
+
required: true,
|
|
4707
|
+
valueKind: 'object',
|
|
4708
|
+
repeatable: false,
|
|
4709
|
+
},
|
|
4710
|
+
{
|
|
4711
|
+
name: 'notifications.slack',
|
|
4712
|
+
path: ['notifications', 'slack'],
|
|
4713
|
+
location: 'body',
|
|
4714
|
+
required: true,
|
|
4715
|
+
valueKind: 'array',
|
|
4716
|
+
repeatable: false,
|
|
4717
|
+
},
|
|
4718
|
+
{
|
|
4719
|
+
name: 'include-transcript-excerpts',
|
|
4720
|
+
path: ['includeTranscriptExcerpts'],
|
|
4721
|
+
location: 'body',
|
|
4722
|
+
required: false,
|
|
4723
|
+
valueKind: 'boolean',
|
|
4724
|
+
repeatable: false,
|
|
4725
|
+
},
|
|
4726
|
+
],
|
|
4727
|
+
hasParams: true,
|
|
4728
|
+
paramsAllOptional: true,
|
|
4729
|
+
bodyOpaque: false,
|
|
4730
|
+
bodyVariants: [],
|
|
4731
|
+
acceptsBody: true,
|
|
4732
|
+
requiresAuth: true,
|
|
4733
|
+
},
|
|
4291
4734
|
{
|
|
4292
4735
|
commandPath: ['metric', 'collection-job', 'cancel'],
|
|
4293
4736
|
clientProperty: 'metricCollectionJob',
|