@runtypelabs/sdk 11.18.0 → 11.19.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/dist/index.cjs +33 -25
- package/dist/index.d.cts +124 -395
- package/dist/index.d.ts +124 -395
- package/dist/index.mjs +33 -25
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -13181,6 +13181,15 @@ interface paths {
|
|
|
13181
13181
|
};
|
|
13182
13182
|
};
|
|
13183
13183
|
};
|
|
13184
|
+
/** @description Invalid cursor: it was not issued by this endpoint, or the conversation a legacy id cursor names no longer exists. Restart from the first page. */
|
|
13185
|
+
400: {
|
|
13186
|
+
headers: {
|
|
13187
|
+
[name: string]: unknown;
|
|
13188
|
+
};
|
|
13189
|
+
content: {
|
|
13190
|
+
"application/json": components["schemas"]["Error"];
|
|
13191
|
+
};
|
|
13192
|
+
};
|
|
13184
13193
|
/** @description Unauthorized */
|
|
13185
13194
|
401: {
|
|
13186
13195
|
headers: {
|
|
@@ -21764,6 +21773,8 @@ interface paths {
|
|
|
21764
21773
|
simulationId?: string;
|
|
21765
21774
|
/** @description Only events for this delegated task */
|
|
21766
21775
|
taskId?: string;
|
|
21776
|
+
/** @description Only events for this API key request */
|
|
21777
|
+
requestId?: string;
|
|
21767
21778
|
/** @description Signal events only: keep occurrences for this signal key */
|
|
21768
21779
|
key?: string;
|
|
21769
21780
|
/** @description Eval runs only: keep runs whose pass rate dropped */
|
|
@@ -21850,7 +21861,7 @@ interface paths {
|
|
|
21850
21861
|
};
|
|
21851
21862
|
/**
|
|
21852
21863
|
* List event types
|
|
21853
|
-
* @description The product events you can poll, each with the filter arguments it accepts and the shape of its `data`. An API key sees only the events its scopes cover (each event's `requiredScopes`).
|
|
21864
|
+
* @description The product events you can poll, each with the filter arguments it accepts and the shape of its `data`. An API key sees only the events its scopes cover (each event's `requiredScopes`), plus `runtype.api_key_request.decided` for the key requests it filed; read it by name when the key holds no other event scope.
|
|
21854
21865
|
*/
|
|
21855
21866
|
get: {
|
|
21856
21867
|
parameters: {
|
|
@@ -41148,320 +41159,6 @@ interface paths {
|
|
|
41148
41159
|
patch?: never;
|
|
41149
41160
|
trace?: never;
|
|
41150
41161
|
};
|
|
41151
|
-
"/v1/products/{productId}/surfaces/{surfaceId}/cli/graduation": {
|
|
41152
|
-
parameters: {
|
|
41153
|
-
query?: never;
|
|
41154
|
-
header?: never;
|
|
41155
|
-
path?: never;
|
|
41156
|
-
cookie?: never;
|
|
41157
|
-
};
|
|
41158
|
-
get?: never;
|
|
41159
|
-
put?: never;
|
|
41160
|
-
/**
|
|
41161
|
-
* Start CLI graduation
|
|
41162
|
-
* @description Mints a single-use token that moves a managed `cli` surface to your npm package once it is in that package's package.json on npm.
|
|
41163
|
-
*/
|
|
41164
|
-
post: {
|
|
41165
|
-
parameters: {
|
|
41166
|
-
query?: never;
|
|
41167
|
-
header?: never;
|
|
41168
|
-
path: {
|
|
41169
|
-
productId: string;
|
|
41170
|
-
surfaceId: string;
|
|
41171
|
-
};
|
|
41172
|
-
cookie?: never;
|
|
41173
|
-
};
|
|
41174
|
-
requestBody: {
|
|
41175
|
-
content: {
|
|
41176
|
-
"application/json": {
|
|
41177
|
-
/** @description Your npm package, `@acme/cli` or `acme`; never `@rtype/*` */
|
|
41178
|
-
packageName: string;
|
|
41179
|
-
};
|
|
41180
|
-
};
|
|
41181
|
-
};
|
|
41182
|
-
responses: {
|
|
41183
|
-
/** @description Token minted */
|
|
41184
|
-
200: {
|
|
41185
|
-
headers: {
|
|
41186
|
-
[name: string]: unknown;
|
|
41187
|
-
};
|
|
41188
|
-
content: {
|
|
41189
|
-
"application/json": components["schemas"]["CliGraduationGrant"];
|
|
41190
|
-
};
|
|
41191
|
-
};
|
|
41192
|
-
/** @description Invalid IDs or package name, or no command name */
|
|
41193
|
-
400: {
|
|
41194
|
-
headers: {
|
|
41195
|
-
[name: string]: unknown;
|
|
41196
|
-
};
|
|
41197
|
-
content: {
|
|
41198
|
-
"application/json": {
|
|
41199
|
-
code?: string;
|
|
41200
|
-
error: string;
|
|
41201
|
-
issues?: {
|
|
41202
|
-
code: string;
|
|
41203
|
-
message: string;
|
|
41204
|
-
verdict: string;
|
|
41205
|
-
}[];
|
|
41206
|
-
/**
|
|
41207
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41208
|
-
* @enum {string}
|
|
41209
|
-
*/
|
|
41210
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41211
|
-
};
|
|
41212
|
-
};
|
|
41213
|
-
};
|
|
41214
|
-
/** @description Insufficient permissions, or `CLI_SURFACE_GRADUATION_DISABLED` */
|
|
41215
|
-
403: {
|
|
41216
|
-
headers: {
|
|
41217
|
-
[name: string]: unknown;
|
|
41218
|
-
};
|
|
41219
|
-
content: {
|
|
41220
|
-
"application/json": {
|
|
41221
|
-
code?: string;
|
|
41222
|
-
error: string;
|
|
41223
|
-
issues?: {
|
|
41224
|
-
code: string;
|
|
41225
|
-
message: string;
|
|
41226
|
-
verdict: string;
|
|
41227
|
-
}[];
|
|
41228
|
-
/**
|
|
41229
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41230
|
-
* @enum {string}
|
|
41231
|
-
*/
|
|
41232
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41233
|
-
};
|
|
41234
|
-
};
|
|
41235
|
-
};
|
|
41236
|
-
/** @description CLI surface not found */
|
|
41237
|
-
404: {
|
|
41238
|
-
headers: {
|
|
41239
|
-
[name: string]: unknown;
|
|
41240
|
-
};
|
|
41241
|
-
content: {
|
|
41242
|
-
"application/json": components["schemas"]["Error"];
|
|
41243
|
-
};
|
|
41244
|
-
};
|
|
41245
|
-
/** @description `CLI_SURFACE_NOT_MANAGED` */
|
|
41246
|
-
409: {
|
|
41247
|
-
headers: {
|
|
41248
|
-
[name: string]: unknown;
|
|
41249
|
-
};
|
|
41250
|
-
content: {
|
|
41251
|
-
"application/json": {
|
|
41252
|
-
code?: string;
|
|
41253
|
-
error: string;
|
|
41254
|
-
issues?: {
|
|
41255
|
-
code: string;
|
|
41256
|
-
message: string;
|
|
41257
|
-
verdict: string;
|
|
41258
|
-
}[];
|
|
41259
|
-
/**
|
|
41260
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41261
|
-
* @enum {string}
|
|
41262
|
-
*/
|
|
41263
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41264
|
-
};
|
|
41265
|
-
};
|
|
41266
|
-
};
|
|
41267
|
-
/** @description `CLI_GRADUATION_NOT_CONFIGURED`: no signing key */
|
|
41268
|
-
503: {
|
|
41269
|
-
headers: {
|
|
41270
|
-
[name: string]: unknown;
|
|
41271
|
-
};
|
|
41272
|
-
content: {
|
|
41273
|
-
"application/json": {
|
|
41274
|
-
code?: string;
|
|
41275
|
-
error: string;
|
|
41276
|
-
issues?: {
|
|
41277
|
-
code: string;
|
|
41278
|
-
message: string;
|
|
41279
|
-
verdict: string;
|
|
41280
|
-
}[];
|
|
41281
|
-
/**
|
|
41282
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41283
|
-
* @enum {string}
|
|
41284
|
-
*/
|
|
41285
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41286
|
-
};
|
|
41287
|
-
};
|
|
41288
|
-
};
|
|
41289
|
-
};
|
|
41290
|
-
};
|
|
41291
|
-
delete?: never;
|
|
41292
|
-
options?: never;
|
|
41293
|
-
head?: never;
|
|
41294
|
-
patch?: never;
|
|
41295
|
-
trace?: never;
|
|
41296
|
-
};
|
|
41297
|
-
"/v1/products/{productId}/surfaces/{surfaceId}/cli/graduation/complete": {
|
|
41298
|
-
parameters: {
|
|
41299
|
-
query?: never;
|
|
41300
|
-
header?: never;
|
|
41301
|
-
path?: never;
|
|
41302
|
-
cookie?: never;
|
|
41303
|
-
};
|
|
41304
|
-
get?: never;
|
|
41305
|
-
put?: never;
|
|
41306
|
-
/**
|
|
41307
|
-
* Complete CLI graduation
|
|
41308
|
-
* @description Verifies the token in the latest npm version of the package, switches the surface to it once, and commits a forwarding `@rtype/<binName>` release. Calling it again after the switch retries that release.
|
|
41309
|
-
*/
|
|
41310
|
-
post: {
|
|
41311
|
-
parameters: {
|
|
41312
|
-
query?: never;
|
|
41313
|
-
header?: never;
|
|
41314
|
-
path: {
|
|
41315
|
-
productId: string;
|
|
41316
|
-
surfaceId: string;
|
|
41317
|
-
};
|
|
41318
|
-
cookie?: never;
|
|
41319
|
-
};
|
|
41320
|
-
requestBody: {
|
|
41321
|
-
content: {
|
|
41322
|
-
"application/json": {
|
|
41323
|
-
/** @description Your npm package, `@acme/cli` or `acme`; never `@rtype/*` */
|
|
41324
|
-
packageName: string;
|
|
41325
|
-
};
|
|
41326
|
-
};
|
|
41327
|
-
};
|
|
41328
|
-
responses: {
|
|
41329
|
-
/** @description Switched over */
|
|
41330
|
-
200: {
|
|
41331
|
-
headers: {
|
|
41332
|
-
[name: string]: unknown;
|
|
41333
|
-
};
|
|
41334
|
-
content: {
|
|
41335
|
-
"application/json": components["schemas"]["CliGraduationResult"];
|
|
41336
|
-
};
|
|
41337
|
-
};
|
|
41338
|
-
/** @description Invalid IDs or package name, or no command name */
|
|
41339
|
-
400: {
|
|
41340
|
-
headers: {
|
|
41341
|
-
[name: string]: unknown;
|
|
41342
|
-
};
|
|
41343
|
-
content: {
|
|
41344
|
-
"application/json": {
|
|
41345
|
-
code?: string;
|
|
41346
|
-
error: string;
|
|
41347
|
-
issues?: {
|
|
41348
|
-
code: string;
|
|
41349
|
-
message: string;
|
|
41350
|
-
verdict: string;
|
|
41351
|
-
}[];
|
|
41352
|
-
/**
|
|
41353
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41354
|
-
* @enum {string}
|
|
41355
|
-
*/
|
|
41356
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41357
|
-
};
|
|
41358
|
-
};
|
|
41359
|
-
};
|
|
41360
|
-
/** @description Insufficient permissions, or `CLI_SURFACE_GRADUATION_DISABLED` */
|
|
41361
|
-
403: {
|
|
41362
|
-
headers: {
|
|
41363
|
-
[name: string]: unknown;
|
|
41364
|
-
};
|
|
41365
|
-
content: {
|
|
41366
|
-
"application/json": {
|
|
41367
|
-
code?: string;
|
|
41368
|
-
error: string;
|
|
41369
|
-
issues?: {
|
|
41370
|
-
code: string;
|
|
41371
|
-
message: string;
|
|
41372
|
-
verdict: string;
|
|
41373
|
-
}[];
|
|
41374
|
-
/**
|
|
41375
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41376
|
-
* @enum {string}
|
|
41377
|
-
*/
|
|
41378
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41379
|
-
};
|
|
41380
|
-
};
|
|
41381
|
-
};
|
|
41382
|
-
/** @description CLI surface not found */
|
|
41383
|
-
404: {
|
|
41384
|
-
headers: {
|
|
41385
|
-
[name: string]: unknown;
|
|
41386
|
-
};
|
|
41387
|
-
content: {
|
|
41388
|
-
"application/json": components["schemas"]["Error"];
|
|
41389
|
-
};
|
|
41390
|
-
};
|
|
41391
|
-
/** @description `CLI_SURFACE_NOT_MANAGED`, `CLI_GRADUATION_TOKEN_NOT_FOUND`, `CLI_GRADUATION_PRERELEASE`, `CLI_GRADUATION_REJECTED` or `CLI_GRADUATION_CONFLICT` */
|
|
41392
|
-
409: {
|
|
41393
|
-
headers: {
|
|
41394
|
-
[name: string]: unknown;
|
|
41395
|
-
};
|
|
41396
|
-
content: {
|
|
41397
|
-
"application/json": {
|
|
41398
|
-
code?: string;
|
|
41399
|
-
error: string;
|
|
41400
|
-
issues?: {
|
|
41401
|
-
code: string;
|
|
41402
|
-
message: string;
|
|
41403
|
-
verdict: string;
|
|
41404
|
-
}[];
|
|
41405
|
-
/**
|
|
41406
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41407
|
-
* @enum {string}
|
|
41408
|
-
*/
|
|
41409
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41410
|
-
};
|
|
41411
|
-
};
|
|
41412
|
-
};
|
|
41413
|
-
/** @description `CLI_NPM_UNAVAILABLE` */
|
|
41414
|
-
502: {
|
|
41415
|
-
headers: {
|
|
41416
|
-
[name: string]: unknown;
|
|
41417
|
-
};
|
|
41418
|
-
content: {
|
|
41419
|
-
"application/json": {
|
|
41420
|
-
code?: string;
|
|
41421
|
-
error: string;
|
|
41422
|
-
issues?: {
|
|
41423
|
-
code: string;
|
|
41424
|
-
message: string;
|
|
41425
|
-
verdict: string;
|
|
41426
|
-
}[];
|
|
41427
|
-
/**
|
|
41428
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41429
|
-
* @enum {string}
|
|
41430
|
-
*/
|
|
41431
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41432
|
-
};
|
|
41433
|
-
};
|
|
41434
|
-
};
|
|
41435
|
-
/** @description `CLI_GRADUATION_NOT_CONFIGURED`: no signing key */
|
|
41436
|
-
503: {
|
|
41437
|
-
headers: {
|
|
41438
|
-
[name: string]: unknown;
|
|
41439
|
-
};
|
|
41440
|
-
content: {
|
|
41441
|
-
"application/json": {
|
|
41442
|
-
code?: string;
|
|
41443
|
-
error: string;
|
|
41444
|
-
issues?: {
|
|
41445
|
-
code: string;
|
|
41446
|
-
message: string;
|
|
41447
|
-
verdict: string;
|
|
41448
|
-
}[];
|
|
41449
|
-
/**
|
|
41450
|
-
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41451
|
-
* @enum {string}
|
|
41452
|
-
*/
|
|
41453
|
-
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41454
|
-
};
|
|
41455
|
-
};
|
|
41456
|
-
};
|
|
41457
|
-
};
|
|
41458
|
-
};
|
|
41459
|
-
delete?: never;
|
|
41460
|
-
options?: never;
|
|
41461
|
-
head?: never;
|
|
41462
|
-
patch?: never;
|
|
41463
|
-
trace?: never;
|
|
41464
|
-
};
|
|
41465
41162
|
"/v1/products/{productId}/surfaces/{surfaceId}/cli/publish": {
|
|
41466
41163
|
parameters: {
|
|
41467
41164
|
query?: never;
|
|
@@ -41471,7 +41168,7 @@ interface paths {
|
|
|
41471
41168
|
};
|
|
41472
41169
|
/**
|
|
41473
41170
|
* Get CLI publish status
|
|
41474
|
-
* @description
|
|
41171
|
+
* @description Whether the install host serves this `cli` surface, and the commands that install it. Read live from the install host's bucket.
|
|
41475
41172
|
*/
|
|
41476
41173
|
get: {
|
|
41477
41174
|
parameters: {
|
|
@@ -41494,7 +41191,7 @@ interface paths {
|
|
|
41494
41191
|
"application/json": components["schemas"]["CliPublishStatus"];
|
|
41495
41192
|
};
|
|
41496
41193
|
};
|
|
41497
|
-
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41194
|
+
/** @description Invalid IDs, or a name, install domain (`CLI_INSTALL_DOMAIN_INVALID`) or package the publish refuses */
|
|
41498
41195
|
400: {
|
|
41499
41196
|
headers: {
|
|
41500
41197
|
[name: string]: unknown;
|
|
@@ -41512,7 +41209,7 @@ interface paths {
|
|
|
41512
41209
|
};
|
|
41513
41210
|
};
|
|
41514
41211
|
};
|
|
41515
|
-
/** @description Insufficient permissions,
|
|
41212
|
+
/** @description Insufficient permissions, `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account, or `CLI_INSTALL_DOMAIN_DISABLED` for an install domain while custom install domains are off */
|
|
41516
41213
|
403: {
|
|
41517
41214
|
headers: {
|
|
41518
41215
|
[name: string]: unknown;
|
|
@@ -41539,7 +41236,7 @@ interface paths {
|
|
|
41539
41236
|
"application/json": components["schemas"]["Error"];
|
|
41540
41237
|
};
|
|
41541
41238
|
};
|
|
41542
|
-
/** @description `
|
|
41239
|
+
/** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
|
|
41543
41240
|
502: {
|
|
41544
41241
|
headers: {
|
|
41545
41242
|
[name: string]: unknown;
|
|
@@ -41557,7 +41254,7 @@ interface paths {
|
|
|
41557
41254
|
};
|
|
41558
41255
|
};
|
|
41559
41256
|
};
|
|
41560
|
-
/** @description `
|
|
41257
|
+
/** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
|
|
41561
41258
|
503: {
|
|
41562
41259
|
headers: {
|
|
41563
41260
|
[name: string]: unknown;
|
|
@@ -41580,7 +41277,7 @@ interface paths {
|
|
|
41580
41277
|
put?: never;
|
|
41581
41278
|
/**
|
|
41582
41279
|
* Publish a CLI surface
|
|
41583
|
-
* @description
|
|
41280
|
+
* @description Writes the surface's `cli.json`, `SKILL.md` and install scripts to the install host under its slug (its command name), so `curl -fsSL https://get.runtype.com/<slug> | sh` installs it. With `installDomain` set, publish issues a TXT token (`_runtype-install.<installDomain>`); once a publish finds it, the install scripts point at `https://<installDomain>`, which serves the same files at its root. Until then the CLI installs from the Runtype host and `installDomain.state` is `pending`. The first version is 1.0.0; changed files bump the patch version. A slug belongs to the first surface that publishes it, a verified domain to the surface whose TXT record proves it, and a name close to a protected brand needs a manual review first.
|
|
41584
41281
|
*/
|
|
41585
41282
|
post: {
|
|
41586
41283
|
parameters: {
|
|
@@ -41594,7 +41291,7 @@ interface paths {
|
|
|
41594
41291
|
};
|
|
41595
41292
|
requestBody?: never;
|
|
41596
41293
|
responses: {
|
|
41597
|
-
/** @description
|
|
41294
|
+
/** @description Published or unchanged */
|
|
41598
41295
|
200: {
|
|
41599
41296
|
headers: {
|
|
41600
41297
|
[name: string]: unknown;
|
|
@@ -41603,7 +41300,7 @@ interface paths {
|
|
|
41603
41300
|
"application/json": components["schemas"]["CliPublishResult"];
|
|
41604
41301
|
};
|
|
41605
41302
|
};
|
|
41606
|
-
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41303
|
+
/** @description Invalid IDs, or a name, install domain (`CLI_INSTALL_DOMAIN_INVALID`) or package the publish refuses */
|
|
41607
41304
|
400: {
|
|
41608
41305
|
headers: {
|
|
41609
41306
|
[name: string]: unknown;
|
|
@@ -41621,7 +41318,7 @@ interface paths {
|
|
|
41621
41318
|
};
|
|
41622
41319
|
};
|
|
41623
41320
|
};
|
|
41624
|
-
/** @description Insufficient permissions,
|
|
41321
|
+
/** @description Insufficient permissions, `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account, or `CLI_INSTALL_DOMAIN_DISABLED` for an install domain while custom install domains are off */
|
|
41625
41322
|
403: {
|
|
41626
41323
|
headers: {
|
|
41627
41324
|
[name: string]: unknown;
|
|
@@ -41648,7 +41345,7 @@ interface paths {
|
|
|
41648
41345
|
"application/json": components["schemas"]["Error"];
|
|
41649
41346
|
};
|
|
41650
41347
|
};
|
|
41651
|
-
/** @description The surface is inactive or
|
|
41348
|
+
/** @description The surface is inactive (`CLI_SURFACE_INACTIVE`) or has no tools (`CLI_SURFACE_HAS_NO_TOOLS`), another surface publishes its slug (`CLI_SLUG_TAKEN`) or holds its install domain while its TXT record still names that surface (`CLI_INSTALL_DOMAIN_TAKEN`), its name needs a brand review (`CLI_NAME_NEEDS_REVIEW`), or a concurrent publish changed it (`CLI_PUBLISH_CONFLICT`) */
|
|
41652
41349
|
409: {
|
|
41653
41350
|
headers: {
|
|
41654
41351
|
[name: string]: unknown;
|
|
@@ -41666,7 +41363,7 @@ interface paths {
|
|
|
41666
41363
|
};
|
|
41667
41364
|
};
|
|
41668
41365
|
};
|
|
41669
|
-
/** @description `
|
|
41366
|
+
/** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
|
|
41670
41367
|
502: {
|
|
41671
41368
|
headers: {
|
|
41672
41369
|
[name: string]: unknown;
|
|
@@ -41684,7 +41381,7 @@ interface paths {
|
|
|
41684
41381
|
};
|
|
41685
41382
|
};
|
|
41686
41383
|
};
|
|
41687
|
-
/** @description `
|
|
41384
|
+
/** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
|
|
41688
41385
|
503: {
|
|
41689
41386
|
headers: {
|
|
41690
41387
|
[name: string]: unknown;
|
|
@@ -45970,7 +45667,7 @@ interface paths {
|
|
|
45970
45667
|
put?: never;
|
|
45971
45668
|
/**
|
|
45972
45669
|
* Bulk edit records
|
|
45973
|
-
* @description Bulk update or delete metadata fields on multiple records.
|
|
45670
|
+
* @description Bulk update or delete metadata fields on multiple records. One request can target at most 5,000 records; a larger target set is rejected with 400 `bulk_edit_too_many_records` before anything is written, so narrow the selection and edit in batches.
|
|
45974
45671
|
*/
|
|
45975
45672
|
post: {
|
|
45976
45673
|
parameters: {
|
|
@@ -46050,13 +45747,13 @@ interface paths {
|
|
|
46050
45747
|
};
|
|
46051
45748
|
};
|
|
46052
45749
|
};
|
|
46053
|
-
/** @description Validation error */
|
|
45750
|
+
/** @description Validation error, or the edit targets more than 5,000 records (`bulk_edit_too_many_records`) */
|
|
46054
45751
|
400: {
|
|
46055
45752
|
headers: {
|
|
46056
45753
|
[name: string]: unknown;
|
|
46057
45754
|
};
|
|
46058
45755
|
content: {
|
|
46059
|
-
"application/json": components["schemas"]["
|
|
45756
|
+
"application/json": components["schemas"]["BulkEditError"];
|
|
46060
45757
|
};
|
|
46061
45758
|
};
|
|
46062
45759
|
/** @description Unauthorized */
|
|
@@ -54233,11 +53930,14 @@ interface paths {
|
|
|
54233
53930
|
};
|
|
54234
53931
|
/**
|
|
54235
53932
|
* List runs for a schedule
|
|
54236
|
-
* @description Returns the run history for a specific schedule, including batch execution summaries.
|
|
53933
|
+
* @description Returns the run history for a specific schedule, newest first, including batch execution summaries. Returns every run when `limit` and `cursor` are both omitted. Pass `limit` to page: a value above 500 is reduced to 500, and a `cursor` without `limit` reads 500 runs. When `hasMore` is true, pass `nextCursor` back as `cursor` to read older runs.
|
|
54237
53934
|
*/
|
|
54238
53935
|
get: {
|
|
54239
53936
|
parameters: {
|
|
54240
|
-
query?:
|
|
53937
|
+
query?: {
|
|
53938
|
+
limit?: string;
|
|
53939
|
+
cursor?: string;
|
|
53940
|
+
};
|
|
54241
53941
|
header?: never;
|
|
54242
53942
|
path: {
|
|
54243
53943
|
id: string;
|
|
@@ -54270,10 +53970,12 @@ interface paths {
|
|
|
54270
53970
|
status: string;
|
|
54271
53971
|
totalRecords: number | null;
|
|
54272
53972
|
}[];
|
|
53973
|
+
hasMore: boolean;
|
|
53974
|
+
nextCursor: string | null;
|
|
54273
53975
|
};
|
|
54274
53976
|
};
|
|
54275
53977
|
};
|
|
54276
|
-
/** @description Invalid ID format */
|
|
53978
|
+
/** @description Invalid ID format, limit, or cursor */
|
|
54277
53979
|
400: {
|
|
54278
53980
|
headers: {
|
|
54279
53981
|
[name: string]: unknown;
|
|
@@ -60643,7 +60345,7 @@ interface paths {
|
|
|
60643
60345
|
enableCanvasOnboarding: boolean;
|
|
60644
60346
|
enableChromeSurface: boolean;
|
|
60645
60347
|
enableCliSurface?: boolean;
|
|
60646
|
-
|
|
60348
|
+
enableCliSurfaceInstallDomain?: boolean;
|
|
60647
60349
|
enableCliSurfacePublish?: boolean;
|
|
60648
60350
|
enableDashboardAssistant: boolean;
|
|
60649
60351
|
enableDecisionModelsDashboard: boolean;
|
|
@@ -61862,6 +61564,12 @@ interface components {
|
|
|
61862
61564
|
toolId: string;
|
|
61863
61565
|
toolName: string;
|
|
61864
61566
|
};
|
|
61567
|
+
BulkEditError: components["schemas"]["Error"] & {
|
|
61568
|
+
/** @description On `bulk_edit_too_many_records`: the most records one bulk edit can target (5000). */
|
|
61569
|
+
limit?: number;
|
|
61570
|
+
/** @description On `bulk_edit_too_many_records`: what was refused and how to narrow the edit. */
|
|
61571
|
+
message?: string;
|
|
61572
|
+
};
|
|
61865
61573
|
BusyMessageRouteReport: {
|
|
61866
61574
|
/** @description The decision model that answered. */
|
|
61867
61575
|
model?: string;
|
|
@@ -61964,72 +61672,66 @@ interface components {
|
|
|
61964
61672
|
/** @description ISO timestamp of the provider message. */
|
|
61965
61673
|
timestamp: string;
|
|
61966
61674
|
};
|
|
61967
|
-
|
|
61968
|
-
|
|
61969
|
-
|
|
61970
|
-
|
|
61971
|
-
|
|
61972
|
-
|
|
61973
|
-
|
|
61974
|
-
|
|
61975
|
-
|
|
61976
|
-
|
|
61977
|
-
|
|
61978
|
-
|
|
61979
|
-
|
|
61980
|
-
|
|
61981
|
-
|
|
61982
|
-
|
|
61983
|
-
|
|
61984
|
-
|
|
61985
|
-
|
|
61986
|
-
|
|
61987
|
-
} | null;
|
|
61988
|
-
/** @description The final `@rtype/<binName>` release, forwarding to your package */
|
|
61989
|
-
forwarding: {
|
|
61990
|
-
commitSha: string | null;
|
|
61991
|
-
message: string;
|
|
61992
|
-
packageName: string;
|
|
61993
|
-
/** @enum {string} */
|
|
61994
|
-
state: "committed" | "unchanged" | "retried" | "not_published" | "skipped" | "not_configured" | "failed";
|
|
61995
|
-
version: string | null;
|
|
61675
|
+
CliInstallCommands: {
|
|
61676
|
+
/** @description The Windows install command: `irm <url>/install.ps1 | iex` */
|
|
61677
|
+
powershell: string;
|
|
61678
|
+
/** @description The macOS and Linux install command: `curl -fsSL <url> | sh` */
|
|
61679
|
+
sh: string;
|
|
61680
|
+
/** @description `GET` serves the POSIX install script, e.g. `https://get.runtype.com/<slug>` */
|
|
61681
|
+
url: string;
|
|
61682
|
+
} | null;
|
|
61683
|
+
/** @description The custom install domain the surface asks for and whether it is verified; null when it asks for none */
|
|
61684
|
+
CliInstallDomain: {
|
|
61685
|
+
/** @description The host a CNAME for `domain` points at when Runtype serves the domain */
|
|
61686
|
+
cnameTarget: string;
|
|
61687
|
+
/** @description The custom install domain the surface asks for, e.g. `get.acme.com` */
|
|
61688
|
+
domain: string;
|
|
61689
|
+
/** @description Each file the domain serves at its root, as the Runtype install host serves it; copy them to serve the domain yourself */
|
|
61690
|
+
files: {
|
|
61691
|
+
"SKILL.md": string;
|
|
61692
|
+
"cli.json": string;
|
|
61693
|
+
"install.ps1": string;
|
|
61694
|
+
"install.sh": string;
|
|
61996
61695
|
};
|
|
61997
|
-
graduatedAt: string;
|
|
61998
61696
|
/**
|
|
61999
|
-
* @description `
|
|
61697
|
+
* @description `verified`: the TXT record proved control of the domain, and the published files point at it. `pending`: the CLI installs from the Runtype install host until the TXT record is found on a later publish.
|
|
62000
61698
|
* @enum {string}
|
|
62001
61699
|
*/
|
|
62002
|
-
|
|
62003
|
-
|
|
62004
|
-
|
|
62005
|
-
|
|
61700
|
+
state: "pending" | "verified";
|
|
61701
|
+
/** @description The TXT record that verifies the domain; null until a publish has issued the token */
|
|
61702
|
+
verification: {
|
|
61703
|
+
/** @description The TXT record name, `_runtype-install.<domain>` */
|
|
61704
|
+
recordName: string;
|
|
61705
|
+
/** @description The TXT record value: this surface's verification token */
|
|
61706
|
+
recordValue: string;
|
|
61707
|
+
} | null;
|
|
61708
|
+
} | null;
|
|
62006
61709
|
CliPublishResult: {
|
|
62007
|
-
|
|
61710
|
+
install: components["schemas"]["CliInstallCommands"];
|
|
61711
|
+
installDomain: components["schemas"]["CliInstallDomain"];
|
|
62008
61712
|
/**
|
|
62009
|
-
* @description `unchanged`: the
|
|
61713
|
+
* @description `unchanged`: the files match the last publish, so the version stays; every file is still rewritten
|
|
62010
61714
|
* @enum {string}
|
|
62011
61715
|
*/
|
|
62012
|
-
outcome: "
|
|
62013
|
-
|
|
61716
|
+
outcome: "published" | "unchanged";
|
|
61717
|
+
publishedAt: string;
|
|
61718
|
+
slug: string;
|
|
62014
61719
|
version: string;
|
|
62015
61720
|
};
|
|
62016
61721
|
CliPublishStatus: {
|
|
62017
|
-
|
|
62018
|
-
|
|
62019
|
-
|
|
62020
|
-
|
|
62021
|
-
|
|
62022
|
-
|
|
62023
|
-
/** @description `@rtype/<binName>`, or null while the surface has no command name */
|
|
62024
|
-
packageName: string | null;
|
|
62025
|
-
/** @description The latest version npm serves */
|
|
62026
|
-
publishedVersion: string | null;
|
|
62027
|
-
registryUrl: string | null;
|
|
61722
|
+
install: components["schemas"]["CliInstallCommands"];
|
|
61723
|
+
installDomain: components["schemas"]["CliInstallDomain"];
|
|
61724
|
+
/** @description When the files last changed */
|
|
61725
|
+
publishedAt: string | null;
|
|
61726
|
+
/** @description The install slug, which is the surface's command name; null while it has none */
|
|
61727
|
+
slug: string | null;
|
|
62028
61728
|
/**
|
|
62029
|
-
* @description `
|
|
61729
|
+
* @description `published`: the install host serves this surface's files under its slug. `not_published`: nothing is published, the surface has no valid command name, or another surface holds the slug.
|
|
62030
61730
|
* @enum {string}
|
|
62031
61731
|
*/
|
|
62032
|
-
state: "not_published" | "
|
|
61732
|
+
state: "not_published" | "published";
|
|
61733
|
+
/** @description The version in the published `cli.json` */
|
|
61734
|
+
version: string | null;
|
|
62033
61735
|
};
|
|
62034
61736
|
ClientInputDeliveryReceipt: {
|
|
62035
61737
|
deliveryId: string;
|
|
@@ -64667,7 +64369,7 @@ interface components {
|
|
|
64667
64369
|
[key: string]: unknown;
|
|
64668
64370
|
};
|
|
64669
64371
|
/** @enum {string} */
|
|
64670
|
-
name: "runtype.execution.failed" | "runtype.approval.requested" | "runtype.schedule.run_failed" | "runtype.eval.run_completed" | "runtype.simulation.run_completed" | "runtype.conversation.human_takeover" | "runtype.skill.proposal_created" | "runtype.task.input_required" | "runtype.task.completed" | "runtype.task.failed" | "runtype.task.cancelled" | "runtype.signal.fired" | "runtype.signal.cluster_appeared";
|
|
64372
|
+
name: "runtype.execution.failed" | "runtype.approval.requested" | "runtype.schedule.run_failed" | "runtype.eval.run_completed" | "runtype.simulation.run_completed" | "runtype.conversation.human_takeover" | "runtype.skill.proposal_created" | "runtype.task.input_required" | "runtype.task.completed" | "runtype.task.failed" | "runtype.task.cancelled" | "runtype.signal.fired" | "runtype.signal.cluster_appeared" | "runtype.api_key_request.decided";
|
|
64671
64373
|
/** @description JSON Schema for the occurrence `data` */
|
|
64672
64374
|
payloadSchema: {
|
|
64673
64375
|
[key: string]: unknown;
|
|
@@ -64692,7 +64394,7 @@ interface components {
|
|
|
64692
64394
|
/** @description Occurrence id (typeid, `pev_` prefix) */
|
|
64693
64395
|
eventId: string;
|
|
64694
64396
|
/** @enum {string} */
|
|
64695
|
-
name: "runtype.execution.failed" | "runtype.approval.requested" | "runtype.schedule.run_failed" | "runtype.eval.run_completed" | "runtype.simulation.run_completed" | "runtype.conversation.human_takeover" | "runtype.skill.proposal_created" | "runtype.task.input_required" | "runtype.task.completed" | "runtype.task.failed" | "runtype.task.cancelled" | "runtype.signal.fired" | "runtype.signal.cluster_appeared";
|
|
64397
|
+
name: "runtype.execution.failed" | "runtype.approval.requested" | "runtype.schedule.run_failed" | "runtype.eval.run_completed" | "runtype.simulation.run_completed" | "runtype.conversation.human_takeover" | "runtype.skill.proposal_created" | "runtype.task.input_required" | "runtype.task.completed" | "runtype.task.failed" | "runtype.task.cancelled" | "runtype.signal.fired" | "runtype.signal.cluster_appeared" | "runtype.api_key_request.decided";
|
|
64696
64398
|
/** @description When it happened (ISO 8601) */
|
|
64697
64399
|
timestamp: string;
|
|
64698
64400
|
};
|
|
@@ -64721,6 +64423,10 @@ interface components {
|
|
|
64721
64423
|
ref: string;
|
|
64722
64424
|
/** @enum {string} */
|
|
64723
64425
|
result: "created" | "updated" | "unchanged" | "failed" | "skipped" | "pruned";
|
|
64426
|
+
/** @description Surface apply only: the signed-in sessions an identity provider or issuer change ended. */
|
|
64427
|
+
sessionsSignedOut?: number;
|
|
64428
|
+
/** @description Surface dryRun only: applying it changes the identity provider or issuer and signs out every session. */
|
|
64429
|
+
signsOutSessions?: boolean;
|
|
64724
64430
|
/** @description Non-blocking advisories, e.g. SCHEDULE_AGENT_CONFIG_UNSUPPORTED when converging an agent moved `live` onto a version its active schedules cannot run. */
|
|
64725
64431
|
warnings?: string[];
|
|
64726
64432
|
}[];
|
|
@@ -66081,6 +65787,8 @@ interface components {
|
|
|
66081
65787
|
contentHash: string;
|
|
66082
65788
|
/** @enum {string} */
|
|
66083
65789
|
result: "unchanged" | "created" | "updated";
|
|
65790
|
+
/** @description Present when the update changed the identity provider or issuer: the number of signed-in sessions it ended. */
|
|
65791
|
+
sessionsSignedOut?: number;
|
|
66084
65792
|
surfaceId: string;
|
|
66085
65793
|
} | {
|
|
66086
65794
|
/** @enum {string} */
|
|
@@ -66093,6 +65801,8 @@ interface components {
|
|
|
66093
65801
|
remoteHash?: string;
|
|
66094
65802
|
/** @enum {string} */
|
|
66095
65803
|
result: "plan";
|
|
65804
|
+
/** @description True when applying this plan changes the identity provider or issuer and signs out every session. */
|
|
65805
|
+
signsOutSessions?: boolean;
|
|
66096
65806
|
surfaceId?: string;
|
|
66097
65807
|
};
|
|
66098
65808
|
SurfacePullResponse: {
|
|
@@ -70118,6 +69828,16 @@ export interface ScheduleRunNowResponse {
|
|
|
70118
69828
|
* Generated from the OpenAPI spec — GET /v1/schedules/{id}/runs list item.
|
|
70119
69829
|
*/
|
|
70120
69830
|
export type ScheduleRun = paths['/v1/schedules/{id}/runs']['get']['responses'][200]['content']['application/json']['data'][number];
|
|
69831
|
+
/**
|
|
69832
|
+
* One response from a schedule's run history: the runs, whether older runs remain, and the cursor to read them.
|
|
69833
|
+
* Generated from the OpenAPI spec — GET /v1/schedules/{id}/runs.
|
|
69834
|
+
*/
|
|
69835
|
+
export type ScheduleRunsPage = paths['/v1/schedules/{id}/runs']['get']['responses'][200]['content']['application/json'];
|
|
69836
|
+
/** Paging for a schedule's run history. Omit both to read every run; `limit` is at most 500. */
|
|
69837
|
+
export interface ScheduleRunsListParams {
|
|
69838
|
+
limit?: number;
|
|
69839
|
+
cursor?: string;
|
|
69840
|
+
}
|
|
70121
69841
|
export interface ScheduleListParams extends ListParams {
|
|
70122
69842
|
search?: string;
|
|
70123
69843
|
status?: 'active' | 'paused';
|
|
@@ -71791,7 +71511,8 @@ export declare class RecordsEndpoint {
|
|
|
71791
71511
|
notFoundIds?: string[];
|
|
71792
71512
|
}>;
|
|
71793
71513
|
/**
|
|
71794
|
-
* Bulk edit multiple records
|
|
71514
|
+
* Bulk edit multiple records. At most 5,000 targets per call, dry runs included; a larger set
|
|
71515
|
+
* returns 400 `bulk_edit_too_many_records`, so narrow the filter and edit in batches.
|
|
71795
71516
|
*/
|
|
71796
71517
|
bulkEdit(data: BulkEditRequest): Promise<BulkEditResponse>;
|
|
71797
71518
|
/**
|
|
@@ -74372,11 +74093,10 @@ export declare class SchedulesEndpoint {
|
|
|
74372
74093
|
*/
|
|
74373
74094
|
resume(id: string): Promise<ScheduleStatusResponse>;
|
|
74374
74095
|
/**
|
|
74375
|
-
* List the run history for a specific schedule.
|
|
74096
|
+
* List the run history for a specific schedule, newest first. Without `params` it returns every run.
|
|
74097
|
+
* Pass `limit` (at most 500) to page, then pass `nextCursor` as `cursor` while `hasMore` is true.
|
|
74376
74098
|
*/
|
|
74377
|
-
listRuns(id: string): Promise<
|
|
74378
|
-
data: ScheduleRun[];
|
|
74379
|
-
}>;
|
|
74099
|
+
listRuns(id: string, params?: ScheduleRunsListParams): Promise<ScheduleRunsPage>;
|
|
74380
74100
|
/**
|
|
74381
74101
|
* Get statistics (success rate, average duration/cost, 7-day history) for a schedule.
|
|
74382
74102
|
*/
|
|
@@ -78992,6 +78712,8 @@ interface EnsureSurfaceConverged {
|
|
|
78992
78712
|
surfaceId: string;
|
|
78993
78713
|
/** The server-computed canonical hash (echo this — never your own). */
|
|
78994
78714
|
contentHash: string;
|
|
78715
|
+
/** Present when the update changed the identity provider or issuer: the signed-in sessions it ended. */
|
|
78716
|
+
sessionsSignedOut?: number;
|
|
78995
78717
|
}
|
|
78996
78718
|
interface EnsureSurfacePlan {
|
|
78997
78719
|
result: 'plan';
|
|
@@ -79000,6 +78722,8 @@ interface EnsureSurfacePlan {
|
|
|
79000
78722
|
contentHash: string;
|
|
79001
78723
|
remoteHash?: string;
|
|
79002
78724
|
surfaceId?: string;
|
|
78725
|
+
/** True when applying this plan changes the identity provider or issuer and signs out every session. */
|
|
78726
|
+
signsOutSessions?: boolean;
|
|
79003
78727
|
}
|
|
79004
78728
|
type EnsureSurfaceResult = EnsureSurfaceConverged | EnsureSurfacePlan;
|
|
79005
78729
|
interface SurfacePullResult {
|
|
@@ -80345,8 +80069,13 @@ export declare class SimulationsEndpoint {
|
|
|
80345
80069
|
}>;
|
|
80346
80070
|
/** Answer one recorded exchange as published and as the variant's design answers it. */
|
|
80347
80071
|
previewVariant(simulationId: string, variantId: string, data: PreviewSimulationVariantRequest): Promise<PreviewSimulationVariantResponse>;
|
|
80348
|
-
/**
|
|
80349
|
-
|
|
80072
|
+
/**
|
|
80073
|
+
* Discard a run variant's frozen synthesized answers so its next run synthesizes again; `tools` limits it to those
|
|
80074
|
+
* server tools' answers.
|
|
80075
|
+
*/
|
|
80076
|
+
resynthesizeVariant(runId: string, variantId: string, options?: {
|
|
80077
|
+
tools?: string[];
|
|
80078
|
+
}): Promise<{
|
|
80350
80079
|
discarded: number;
|
|
80351
80080
|
}>;
|
|
80352
80081
|
/** Mark a synthesized answer plausible or implausible; `null` clears the review. */
|