@roarkanalytics/cli 0.60.0 → 0.67.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 +63 -0
- package/README.md +36 -0
- package/commands.js +1054 -9
- package/completions.js +4 -4
- package/man/roark-calendar-connection-check.1 +93 -0
- package/man/roark-calendar-connection-create.1 +102 -0
- package/man/roark-calendar-connection-delete.1 +93 -0
- package/man/roark-calendar-connection-get.1 +93 -0
- package/man/roark-calendar-connection-list.1 +93 -0
- package/man/roark-calendar-connection-target-get.1 +96 -0
- package/man/roark-calendar-connection-target-list.1 +93 -0
- package/man/roark-calendar-connection-update.1 +103 -0
- 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-metric-definition-update.1 +3 -0
- package/man/roark-metric-variant-update.1 +3 -0
- package/man/roark-tool-create.1 +123 -0
- package/man/roark-tool-delete.1 +93 -0
- package/man/roark-tool-get.1 +93 -0
- package/man/roark-tool-list.1 +96 -0
- package/man/roark-tool-update.1 +127 -0
- package/man/roark.1 +63 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +23 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/commands.js
CHANGED
|
@@ -28,6 +28,8 @@ exports.GROUPS = {
|
|
|
28
28
|
'benchmark target': 'Read benchmark targets',
|
|
29
29
|
'benchmark target history': 'Read benchmark target histories',
|
|
30
30
|
'benchmark target score-sample': 'Read benchmark target score samples',
|
|
31
|
+
'calendar-connection': 'Manage calendar connections',
|
|
32
|
+
'calendar-connection target': 'Read calendar connection targets',
|
|
31
33
|
call: 'Manage calls',
|
|
32
34
|
'call batch': 'Manage call batch',
|
|
33
35
|
'call cost': 'Read call cost',
|
|
@@ -47,6 +49,8 @@ exports.GROUPS = {
|
|
|
47
49
|
'dashboard widget': 'Manage dashboard widgets',
|
|
48
50
|
'dashboard widget-data': 'Read dashboard widget data',
|
|
49
51
|
'http-request-definition': 'Manage HTTP request definitions',
|
|
52
|
+
'live-report': 'Manage live reports',
|
|
53
|
+
'live-report document': 'Read live report documents',
|
|
50
54
|
metric: 'Manage metrics',
|
|
51
55
|
'metric collection-job': 'Manage metric collection jobs',
|
|
52
56
|
'metric definition': 'Manage metric definitions',
|
|
@@ -72,6 +76,7 @@ exports.GROUPS = {
|
|
|
72
76
|
'simulation template': 'Read simulation templates',
|
|
73
77
|
'simulation tool': 'Read simulation tool',
|
|
74
78
|
'simulation tool-fixture': 'Manage simulation tool fixtures',
|
|
79
|
+
tool: 'Manage tools',
|
|
75
80
|
usage: 'Read usage',
|
|
76
81
|
webhook: 'Manage webhooks',
|
|
77
82
|
};
|
|
@@ -2006,6 +2011,260 @@ exports.COMMANDS = [
|
|
|
2006
2011
|
acceptsBody: false,
|
|
2007
2012
|
requiresAuth: true,
|
|
2008
2013
|
},
|
|
2014
|
+
{
|
|
2015
|
+
commandPath: ['calendar-connection', 'check'],
|
|
2016
|
+
clientProperty: 'calendarConnection',
|
|
2017
|
+
methodName: 'check',
|
|
2018
|
+
httpMethod: 'post',
|
|
2019
|
+
httpPath: '/v1/calendar-connection/{connectionId}/check',
|
|
2020
|
+
summary: 'Check a calendar connection',
|
|
2021
|
+
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.',
|
|
2022
|
+
positionals: [
|
|
2023
|
+
{
|
|
2024
|
+
name: 'connection-id',
|
|
2025
|
+
paramKey: 'connectionId',
|
|
2026
|
+
description: 'Calendar connection ID',
|
|
2027
|
+
},
|
|
2028
|
+
],
|
|
2029
|
+
flags: [],
|
|
2030
|
+
hasParams: false,
|
|
2031
|
+
paramsAllOptional: true,
|
|
2032
|
+
bodyOpaque: false,
|
|
2033
|
+
bodyVariants: [],
|
|
2034
|
+
acceptsBody: false,
|
|
2035
|
+
requiresAuth: true,
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
commandPath: ['calendar-connection', 'create'],
|
|
2039
|
+
clientProperty: 'calendarConnection',
|
|
2040
|
+
methodName: 'create',
|
|
2041
|
+
httpMethod: 'post',
|
|
2042
|
+
httpPath: '/v1/calendar-connection',
|
|
2043
|
+
summary: 'Connect a calendar account',
|
|
2044
|
+
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.',
|
|
2045
|
+
positionals: [],
|
|
2046
|
+
flags: [
|
|
2047
|
+
{
|
|
2048
|
+
name: 'provider',
|
|
2049
|
+
path: ['provider'],
|
|
2050
|
+
location: 'body',
|
|
2051
|
+
required: true,
|
|
2052
|
+
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.',
|
|
2053
|
+
valueKind: 'string',
|
|
2054
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2055
|
+
repeatable: false,
|
|
2056
|
+
},
|
|
2057
|
+
{
|
|
2058
|
+
name: 'label',
|
|
2059
|
+
path: ['label'],
|
|
2060
|
+
location: 'body',
|
|
2061
|
+
required: true,
|
|
2062
|
+
description: 'Customer-facing name for this account, unique within the project. Required.',
|
|
2063
|
+
valueKind: 'string',
|
|
2064
|
+
repeatable: false,
|
|
2065
|
+
},
|
|
2066
|
+
{
|
|
2067
|
+
name: 'api-key',
|
|
2068
|
+
path: ['apiKey'],
|
|
2069
|
+
location: 'body',
|
|
2070
|
+
required: true,
|
|
2071
|
+
description: 'For CAL_COM: a Cal.com API key (starts with `cal_`). It is verified against Cal.com before anything is stored, so an invalid key is a 400 and no connection is created. Stored encrypted and never returned.',
|
|
2072
|
+
valueKind: 'string',
|
|
2073
|
+
repeatable: false,
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
name: 'timezone',
|
|
2077
|
+
path: ['timezone'],
|
|
2078
|
+
location: 'body',
|
|
2079
|
+
required: false,
|
|
2080
|
+
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.',
|
|
2081
|
+
valueKind: 'string',
|
|
2082
|
+
repeatable: false,
|
|
2083
|
+
},
|
|
2084
|
+
],
|
|
2085
|
+
hasParams: true,
|
|
2086
|
+
paramsAllOptional: false,
|
|
2087
|
+
bodyOpaque: false,
|
|
2088
|
+
bodyVariants: [],
|
|
2089
|
+
acceptsBody: true,
|
|
2090
|
+
requiresAuth: true,
|
|
2091
|
+
},
|
|
2092
|
+
{
|
|
2093
|
+
commandPath: ['calendar-connection', 'delete'],
|
|
2094
|
+
clientProperty: 'calendarConnection',
|
|
2095
|
+
methodName: 'delete',
|
|
2096
|
+
httpMethod: 'delete',
|
|
2097
|
+
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2098
|
+
summary: 'Delete a calendar connection',
|
|
2099
|
+
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.',
|
|
2100
|
+
positionals: [
|
|
2101
|
+
{
|
|
2102
|
+
name: 'connection-id',
|
|
2103
|
+
paramKey: 'connectionId',
|
|
2104
|
+
description: 'Calendar connection ID',
|
|
2105
|
+
},
|
|
2106
|
+
],
|
|
2107
|
+
flags: [],
|
|
2108
|
+
hasParams: false,
|
|
2109
|
+
paramsAllOptional: true,
|
|
2110
|
+
bodyOpaque: false,
|
|
2111
|
+
bodyVariants: [],
|
|
2112
|
+
acceptsBody: false,
|
|
2113
|
+
requiresAuth: true,
|
|
2114
|
+
},
|
|
2115
|
+
{
|
|
2116
|
+
commandPath: ['calendar-connection', 'get'],
|
|
2117
|
+
clientProperty: 'calendarConnection',
|
|
2118
|
+
methodName: 'getByID',
|
|
2119
|
+
httpMethod: 'get',
|
|
2120
|
+
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2121
|
+
summary: 'Get a calendar connection',
|
|
2122
|
+
description: 'Returns one calendar connection. The stored credential is never included.',
|
|
2123
|
+
positionals: [
|
|
2124
|
+
{
|
|
2125
|
+
name: 'connection-id',
|
|
2126
|
+
paramKey: 'connectionId',
|
|
2127
|
+
description: 'Calendar connection ID',
|
|
2128
|
+
},
|
|
2129
|
+
],
|
|
2130
|
+
flags: [],
|
|
2131
|
+
hasParams: false,
|
|
2132
|
+
paramsAllOptional: true,
|
|
2133
|
+
bodyOpaque: false,
|
|
2134
|
+
bodyVariants: [],
|
|
2135
|
+
acceptsBody: false,
|
|
2136
|
+
requiresAuth: true,
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
commandPath: ['calendar-connection', 'list'],
|
|
2140
|
+
clientProperty: 'calendarConnection',
|
|
2141
|
+
methodName: 'list',
|
|
2142
|
+
httpMethod: 'get',
|
|
2143
|
+
httpPath: '/v1/calendar-connection',
|
|
2144
|
+
summary: 'List calendar connections',
|
|
2145
|
+
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.',
|
|
2146
|
+
positionals: [],
|
|
2147
|
+
flags: [
|
|
2148
|
+
{
|
|
2149
|
+
name: 'provider',
|
|
2150
|
+
path: ['provider'],
|
|
2151
|
+
location: 'query',
|
|
2152
|
+
required: false,
|
|
2153
|
+
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.',
|
|
2154
|
+
valueKind: 'string',
|
|
2155
|
+
enumValues: ['CAL_COM', 'GOOGLE', 'CALENDLY'],
|
|
2156
|
+
repeatable: false,
|
|
2157
|
+
},
|
|
2158
|
+
],
|
|
2159
|
+
hasParams: true,
|
|
2160
|
+
paramsAllOptional: true,
|
|
2161
|
+
bodyOpaque: false,
|
|
2162
|
+
bodyVariants: [],
|
|
2163
|
+
acceptsBody: false,
|
|
2164
|
+
requiresAuth: true,
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
commandPath: ['calendar-connection', 'target', 'get'],
|
|
2168
|
+
clientProperty: 'calendarConnection',
|
|
2169
|
+
methodName: 'getTarget',
|
|
2170
|
+
httpMethod: 'get',
|
|
2171
|
+
httpPath: '/v1/calendar-connection/{connectionId}/targets/{targetId}',
|
|
2172
|
+
summary: 'Read one bookable target',
|
|
2173
|
+
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.',
|
|
2174
|
+
positionals: [
|
|
2175
|
+
{
|
|
2176
|
+
name: 'connection-id',
|
|
2177
|
+
paramKey: 'connectionId',
|
|
2178
|
+
description: 'Calendar connection ID',
|
|
2179
|
+
},
|
|
2180
|
+
{
|
|
2181
|
+
name: 'target-id',
|
|
2182
|
+
paramKey: 'targetId',
|
|
2183
|
+
description: 'Target id, as the list returned it',
|
|
2184
|
+
},
|
|
2185
|
+
],
|
|
2186
|
+
flags: [],
|
|
2187
|
+
hasParams: true,
|
|
2188
|
+
paramsAllOptional: false,
|
|
2189
|
+
bodyOpaque: false,
|
|
2190
|
+
bodyVariants: [],
|
|
2191
|
+
acceptsBody: false,
|
|
2192
|
+
requiresAuth: true,
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
commandPath: ['calendar-connection', 'target', 'list'],
|
|
2196
|
+
clientProperty: 'calendarConnection',
|
|
2197
|
+
methodName: 'listTargets',
|
|
2198
|
+
httpMethod: 'get',
|
|
2199
|
+
httpPath: '/v1/calendar-connection/{connectionId}/targets',
|
|
2200
|
+
summary: 'List what can be booked on a calendar',
|
|
2201
|
+
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.',
|
|
2202
|
+
positionals: [
|
|
2203
|
+
{
|
|
2204
|
+
name: 'connection-id',
|
|
2205
|
+
paramKey: 'connectionId',
|
|
2206
|
+
description: 'Calendar connection ID',
|
|
2207
|
+
},
|
|
2208
|
+
],
|
|
2209
|
+
flags: [],
|
|
2210
|
+
hasParams: false,
|
|
2211
|
+
paramsAllOptional: true,
|
|
2212
|
+
bodyOpaque: false,
|
|
2213
|
+
bodyVariants: [],
|
|
2214
|
+
acceptsBody: false,
|
|
2215
|
+
requiresAuth: true,
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
commandPath: ['calendar-connection', 'update'],
|
|
2219
|
+
clientProperty: 'calendarConnection',
|
|
2220
|
+
methodName: 'update',
|
|
2221
|
+
httpMethod: 'patch',
|
|
2222
|
+
httpPath: '/v1/calendar-connection/{connectionId}',
|
|
2223
|
+
summary: 'Update a calendar connection',
|
|
2224
|
+
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.',
|
|
2225
|
+
positionals: [
|
|
2226
|
+
{
|
|
2227
|
+
name: 'connection-id',
|
|
2228
|
+
paramKey: 'connectionId',
|
|
2229
|
+
description: 'Calendar connection ID',
|
|
2230
|
+
},
|
|
2231
|
+
],
|
|
2232
|
+
flags: [
|
|
2233
|
+
{
|
|
2234
|
+
name: 'label',
|
|
2235
|
+
path: ['label'],
|
|
2236
|
+
location: 'body',
|
|
2237
|
+
required: false,
|
|
2238
|
+
description: 'Rename the connection.',
|
|
2239
|
+
valueKind: 'string',
|
|
2240
|
+
repeatable: false,
|
|
2241
|
+
},
|
|
2242
|
+
{
|
|
2243
|
+
name: 'timezone',
|
|
2244
|
+
path: ['timezone'],
|
|
2245
|
+
location: 'body',
|
|
2246
|
+
required: false,
|
|
2247
|
+
description: 'Change the named IANA timezone slots are offered in.',
|
|
2248
|
+
valueKind: 'string',
|
|
2249
|
+
repeatable: false,
|
|
2250
|
+
},
|
|
2251
|
+
{
|
|
2252
|
+
name: 'api-key',
|
|
2253
|
+
path: ['apiKey'],
|
|
2254
|
+
location: 'body',
|
|
2255
|
+
required: false,
|
|
2256
|
+
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.',
|
|
2257
|
+
valueKind: 'string',
|
|
2258
|
+
repeatable: false,
|
|
2259
|
+
},
|
|
2260
|
+
],
|
|
2261
|
+
hasParams: true,
|
|
2262
|
+
paramsAllOptional: true,
|
|
2263
|
+
bodyOpaque: false,
|
|
2264
|
+
bodyVariants: [],
|
|
2265
|
+
acceptsBody: true,
|
|
2266
|
+
requiresAuth: true,
|
|
2267
|
+
},
|
|
2009
2268
|
{
|
|
2010
2269
|
commandPath: ['call', 'batch', 'delete'],
|
|
2011
2270
|
clientProperty: 'call',
|
|
@@ -4236,21 +4495,489 @@ exports.COMMANDS = [
|
|
|
4236
4495
|
repeatable: false,
|
|
4237
4496
|
},
|
|
4238
4497
|
{
|
|
4239
|
-
name: 'body',
|
|
4240
|
-
path: ['body'],
|
|
4498
|
+
name: 'body',
|
|
4499
|
+
path: ['body'],
|
|
4500
|
+
location: 'body',
|
|
4501
|
+
required: false,
|
|
4502
|
+
description: 'Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage.',
|
|
4503
|
+
valueKind: 'string',
|
|
4504
|
+
repeatable: false,
|
|
4505
|
+
},
|
|
4506
|
+
{
|
|
4507
|
+
name: 'headers',
|
|
4508
|
+
path: ['headers'],
|
|
4509
|
+
location: 'body',
|
|
4510
|
+
required: false,
|
|
4511
|
+
description: 'Request headers as key-value pairs',
|
|
4512
|
+
valueKind: 'object',
|
|
4513
|
+
repeatable: false,
|
|
4514
|
+
},
|
|
4515
|
+
],
|
|
4516
|
+
hasParams: true,
|
|
4517
|
+
paramsAllOptional: true,
|
|
4518
|
+
bodyOpaque: false,
|
|
4519
|
+
bodyVariants: [],
|
|
4520
|
+
acceptsBody: true,
|
|
4521
|
+
requiresAuth: true,
|
|
4522
|
+
},
|
|
4523
|
+
{
|
|
4524
|
+
commandPath: ['live-report', 'create'],
|
|
4525
|
+
clientProperty: 'liveReport',
|
|
4526
|
+
methodName: 'create',
|
|
4527
|
+
httpMethod: 'post',
|
|
4528
|
+
httpPath: '/v1/live-report',
|
|
4529
|
+
summary: 'Create a live report',
|
|
4530
|
+
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.",
|
|
4531
|
+
positionals: [],
|
|
4532
|
+
flags: [
|
|
4533
|
+
{
|
|
4534
|
+
name: 'name',
|
|
4535
|
+
path: ['name'],
|
|
4536
|
+
location: 'body',
|
|
4537
|
+
required: true,
|
|
4538
|
+
valueKind: 'string',
|
|
4539
|
+
repeatable: false,
|
|
4540
|
+
},
|
|
4541
|
+
{
|
|
4542
|
+
name: 'description',
|
|
4543
|
+
path: ['description'],
|
|
4544
|
+
location: 'body',
|
|
4545
|
+
required: false,
|
|
4546
|
+
valueKind: 'string',
|
|
4547
|
+
repeatable: false,
|
|
4548
|
+
},
|
|
4549
|
+
{
|
|
4550
|
+
name: 'agent-id',
|
|
4551
|
+
path: ['agentId'],
|
|
4552
|
+
location: 'body',
|
|
4553
|
+
required: false,
|
|
4554
|
+
valueKind: 'string',
|
|
4555
|
+
repeatable: false,
|
|
4556
|
+
},
|
|
4557
|
+
{
|
|
4558
|
+
name: 'filters',
|
|
4559
|
+
path: ['filters'],
|
|
4560
|
+
location: 'body',
|
|
4561
|
+
required: false,
|
|
4562
|
+
valueKind: 'array',
|
|
4563
|
+
repeatable: false,
|
|
4564
|
+
},
|
|
4565
|
+
{
|
|
4566
|
+
name: 'targets',
|
|
4567
|
+
path: ['targets'],
|
|
4568
|
+
location: 'body',
|
|
4569
|
+
required: false,
|
|
4570
|
+
valueKind: 'array',
|
|
4571
|
+
repeatable: false,
|
|
4572
|
+
},
|
|
4573
|
+
{
|
|
4574
|
+
name: 'dashboard-id',
|
|
4575
|
+
path: ['dashboardId'],
|
|
4576
|
+
location: 'body',
|
|
4577
|
+
required: false,
|
|
4578
|
+
valueKind: 'string',
|
|
4579
|
+
repeatable: false,
|
|
4580
|
+
},
|
|
4581
|
+
{
|
|
4582
|
+
name: 'cadence',
|
|
4583
|
+
path: ['cadence'],
|
|
4584
|
+
location: 'body',
|
|
4585
|
+
required: false,
|
|
4586
|
+
valueKind: 'string',
|
|
4587
|
+
enumValues: ['DAILY', 'WEEKLY', 'MONTHLY'],
|
|
4588
|
+
repeatable: false,
|
|
4589
|
+
},
|
|
4590
|
+
{
|
|
4591
|
+
name: 'timezone',
|
|
4592
|
+
path: ['timezone'],
|
|
4593
|
+
location: 'body',
|
|
4594
|
+
required: false,
|
|
4595
|
+
valueKind: 'string',
|
|
4596
|
+
repeatable: false,
|
|
4597
|
+
},
|
|
4598
|
+
{
|
|
4599
|
+
name: 'delivery-hour',
|
|
4600
|
+
path: ['deliveryHour'],
|
|
4601
|
+
location: 'body',
|
|
4602
|
+
required: false,
|
|
4603
|
+
valueKind: 'integer',
|
|
4604
|
+
repeatable: false,
|
|
4605
|
+
},
|
|
4606
|
+
{
|
|
4607
|
+
name: 'status',
|
|
4608
|
+
path: ['status'],
|
|
4609
|
+
location: 'body',
|
|
4610
|
+
required: false,
|
|
4611
|
+
valueKind: 'string',
|
|
4612
|
+
enumValues: ['ACTIVE', 'PAUSED'],
|
|
4613
|
+
repeatable: false,
|
|
4614
|
+
},
|
|
4615
|
+
{
|
|
4616
|
+
name: 'notifications',
|
|
4617
|
+
path: ['notifications'],
|
|
4618
|
+
location: 'body',
|
|
4619
|
+
required: false,
|
|
4620
|
+
valueKind: 'object',
|
|
4621
|
+
},
|
|
4622
|
+
{
|
|
4623
|
+
name: 'notifications.email',
|
|
4624
|
+
path: ['notifications', 'email'],
|
|
4625
|
+
location: 'body',
|
|
4626
|
+
required: true,
|
|
4627
|
+
valueKind: 'object',
|
|
4628
|
+
repeatable: false,
|
|
4629
|
+
},
|
|
4630
|
+
{
|
|
4631
|
+
name: 'notifications.slack',
|
|
4632
|
+
path: ['notifications', 'slack'],
|
|
4633
|
+
location: 'body',
|
|
4634
|
+
required: true,
|
|
4635
|
+
valueKind: 'array',
|
|
4636
|
+
repeatable: false,
|
|
4637
|
+
},
|
|
4638
|
+
{
|
|
4639
|
+
name: 'include-transcript-excerpts',
|
|
4640
|
+
path: ['includeTranscriptExcerpts'],
|
|
4641
|
+
location: 'body',
|
|
4642
|
+
required: false,
|
|
4643
|
+
valueKind: 'boolean',
|
|
4644
|
+
repeatable: false,
|
|
4645
|
+
},
|
|
4646
|
+
{
|
|
4647
|
+
name: 'generate-now',
|
|
4648
|
+
path: ['generateNow'],
|
|
4649
|
+
location: 'body',
|
|
4650
|
+
required: false,
|
|
4651
|
+
description: 'Write the report for the latest closed period right away. Default true.',
|
|
4652
|
+
valueKind: 'boolean',
|
|
4653
|
+
repeatable: false,
|
|
4654
|
+
},
|
|
4655
|
+
],
|
|
4656
|
+
hasParams: true,
|
|
4657
|
+
paramsAllOptional: false,
|
|
4658
|
+
bodyOpaque: false,
|
|
4659
|
+
bodyVariants: [],
|
|
4660
|
+
acceptsBody: true,
|
|
4661
|
+
requiresAuth: true,
|
|
4662
|
+
},
|
|
4663
|
+
{
|
|
4664
|
+
commandPath: ['live-report', 'delete'],
|
|
4665
|
+
clientProperty: 'liveReport',
|
|
4666
|
+
methodName: 'delete',
|
|
4667
|
+
httpMethod: 'delete',
|
|
4668
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4669
|
+
summary: 'Delete a live report',
|
|
4670
|
+
description: 'Deletes the report and stops its scheduled reports.',
|
|
4671
|
+
positionals: [
|
|
4672
|
+
{
|
|
4673
|
+
name: 'report-id',
|
|
4674
|
+
paramKey: 'reportId',
|
|
4675
|
+
description: 'The live report ID',
|
|
4676
|
+
},
|
|
4677
|
+
],
|
|
4678
|
+
flags: [],
|
|
4679
|
+
hasParams: false,
|
|
4680
|
+
paramsAllOptional: true,
|
|
4681
|
+
bodyOpaque: false,
|
|
4682
|
+
bodyVariants: [],
|
|
4683
|
+
acceptsBody: false,
|
|
4684
|
+
requiresAuth: true,
|
|
4685
|
+
},
|
|
4686
|
+
{
|
|
4687
|
+
commandPath: ['live-report', 'document', 'get'],
|
|
4688
|
+
clientProperty: 'liveReport',
|
|
4689
|
+
methodName: 'getDocument',
|
|
4690
|
+
httpMethod: 'get',
|
|
4691
|
+
httpPath: '/v1/live-report/{reportId}/document/{documentId}',
|
|
4692
|
+
summary: 'Get a report document',
|
|
4693
|
+
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.',
|
|
4694
|
+
positionals: [
|
|
4695
|
+
{
|
|
4696
|
+
name: 'report-id',
|
|
4697
|
+
paramKey: 'reportId',
|
|
4698
|
+
description: 'The live report ID',
|
|
4699
|
+
},
|
|
4700
|
+
{
|
|
4701
|
+
name: 'document-id',
|
|
4702
|
+
paramKey: 'documentId',
|
|
4703
|
+
description: 'The report document ID',
|
|
4704
|
+
},
|
|
4705
|
+
],
|
|
4706
|
+
flags: [],
|
|
4707
|
+
hasParams: true,
|
|
4708
|
+
paramsAllOptional: false,
|
|
4709
|
+
bodyOpaque: false,
|
|
4710
|
+
bodyVariants: [],
|
|
4711
|
+
acceptsBody: false,
|
|
4712
|
+
requiresAuth: true,
|
|
4713
|
+
},
|
|
4714
|
+
{
|
|
4715
|
+
commandPath: ['live-report', 'document', 'list'],
|
|
4716
|
+
clientProperty: 'liveReport',
|
|
4717
|
+
methodName: 'listDocuments',
|
|
4718
|
+
httpMethod: 'get',
|
|
4719
|
+
httpPath: '/v1/live-report/{reportId}/document',
|
|
4720
|
+
summary: 'List report documents',
|
|
4721
|
+
description: "Lists a report's documents, newest period first.",
|
|
4722
|
+
positionals: [
|
|
4723
|
+
{
|
|
4724
|
+
name: 'report-id',
|
|
4725
|
+
paramKey: 'reportId',
|
|
4726
|
+
},
|
|
4727
|
+
],
|
|
4728
|
+
flags: [
|
|
4729
|
+
{
|
|
4730
|
+
name: 'limit',
|
|
4731
|
+
path: ['limit'],
|
|
4732
|
+
location: 'query',
|
|
4733
|
+
required: false,
|
|
4734
|
+
description: 'Page size, at most 100.',
|
|
4735
|
+
valueKind: 'integer',
|
|
4736
|
+
repeatable: false,
|
|
4737
|
+
},
|
|
4738
|
+
{
|
|
4739
|
+
name: 'offset',
|
|
4740
|
+
path: ['offset'],
|
|
4741
|
+
location: 'query',
|
|
4742
|
+
required: false,
|
|
4743
|
+
valueKind: 'integer',
|
|
4744
|
+
repeatable: false,
|
|
4745
|
+
},
|
|
4746
|
+
],
|
|
4747
|
+
hasParams: true,
|
|
4748
|
+
paramsAllOptional: true,
|
|
4749
|
+
bodyOpaque: false,
|
|
4750
|
+
bodyVariants: [],
|
|
4751
|
+
acceptsBody: false,
|
|
4752
|
+
requiresAuth: true,
|
|
4753
|
+
},
|
|
4754
|
+
{
|
|
4755
|
+
commandPath: ['live-report', 'get'],
|
|
4756
|
+
clientProperty: 'liveReport',
|
|
4757
|
+
methodName: 'getByID',
|
|
4758
|
+
httpMethod: 'get',
|
|
4759
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4760
|
+
summary: 'Get a live report',
|
|
4761
|
+
description: 'Get a live report',
|
|
4762
|
+
positionals: [
|
|
4763
|
+
{
|
|
4764
|
+
name: 'report-id',
|
|
4765
|
+
paramKey: 'reportId',
|
|
4766
|
+
description: 'The live report ID',
|
|
4767
|
+
},
|
|
4768
|
+
],
|
|
4769
|
+
flags: [],
|
|
4770
|
+
hasParams: false,
|
|
4771
|
+
paramsAllOptional: true,
|
|
4772
|
+
bodyOpaque: false,
|
|
4773
|
+
bodyVariants: [],
|
|
4774
|
+
acceptsBody: false,
|
|
4775
|
+
requiresAuth: true,
|
|
4776
|
+
},
|
|
4777
|
+
{
|
|
4778
|
+
commandPath: ['live-report', 'list'],
|
|
4779
|
+
clientProperty: 'liveReport',
|
|
4780
|
+
methodName: 'list',
|
|
4781
|
+
httpMethod: 'get',
|
|
4782
|
+
httpPath: '/v1/live-report',
|
|
4783
|
+
summary: 'List live reports',
|
|
4784
|
+
description: "Lists the project's saved live call reports, newest first.",
|
|
4785
|
+
positionals: [],
|
|
4786
|
+
flags: [
|
|
4787
|
+
{
|
|
4788
|
+
name: 'limit',
|
|
4789
|
+
path: ['limit'],
|
|
4790
|
+
location: 'query',
|
|
4791
|
+
required: false,
|
|
4792
|
+
description: 'Page size, at most 100.',
|
|
4793
|
+
valueKind: 'integer',
|
|
4794
|
+
repeatable: false,
|
|
4795
|
+
},
|
|
4796
|
+
{
|
|
4797
|
+
name: 'offset',
|
|
4798
|
+
path: ['offset'],
|
|
4799
|
+
location: 'query',
|
|
4800
|
+
required: false,
|
|
4801
|
+
valueKind: 'integer',
|
|
4802
|
+
repeatable: false,
|
|
4803
|
+
},
|
|
4804
|
+
],
|
|
4805
|
+
hasParams: true,
|
|
4806
|
+
paramsAllOptional: true,
|
|
4807
|
+
bodyOpaque: false,
|
|
4808
|
+
bodyVariants: [],
|
|
4809
|
+
acceptsBody: false,
|
|
4810
|
+
requiresAuth: true,
|
|
4811
|
+
},
|
|
4812
|
+
{
|
|
4813
|
+
commandPath: ['live-report', 'run'],
|
|
4814
|
+
clientProperty: 'liveReport',
|
|
4815
|
+
methodName: 'run',
|
|
4816
|
+
httpMethod: 'post',
|
|
4817
|
+
httpPath: '/v1/live-report/{reportId}/generate',
|
|
4818
|
+
summary: 'Generate a live report document',
|
|
4819
|
+
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.',
|
|
4820
|
+
positionals: [
|
|
4821
|
+
{
|
|
4822
|
+
name: 'report-id',
|
|
4823
|
+
paramKey: 'reportId',
|
|
4824
|
+
description: 'The live report ID',
|
|
4825
|
+
},
|
|
4826
|
+
],
|
|
4827
|
+
flags: [
|
|
4828
|
+
{
|
|
4829
|
+
name: 'period-start',
|
|
4830
|
+
path: ['periodStart'],
|
|
4831
|
+
location: 'body',
|
|
4832
|
+
required: false,
|
|
4833
|
+
description: 'ISO 8601 start of a custom window. Omit both for the latest closed period.',
|
|
4834
|
+
valueKind: 'string',
|
|
4835
|
+
repeatable: false,
|
|
4836
|
+
},
|
|
4837
|
+
{
|
|
4838
|
+
name: 'period-end',
|
|
4839
|
+
path: ['periodEnd'],
|
|
4840
|
+
location: 'body',
|
|
4841
|
+
required: false,
|
|
4842
|
+
description: 'ISO 8601 end (exclusive) of a custom window. Requires periodStart.',
|
|
4843
|
+
valueKind: 'string',
|
|
4844
|
+
repeatable: false,
|
|
4845
|
+
},
|
|
4846
|
+
],
|
|
4847
|
+
hasParams: true,
|
|
4848
|
+
paramsAllOptional: true,
|
|
4849
|
+
bodyOpaque: false,
|
|
4850
|
+
bodyVariants: [],
|
|
4851
|
+
acceptsBody: true,
|
|
4852
|
+
requiresAuth: true,
|
|
4853
|
+
},
|
|
4854
|
+
{
|
|
4855
|
+
commandPath: ['live-report', 'update'],
|
|
4856
|
+
clientProperty: 'liveReport',
|
|
4857
|
+
methodName: 'update',
|
|
4858
|
+
httpMethod: 'patch',
|
|
4859
|
+
httpPath: '/v1/live-report/{reportId}',
|
|
4860
|
+
summary: 'Update a live report',
|
|
4861
|
+
description: 'Changes the fields sent. Set `status` to PAUSED to stop scheduled reports.',
|
|
4862
|
+
positionals: [
|
|
4863
|
+
{
|
|
4864
|
+
name: 'report-id',
|
|
4865
|
+
paramKey: 'reportId',
|
|
4866
|
+
description: 'The live report ID',
|
|
4867
|
+
},
|
|
4868
|
+
],
|
|
4869
|
+
flags: [
|
|
4870
|
+
{
|
|
4871
|
+
name: 'name',
|
|
4872
|
+
path: ['name'],
|
|
4873
|
+
location: 'body',
|
|
4874
|
+
required: false,
|
|
4875
|
+
valueKind: 'string',
|
|
4876
|
+
repeatable: false,
|
|
4877
|
+
},
|
|
4878
|
+
{
|
|
4879
|
+
name: 'description',
|
|
4880
|
+
path: ['description'],
|
|
4881
|
+
location: 'body',
|
|
4882
|
+
required: false,
|
|
4883
|
+
valueKind: 'string',
|
|
4884
|
+
repeatable: false,
|
|
4885
|
+
},
|
|
4886
|
+
{
|
|
4887
|
+
name: 'agent-id',
|
|
4888
|
+
path: ['agentId'],
|
|
4889
|
+
location: 'body',
|
|
4890
|
+
required: false,
|
|
4891
|
+
valueKind: 'string',
|
|
4892
|
+
repeatable: false,
|
|
4893
|
+
},
|
|
4894
|
+
{
|
|
4895
|
+
name: 'filters',
|
|
4896
|
+
path: ['filters'],
|
|
4897
|
+
location: 'body',
|
|
4898
|
+
required: false,
|
|
4899
|
+
valueKind: 'array',
|
|
4900
|
+
repeatable: false,
|
|
4901
|
+
},
|
|
4902
|
+
{
|
|
4903
|
+
name: 'targets',
|
|
4904
|
+
path: ['targets'],
|
|
4905
|
+
location: 'body',
|
|
4906
|
+
required: false,
|
|
4907
|
+
valueKind: 'array',
|
|
4908
|
+
repeatable: false,
|
|
4909
|
+
},
|
|
4910
|
+
{
|
|
4911
|
+
name: 'dashboard-id',
|
|
4912
|
+
path: ['dashboardId'],
|
|
4913
|
+
location: 'body',
|
|
4914
|
+
required: false,
|
|
4915
|
+
valueKind: 'string',
|
|
4916
|
+
repeatable: false,
|
|
4917
|
+
},
|
|
4918
|
+
{
|
|
4919
|
+
name: 'cadence',
|
|
4920
|
+
path: ['cadence'],
|
|
4921
|
+
location: 'body',
|
|
4922
|
+
required: false,
|
|
4923
|
+
valueKind: 'string',
|
|
4924
|
+
enumValues: ['DAILY', 'WEEKLY', 'MONTHLY'],
|
|
4925
|
+
repeatable: false,
|
|
4926
|
+
},
|
|
4927
|
+
{
|
|
4928
|
+
name: 'timezone',
|
|
4929
|
+
path: ['timezone'],
|
|
4930
|
+
location: 'body',
|
|
4931
|
+
required: false,
|
|
4932
|
+
valueKind: 'string',
|
|
4933
|
+
repeatable: false,
|
|
4934
|
+
},
|
|
4935
|
+
{
|
|
4936
|
+
name: 'delivery-hour',
|
|
4937
|
+
path: ['deliveryHour'],
|
|
4938
|
+
location: 'body',
|
|
4939
|
+
required: false,
|
|
4940
|
+
valueKind: 'integer',
|
|
4941
|
+
repeatable: false,
|
|
4942
|
+
},
|
|
4943
|
+
{
|
|
4944
|
+
name: 'status',
|
|
4945
|
+
path: ['status'],
|
|
4946
|
+
location: 'body',
|
|
4947
|
+
required: false,
|
|
4948
|
+
valueKind: 'string',
|
|
4949
|
+
enumValues: ['ACTIVE', 'PAUSED'],
|
|
4950
|
+
repeatable: false,
|
|
4951
|
+
},
|
|
4952
|
+
{
|
|
4953
|
+
name: 'notifications',
|
|
4954
|
+
path: ['notifications'],
|
|
4955
|
+
location: 'body',
|
|
4956
|
+
required: false,
|
|
4957
|
+
valueKind: 'object',
|
|
4958
|
+
},
|
|
4959
|
+
{
|
|
4960
|
+
name: 'notifications.email',
|
|
4961
|
+
path: ['notifications', 'email'],
|
|
4962
|
+
location: 'body',
|
|
4963
|
+
required: true,
|
|
4964
|
+
valueKind: 'object',
|
|
4965
|
+
repeatable: false,
|
|
4966
|
+
},
|
|
4967
|
+
{
|
|
4968
|
+
name: 'notifications.slack',
|
|
4969
|
+
path: ['notifications', 'slack'],
|
|
4241
4970
|
location: 'body',
|
|
4242
|
-
required:
|
|
4243
|
-
|
|
4244
|
-
valueKind: 'string',
|
|
4971
|
+
required: true,
|
|
4972
|
+
valueKind: 'array',
|
|
4245
4973
|
repeatable: false,
|
|
4246
4974
|
},
|
|
4247
4975
|
{
|
|
4248
|
-
name: '
|
|
4249
|
-
path: ['
|
|
4976
|
+
name: 'include-transcript-excerpts',
|
|
4977
|
+
path: ['includeTranscriptExcerpts'],
|
|
4250
4978
|
location: 'body',
|
|
4251
4979
|
required: false,
|
|
4252
|
-
|
|
4253
|
-
valueKind: 'object',
|
|
4980
|
+
valueKind: 'boolean',
|
|
4254
4981
|
repeatable: false,
|
|
4255
4982
|
},
|
|
4256
4983
|
],
|
|
@@ -4554,6 +5281,15 @@ exports.COMMANDS = [
|
|
|
4554
5281
|
valueKind: 'string',
|
|
4555
5282
|
repeatable: false,
|
|
4556
5283
|
},
|
|
5284
|
+
{
|
|
5285
|
+
name: 'grades-short-calls',
|
|
5286
|
+
path: ['gradesShortCalls'],
|
|
5287
|
+
location: 'body',
|
|
5288
|
+
required: false,
|
|
5289
|
+
description: 'Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false.',
|
|
5290
|
+
valueKind: 'boolean',
|
|
5291
|
+
repeatable: false,
|
|
5292
|
+
},
|
|
4557
5293
|
{
|
|
4558
5294
|
name: 'classification-options',
|
|
4559
5295
|
path: ['classificationOptions'],
|
|
@@ -5164,6 +5900,15 @@ exports.COMMANDS = [
|
|
|
5164
5900
|
valueKind: 'string',
|
|
5165
5901
|
repeatable: false,
|
|
5166
5902
|
},
|
|
5903
|
+
{
|
|
5904
|
+
name: 'grades-short-calls',
|
|
5905
|
+
path: ['gradesShortCalls'],
|
|
5906
|
+
location: 'body',
|
|
5907
|
+
required: false,
|
|
5908
|
+
description: 'Score this metric on a simulated call with fewer than 4 transcript lines. Such calls skip every other metric. Default false.',
|
|
5909
|
+
valueKind: 'boolean',
|
|
5910
|
+
repeatable: false,
|
|
5911
|
+
},
|
|
5167
5912
|
{
|
|
5168
5913
|
name: 'max-classifications',
|
|
5169
5914
|
path: ['maxClassifications'],
|
|
@@ -7891,6 +8636,306 @@ exports.COMMANDS = [
|
|
|
7891
8636
|
acceptsBody: true,
|
|
7892
8637
|
requiresAuth: true,
|
|
7893
8638
|
},
|
|
8639
|
+
{
|
|
8640
|
+
commandPath: ['tool', 'create'],
|
|
8641
|
+
clientProperty: 'tool',
|
|
8642
|
+
methodName: 'create',
|
|
8643
|
+
httpMethod: 'post',
|
|
8644
|
+
httpPath: '/v1/tool',
|
|
8645
|
+
summary: 'Create a tool',
|
|
8646
|
+
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.',
|
|
8647
|
+
positionals: [],
|
|
8648
|
+
flags: [
|
|
8649
|
+
{
|
|
8650
|
+
name: 'name',
|
|
8651
|
+
path: ['name'],
|
|
8652
|
+
location: 'body',
|
|
8653
|
+
required: true,
|
|
8654
|
+
valueKind: 'string',
|
|
8655
|
+
repeatable: false,
|
|
8656
|
+
},
|
|
8657
|
+
{
|
|
8658
|
+
name: 'description',
|
|
8659
|
+
path: ['description'],
|
|
8660
|
+
location: 'body',
|
|
8661
|
+
required: true,
|
|
8662
|
+
description: 'When the agent should use the tool',
|
|
8663
|
+
valueKind: 'string',
|
|
8664
|
+
repeatable: false,
|
|
8665
|
+
},
|
|
8666
|
+
{
|
|
8667
|
+
name: 'agent-id',
|
|
8668
|
+
path: ['agentId'],
|
|
8669
|
+
location: 'body',
|
|
8670
|
+
required: false,
|
|
8671
|
+
valueKind: 'string',
|
|
8672
|
+
repeatable: false,
|
|
8673
|
+
},
|
|
8674
|
+
{
|
|
8675
|
+
name: 'inputs',
|
|
8676
|
+
path: ['inputs'],
|
|
8677
|
+
location: 'body',
|
|
8678
|
+
required: false,
|
|
8679
|
+
valueKind: 'array',
|
|
8680
|
+
repeatable: false,
|
|
8681
|
+
},
|
|
8682
|
+
{
|
|
8683
|
+
name: 'invocation-criteria',
|
|
8684
|
+
path: ['invocationCriteria'],
|
|
8685
|
+
location: 'body',
|
|
8686
|
+
required: false,
|
|
8687
|
+
valueKind: 'string',
|
|
8688
|
+
repeatable: false,
|
|
8689
|
+
},
|
|
8690
|
+
{
|
|
8691
|
+
name: 'expected-result',
|
|
8692
|
+
path: ['expectedResult'],
|
|
8693
|
+
location: 'body',
|
|
8694
|
+
required: false,
|
|
8695
|
+
valueKind: 'string',
|
|
8696
|
+
repeatable: false,
|
|
8697
|
+
},
|
|
8698
|
+
{
|
|
8699
|
+
name: 'runtime',
|
|
8700
|
+
path: ['runtime'],
|
|
8701
|
+
location: 'body',
|
|
8702
|
+
required: false,
|
|
8703
|
+
description: 'Omit or null for a tool that is only graded',
|
|
8704
|
+
valueKind: 'object',
|
|
8705
|
+
},
|
|
8706
|
+
{
|
|
8707
|
+
name: 'runtime.request',
|
|
8708
|
+
path: ['runtime', 'request'],
|
|
8709
|
+
location: 'body',
|
|
8710
|
+
required: true,
|
|
8711
|
+
valueKind: 'object',
|
|
8712
|
+
repeatable: false,
|
|
8713
|
+
},
|
|
8714
|
+
{
|
|
8715
|
+
name: 'runtime.changes-data',
|
|
8716
|
+
path: ['runtime', 'changesData'],
|
|
8717
|
+
location: 'body',
|
|
8718
|
+
required: false,
|
|
8719
|
+
valueKind: 'boolean',
|
|
8720
|
+
repeatable: false,
|
|
8721
|
+
},
|
|
8722
|
+
{
|
|
8723
|
+
name: 'runtime.response-fields',
|
|
8724
|
+
path: ['runtime', 'responseFields'],
|
|
8725
|
+
location: 'body',
|
|
8726
|
+
required: false,
|
|
8727
|
+
valueKind: 'array',
|
|
8728
|
+
repeatable: true,
|
|
8729
|
+
},
|
|
8730
|
+
{
|
|
8731
|
+
name: 'runtime.messages',
|
|
8732
|
+
path: ['runtime', 'messages'],
|
|
8733
|
+
location: 'body',
|
|
8734
|
+
required: false,
|
|
8735
|
+
valueKind: 'object',
|
|
8736
|
+
repeatable: false,
|
|
8737
|
+
},
|
|
8738
|
+
],
|
|
8739
|
+
hasParams: true,
|
|
8740
|
+
paramsAllOptional: false,
|
|
8741
|
+
bodyOpaque: false,
|
|
8742
|
+
bodyVariants: [],
|
|
8743
|
+
acceptsBody: true,
|
|
8744
|
+
requiresAuth: true,
|
|
8745
|
+
},
|
|
8746
|
+
{
|
|
8747
|
+
commandPath: ['tool', 'delete'],
|
|
8748
|
+
clientProperty: 'tool',
|
|
8749
|
+
methodName: 'delete',
|
|
8750
|
+
httpMethod: 'delete',
|
|
8751
|
+
httpPath: '/v1/tool/{toolId}',
|
|
8752
|
+
summary: 'Delete a tool',
|
|
8753
|
+
description: 'Deletes a tool no agent version uses. A tool an agent version uses returns 409.',
|
|
8754
|
+
positionals: [
|
|
8755
|
+
{
|
|
8756
|
+
name: 'tool-id',
|
|
8757
|
+
paramKey: 'toolId',
|
|
8758
|
+
},
|
|
8759
|
+
],
|
|
8760
|
+
flags: [],
|
|
8761
|
+
hasParams: false,
|
|
8762
|
+
paramsAllOptional: true,
|
|
8763
|
+
bodyOpaque: false,
|
|
8764
|
+
bodyVariants: [],
|
|
8765
|
+
acceptsBody: false,
|
|
8766
|
+
requiresAuth: true,
|
|
8767
|
+
},
|
|
8768
|
+
{
|
|
8769
|
+
commandPath: ['tool', 'get'],
|
|
8770
|
+
clientProperty: 'tool',
|
|
8771
|
+
methodName: 'getByID',
|
|
8772
|
+
httpMethod: 'get',
|
|
8773
|
+
httpPath: '/v1/tool/{toolId}',
|
|
8774
|
+
summary: 'Get a tool',
|
|
8775
|
+
description: 'Get a tool',
|
|
8776
|
+
positionals: [
|
|
8777
|
+
{
|
|
8778
|
+
name: 'tool-id',
|
|
8779
|
+
paramKey: 'toolId',
|
|
8780
|
+
},
|
|
8781
|
+
],
|
|
8782
|
+
flags: [],
|
|
8783
|
+
hasParams: false,
|
|
8784
|
+
paramsAllOptional: true,
|
|
8785
|
+
bodyOpaque: false,
|
|
8786
|
+
bodyVariants: [],
|
|
8787
|
+
acceptsBody: false,
|
|
8788
|
+
requiresAuth: true,
|
|
8789
|
+
},
|
|
8790
|
+
{
|
|
8791
|
+
commandPath: ['tool', 'list'],
|
|
8792
|
+
clientProperty: 'tool',
|
|
8793
|
+
methodName: 'list',
|
|
8794
|
+
httpMethod: 'get',
|
|
8795
|
+
httpPath: '/v1/tool',
|
|
8796
|
+
summary: 'List tools',
|
|
8797
|
+
description: "The project's tools and the built-in ones, each with its latest version: inputs, description and, for a tool a hosted agent runs, its request. Attach one to an agent draft by id.",
|
|
8798
|
+
positionals: [],
|
|
8799
|
+
flags: [
|
|
8800
|
+
{
|
|
8801
|
+
name: 'agent-id',
|
|
8802
|
+
path: ['agentId'],
|
|
8803
|
+
location: 'query',
|
|
8804
|
+
required: false,
|
|
8805
|
+
description: 'Only tools scoped to this agent',
|
|
8806
|
+
valueKind: 'string',
|
|
8807
|
+
repeatable: false,
|
|
8808
|
+
},
|
|
8809
|
+
{
|
|
8810
|
+
name: 'include-built-in',
|
|
8811
|
+
path: ['includeBuiltIn'],
|
|
8812
|
+
location: 'query',
|
|
8813
|
+
required: false,
|
|
8814
|
+
description: 'Include the built-in tools (default true)',
|
|
8815
|
+
valueKind: 'string',
|
|
8816
|
+
enumValues: ['true', 'false'],
|
|
8817
|
+
repeatable: false,
|
|
8818
|
+
},
|
|
8819
|
+
],
|
|
8820
|
+
hasParams: true,
|
|
8821
|
+
paramsAllOptional: true,
|
|
8822
|
+
bodyOpaque: false,
|
|
8823
|
+
bodyVariants: [],
|
|
8824
|
+
acceptsBody: false,
|
|
8825
|
+
requiresAuth: true,
|
|
8826
|
+
},
|
|
8827
|
+
{
|
|
8828
|
+
commandPath: ['tool', 'update'],
|
|
8829
|
+
clientProperty: 'tool',
|
|
8830
|
+
methodName: 'update',
|
|
8831
|
+
httpMethod: 'put',
|
|
8832
|
+
httpPath: '/v1/tool/{toolId}',
|
|
8833
|
+
summary: 'Update a tool',
|
|
8834
|
+
description: 'Replaces the tool: its name, scope, inputs, description, grading hints and runtime. A field left out is cleared, so omitting agentId makes the tool project-wide. A change declares a new version; agent versions pinned to an older one keep it.',
|
|
8835
|
+
positionals: [
|
|
8836
|
+
{
|
|
8837
|
+
name: 'tool-id',
|
|
8838
|
+
paramKey: 'toolId',
|
|
8839
|
+
},
|
|
8840
|
+
],
|
|
8841
|
+
flags: [
|
|
8842
|
+
{
|
|
8843
|
+
name: 'name',
|
|
8844
|
+
path: ['name'],
|
|
8845
|
+
location: 'body',
|
|
8846
|
+
required: true,
|
|
8847
|
+
valueKind: 'string',
|
|
8848
|
+
repeatable: false,
|
|
8849
|
+
},
|
|
8850
|
+
{
|
|
8851
|
+
name: 'description',
|
|
8852
|
+
path: ['description'],
|
|
8853
|
+
location: 'body',
|
|
8854
|
+
required: true,
|
|
8855
|
+
description: 'When the agent should use the tool',
|
|
8856
|
+
valueKind: 'string',
|
|
8857
|
+
repeatable: false,
|
|
8858
|
+
},
|
|
8859
|
+
{
|
|
8860
|
+
name: 'agent-id',
|
|
8861
|
+
path: ['agentId'],
|
|
8862
|
+
location: 'body',
|
|
8863
|
+
required: false,
|
|
8864
|
+
valueKind: 'string',
|
|
8865
|
+
repeatable: false,
|
|
8866
|
+
},
|
|
8867
|
+
{
|
|
8868
|
+
name: 'inputs',
|
|
8869
|
+
path: ['inputs'],
|
|
8870
|
+
location: 'body',
|
|
8871
|
+
required: false,
|
|
8872
|
+
valueKind: 'array',
|
|
8873
|
+
repeatable: false,
|
|
8874
|
+
},
|
|
8875
|
+
{
|
|
8876
|
+
name: 'invocation-criteria',
|
|
8877
|
+
path: ['invocationCriteria'],
|
|
8878
|
+
location: 'body',
|
|
8879
|
+
required: false,
|
|
8880
|
+
valueKind: 'string',
|
|
8881
|
+
repeatable: false,
|
|
8882
|
+
},
|
|
8883
|
+
{
|
|
8884
|
+
name: 'expected-result',
|
|
8885
|
+
path: ['expectedResult'],
|
|
8886
|
+
location: 'body',
|
|
8887
|
+
required: false,
|
|
8888
|
+
valueKind: 'string',
|
|
8889
|
+
repeatable: false,
|
|
8890
|
+
},
|
|
8891
|
+
{
|
|
8892
|
+
name: 'runtime',
|
|
8893
|
+
path: ['runtime'],
|
|
8894
|
+
location: 'body',
|
|
8895
|
+
required: false,
|
|
8896
|
+
description: 'Omit or null for a tool that is only graded',
|
|
8897
|
+
valueKind: 'object',
|
|
8898
|
+
},
|
|
8899
|
+
{
|
|
8900
|
+
name: 'runtime.request',
|
|
8901
|
+
path: ['runtime', 'request'],
|
|
8902
|
+
location: 'body',
|
|
8903
|
+
required: true,
|
|
8904
|
+
valueKind: 'object',
|
|
8905
|
+
repeatable: false,
|
|
8906
|
+
},
|
|
8907
|
+
{
|
|
8908
|
+
name: 'runtime.changes-data',
|
|
8909
|
+
path: ['runtime', 'changesData'],
|
|
8910
|
+
location: 'body',
|
|
8911
|
+
required: false,
|
|
8912
|
+
valueKind: 'boolean',
|
|
8913
|
+
repeatable: false,
|
|
8914
|
+
},
|
|
8915
|
+
{
|
|
8916
|
+
name: 'runtime.response-fields',
|
|
8917
|
+
path: ['runtime', 'responseFields'],
|
|
8918
|
+
location: 'body',
|
|
8919
|
+
required: false,
|
|
8920
|
+
valueKind: 'array',
|
|
8921
|
+
repeatable: true,
|
|
8922
|
+
},
|
|
8923
|
+
{
|
|
8924
|
+
name: 'runtime.messages',
|
|
8925
|
+
path: ['runtime', 'messages'],
|
|
8926
|
+
location: 'body',
|
|
8927
|
+
required: false,
|
|
8928
|
+
valueKind: 'object',
|
|
8929
|
+
repeatable: false,
|
|
8930
|
+
},
|
|
8931
|
+
],
|
|
8932
|
+
hasParams: true,
|
|
8933
|
+
paramsAllOptional: false,
|
|
8934
|
+
bodyOpaque: false,
|
|
8935
|
+
bodyVariants: [],
|
|
8936
|
+
acceptsBody: true,
|
|
8937
|
+
requiresAuth: true,
|
|
8938
|
+
},
|
|
7894
8939
|
{
|
|
7895
8940
|
commandPath: ['usage', 'get'],
|
|
7896
8941
|
clientProperty: 'usage',
|