@roarkanalytics/cli 0.61.1 → 0.68.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -0
- package/README.md +45 -0
- package/commands.js +575 -0
- 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-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 +39 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +15 -2
- package/runtime/commands/config-as-code.js +5 -23
- package/runtime/commands/get-started.d.ts +34 -0
- package/runtime/commands/get-started.js +350 -0
- package/runtime/config-bundle.d.ts +10 -0
- package/runtime/config-bundle.js +14 -3
- package/runtime/config-changes.d.ts +15 -0
- package/runtime/config-changes.js +32 -0
- package/runtime/get-started/account.d.ts +18 -0
- package/runtime/get-started/account.js +35 -0
- package/runtime/get-started/agent.d.ts +17 -0
- package/runtime/get-started/agent.js +116 -0
- package/runtime/get-started/answers.d.ts +15 -0
- package/runtime/get-started/answers.js +42 -0
- package/runtime/get-started/apply.d.ts +35 -0
- package/runtime/get-started/apply.js +54 -0
- package/runtime/get-started/existing.d.ts +15 -0
- package/runtime/get-started/existing.js +47 -0
- package/runtime/get-started/ladder.d.ts +37 -0
- package/runtime/get-started/ladder.js +69 -0
- package/runtime/get-started/module.d.ts +20 -0
- package/runtime/get-started/module.js +159 -0
- package/runtime/get-started/placeholder.d.ts +9 -0
- package/runtime/get-started/placeholder.js +36 -0
- package/runtime/get-started/prompt.d.ts +32 -0
- package/runtime/get-started/prompt.js +132 -0
- package/runtime/get-started/resources.d.ts +106 -0
- package/runtime/get-started/resources.js +184 -0
- package/runtime/get-started/run.d.ts +42 -0
- package/runtime/get-started/run.js +101 -0
- package/runtime/get-started/scaffold-only.d.ts +19 -0
- package/runtime/get-started/scaffold-only.js +43 -0
- package/runtime/get-started/scaffold.d.ts +15 -0
- package/runtime/get-started/scaffold.js +35 -0
- package/runtime/get-started/starter-metrics.d.ts +33 -0
- package/runtime/get-started/starter-metrics.js +104 -0
- package/runtime/get-started/steps.d.ts +33 -0
- package/runtime/get-started/steps.js +112 -0
- package/runtime/get-started/target.d.ts +47 -0
- package/runtime/get-started/target.js +81 -0
- package/runtime/get-started/types.d.ts +18 -0
- package/runtime/get-started/types.js +8 -0
- package/runtime/get-started/watch.d.ts +57 -0
- package/runtime/get-started/watch.js +103 -0
- package/runtime/program.js +5 -0
- 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',
|
|
@@ -74,6 +76,7 @@ exports.GROUPS = {
|
|
|
74
76
|
'simulation template': 'Read simulation templates',
|
|
75
77
|
'simulation tool': 'Read simulation tool',
|
|
76
78
|
'simulation tool-fixture': 'Manage simulation tool fixtures',
|
|
79
|
+
tool: 'Manage tools',
|
|
77
80
|
usage: 'Read usage',
|
|
78
81
|
webhook: 'Manage webhooks',
|
|
79
82
|
};
|
|
@@ -2008,6 +2011,260 @@ exports.COMMANDS = [
|
|
|
2008
2011
|
acceptsBody: false,
|
|
2009
2012
|
requiresAuth: true,
|
|
2010
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
|
+
},
|
|
2011
2268
|
{
|
|
2012
2269
|
commandPath: ['call', 'batch', 'delete'],
|
|
2013
2270
|
clientProperty: 'call',
|
|
@@ -5024,6 +5281,15 @@ exports.COMMANDS = [
|
|
|
5024
5281
|
valueKind: 'string',
|
|
5025
5282
|
repeatable: false,
|
|
5026
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
|
+
},
|
|
5027
5293
|
{
|
|
5028
5294
|
name: 'classification-options',
|
|
5029
5295
|
path: ['classificationOptions'],
|
|
@@ -5634,6 +5900,15 @@ exports.COMMANDS = [
|
|
|
5634
5900
|
valueKind: 'string',
|
|
5635
5901
|
repeatable: false,
|
|
5636
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
|
+
},
|
|
5637
5912
|
{
|
|
5638
5913
|
name: 'max-classifications',
|
|
5639
5914
|
path: ['maxClassifications'],
|
|
@@ -8361,6 +8636,306 @@ exports.COMMANDS = [
|
|
|
8361
8636
|
acceptsBody: true,
|
|
8362
8637
|
requiresAuth: true,
|
|
8363
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
|
+
},
|
|
8364
8939
|
{
|
|
8365
8940
|
commandPath: ['usage', 'get'],
|
|
8366
8941
|
clientProperty: 'usage',
|