@runtypelabs/sdk 11.15.1 → 11.18.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 +6 -4
- package/dist/index.d.cts +1186 -94
- package/dist/index.d.ts +1186 -94
- package/dist/index.mjs +6 -4
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -370,6 +370,110 @@ interface paths {
|
|
|
370
370
|
patch?: never;
|
|
371
371
|
trace?: never;
|
|
372
372
|
};
|
|
373
|
+
"/v1/agent-versions/{agentId}/propose": {
|
|
374
|
+
parameters: {
|
|
375
|
+
query?: never;
|
|
376
|
+
header?: never;
|
|
377
|
+
path?: never;
|
|
378
|
+
cookie?: never;
|
|
379
|
+
};
|
|
380
|
+
get?: never;
|
|
381
|
+
put?: never;
|
|
382
|
+
/**
|
|
383
|
+
* Propose a new agent version
|
|
384
|
+
* @description Append a version carrying new instructions and aim a preview alias at it. The agent row, its draft pointer, the published version and the `live` alias do not move, so no run reaches it unless it names the alias. Repeating the same instructions changes nothing.
|
|
385
|
+
*/
|
|
386
|
+
post: {
|
|
387
|
+
parameters: {
|
|
388
|
+
query?: never;
|
|
389
|
+
header?: never;
|
|
390
|
+
path: {
|
|
391
|
+
agentId: string;
|
|
392
|
+
};
|
|
393
|
+
cookie?: never;
|
|
394
|
+
};
|
|
395
|
+
requestBody: {
|
|
396
|
+
content: {
|
|
397
|
+
"application/json": {
|
|
398
|
+
/** @description The preview alias to aim at it. Defaults to `otto-proposed-` plus the label as a slug, or a hash of the instructions when there is no label. */
|
|
399
|
+
alias?: string;
|
|
400
|
+
label?: string;
|
|
401
|
+
/** @description Why this version exists: the evidence for it, shown in version history. */
|
|
402
|
+
notes?: string;
|
|
403
|
+
/** @description The full instructions this version proposes. */
|
|
404
|
+
systemPrompt: string;
|
|
405
|
+
};
|
|
406
|
+
};
|
|
407
|
+
};
|
|
408
|
+
responses: {
|
|
409
|
+
/** @description The proposed version */
|
|
410
|
+
200: {
|
|
411
|
+
headers: {
|
|
412
|
+
[name: string]: unknown;
|
|
413
|
+
};
|
|
414
|
+
content: {
|
|
415
|
+
"application/json": {
|
|
416
|
+
agentId: string;
|
|
417
|
+
alias: string;
|
|
418
|
+
/** @description False when this alias already pointed at these instructions. */
|
|
419
|
+
changed: boolean;
|
|
420
|
+
versionId: string;
|
|
421
|
+
};
|
|
422
|
+
};
|
|
423
|
+
};
|
|
424
|
+
/** @description Invalid input, or the agent type cannot be proposed against */
|
|
425
|
+
400: {
|
|
426
|
+
headers: {
|
|
427
|
+
[name: string]: unknown;
|
|
428
|
+
};
|
|
429
|
+
content: {
|
|
430
|
+
"application/json": components["schemas"]["Error"];
|
|
431
|
+
};
|
|
432
|
+
};
|
|
433
|
+
/** @description Unauthorized */
|
|
434
|
+
401: {
|
|
435
|
+
headers: {
|
|
436
|
+
[name: string]: unknown;
|
|
437
|
+
};
|
|
438
|
+
content: {
|
|
439
|
+
"application/json": components["schemas"]["Error"];
|
|
440
|
+
};
|
|
441
|
+
};
|
|
442
|
+
/** @description Insufficient permissions */
|
|
443
|
+
403: {
|
|
444
|
+
headers: {
|
|
445
|
+
[name: string]: unknown;
|
|
446
|
+
};
|
|
447
|
+
content: {
|
|
448
|
+
"application/json": components["schemas"]["Error"];
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
/** @description Agent not found */
|
|
452
|
+
404: {
|
|
453
|
+
headers: {
|
|
454
|
+
[name: string]: unknown;
|
|
455
|
+
};
|
|
456
|
+
content: {
|
|
457
|
+
"application/json": components["schemas"]["Error"];
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
/** @description Internal server error */
|
|
461
|
+
500: {
|
|
462
|
+
headers: {
|
|
463
|
+
[name: string]: unknown;
|
|
464
|
+
};
|
|
465
|
+
content: {
|
|
466
|
+
"application/json": components["schemas"]["InternalError"];
|
|
467
|
+
};
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
delete?: never;
|
|
472
|
+
options?: never;
|
|
473
|
+
head?: never;
|
|
474
|
+
patch?: never;
|
|
475
|
+
trace?: never;
|
|
476
|
+
};
|
|
373
477
|
"/v1/agent-versions/{agentId}/publish": {
|
|
374
478
|
parameters: {
|
|
375
479
|
query?: never;
|
|
@@ -2311,7 +2415,7 @@ interface paths {
|
|
|
2311
2415
|
};
|
|
2312
2416
|
/**
|
|
2313
2417
|
* Update agent
|
|
2314
|
-
* @description Update an existing agent. Supports partial updates — only provided fields are changed. Both config and externalConfig are merged onto the stored values, so a partial write preserves keys it omits (notably externalConfig.protocol and externalConfig.cachedAgentCard). To REMOVE a value, send it explicitly as null: a null field clears that field, and externalConfig: null clears the whole object. Nested values replace atomically — sending auth replaces the entire auth block, so switching auth type cannot reuse the previous credential. Agent management responses return a configured auth.credentials value as <redacted>; echoing that placeholder on an update preserves the stored credential only when auth.type is unchanged. Repointing an A2A external agent (endpoint, agentCardUrl, protocol, transport or deviceId) re-fetches and caches the agent card from its new location, as create does, and rejects the update with 400 or 502 when no card can be fetched; an explicitly sent cachedAgentCard is kept as sent, and switching to the runtype-stream protocol discards the card. Moving externalConfig.endpoint to a different host additionally requires re-sending externalConfig.auth: a stored credential is never carried to a host it was not configured against, so a repoint that omits auth is rejected with 400.
|
|
2418
|
+
* @description Update an existing agent. Supports partial updates — only provided fields are changed. Both config and externalConfig are merged onto the stored values, so a partial write preserves keys it omits (notably externalConfig.protocol and externalConfig.cachedAgentCard). To REMOVE a value, send it explicitly as null: a null field clears that field, and externalConfig: null clears the whole object. Nested values replace atomically — sending auth replaces the entire auth block, so switching auth type cannot reuse the previous credential. Agent management responses return a configured auth.credentials value as <redacted>; echoing that placeholder on an update preserves the stored credential only when auth.type is unchanged. Repointing an A2A external agent (endpoint, agentCardUrl, protocol, transport or deviceId) re-fetches and caches the agent card from its new location, as create does, and rejects the update with 400 or 502 when no card can be fetched; an explicitly sent cachedAgentCard is kept as sent, and switching to the runtype-stream protocol discards the card. Moving externalConfig.endpoint to a different host additionally requires re-sending externalConfig.auth: a stored credential is never carried to a host it was not configured against, so a repoint that omits auth is rejected with 400. When auth.credentials is a {{secret:NAME}} reference, re-sending that same reference with the new endpoint repoints the agent without the caller ever handling the token; the 400 names the stored reference so a client that only sees <redacted> can re-send it.
|
|
2315
2419
|
*/
|
|
2316
2420
|
put: {
|
|
2317
2421
|
parameters: {
|
|
@@ -14154,7 +14258,13 @@ interface paths {
|
|
|
14154
14258
|
content: {
|
|
14155
14259
|
"application/json": {
|
|
14156
14260
|
data: {
|
|
14261
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
14262
|
+
allowDestructive?: boolean;
|
|
14263
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
14264
|
+
allowSimulationRun?: boolean;
|
|
14157
14265
|
apiKeyId: string | null;
|
|
14266
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
14267
|
+
attachmentCount?: number;
|
|
14158
14268
|
clientName: string | null;
|
|
14159
14269
|
clientVersion: string | null;
|
|
14160
14270
|
completedAt: string | null;
|
|
@@ -14278,6 +14388,16 @@ interface paths {
|
|
|
14278
14388
|
content: {
|
|
14279
14389
|
"application/json": {
|
|
14280
14390
|
allowDestructive?: boolean;
|
|
14391
|
+
/** @description Permit starting simulation runs, each with a stated `maxSpendUsd` of at most $25, and no other gated operation. `allowDestructive` also permits them. */
|
|
14392
|
+
allowSimulationRun?: boolean;
|
|
14393
|
+
/** @description One image for the worker to read on its first turn. `otto` tasks only. */
|
|
14394
|
+
attachments?: {
|
|
14395
|
+
/** @description The image as a data URL, up to 2 MB of text. */
|
|
14396
|
+
image: string;
|
|
14397
|
+
mimeType?: string;
|
|
14398
|
+
/** @enum {string} */
|
|
14399
|
+
type: "image";
|
|
14400
|
+
}[];
|
|
14281
14401
|
clientName?: string;
|
|
14282
14402
|
clientVersion?: string;
|
|
14283
14403
|
context?: unknown;
|
|
@@ -14305,7 +14425,13 @@ interface paths {
|
|
|
14305
14425
|
};
|
|
14306
14426
|
content: {
|
|
14307
14427
|
"application/json": {
|
|
14428
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
14429
|
+
allowDestructive?: boolean;
|
|
14430
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
14431
|
+
allowSimulationRun?: boolean;
|
|
14308
14432
|
apiKeyId: string | null;
|
|
14433
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
14434
|
+
attachmentCount?: number;
|
|
14309
14435
|
clientName: string | null;
|
|
14310
14436
|
clientVersion: string | null;
|
|
14311
14437
|
completedAt: string | null;
|
|
@@ -14373,7 +14499,13 @@ interface paths {
|
|
|
14373
14499
|
};
|
|
14374
14500
|
content: {
|
|
14375
14501
|
"application/json": {
|
|
14502
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
14503
|
+
allowDestructive?: boolean;
|
|
14504
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
14505
|
+
allowSimulationRun?: boolean;
|
|
14376
14506
|
apiKeyId: string | null;
|
|
14507
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
14508
|
+
attachmentCount?: number;
|
|
14377
14509
|
clientName: string | null;
|
|
14378
14510
|
clientVersion: string | null;
|
|
14379
14511
|
completedAt: string | null;
|
|
@@ -14628,7 +14760,13 @@ interface paths {
|
|
|
14628
14760
|
type: "task_cancelled";
|
|
14629
14761
|
})[];
|
|
14630
14762
|
task: {
|
|
14763
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
14764
|
+
allowDestructive?: boolean;
|
|
14765
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
14766
|
+
allowSimulationRun?: boolean;
|
|
14631
14767
|
apiKeyId: string | null;
|
|
14768
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
14769
|
+
attachmentCount?: number;
|
|
14632
14770
|
clientName: string | null;
|
|
14633
14771
|
clientVersion: string | null;
|
|
14634
14772
|
completedAt: string | null;
|
|
@@ -14734,6 +14872,91 @@ interface paths {
|
|
|
14734
14872
|
patch?: never;
|
|
14735
14873
|
trace?: never;
|
|
14736
14874
|
};
|
|
14875
|
+
"/v1/delegate-tasks/{id}/attachments/{index}": {
|
|
14876
|
+
parameters: {
|
|
14877
|
+
query?: never;
|
|
14878
|
+
header?: never;
|
|
14879
|
+
path?: never;
|
|
14880
|
+
cookie?: never;
|
|
14881
|
+
};
|
|
14882
|
+
/**
|
|
14883
|
+
* Read an image a delegate task started with
|
|
14884
|
+
* @description The image at this position of the task's `attachments`. API keys need `DELEGATE_TASKS:READ`.
|
|
14885
|
+
*/
|
|
14886
|
+
get: {
|
|
14887
|
+
parameters: {
|
|
14888
|
+
query?: never;
|
|
14889
|
+
header?: never;
|
|
14890
|
+
path: {
|
|
14891
|
+
/** @description The task id (`dlg_…`). */
|
|
14892
|
+
id: string;
|
|
14893
|
+
index: number | null;
|
|
14894
|
+
};
|
|
14895
|
+
cookie?: never;
|
|
14896
|
+
};
|
|
14897
|
+
requestBody?: never;
|
|
14898
|
+
responses: {
|
|
14899
|
+
/** @description The image */
|
|
14900
|
+
200: {
|
|
14901
|
+
headers: {
|
|
14902
|
+
[name: string]: unknown;
|
|
14903
|
+
};
|
|
14904
|
+
content: {
|
|
14905
|
+
"application/json": {
|
|
14906
|
+
/** @description The image as a data URL, up to 2 MB of text. */
|
|
14907
|
+
image: string;
|
|
14908
|
+
mimeType?: string;
|
|
14909
|
+
/** @enum {string} */
|
|
14910
|
+
type: "image";
|
|
14911
|
+
};
|
|
14912
|
+
};
|
|
14913
|
+
};
|
|
14914
|
+
/** @description Unauthorized */
|
|
14915
|
+
401: {
|
|
14916
|
+
headers: {
|
|
14917
|
+
[name: string]: unknown;
|
|
14918
|
+
};
|
|
14919
|
+
content: {
|
|
14920
|
+
"application/json": components["schemas"]["Error"];
|
|
14921
|
+
};
|
|
14922
|
+
};
|
|
14923
|
+
/** @description Missing API key scope */
|
|
14924
|
+
403: {
|
|
14925
|
+
headers: {
|
|
14926
|
+
[name: string]: unknown;
|
|
14927
|
+
};
|
|
14928
|
+
content: {
|
|
14929
|
+
"application/json": components["schemas"]["Error"];
|
|
14930
|
+
};
|
|
14931
|
+
};
|
|
14932
|
+
/** @description Feature disabled, or no such task in this organization */
|
|
14933
|
+
404: {
|
|
14934
|
+
headers: {
|
|
14935
|
+
[name: string]: unknown;
|
|
14936
|
+
};
|
|
14937
|
+
content: {
|
|
14938
|
+
"application/json": components["schemas"]["Error"];
|
|
14939
|
+
};
|
|
14940
|
+
};
|
|
14941
|
+
/** @description The operator agent is not available on this deployment */
|
|
14942
|
+
503: {
|
|
14943
|
+
headers: {
|
|
14944
|
+
[name: string]: unknown;
|
|
14945
|
+
};
|
|
14946
|
+
content: {
|
|
14947
|
+
"application/json": components["schemas"]["Error"];
|
|
14948
|
+
};
|
|
14949
|
+
};
|
|
14950
|
+
};
|
|
14951
|
+
};
|
|
14952
|
+
put?: never;
|
|
14953
|
+
post?: never;
|
|
14954
|
+
delete?: never;
|
|
14955
|
+
options?: never;
|
|
14956
|
+
head?: never;
|
|
14957
|
+
patch?: never;
|
|
14958
|
+
trace?: never;
|
|
14959
|
+
};
|
|
14737
14960
|
"/v1/delegate-tasks/{id}/cancel": {
|
|
14738
14961
|
parameters: {
|
|
14739
14962
|
query?: never;
|
|
@@ -14769,7 +14992,13 @@ interface paths {
|
|
|
14769
14992
|
/** @enum {boolean} */
|
|
14770
14993
|
accepted: true;
|
|
14771
14994
|
task: {
|
|
14995
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
14996
|
+
allowDestructive?: boolean;
|
|
14997
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
14998
|
+
allowSimulationRun?: boolean;
|
|
14772
14999
|
apiKeyId: string | null;
|
|
15000
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
15001
|
+
attachmentCount?: number;
|
|
14773
15002
|
clientName: string | null;
|
|
14774
15003
|
clientVersion: string | null;
|
|
14775
15004
|
completedAt: string | null;
|
|
@@ -15016,7 +15245,13 @@ interface paths {
|
|
|
15016
15245
|
/** @description Journal seq of the `message_received` event this message became. */
|
|
15017
15246
|
messageSeq?: number;
|
|
15018
15247
|
task: {
|
|
15248
|
+
/** @description Whether the caller allowed destructive and consequential operations. */
|
|
15249
|
+
allowDestructive?: boolean;
|
|
15250
|
+
/** @description Whether the caller allowed starting simulation runs, and no other gated operation. */
|
|
15251
|
+
allowSimulationRun?: boolean;
|
|
15019
15252
|
apiKeyId: string | null;
|
|
15253
|
+
/** @description Images the task started with; read each from its attachment route. */
|
|
15254
|
+
attachmentCount?: number;
|
|
15020
15255
|
clientName: string | null;
|
|
15021
15256
|
clientVersion: string | null;
|
|
15022
15257
|
completedAt: string | null;
|
|
@@ -32643,6 +32878,8 @@ interface paths {
|
|
|
32643
32878
|
supportsCustomKey?: boolean;
|
|
32644
32879
|
supportsSearch?: boolean;
|
|
32645
32880
|
supportsStreaming?: boolean;
|
|
32881
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
32882
|
+
supportsToolUse?: boolean;
|
|
32646
32883
|
updatedAt: string;
|
|
32647
32884
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
32648
32885
|
userId: string | null;
|
|
@@ -32817,6 +33054,8 @@ interface paths {
|
|
|
32817
33054
|
supportsCustomKey?: boolean;
|
|
32818
33055
|
supportsSearch?: boolean;
|
|
32819
33056
|
supportsStreaming?: boolean;
|
|
33057
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
33058
|
+
supportsToolUse?: boolean;
|
|
32820
33059
|
updatedAt: string;
|
|
32821
33060
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
32822
33061
|
userId: string | null;
|
|
@@ -32917,6 +33156,8 @@ interface paths {
|
|
|
32917
33156
|
query?: {
|
|
32918
33157
|
showAll?: string;
|
|
32919
33158
|
category?: string;
|
|
33159
|
+
/** @description Free-text search over model name, id, creator, provider and tags. Every word must match (prefixes count); results are ordered by relevance. */
|
|
33160
|
+
q?: string;
|
|
32920
33161
|
};
|
|
32921
33162
|
header?: never;
|
|
32922
33163
|
path?: never;
|
|
@@ -33019,7 +33260,7 @@ interface paths {
|
|
|
33019
33260
|
};
|
|
33020
33261
|
/**
|
|
33021
33262
|
* Get grouped models
|
|
33022
|
-
* @description Get models grouped by base model with all provider options. Supports filtering to configured-only models. The account custom models (`isCustom: true`) always follow the catalog groups; `category=custom` returns only them. `credentialPolicy` states which providers may serve a call.
|
|
33263
|
+
* @description Get models grouped by base model with all provider options. Supports filtering to configured-only models and free-text search (`q`). The account custom models (`isCustom: true`) always follow the catalog groups; `category=custom` returns only them. `credentialPolicy` states which providers may serve a call.
|
|
33023
33264
|
*/
|
|
33024
33265
|
get: {
|
|
33025
33266
|
parameters: {
|
|
@@ -33027,6 +33268,8 @@ interface paths {
|
|
|
33027
33268
|
showAll?: string;
|
|
33028
33269
|
category?: string;
|
|
33029
33270
|
configured?: string;
|
|
33271
|
+
/** @description Free-text search over model name, id, creator, provider and tags. Every word must match (prefixes count); results are ordered by relevance. */
|
|
33272
|
+
q?: string;
|
|
33030
33273
|
};
|
|
33031
33274
|
header?: never;
|
|
33032
33275
|
path?: never;
|
|
@@ -33517,6 +33760,8 @@ interface paths {
|
|
|
33517
33760
|
supportsCustomKey?: boolean;
|
|
33518
33761
|
supportsSearch?: boolean;
|
|
33519
33762
|
supportsStreaming?: boolean;
|
|
33763
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
33764
|
+
supportsToolUse?: boolean;
|
|
33520
33765
|
updatedAt: string;
|
|
33521
33766
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
33522
33767
|
userId: string | null;
|
|
@@ -33796,6 +34041,8 @@ interface paths {
|
|
|
33796
34041
|
supportsCustomKey?: boolean;
|
|
33797
34042
|
supportsSearch?: boolean;
|
|
33798
34043
|
supportsStreaming?: boolean;
|
|
34044
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
34045
|
+
supportsToolUse?: boolean;
|
|
33799
34046
|
updatedAt: string;
|
|
33800
34047
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
33801
34048
|
userId: string | null;
|
|
@@ -34248,6 +34495,7 @@ interface paths {
|
|
|
34248
34495
|
limit?: string;
|
|
34249
34496
|
cursor?: string;
|
|
34250
34497
|
search?: string;
|
|
34498
|
+
sort?: "activity" | "name";
|
|
34251
34499
|
/** @description Response representation. `full` (default) preserves complete values; `compact` shortens every string value longer than 100 characters to a 100-character preview followed by `…`. */
|
|
34252
34500
|
view?: "full" | "compact";
|
|
34253
34501
|
};
|
|
@@ -34625,7 +34873,7 @@ interface paths {
|
|
|
34625
34873
|
"application/json": components["schemas"]["Error"];
|
|
34626
34874
|
};
|
|
34627
34875
|
};
|
|
34628
|
-
/** @description Insufficient permissions for the entities this FPO materializes */
|
|
34876
|
+
/** @description Insufficient permissions for the entities this FPO materializes, or a `cli` surface while CLI surfaces are not enabled for the account (`CLI_SURFACE_DISABLED`) */
|
|
34629
34877
|
403: {
|
|
34630
34878
|
headers: {
|
|
34631
34879
|
[name: string]: unknown;
|
|
@@ -37169,7 +37417,7 @@ interface paths {
|
|
|
37169
37417
|
/** @enum {string} */
|
|
37170
37418
|
status?: "draft" | "active" | "paused";
|
|
37171
37419
|
/** @enum {string} */
|
|
37172
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37420
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37173
37421
|
};
|
|
37174
37422
|
};
|
|
37175
37423
|
};
|
|
@@ -37227,7 +37475,7 @@ interface paths {
|
|
|
37227
37475
|
"application/json": components["schemas"]["Error"];
|
|
37228
37476
|
};
|
|
37229
37477
|
};
|
|
37230
|
-
/** @description Insufficient permissions */
|
|
37478
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
|
|
37231
37479
|
403: {
|
|
37232
37480
|
headers: {
|
|
37233
37481
|
[name: string]: unknown;
|
|
@@ -37306,7 +37554,7 @@ interface paths {
|
|
|
37306
37554
|
/** @enum {string} */
|
|
37307
37555
|
status?: "draft" | "active" | "paused";
|
|
37308
37556
|
/** @enum {string} */
|
|
37309
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37557
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37310
37558
|
};
|
|
37311
37559
|
dryRun?: boolean;
|
|
37312
37560
|
expectedRemoteHash?: string;
|
|
@@ -37344,7 +37592,7 @@ interface paths {
|
|
|
37344
37592
|
"application/json": components["schemas"]["Error"];
|
|
37345
37593
|
};
|
|
37346
37594
|
};
|
|
37347
|
-
/** @description Insufficient permissions */
|
|
37595
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
|
|
37348
37596
|
403: {
|
|
37349
37597
|
headers: {
|
|
37350
37598
|
[name: string]: unknown;
|
|
@@ -39490,7 +39738,7 @@ interface paths {
|
|
|
39490
39738
|
patch?: never;
|
|
39491
39739
|
trace?: never;
|
|
39492
39740
|
};
|
|
39493
|
-
"/v1/products/{id}/surfaces/{surfaceId}/
|
|
39741
|
+
"/v1/products/{id}/surfaces/{surfaceId}/sessions": {
|
|
39494
39742
|
parameters: {
|
|
39495
39743
|
query?: never;
|
|
39496
39744
|
header?: never;
|
|
@@ -39498,12 +39746,17 @@ interface paths {
|
|
|
39498
39746
|
cookie?: never;
|
|
39499
39747
|
};
|
|
39500
39748
|
/**
|
|
39501
|
-
*
|
|
39502
|
-
* @description
|
|
39749
|
+
* List signed-in surface sessions
|
|
39750
|
+
* @description List the live end-user sessions on an MCP surface whose auth mode is `required` (hosted sign-in). Each session is one refresh-token family an MCP client holds for a signed-in user.
|
|
39503
39751
|
*/
|
|
39504
39752
|
get: {
|
|
39505
39753
|
parameters: {
|
|
39506
|
-
query?:
|
|
39754
|
+
query?: {
|
|
39755
|
+
/** @description Maximum sessions to return, 1 to 100. Defaults to 50. */
|
|
39756
|
+
limit?: string;
|
|
39757
|
+
/** @description The `nextCursor` from the previous page. */
|
|
39758
|
+
cursor?: string;
|
|
39759
|
+
};
|
|
39507
39760
|
header?: never;
|
|
39508
39761
|
path: {
|
|
39509
39762
|
id: string;
|
|
@@ -39513,93 +39766,20 @@ interface paths {
|
|
|
39513
39766
|
};
|
|
39514
39767
|
requestBody?: never;
|
|
39515
39768
|
responses: {
|
|
39516
|
-
/** @description
|
|
39769
|
+
/** @description Live sessions, newest first */
|
|
39517
39770
|
200: {
|
|
39518
39771
|
headers: {
|
|
39519
39772
|
[name: string]: unknown;
|
|
39520
39773
|
};
|
|
39521
39774
|
content: {
|
|
39522
39775
|
"application/json": {
|
|
39523
|
-
|
|
39524
|
-
|
|
39525
|
-
|
|
39526
|
-
state: "ready" | "needs_setup";
|
|
39527
|
-
steps: {
|
|
39528
|
-
alternatives?: ({
|
|
39529
|
-
args: {
|
|
39530
|
-
[key: string]: unknown;
|
|
39531
|
-
};
|
|
39532
|
-
pendingArgs?: {
|
|
39533
|
-
[key: string]: string;
|
|
39534
|
-
};
|
|
39535
|
-
/** @enum {string} */
|
|
39536
|
-
rung: "mcp_tool";
|
|
39537
|
-
summary: string;
|
|
39538
|
-
tool: string;
|
|
39539
|
-
} | {
|
|
39540
|
-
endpoint: string;
|
|
39541
|
-
/** @enum {string} */
|
|
39542
|
-
method: "PATCH" | "POST" | "PUT";
|
|
39543
|
-
/** @enum {string} */
|
|
39544
|
-
rung: "rest";
|
|
39545
|
-
summary: string;
|
|
39546
|
-
} | {
|
|
39547
|
-
reason: string;
|
|
39548
|
-
/** @enum {string} */
|
|
39549
|
-
rung: "browser";
|
|
39550
|
-
summary: string;
|
|
39551
|
-
url: string;
|
|
39552
|
-
} | {
|
|
39553
|
-
/** @enum {string} */
|
|
39554
|
-
rung: "satisfied";
|
|
39555
|
-
})[];
|
|
39556
|
-
docsUrl?: string;
|
|
39557
|
-
fulfillment: {
|
|
39558
|
-
args: {
|
|
39559
|
-
[key: string]: unknown;
|
|
39560
|
-
};
|
|
39561
|
-
pendingArgs?: {
|
|
39562
|
-
[key: string]: string;
|
|
39563
|
-
};
|
|
39564
|
-
/** @enum {string} */
|
|
39565
|
-
rung: "mcp_tool";
|
|
39566
|
-
summary: string;
|
|
39567
|
-
tool: string;
|
|
39568
|
-
} | {
|
|
39569
|
-
endpoint: string;
|
|
39570
|
-
/** @enum {string} */
|
|
39571
|
-
method: "PATCH" | "POST" | "PUT";
|
|
39572
|
-
/** @enum {string} */
|
|
39573
|
-
rung: "rest";
|
|
39574
|
-
summary: string;
|
|
39575
|
-
} | {
|
|
39576
|
-
reason: string;
|
|
39577
|
-
/** @enum {string} */
|
|
39578
|
-
rung: "browser";
|
|
39579
|
-
summary: string;
|
|
39580
|
-
url: string;
|
|
39581
|
-
} | {
|
|
39582
|
-
/** @enum {string} */
|
|
39583
|
-
rung: "satisfied";
|
|
39584
|
-
};
|
|
39585
|
-
helpText?: string;
|
|
39586
|
-
id: string;
|
|
39587
|
-
/** @enum {string} */
|
|
39588
|
-
kind: "secret" | "surface_install";
|
|
39589
|
-
required: boolean;
|
|
39590
|
-
secretKey?: string;
|
|
39591
|
-
/** @enum {string} */
|
|
39592
|
-
status: "satisfied" | "pending";
|
|
39593
|
-
surfaceId?: string;
|
|
39594
|
-
surfaceType?: string;
|
|
39595
|
-
title: string;
|
|
39596
|
-
}[];
|
|
39597
|
-
surfaceId: string;
|
|
39598
|
-
surfaceType: string;
|
|
39776
|
+
data: components["schemas"]["SurfaceSession"][];
|
|
39777
|
+
/** @description Pass as `cursor` to read the next page; null on the last page. */
|
|
39778
|
+
nextCursor: string | null;
|
|
39599
39779
|
};
|
|
39600
39780
|
};
|
|
39601
39781
|
};
|
|
39602
|
-
/** @description Invalid
|
|
39782
|
+
/** @description Invalid ID */
|
|
39603
39783
|
400: {
|
|
39604
39784
|
headers: {
|
|
39605
39785
|
[name: string]: unknown;
|
|
@@ -39617,7 +39797,261 @@ interface paths {
|
|
|
39617
39797
|
"application/json": components["schemas"]["Error"];
|
|
39618
39798
|
};
|
|
39619
39799
|
};
|
|
39620
|
-
/** @description
|
|
39800
|
+
/** @description Insufficient permissions */
|
|
39801
|
+
403: {
|
|
39802
|
+
headers: {
|
|
39803
|
+
[name: string]: unknown;
|
|
39804
|
+
};
|
|
39805
|
+
content: {
|
|
39806
|
+
"application/json": components["schemas"]["Error"];
|
|
39807
|
+
};
|
|
39808
|
+
};
|
|
39809
|
+
/** @description Product, surface or session not found */
|
|
39810
|
+
404: {
|
|
39811
|
+
headers: {
|
|
39812
|
+
[name: string]: unknown;
|
|
39813
|
+
};
|
|
39814
|
+
content: {
|
|
39815
|
+
"application/json": components["schemas"]["Error"];
|
|
39816
|
+
};
|
|
39817
|
+
};
|
|
39818
|
+
/** @description Internal server error */
|
|
39819
|
+
500: {
|
|
39820
|
+
headers: {
|
|
39821
|
+
[name: string]: unknown;
|
|
39822
|
+
};
|
|
39823
|
+
content: {
|
|
39824
|
+
"application/json": components["schemas"]["Error"];
|
|
39825
|
+
};
|
|
39826
|
+
};
|
|
39827
|
+
};
|
|
39828
|
+
};
|
|
39829
|
+
put?: never;
|
|
39830
|
+
post?: never;
|
|
39831
|
+
delete?: never;
|
|
39832
|
+
options?: never;
|
|
39833
|
+
head?: never;
|
|
39834
|
+
patch?: never;
|
|
39835
|
+
trace?: never;
|
|
39836
|
+
};
|
|
39837
|
+
"/v1/products/{id}/surfaces/{surfaceId}/sessions/{sessionId}": {
|
|
39838
|
+
parameters: {
|
|
39839
|
+
query?: never;
|
|
39840
|
+
header?: never;
|
|
39841
|
+
path?: never;
|
|
39842
|
+
cookie?: never;
|
|
39843
|
+
};
|
|
39844
|
+
get?: never;
|
|
39845
|
+
put?: never;
|
|
39846
|
+
post?: never;
|
|
39847
|
+
/**
|
|
39848
|
+
* Revoke a signed-in surface session
|
|
39849
|
+
* @description Revoke one end-user session on an MCP surface: its refresh tokens stop rotating and its access tokens are refused, within about a minute everywhere.
|
|
39850
|
+
*/
|
|
39851
|
+
delete: {
|
|
39852
|
+
parameters: {
|
|
39853
|
+
query?: never;
|
|
39854
|
+
header?: never;
|
|
39855
|
+
path: {
|
|
39856
|
+
id: string;
|
|
39857
|
+
surfaceId: string;
|
|
39858
|
+
sessionId: string;
|
|
39859
|
+
};
|
|
39860
|
+
cookie?: never;
|
|
39861
|
+
};
|
|
39862
|
+
requestBody?: never;
|
|
39863
|
+
responses: {
|
|
39864
|
+
/** @description Session revoked */
|
|
39865
|
+
200: {
|
|
39866
|
+
headers: {
|
|
39867
|
+
[name: string]: unknown;
|
|
39868
|
+
};
|
|
39869
|
+
content: {
|
|
39870
|
+
"application/json": {
|
|
39871
|
+
success: boolean;
|
|
39872
|
+
};
|
|
39873
|
+
};
|
|
39874
|
+
};
|
|
39875
|
+
/** @description Invalid ID */
|
|
39876
|
+
400: {
|
|
39877
|
+
headers: {
|
|
39878
|
+
[name: string]: unknown;
|
|
39879
|
+
};
|
|
39880
|
+
content: {
|
|
39881
|
+
"application/json": components["schemas"]["Error"];
|
|
39882
|
+
};
|
|
39883
|
+
};
|
|
39884
|
+
/** @description Unauthorized */
|
|
39885
|
+
401: {
|
|
39886
|
+
headers: {
|
|
39887
|
+
[name: string]: unknown;
|
|
39888
|
+
};
|
|
39889
|
+
content: {
|
|
39890
|
+
"application/json": components["schemas"]["Error"];
|
|
39891
|
+
};
|
|
39892
|
+
};
|
|
39893
|
+
/** @description Insufficient permissions */
|
|
39894
|
+
403: {
|
|
39895
|
+
headers: {
|
|
39896
|
+
[name: string]: unknown;
|
|
39897
|
+
};
|
|
39898
|
+
content: {
|
|
39899
|
+
"application/json": components["schemas"]["Error"];
|
|
39900
|
+
};
|
|
39901
|
+
};
|
|
39902
|
+
/** @description Product, surface or session not found */
|
|
39903
|
+
404: {
|
|
39904
|
+
headers: {
|
|
39905
|
+
[name: string]: unknown;
|
|
39906
|
+
};
|
|
39907
|
+
content: {
|
|
39908
|
+
"application/json": components["schemas"]["Error"];
|
|
39909
|
+
};
|
|
39910
|
+
};
|
|
39911
|
+
/** @description Internal server error */
|
|
39912
|
+
500: {
|
|
39913
|
+
headers: {
|
|
39914
|
+
[name: string]: unknown;
|
|
39915
|
+
};
|
|
39916
|
+
content: {
|
|
39917
|
+
"application/json": components["schemas"]["Error"];
|
|
39918
|
+
};
|
|
39919
|
+
};
|
|
39920
|
+
};
|
|
39921
|
+
};
|
|
39922
|
+
options?: never;
|
|
39923
|
+
head?: never;
|
|
39924
|
+
patch?: never;
|
|
39925
|
+
trace?: never;
|
|
39926
|
+
};
|
|
39927
|
+
"/v1/products/{id}/surfaces/{surfaceId}/setup": {
|
|
39928
|
+
parameters: {
|
|
39929
|
+
query?: never;
|
|
39930
|
+
header?: never;
|
|
39931
|
+
path?: never;
|
|
39932
|
+
cookie?: never;
|
|
39933
|
+
};
|
|
39934
|
+
/**
|
|
39935
|
+
* Get surface setup readiness
|
|
39936
|
+
* @description Get the headless-first next steps to make a single surface live. Secret steps are product-scoped and therefore only appear on the product-level setup endpoint.
|
|
39937
|
+
*/
|
|
39938
|
+
get: {
|
|
39939
|
+
parameters: {
|
|
39940
|
+
query?: never;
|
|
39941
|
+
header?: never;
|
|
39942
|
+
path: {
|
|
39943
|
+
id: string;
|
|
39944
|
+
surfaceId: string;
|
|
39945
|
+
};
|
|
39946
|
+
cookie?: never;
|
|
39947
|
+
};
|
|
39948
|
+
requestBody?: never;
|
|
39949
|
+
responses: {
|
|
39950
|
+
/** @description Surface setup readiness */
|
|
39951
|
+
200: {
|
|
39952
|
+
headers: {
|
|
39953
|
+
[name: string]: unknown;
|
|
39954
|
+
};
|
|
39955
|
+
content: {
|
|
39956
|
+
"application/json": {
|
|
39957
|
+
name: string;
|
|
39958
|
+
pendingCount: number;
|
|
39959
|
+
/** @enum {string} */
|
|
39960
|
+
state: "ready" | "needs_setup";
|
|
39961
|
+
steps: {
|
|
39962
|
+
alternatives?: ({
|
|
39963
|
+
args: {
|
|
39964
|
+
[key: string]: unknown;
|
|
39965
|
+
};
|
|
39966
|
+
pendingArgs?: {
|
|
39967
|
+
[key: string]: string;
|
|
39968
|
+
};
|
|
39969
|
+
/** @enum {string} */
|
|
39970
|
+
rung: "mcp_tool";
|
|
39971
|
+
summary: string;
|
|
39972
|
+
tool: string;
|
|
39973
|
+
} | {
|
|
39974
|
+
endpoint: string;
|
|
39975
|
+
/** @enum {string} */
|
|
39976
|
+
method: "PATCH" | "POST" | "PUT";
|
|
39977
|
+
/** @enum {string} */
|
|
39978
|
+
rung: "rest";
|
|
39979
|
+
summary: string;
|
|
39980
|
+
} | {
|
|
39981
|
+
reason: string;
|
|
39982
|
+
/** @enum {string} */
|
|
39983
|
+
rung: "browser";
|
|
39984
|
+
summary: string;
|
|
39985
|
+
url: string;
|
|
39986
|
+
} | {
|
|
39987
|
+
/** @enum {string} */
|
|
39988
|
+
rung: "satisfied";
|
|
39989
|
+
})[];
|
|
39990
|
+
docsUrl?: string;
|
|
39991
|
+
fulfillment: {
|
|
39992
|
+
args: {
|
|
39993
|
+
[key: string]: unknown;
|
|
39994
|
+
};
|
|
39995
|
+
pendingArgs?: {
|
|
39996
|
+
[key: string]: string;
|
|
39997
|
+
};
|
|
39998
|
+
/** @enum {string} */
|
|
39999
|
+
rung: "mcp_tool";
|
|
40000
|
+
summary: string;
|
|
40001
|
+
tool: string;
|
|
40002
|
+
} | {
|
|
40003
|
+
endpoint: string;
|
|
40004
|
+
/** @enum {string} */
|
|
40005
|
+
method: "PATCH" | "POST" | "PUT";
|
|
40006
|
+
/** @enum {string} */
|
|
40007
|
+
rung: "rest";
|
|
40008
|
+
summary: string;
|
|
40009
|
+
} | {
|
|
40010
|
+
reason: string;
|
|
40011
|
+
/** @enum {string} */
|
|
40012
|
+
rung: "browser";
|
|
40013
|
+
summary: string;
|
|
40014
|
+
url: string;
|
|
40015
|
+
} | {
|
|
40016
|
+
/** @enum {string} */
|
|
40017
|
+
rung: "satisfied";
|
|
40018
|
+
};
|
|
40019
|
+
helpText?: string;
|
|
40020
|
+
id: string;
|
|
40021
|
+
/** @enum {string} */
|
|
40022
|
+
kind: "secret" | "surface_install";
|
|
40023
|
+
required: boolean;
|
|
40024
|
+
secretKey?: string;
|
|
40025
|
+
/** @enum {string} */
|
|
40026
|
+
status: "satisfied" | "pending";
|
|
40027
|
+
surfaceId?: string;
|
|
40028
|
+
surfaceType?: string;
|
|
40029
|
+
title: string;
|
|
40030
|
+
}[];
|
|
40031
|
+
surfaceId: string;
|
|
40032
|
+
surfaceType: string;
|
|
40033
|
+
};
|
|
40034
|
+
};
|
|
40035
|
+
};
|
|
40036
|
+
/** @description Invalid product ID */
|
|
40037
|
+
400: {
|
|
40038
|
+
headers: {
|
|
40039
|
+
[name: string]: unknown;
|
|
40040
|
+
};
|
|
40041
|
+
content: {
|
|
40042
|
+
"application/json": components["schemas"]["Error"];
|
|
40043
|
+
};
|
|
40044
|
+
};
|
|
40045
|
+
/** @description Unauthorized */
|
|
40046
|
+
401: {
|
|
40047
|
+
headers: {
|
|
40048
|
+
[name: string]: unknown;
|
|
40049
|
+
};
|
|
40050
|
+
content: {
|
|
40051
|
+
"application/json": components["schemas"]["Error"];
|
|
40052
|
+
};
|
|
40053
|
+
};
|
|
40054
|
+
/** @description Product or surface not found */
|
|
39621
40055
|
404: {
|
|
39622
40056
|
headers: {
|
|
39623
40057
|
[name: string]: unknown;
|
|
@@ -40714,6 +41148,568 @@ interface paths {
|
|
|
40714
41148
|
patch?: never;
|
|
40715
41149
|
trace?: never;
|
|
40716
41150
|
};
|
|
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
|
+
"/v1/products/{productId}/surfaces/{surfaceId}/cli/publish": {
|
|
41466
|
+
parameters: {
|
|
41467
|
+
query?: never;
|
|
41468
|
+
header?: never;
|
|
41469
|
+
path?: never;
|
|
41470
|
+
cookie?: never;
|
|
41471
|
+
};
|
|
41472
|
+
/**
|
|
41473
|
+
* Get CLI publish status
|
|
41474
|
+
* @description Where a managed `cli` surface stands on npm, read live from the CLI registry repository and the npm registry. Nothing is stored.
|
|
41475
|
+
*/
|
|
41476
|
+
get: {
|
|
41477
|
+
parameters: {
|
|
41478
|
+
query?: never;
|
|
41479
|
+
header?: never;
|
|
41480
|
+
path: {
|
|
41481
|
+
productId: string;
|
|
41482
|
+
surfaceId: string;
|
|
41483
|
+
};
|
|
41484
|
+
cookie?: never;
|
|
41485
|
+
};
|
|
41486
|
+
requestBody?: never;
|
|
41487
|
+
responses: {
|
|
41488
|
+
/** @description Publish status */
|
|
41489
|
+
200: {
|
|
41490
|
+
headers: {
|
|
41491
|
+
[name: string]: unknown;
|
|
41492
|
+
};
|
|
41493
|
+
content: {
|
|
41494
|
+
"application/json": components["schemas"]["CliPublishStatus"];
|
|
41495
|
+
};
|
|
41496
|
+
};
|
|
41497
|
+
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41498
|
+
400: {
|
|
41499
|
+
headers: {
|
|
41500
|
+
[name: string]: unknown;
|
|
41501
|
+
};
|
|
41502
|
+
content: {
|
|
41503
|
+
"application/json": {
|
|
41504
|
+
code?: string;
|
|
41505
|
+
error: string;
|
|
41506
|
+
issues?: {
|
|
41507
|
+
code: string;
|
|
41508
|
+
message: string;
|
|
41509
|
+
/** @enum {string} */
|
|
41510
|
+
verdict: "review" | "reject";
|
|
41511
|
+
}[];
|
|
41512
|
+
};
|
|
41513
|
+
};
|
|
41514
|
+
};
|
|
41515
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account */
|
|
41516
|
+
403: {
|
|
41517
|
+
headers: {
|
|
41518
|
+
[name: string]: unknown;
|
|
41519
|
+
};
|
|
41520
|
+
content: {
|
|
41521
|
+
"application/json": {
|
|
41522
|
+
code?: string;
|
|
41523
|
+
error: string;
|
|
41524
|
+
issues?: {
|
|
41525
|
+
code: string;
|
|
41526
|
+
message: string;
|
|
41527
|
+
/** @enum {string} */
|
|
41528
|
+
verdict: "review" | "reject";
|
|
41529
|
+
}[];
|
|
41530
|
+
};
|
|
41531
|
+
};
|
|
41532
|
+
};
|
|
41533
|
+
/** @description Product or CLI surface not found */
|
|
41534
|
+
404: {
|
|
41535
|
+
headers: {
|
|
41536
|
+
[name: string]: unknown;
|
|
41537
|
+
};
|
|
41538
|
+
content: {
|
|
41539
|
+
"application/json": components["schemas"]["Error"];
|
|
41540
|
+
};
|
|
41541
|
+
};
|
|
41542
|
+
/** @description `CLI_REGISTRY_UNAVAILABLE`: GitHub or npm failed */
|
|
41543
|
+
502: {
|
|
41544
|
+
headers: {
|
|
41545
|
+
[name: string]: unknown;
|
|
41546
|
+
};
|
|
41547
|
+
content: {
|
|
41548
|
+
"application/json": {
|
|
41549
|
+
code?: string;
|
|
41550
|
+
error: string;
|
|
41551
|
+
issues?: {
|
|
41552
|
+
code: string;
|
|
41553
|
+
message: string;
|
|
41554
|
+
/** @enum {string} */
|
|
41555
|
+
verdict: "review" | "reject";
|
|
41556
|
+
}[];
|
|
41557
|
+
};
|
|
41558
|
+
};
|
|
41559
|
+
};
|
|
41560
|
+
/** @description `CLI_REGISTRY_NOT_CONFIGURED`: this deployment has no registry credential, or (outside production) no `CLI_REGISTRY_REPOSITORY` */
|
|
41561
|
+
503: {
|
|
41562
|
+
headers: {
|
|
41563
|
+
[name: string]: unknown;
|
|
41564
|
+
};
|
|
41565
|
+
content: {
|
|
41566
|
+
"application/json": {
|
|
41567
|
+
code?: string;
|
|
41568
|
+
error: string;
|
|
41569
|
+
issues?: {
|
|
41570
|
+
code: string;
|
|
41571
|
+
message: string;
|
|
41572
|
+
/** @enum {string} */
|
|
41573
|
+
verdict: "review" | "reject";
|
|
41574
|
+
}[];
|
|
41575
|
+
};
|
|
41576
|
+
};
|
|
41577
|
+
};
|
|
41578
|
+
};
|
|
41579
|
+
};
|
|
41580
|
+
put?: never;
|
|
41581
|
+
/**
|
|
41582
|
+
* Publish a CLI surface
|
|
41583
|
+
* @description Builds the surface's npm package and commits it to the CLI registry, where a commit is a publish. The first version is 1.0.0; a changed bundle bumps the patch version and an unchanged one commits nothing, unless its last publish run failed, which starts the publish workflow again. A first publish needs a name free on npm that needs no brand review.
|
|
41584
|
+
*/
|
|
41585
|
+
post: {
|
|
41586
|
+
parameters: {
|
|
41587
|
+
query?: never;
|
|
41588
|
+
header?: never;
|
|
41589
|
+
path: {
|
|
41590
|
+
productId: string;
|
|
41591
|
+
surfaceId: string;
|
|
41592
|
+
};
|
|
41593
|
+
cookie?: never;
|
|
41594
|
+
};
|
|
41595
|
+
requestBody?: never;
|
|
41596
|
+
responses: {
|
|
41597
|
+
/** @description Committed, unchanged, or retried */
|
|
41598
|
+
200: {
|
|
41599
|
+
headers: {
|
|
41600
|
+
[name: string]: unknown;
|
|
41601
|
+
};
|
|
41602
|
+
content: {
|
|
41603
|
+
"application/json": components["schemas"]["CliPublishResult"];
|
|
41604
|
+
};
|
|
41605
|
+
};
|
|
41606
|
+
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41607
|
+
400: {
|
|
41608
|
+
headers: {
|
|
41609
|
+
[name: string]: unknown;
|
|
41610
|
+
};
|
|
41611
|
+
content: {
|
|
41612
|
+
"application/json": {
|
|
41613
|
+
code?: string;
|
|
41614
|
+
error: string;
|
|
41615
|
+
issues?: {
|
|
41616
|
+
code: string;
|
|
41617
|
+
message: string;
|
|
41618
|
+
/** @enum {string} */
|
|
41619
|
+
verdict: "review" | "reject";
|
|
41620
|
+
}[];
|
|
41621
|
+
};
|
|
41622
|
+
};
|
|
41623
|
+
};
|
|
41624
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account */
|
|
41625
|
+
403: {
|
|
41626
|
+
headers: {
|
|
41627
|
+
[name: string]: unknown;
|
|
41628
|
+
};
|
|
41629
|
+
content: {
|
|
41630
|
+
"application/json": {
|
|
41631
|
+
code?: string;
|
|
41632
|
+
error: string;
|
|
41633
|
+
issues?: {
|
|
41634
|
+
code: string;
|
|
41635
|
+
message: string;
|
|
41636
|
+
/** @enum {string} */
|
|
41637
|
+
verdict: "review" | "reject";
|
|
41638
|
+
}[];
|
|
41639
|
+
};
|
|
41640
|
+
};
|
|
41641
|
+
};
|
|
41642
|
+
/** @description Product or CLI surface not found */
|
|
41643
|
+
404: {
|
|
41644
|
+
headers: {
|
|
41645
|
+
[name: string]: unknown;
|
|
41646
|
+
};
|
|
41647
|
+
content: {
|
|
41648
|
+
"application/json": components["schemas"]["Error"];
|
|
41649
|
+
};
|
|
41650
|
+
};
|
|
41651
|
+
/** @description The surface is inactive or graduated, names a package other than `@rtype/<binName>` (`CLI_PACKAGE_NAME_MISMATCH`), has no tools, its name is taken or needs review, its failed first publish waits for the approval (`CLI_FIRST_PUBLISH_AWAITING_APPROVAL`), or the registry kept moving */
|
|
41652
|
+
409: {
|
|
41653
|
+
headers: {
|
|
41654
|
+
[name: string]: unknown;
|
|
41655
|
+
};
|
|
41656
|
+
content: {
|
|
41657
|
+
"application/json": {
|
|
41658
|
+
code?: string;
|
|
41659
|
+
error: string;
|
|
41660
|
+
issues?: {
|
|
41661
|
+
code: string;
|
|
41662
|
+
message: string;
|
|
41663
|
+
/** @enum {string} */
|
|
41664
|
+
verdict: "review" | "reject";
|
|
41665
|
+
}[];
|
|
41666
|
+
};
|
|
41667
|
+
};
|
|
41668
|
+
};
|
|
41669
|
+
/** @description `CLI_REGISTRY_UNAVAILABLE`: GitHub or npm failed */
|
|
41670
|
+
502: {
|
|
41671
|
+
headers: {
|
|
41672
|
+
[name: string]: unknown;
|
|
41673
|
+
};
|
|
41674
|
+
content: {
|
|
41675
|
+
"application/json": {
|
|
41676
|
+
code?: string;
|
|
41677
|
+
error: string;
|
|
41678
|
+
issues?: {
|
|
41679
|
+
code: string;
|
|
41680
|
+
message: string;
|
|
41681
|
+
/** @enum {string} */
|
|
41682
|
+
verdict: "review" | "reject";
|
|
41683
|
+
}[];
|
|
41684
|
+
};
|
|
41685
|
+
};
|
|
41686
|
+
};
|
|
41687
|
+
/** @description `CLI_REGISTRY_NOT_CONFIGURED`: this deployment has no registry credential, or (outside production) no `CLI_REGISTRY_REPOSITORY` */
|
|
41688
|
+
503: {
|
|
41689
|
+
headers: {
|
|
41690
|
+
[name: string]: unknown;
|
|
41691
|
+
};
|
|
41692
|
+
content: {
|
|
41693
|
+
"application/json": {
|
|
41694
|
+
code?: string;
|
|
41695
|
+
error: string;
|
|
41696
|
+
issues?: {
|
|
41697
|
+
code: string;
|
|
41698
|
+
message: string;
|
|
41699
|
+
/** @enum {string} */
|
|
41700
|
+
verdict: "review" | "reject";
|
|
41701
|
+
}[];
|
|
41702
|
+
};
|
|
41703
|
+
};
|
|
41704
|
+
};
|
|
41705
|
+
};
|
|
41706
|
+
};
|
|
41707
|
+
delete?: never;
|
|
41708
|
+
options?: never;
|
|
41709
|
+
head?: never;
|
|
41710
|
+
patch?: never;
|
|
41711
|
+
trace?: never;
|
|
41712
|
+
};
|
|
40717
41713
|
"/v1/products/{productId}/surfaces/{surfaceId}/discovered-tools": {
|
|
40718
41714
|
parameters: {
|
|
40719
41715
|
query?: never;
|
|
@@ -40930,6 +41926,8 @@ interface paths {
|
|
|
40930
41926
|
authorization_servers: string[];
|
|
40931
41927
|
bearer_methods_supported: string[];
|
|
40932
41928
|
resource: string;
|
|
41929
|
+
resource_name?: string;
|
|
41930
|
+
scopes_supported?: string[];
|
|
40933
41931
|
};
|
|
40934
41932
|
};
|
|
40935
41933
|
};
|
|
@@ -59644,12 +60642,19 @@ interface paths {
|
|
|
59644
60642
|
enableAgentSkills: boolean;
|
|
59645
60643
|
enableCanvasOnboarding: boolean;
|
|
59646
60644
|
enableChromeSurface: boolean;
|
|
60645
|
+
enableCliSurface?: boolean;
|
|
60646
|
+
enableCliSurfaceGraduation?: boolean;
|
|
60647
|
+
enableCliSurfacePublish?: boolean;
|
|
59647
60648
|
enableDashboardAssistant: boolean;
|
|
59648
60649
|
enableDecisionModelsDashboard: boolean;
|
|
59649
60650
|
enableDelegateToOtto?: boolean;
|
|
59650
60651
|
enableDelegateToRuntype?: boolean;
|
|
59651
60652
|
enableEndUserUsageAnalytics: boolean;
|
|
59652
60653
|
enableMassiveWebRender: boolean;
|
|
60654
|
+
enableMcpSurfaceCustomerIdp?: boolean;
|
|
60655
|
+
enableMcpSurfaceDeviceGrant?: boolean;
|
|
60656
|
+
enableMcpSurfaceOobApprovals?: boolean;
|
|
60657
|
+
enableMcpSurfaceSignIn?: boolean;
|
|
59653
60658
|
enableOnboardingIntentGate: boolean;
|
|
59654
60659
|
enableRuntown: boolean;
|
|
59655
60660
|
enableRuntypeApps: boolean;
|
|
@@ -60959,6 +61964,73 @@ interface components {
|
|
|
60959
61964
|
/** @description ISO timestamp of the provider message. */
|
|
60960
61965
|
timestamp: string;
|
|
60961
61966
|
};
|
|
61967
|
+
CliGraduationGrant: {
|
|
61968
|
+
binName: string;
|
|
61969
|
+
/** @description Publish the version carrying the token before this */
|
|
61970
|
+
expiresAt: string;
|
|
61971
|
+
packageJson: {
|
|
61972
|
+
rtype: {
|
|
61973
|
+
graduationToken: string;
|
|
61974
|
+
surfaceId: string;
|
|
61975
|
+
};
|
|
61976
|
+
};
|
|
61977
|
+
packageName: string;
|
|
61978
|
+
surfaceId: string;
|
|
61979
|
+
token: string;
|
|
61980
|
+
};
|
|
61981
|
+
CliGraduationResult: {
|
|
61982
|
+
/** @description The `npm deprecate` a Runtype maintainer runs (it needs 2FA) */
|
|
61983
|
+
deprecation: {
|
|
61984
|
+
command: string;
|
|
61985
|
+
message: string;
|
|
61986
|
+
packageName: string;
|
|
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;
|
|
61996
|
+
};
|
|
61997
|
+
graduatedAt: string;
|
|
61998
|
+
/**
|
|
61999
|
+
* @description `retried`: already switched to this package, so only forwarding ran again
|
|
62000
|
+
* @enum {string}
|
|
62001
|
+
*/
|
|
62002
|
+
outcome: "graduated" | "retried";
|
|
62003
|
+
packageName: string;
|
|
62004
|
+
version: string;
|
|
62005
|
+
};
|
|
62006
|
+
CliPublishResult: {
|
|
62007
|
+
commitSha: string | null;
|
|
62008
|
+
/**
|
|
62009
|
+
* @description `unchanged`: the built package matches the committed one, so nothing was committed. `retried`: it matches, but the last publish run failed, so the publish workflow was started again
|
|
62010
|
+
* @enum {string}
|
|
62011
|
+
*/
|
|
62012
|
+
outcome: "committed" | "unchanged" | "retried";
|
|
62013
|
+
packageName: string;
|
|
62014
|
+
version: string;
|
|
62015
|
+
};
|
|
62016
|
+
CliPublishStatus: {
|
|
62017
|
+
/** @description The last registry commit to the directory */
|
|
62018
|
+
commitSha: string | null;
|
|
62019
|
+
committedVersion: string | null;
|
|
62020
|
+
/** @description The package directory in the CLI registry repository */
|
|
62021
|
+
directory: string | null;
|
|
62022
|
+
npmUrl: string | null;
|
|
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;
|
|
62028
|
+
/**
|
|
62029
|
+
* @description `not_published`: nothing committed, or the surface is graduated or names a package other than `@rtype/<binName>`. `staged`: committed, waiting for the daily first-publish approval. `publishing`: a new version is committed and not yet on npm. `published`: the committed version is on npm. `failed`: the newest publish workflow run that planned this package since the last commit (and since the stage) failed or was cancelled; publishing again retries it, unless the package has no release yet, which only the daily first-publish approval retries.
|
|
62030
|
+
* @enum {string}
|
|
62031
|
+
*/
|
|
62032
|
+
state: "not_published" | "staged" | "publishing" | "published" | "failed";
|
|
62033
|
+
};
|
|
60962
62034
|
ClientInputDeliveryReceipt: {
|
|
60963
62035
|
deliveryId: string;
|
|
60964
62036
|
executionId: string;
|
|
@@ -65043,12 +66115,29 @@ interface components {
|
|
|
65043
66115
|
/** @enum {string} */
|
|
65044
66116
|
status?: "draft" | "active" | "paused";
|
|
65045
66117
|
/** @enum {string} */
|
|
65046
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
66118
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
65047
66119
|
};
|
|
65048
66120
|
lastModifiedSource: string | null;
|
|
65049
66121
|
surfaceId: string;
|
|
65050
66122
|
updatedAt: string | null;
|
|
65051
66123
|
};
|
|
66124
|
+
SurfaceSession: {
|
|
66125
|
+
/** @description The MCP client the user authorized. */
|
|
66126
|
+
clientId: string;
|
|
66127
|
+
/** Format: date-time */
|
|
66128
|
+
createdAt: string;
|
|
66129
|
+
email: string;
|
|
66130
|
+
endUserCredentialId: string;
|
|
66131
|
+
/**
|
|
66132
|
+
* Format: date-time
|
|
66133
|
+
* @description When the current refresh token expires.
|
|
66134
|
+
*/
|
|
66135
|
+
expiresAt: string;
|
|
66136
|
+
/** Format: date-time */
|
|
66137
|
+
lastRefreshedAt: string;
|
|
66138
|
+
/** @description The refresh-token family; revoking it ends the session. */
|
|
66139
|
+
sessionId: string;
|
|
66140
|
+
};
|
|
65052
66141
|
TokenAudiencePolicy: {
|
|
65053
66142
|
agentId: string;
|
|
65054
66143
|
entries: components["schemas"]["TokenAudiencePolicyEntry"][];
|
|
@@ -71047,9 +72136,12 @@ export declare class ModelConfigsEndpoint {
|
|
|
71047
72136
|
private client;
|
|
71048
72137
|
constructor(client: ApiClient);
|
|
71049
72138
|
/**
|
|
71050
|
-
* Get the available models catalog, followed by the account's custom models (`uiCategory: 'custom'`)
|
|
72139
|
+
* Get the available models catalog, followed by the account's custom models (`uiCategory: 'custom'`).
|
|
72140
|
+
* Pass `q` to search by name, id, creator, provider or tag; results are then ordered by relevance.
|
|
71051
72141
|
*/
|
|
71052
|
-
getAvailable(
|
|
72142
|
+
getAvailable(params?: {
|
|
72143
|
+
q?: string;
|
|
72144
|
+
}): Promise<ModelConfig[]>;
|
|
71053
72145
|
/**
|
|
71054
72146
|
* Get search-capable models (all available, regardless of user configuration)
|
|
71055
72147
|
*/
|
|
@@ -77838,7 +78930,7 @@ interface SurfaceContentInput {
|
|
|
77838
78930
|
status?: string | null;
|
|
77839
78931
|
}
|
|
77840
78932
|
/** The surface types `ensure` accepts (mirrors the server's createSurfaceSchema). */
|
|
77841
|
-
type SurfaceDefinitionType = 'chat' | 'mcp' | 'mcp_code' | 'api' | 'webhook' | 'schedule' | 'a2a' | 'email' | 'slack' | 'sms' | 'imessage' | 'discord' | 'whatsapp' | 'telegram' | 'hosted-page' | 'chrome_extension';
|
|
78933
|
+
type SurfaceDefinitionType = 'chat' | 'mcp' | 'mcp_code' | 'cli' | 'api' | 'webhook' | 'schedule' | 'a2a' | 'email' | 'slack' | 'sms' | 'imessage' | 'discord' | 'whatsapp' | 'telegram' | 'hosted-page' | 'chrome_extension';
|
|
77842
78934
|
type SurfaceDefinitionStatus = 'draft' | 'active' | 'paused';
|
|
77843
78935
|
/** `defineSurface` input: identity (name) + the convergeable content fields. */
|
|
77844
78936
|
interface DefineSurfaceInput {
|