@roarkanalytics/cli 0.60.0 → 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 +14 -0
- package/README.md +13 -0
- package/commands.js +470 -0
- package/completions.js +4 -4
- 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 +24 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +10 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.61.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.61.0...v0.61.1) (2026-11-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* **deps:** raise the @roarkanalytics/sdk floor to 6.2.0 ([#161](https://github.com/roarkhq/cli-roark-analytics/issues/161)) ([05a3503](https://github.com/roarkhq/cli-roark-analytics/commit/05a3503247b23cb48cc26dc0831ed1c4d13e08c3))
|
|
9
|
+
|
|
10
|
+
## [0.61.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.60.0...v0.61.0) (2026-11-02)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **cli:** cli update ([#159](https://github.com/roarkhq/cli-roark-analytics/issues/159)) ([5b4357a](https://github.com/roarkhq/cli-roark-analytics/commit/5b4357a1e5b0f76c2a735de57808d7a0be976ec8))
|
|
16
|
+
|
|
3
17
|
## [0.60.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.59.1...v0.60.0) (2026-11-01)
|
|
4
18
|
|
|
5
19
|
|
package/README.md
CHANGED
|
@@ -251,6 +251,19 @@ roark completion fish | source
|
|
|
251
251
|
| `roark http-request-definition list` | List HTTP request definitions |
|
|
252
252
|
| `roark http-request-definition update <definition-id>` | Update HTTP request definition |
|
|
253
253
|
|
|
254
|
+
### live-report
|
|
255
|
+
|
|
256
|
+
| Command | Description |
|
|
257
|
+
| ----------------------------------------------------------------------------------------------------- | ------------------------------- |
|
|
258
|
+
| `roark live-report create --name <value> --notifications.email <value> --notifications.slack <value>` | Create a live report |
|
|
259
|
+
| `roark live-report delete <report-id>` | Delete a live report |
|
|
260
|
+
| `roark live-report document get <report-id> <document-id>` | Get a report document |
|
|
261
|
+
| `roark live-report document list <report-id>` | List report documents |
|
|
262
|
+
| `roark live-report get <report-id>` | Get a live report |
|
|
263
|
+
| `roark live-report list` | List live reports |
|
|
264
|
+
| `roark live-report run <report-id>` | Generate a live report document |
|
|
265
|
+
| `roark live-report update <report-id> --notifications.email <value> --notifications.slack <value>` | Update a live report |
|
|
266
|
+
|
|
254
267
|
### metric
|
|
255
268
|
|
|
256
269
|
| Command | Description |
|
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',
|
|
@@ -4261,6 +4263,474 @@ exports.COMMANDS = [
|
|
|
4261
4263
|
acceptsBody: true,
|
|
4262
4264
|
requiresAuth: true,
|
|
4263
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
|
+
},
|
|
4264
4734
|
{
|
|
4265
4735
|
commandPath: ['metric', 'collection-job', 'cancel'],
|
|
4266
4736
|
clientProperty: 'metricCollectionJob',
|