@runtypelabs/sdk 11.17.0 → 11.18.2
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 +25 -22
- package/dist/index.d.cts +1114 -215
- package/dist/index.d.ts +1114 -215
- package/dist/index.mjs +25 -22
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -2415,7 +2415,7 @@ interface paths {
|
|
|
2415
2415
|
};
|
|
2416
2416
|
/**
|
|
2417
2417
|
* Update agent
|
|
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.
|
|
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.
|
|
2419
2419
|
*/
|
|
2420
2420
|
put: {
|
|
2421
2421
|
parameters: {
|
|
@@ -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: {
|
|
@@ -32878,6 +32889,8 @@ interface paths {
|
|
|
32878
32889
|
supportsCustomKey?: boolean;
|
|
32879
32890
|
supportsSearch?: boolean;
|
|
32880
32891
|
supportsStreaming?: boolean;
|
|
32892
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
32893
|
+
supportsToolUse?: boolean;
|
|
32881
32894
|
updatedAt: string;
|
|
32882
32895
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
32883
32896
|
userId: string | null;
|
|
@@ -33052,6 +33065,8 @@ interface paths {
|
|
|
33052
33065
|
supportsCustomKey?: boolean;
|
|
33053
33066
|
supportsSearch?: boolean;
|
|
33054
33067
|
supportsStreaming?: boolean;
|
|
33068
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
33069
|
+
supportsToolUse?: boolean;
|
|
33055
33070
|
updatedAt: string;
|
|
33056
33071
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
33057
33072
|
userId: string | null;
|
|
@@ -33756,6 +33771,8 @@ interface paths {
|
|
|
33756
33771
|
supportsCustomKey?: boolean;
|
|
33757
33772
|
supportsSearch?: boolean;
|
|
33758
33773
|
supportsStreaming?: boolean;
|
|
33774
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
33775
|
+
supportsToolUse?: boolean;
|
|
33759
33776
|
updatedAt: string;
|
|
33760
33777
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
33761
33778
|
userId: string | null;
|
|
@@ -34035,6 +34052,8 @@ interface paths {
|
|
|
34035
34052
|
supportsCustomKey?: boolean;
|
|
34036
34053
|
supportsSearch?: boolean;
|
|
34037
34054
|
supportsStreaming?: boolean;
|
|
34055
|
+
/** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
|
|
34056
|
+
supportsToolUse?: boolean;
|
|
34038
34057
|
updatedAt: string;
|
|
34039
34058
|
/** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
|
|
34040
34059
|
userId: string | null;
|
|
@@ -34487,6 +34506,7 @@ interface paths {
|
|
|
34487
34506
|
limit?: string;
|
|
34488
34507
|
cursor?: string;
|
|
34489
34508
|
search?: string;
|
|
34509
|
+
sort?: "activity" | "name";
|
|
34490
34510
|
/** @description Response representation. `full` (default) preserves complete values; `compact` shortens every string value longer than 100 characters to a 100-character preview followed by `…`. */
|
|
34491
34511
|
view?: "full" | "compact";
|
|
34492
34512
|
};
|
|
@@ -34864,7 +34884,7 @@ interface paths {
|
|
|
34864
34884
|
"application/json": components["schemas"]["Error"];
|
|
34865
34885
|
};
|
|
34866
34886
|
};
|
|
34867
|
-
/** @description Insufficient permissions for the entities this FPO materializes */
|
|
34887
|
+
/** @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`) */
|
|
34868
34888
|
403: {
|
|
34869
34889
|
headers: {
|
|
34870
34890
|
[name: string]: unknown;
|
|
@@ -37408,7 +37428,7 @@ interface paths {
|
|
|
37408
37428
|
/** @enum {string} */
|
|
37409
37429
|
status?: "draft" | "active" | "paused";
|
|
37410
37430
|
/** @enum {string} */
|
|
37411
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37431
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37412
37432
|
};
|
|
37413
37433
|
};
|
|
37414
37434
|
};
|
|
@@ -37466,7 +37486,7 @@ interface paths {
|
|
|
37466
37486
|
"application/json": components["schemas"]["Error"];
|
|
37467
37487
|
};
|
|
37468
37488
|
};
|
|
37469
|
-
/** @description Insufficient permissions */
|
|
37489
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
|
|
37470
37490
|
403: {
|
|
37471
37491
|
headers: {
|
|
37472
37492
|
[name: string]: unknown;
|
|
@@ -37545,7 +37565,7 @@ interface paths {
|
|
|
37545
37565
|
/** @enum {string} */
|
|
37546
37566
|
status?: "draft" | "active" | "paused";
|
|
37547
37567
|
/** @enum {string} */
|
|
37548
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37568
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
37549
37569
|
};
|
|
37550
37570
|
dryRun?: boolean;
|
|
37551
37571
|
expectedRemoteHash?: string;
|
|
@@ -37583,7 +37603,7 @@ interface paths {
|
|
|
37583
37603
|
"application/json": components["schemas"]["Error"];
|
|
37584
37604
|
};
|
|
37585
37605
|
};
|
|
37586
|
-
/** @description Insufficient permissions */
|
|
37606
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
|
|
37587
37607
|
403: {
|
|
37588
37608
|
headers: {
|
|
37589
37609
|
[name: string]: unknown;
|
|
@@ -39729,7 +39749,7 @@ interface paths {
|
|
|
39729
39749
|
patch?: never;
|
|
39730
39750
|
trace?: never;
|
|
39731
39751
|
};
|
|
39732
|
-
"/v1/products/{id}/surfaces/{surfaceId}/
|
|
39752
|
+
"/v1/products/{id}/surfaces/{surfaceId}/sessions": {
|
|
39733
39753
|
parameters: {
|
|
39734
39754
|
query?: never;
|
|
39735
39755
|
header?: never;
|
|
@@ -39737,12 +39757,17 @@ interface paths {
|
|
|
39737
39757
|
cookie?: never;
|
|
39738
39758
|
};
|
|
39739
39759
|
/**
|
|
39740
|
-
*
|
|
39741
|
-
* @description
|
|
39760
|
+
* List signed-in surface sessions
|
|
39761
|
+
* @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.
|
|
39742
39762
|
*/
|
|
39743
39763
|
get: {
|
|
39744
39764
|
parameters: {
|
|
39745
|
-
query?:
|
|
39765
|
+
query?: {
|
|
39766
|
+
/** @description Maximum sessions to return, 1 to 100. Defaults to 50. */
|
|
39767
|
+
limit?: string;
|
|
39768
|
+
/** @description The `nextCursor` from the previous page. */
|
|
39769
|
+
cursor?: string;
|
|
39770
|
+
};
|
|
39746
39771
|
header?: never;
|
|
39747
39772
|
path: {
|
|
39748
39773
|
id: string;
|
|
@@ -39752,93 +39777,20 @@ interface paths {
|
|
|
39752
39777
|
};
|
|
39753
39778
|
requestBody?: never;
|
|
39754
39779
|
responses: {
|
|
39755
|
-
/** @description
|
|
39780
|
+
/** @description Live sessions, newest first */
|
|
39756
39781
|
200: {
|
|
39757
39782
|
headers: {
|
|
39758
39783
|
[name: string]: unknown;
|
|
39759
39784
|
};
|
|
39760
39785
|
content: {
|
|
39761
39786
|
"application/json": {
|
|
39762
|
-
|
|
39763
|
-
|
|
39764
|
-
|
|
39765
|
-
state: "ready" | "needs_setup";
|
|
39766
|
-
steps: {
|
|
39767
|
-
alternatives?: ({
|
|
39768
|
-
args: {
|
|
39769
|
-
[key: string]: unknown;
|
|
39770
|
-
};
|
|
39771
|
-
pendingArgs?: {
|
|
39772
|
-
[key: string]: string;
|
|
39773
|
-
};
|
|
39774
|
-
/** @enum {string} */
|
|
39775
|
-
rung: "mcp_tool";
|
|
39776
|
-
summary: string;
|
|
39777
|
-
tool: string;
|
|
39778
|
-
} | {
|
|
39779
|
-
endpoint: string;
|
|
39780
|
-
/** @enum {string} */
|
|
39781
|
-
method: "PATCH" | "POST" | "PUT";
|
|
39782
|
-
/** @enum {string} */
|
|
39783
|
-
rung: "rest";
|
|
39784
|
-
summary: string;
|
|
39785
|
-
} | {
|
|
39786
|
-
reason: string;
|
|
39787
|
-
/** @enum {string} */
|
|
39788
|
-
rung: "browser";
|
|
39789
|
-
summary: string;
|
|
39790
|
-
url: string;
|
|
39791
|
-
} | {
|
|
39792
|
-
/** @enum {string} */
|
|
39793
|
-
rung: "satisfied";
|
|
39794
|
-
})[];
|
|
39795
|
-
docsUrl?: string;
|
|
39796
|
-
fulfillment: {
|
|
39797
|
-
args: {
|
|
39798
|
-
[key: string]: unknown;
|
|
39799
|
-
};
|
|
39800
|
-
pendingArgs?: {
|
|
39801
|
-
[key: string]: string;
|
|
39802
|
-
};
|
|
39803
|
-
/** @enum {string} */
|
|
39804
|
-
rung: "mcp_tool";
|
|
39805
|
-
summary: string;
|
|
39806
|
-
tool: string;
|
|
39807
|
-
} | {
|
|
39808
|
-
endpoint: string;
|
|
39809
|
-
/** @enum {string} */
|
|
39810
|
-
method: "PATCH" | "POST" | "PUT";
|
|
39811
|
-
/** @enum {string} */
|
|
39812
|
-
rung: "rest";
|
|
39813
|
-
summary: string;
|
|
39814
|
-
} | {
|
|
39815
|
-
reason: string;
|
|
39816
|
-
/** @enum {string} */
|
|
39817
|
-
rung: "browser";
|
|
39818
|
-
summary: string;
|
|
39819
|
-
url: string;
|
|
39820
|
-
} | {
|
|
39821
|
-
/** @enum {string} */
|
|
39822
|
-
rung: "satisfied";
|
|
39823
|
-
};
|
|
39824
|
-
helpText?: string;
|
|
39825
|
-
id: string;
|
|
39826
|
-
/** @enum {string} */
|
|
39827
|
-
kind: "secret" | "surface_install";
|
|
39828
|
-
required: boolean;
|
|
39829
|
-
secretKey?: string;
|
|
39830
|
-
/** @enum {string} */
|
|
39831
|
-
status: "satisfied" | "pending";
|
|
39832
|
-
surfaceId?: string;
|
|
39833
|
-
surfaceType?: string;
|
|
39834
|
-
title: string;
|
|
39835
|
-
}[];
|
|
39836
|
-
surfaceId: string;
|
|
39837
|
-
surfaceType: string;
|
|
39787
|
+
data: components["schemas"]["SurfaceSession"][];
|
|
39788
|
+
/** @description Pass as `cursor` to read the next page; null on the last page. */
|
|
39789
|
+
nextCursor: string | null;
|
|
39838
39790
|
};
|
|
39839
39791
|
};
|
|
39840
39792
|
};
|
|
39841
|
-
/** @description Invalid
|
|
39793
|
+
/** @description Invalid ID */
|
|
39842
39794
|
400: {
|
|
39843
39795
|
headers: {
|
|
39844
39796
|
[name: string]: unknown;
|
|
@@ -39856,7 +39808,16 @@ interface paths {
|
|
|
39856
39808
|
"application/json": components["schemas"]["Error"];
|
|
39857
39809
|
};
|
|
39858
39810
|
};
|
|
39859
|
-
/** @description
|
|
39811
|
+
/** @description Insufficient permissions */
|
|
39812
|
+
403: {
|
|
39813
|
+
headers: {
|
|
39814
|
+
[name: string]: unknown;
|
|
39815
|
+
};
|
|
39816
|
+
content: {
|
|
39817
|
+
"application/json": components["schemas"]["Error"];
|
|
39818
|
+
};
|
|
39819
|
+
};
|
|
39820
|
+
/** @description Product, surface or session not found */
|
|
39860
39821
|
404: {
|
|
39861
39822
|
headers: {
|
|
39862
39823
|
[name: string]: unknown;
|
|
@@ -39884,7 +39845,7 @@ interface paths {
|
|
|
39884
39845
|
patch?: never;
|
|
39885
39846
|
trace?: never;
|
|
39886
39847
|
};
|
|
39887
|
-
"/v1/products/{id}/surfaces/{surfaceId}/
|
|
39848
|
+
"/v1/products/{id}/surfaces/{surfaceId}/sessions/{sessionId}": {
|
|
39888
39849
|
parameters: {
|
|
39889
39850
|
query?: never;
|
|
39890
39851
|
header?: never;
|
|
@@ -39893,45 +39854,36 @@ interface paths {
|
|
|
39893
39854
|
};
|
|
39894
39855
|
get?: never;
|
|
39895
39856
|
put?: never;
|
|
39857
|
+
post?: never;
|
|
39896
39858
|
/**
|
|
39897
|
-
*
|
|
39898
|
-
* @description
|
|
39859
|
+
* Revoke a signed-in surface session
|
|
39860
|
+
* @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.
|
|
39899
39861
|
*/
|
|
39900
|
-
|
|
39862
|
+
delete: {
|
|
39901
39863
|
parameters: {
|
|
39902
39864
|
query?: never;
|
|
39903
39865
|
header?: never;
|
|
39904
39866
|
path: {
|
|
39905
|
-
/** @description Product ID */
|
|
39906
39867
|
id: string;
|
|
39907
|
-
/** @description Surface ID */
|
|
39908
39868
|
surfaceId: string;
|
|
39869
|
+
sessionId: string;
|
|
39909
39870
|
};
|
|
39910
39871
|
cookie?: never;
|
|
39911
39872
|
};
|
|
39912
|
-
requestBody
|
|
39913
|
-
content: {
|
|
39914
|
-
"application/json": {
|
|
39915
|
-
payload?: unknown;
|
|
39916
|
-
};
|
|
39917
|
-
};
|
|
39918
|
-
};
|
|
39873
|
+
requestBody?: never;
|
|
39919
39874
|
responses: {
|
|
39920
|
-
/** @description
|
|
39875
|
+
/** @description Session revoked */
|
|
39921
39876
|
200: {
|
|
39922
39877
|
headers: {
|
|
39923
39878
|
[name: string]: unknown;
|
|
39924
39879
|
};
|
|
39925
39880
|
content: {
|
|
39926
39881
|
"application/json": {
|
|
39927
|
-
|
|
39928
|
-
learningState: string;
|
|
39929
|
-
mappingSuggestions: unknown[];
|
|
39930
|
-
schema?: unknown;
|
|
39882
|
+
success: boolean;
|
|
39931
39883
|
};
|
|
39932
39884
|
};
|
|
39933
39885
|
};
|
|
39934
|
-
/** @description Invalid
|
|
39886
|
+
/** @description Invalid ID */
|
|
39935
39887
|
400: {
|
|
39936
39888
|
headers: {
|
|
39937
39889
|
[name: string]: unknown;
|
|
@@ -39949,7 +39901,16 @@ interface paths {
|
|
|
39949
39901
|
"application/json": components["schemas"]["Error"];
|
|
39950
39902
|
};
|
|
39951
39903
|
};
|
|
39952
|
-
/** @description
|
|
39904
|
+
/** @description Insufficient permissions */
|
|
39905
|
+
403: {
|
|
39906
|
+
headers: {
|
|
39907
|
+
[name: string]: unknown;
|
|
39908
|
+
};
|
|
39909
|
+
content: {
|
|
39910
|
+
"application/json": components["schemas"]["Error"];
|
|
39911
|
+
};
|
|
39912
|
+
};
|
|
39913
|
+
/** @description Product, surface or session not found */
|
|
39953
39914
|
404: {
|
|
39954
39915
|
headers: {
|
|
39955
39916
|
[name: string]: unknown;
|
|
@@ -39969,58 +39930,121 @@ interface paths {
|
|
|
39969
39930
|
};
|
|
39970
39931
|
};
|
|
39971
39932
|
};
|
|
39972
|
-
delete?: never;
|
|
39973
39933
|
options?: never;
|
|
39974
39934
|
head?: never;
|
|
39975
39935
|
patch?: never;
|
|
39976
39936
|
trace?: never;
|
|
39977
39937
|
};
|
|
39978
|
-
"/v1/products/{id}/surfaces/{surfaceId}/
|
|
39938
|
+
"/v1/products/{id}/surfaces/{surfaceId}/setup": {
|
|
39979
39939
|
parameters: {
|
|
39980
39940
|
query?: never;
|
|
39981
39941
|
header?: never;
|
|
39982
39942
|
path?: never;
|
|
39983
39943
|
cookie?: never;
|
|
39984
39944
|
};
|
|
39985
|
-
get?: never;
|
|
39986
|
-
put?: never;
|
|
39987
39945
|
/**
|
|
39988
|
-
*
|
|
39989
|
-
* @description
|
|
39946
|
+
* Get surface setup readiness
|
|
39947
|
+
* @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.
|
|
39990
39948
|
*/
|
|
39991
|
-
|
|
39949
|
+
get: {
|
|
39992
39950
|
parameters: {
|
|
39993
39951
|
query?: never;
|
|
39994
39952
|
header?: never;
|
|
39995
39953
|
path: {
|
|
39996
|
-
/** @description Product ID */
|
|
39997
39954
|
id: string;
|
|
39998
|
-
/** @description Surface ID */
|
|
39999
39955
|
surfaceId: string;
|
|
40000
39956
|
};
|
|
40001
39957
|
cookie?: never;
|
|
40002
39958
|
};
|
|
40003
|
-
requestBody
|
|
40004
|
-
content: {
|
|
40005
|
-
"application/json": {
|
|
40006
|
-
enabled: boolean;
|
|
40007
|
-
};
|
|
40008
|
-
};
|
|
40009
|
-
};
|
|
39959
|
+
requestBody?: never;
|
|
40010
39960
|
responses: {
|
|
40011
|
-
/** @description
|
|
39961
|
+
/** @description Surface setup readiness */
|
|
40012
39962
|
200: {
|
|
40013
39963
|
headers: {
|
|
40014
39964
|
[name: string]: unknown;
|
|
40015
39965
|
};
|
|
40016
39966
|
content: {
|
|
40017
39967
|
"application/json": {
|
|
40018
|
-
|
|
40019
|
-
|
|
39968
|
+
name: string;
|
|
39969
|
+
pendingCount: number;
|
|
39970
|
+
/** @enum {string} */
|
|
39971
|
+
state: "ready" | "needs_setup";
|
|
39972
|
+
steps: {
|
|
39973
|
+
alternatives?: ({
|
|
39974
|
+
args: {
|
|
39975
|
+
[key: string]: unknown;
|
|
39976
|
+
};
|
|
39977
|
+
pendingArgs?: {
|
|
39978
|
+
[key: string]: string;
|
|
39979
|
+
};
|
|
39980
|
+
/** @enum {string} */
|
|
39981
|
+
rung: "mcp_tool";
|
|
39982
|
+
summary: string;
|
|
39983
|
+
tool: string;
|
|
39984
|
+
} | {
|
|
39985
|
+
endpoint: string;
|
|
39986
|
+
/** @enum {string} */
|
|
39987
|
+
method: "PATCH" | "POST" | "PUT";
|
|
39988
|
+
/** @enum {string} */
|
|
39989
|
+
rung: "rest";
|
|
39990
|
+
summary: string;
|
|
39991
|
+
} | {
|
|
39992
|
+
reason: string;
|
|
39993
|
+
/** @enum {string} */
|
|
39994
|
+
rung: "browser";
|
|
39995
|
+
summary: string;
|
|
39996
|
+
url: string;
|
|
39997
|
+
} | {
|
|
39998
|
+
/** @enum {string} */
|
|
39999
|
+
rung: "satisfied";
|
|
40000
|
+
})[];
|
|
40001
|
+
docsUrl?: string;
|
|
40002
|
+
fulfillment: {
|
|
40003
|
+
args: {
|
|
40004
|
+
[key: string]: unknown;
|
|
40005
|
+
};
|
|
40006
|
+
pendingArgs?: {
|
|
40007
|
+
[key: string]: string;
|
|
40008
|
+
};
|
|
40009
|
+
/** @enum {string} */
|
|
40010
|
+
rung: "mcp_tool";
|
|
40011
|
+
summary: string;
|
|
40012
|
+
tool: string;
|
|
40013
|
+
} | {
|
|
40014
|
+
endpoint: string;
|
|
40015
|
+
/** @enum {string} */
|
|
40016
|
+
method: "PATCH" | "POST" | "PUT";
|
|
40017
|
+
/** @enum {string} */
|
|
40018
|
+
rung: "rest";
|
|
40019
|
+
summary: string;
|
|
40020
|
+
} | {
|
|
40021
|
+
reason: string;
|
|
40022
|
+
/** @enum {string} */
|
|
40023
|
+
rung: "browser";
|
|
40024
|
+
summary: string;
|
|
40025
|
+
url: string;
|
|
40026
|
+
} | {
|
|
40027
|
+
/** @enum {string} */
|
|
40028
|
+
rung: "satisfied";
|
|
40029
|
+
};
|
|
40030
|
+
helpText?: string;
|
|
40031
|
+
id: string;
|
|
40032
|
+
/** @enum {string} */
|
|
40033
|
+
kind: "secret" | "surface_install";
|
|
40034
|
+
required: boolean;
|
|
40035
|
+
secretKey?: string;
|
|
40036
|
+
/** @enum {string} */
|
|
40037
|
+
status: "satisfied" | "pending";
|
|
40038
|
+
surfaceId?: string;
|
|
40039
|
+
surfaceType?: string;
|
|
40040
|
+
title: string;
|
|
40041
|
+
}[];
|
|
40042
|
+
surfaceId: string;
|
|
40043
|
+
surfaceType: string;
|
|
40020
40044
|
};
|
|
40021
40045
|
};
|
|
40022
40046
|
};
|
|
40023
|
-
/** @description Invalid
|
|
40047
|
+
/** @description Invalid product ID */
|
|
40024
40048
|
400: {
|
|
40025
40049
|
headers: {
|
|
40026
40050
|
[name: string]: unknown;
|
|
@@ -40038,7 +40062,7 @@ interface paths {
|
|
|
40038
40062
|
"application/json": components["schemas"]["Error"];
|
|
40039
40063
|
};
|
|
40040
40064
|
};
|
|
40041
|
-
/** @description
|
|
40065
|
+
/** @description Product or surface not found */
|
|
40042
40066
|
404: {
|
|
40043
40067
|
headers: {
|
|
40044
40068
|
[name: string]: unknown;
|
|
@@ -40058,24 +40082,28 @@ interface paths {
|
|
|
40058
40082
|
};
|
|
40059
40083
|
};
|
|
40060
40084
|
};
|
|
40085
|
+
put?: never;
|
|
40086
|
+
post?: never;
|
|
40061
40087
|
delete?: never;
|
|
40062
40088
|
options?: never;
|
|
40063
40089
|
head?: never;
|
|
40064
40090
|
patch?: never;
|
|
40065
40091
|
trace?: never;
|
|
40066
40092
|
};
|
|
40067
|
-
"/v1/products/{id}/surfaces/{surfaceId}/webhook-
|
|
40093
|
+
"/v1/products/{id}/surfaces/{surfaceId}/webhook-infer": {
|
|
40068
40094
|
parameters: {
|
|
40069
40095
|
query?: never;
|
|
40070
40096
|
header?: never;
|
|
40071
40097
|
path?: never;
|
|
40072
40098
|
cookie?: never;
|
|
40073
40099
|
};
|
|
40100
|
+
get?: never;
|
|
40101
|
+
put?: never;
|
|
40074
40102
|
/**
|
|
40075
|
-
*
|
|
40076
|
-
* @description
|
|
40103
|
+
* Infer schema from JSON payload
|
|
40104
|
+
* @description Infer a webhook schema from a pasted JSON payload.
|
|
40077
40105
|
*/
|
|
40078
|
-
|
|
40106
|
+
post: {
|
|
40079
40107
|
parameters: {
|
|
40080
40108
|
query?: never;
|
|
40081
40109
|
header?: never;
|
|
@@ -40087,35 +40115,30 @@ interface paths {
|
|
|
40087
40115
|
};
|
|
40088
40116
|
cookie?: never;
|
|
40089
40117
|
};
|
|
40090
|
-
requestBody
|
|
40118
|
+
requestBody: {
|
|
40119
|
+
content: {
|
|
40120
|
+
"application/json": {
|
|
40121
|
+
payload?: unknown;
|
|
40122
|
+
};
|
|
40123
|
+
};
|
|
40124
|
+
};
|
|
40091
40125
|
responses: {
|
|
40092
|
-
/** @description
|
|
40126
|
+
/** @description Schema inferred */
|
|
40093
40127
|
200: {
|
|
40094
40128
|
headers: {
|
|
40095
40129
|
[name: string]: unknown;
|
|
40096
40130
|
};
|
|
40097
40131
|
content: {
|
|
40098
40132
|
"application/json": {
|
|
40099
|
-
|
|
40100
|
-
|
|
40101
|
-
|
|
40102
|
-
|
|
40103
|
-
id: string;
|
|
40104
|
-
}[];
|
|
40133
|
+
jsonSchema?: unknown;
|
|
40134
|
+
learningState: string;
|
|
40135
|
+
mappingSuggestions: unknown[];
|
|
40136
|
+
schema?: unknown;
|
|
40105
40137
|
};
|
|
40106
40138
|
};
|
|
40107
40139
|
};
|
|
40108
|
-
/** @description
|
|
40109
|
-
|
|
40110
|
-
headers: {
|
|
40111
|
-
[name: string]: unknown;
|
|
40112
|
-
};
|
|
40113
|
-
content: {
|
|
40114
|
-
"application/json": components["schemas"]["Error"];
|
|
40115
|
-
};
|
|
40116
|
-
};
|
|
40117
|
-
/** @description Not found */
|
|
40118
|
-
404: {
|
|
40140
|
+
/** @description Invalid request */
|
|
40141
|
+
400: {
|
|
40119
40142
|
headers: {
|
|
40120
40143
|
[name: string]: unknown;
|
|
40121
40144
|
};
|
|
@@ -40123,52 +40146,235 @@ interface paths {
|
|
|
40123
40146
|
"application/json": components["schemas"]["Error"];
|
|
40124
40147
|
};
|
|
40125
40148
|
};
|
|
40126
|
-
|
|
40127
|
-
|
|
40128
|
-
|
|
40129
|
-
|
|
40130
|
-
|
|
40131
|
-
|
|
40132
|
-
|
|
40133
|
-
|
|
40134
|
-
|
|
40135
|
-
|
|
40136
|
-
|
|
40137
|
-
|
|
40138
|
-
|
|
40139
|
-
|
|
40140
|
-
|
|
40141
|
-
|
|
40142
|
-
|
|
40143
|
-
|
|
40144
|
-
|
|
40145
|
-
|
|
40146
|
-
|
|
40147
|
-
|
|
40148
|
-
|
|
40149
|
-
|
|
40150
|
-
|
|
40151
|
-
|
|
40152
|
-
|
|
40153
|
-
|
|
40154
|
-
|
|
40155
|
-
|
|
40156
|
-
|
|
40157
|
-
|
|
40158
|
-
|
|
40159
|
-
|
|
40160
|
-
|
|
40161
|
-
|
|
40162
|
-
|
|
40163
|
-
|
|
40164
|
-
|
|
40165
|
-
|
|
40166
|
-
|
|
40167
|
-
|
|
40168
|
-
|
|
40169
|
-
|
|
40170
|
-
|
|
40171
|
-
|
|
40149
|
+
/** @description Unauthorized */
|
|
40150
|
+
401: {
|
|
40151
|
+
headers: {
|
|
40152
|
+
[name: string]: unknown;
|
|
40153
|
+
};
|
|
40154
|
+
content: {
|
|
40155
|
+
"application/json": components["schemas"]["Error"];
|
|
40156
|
+
};
|
|
40157
|
+
};
|
|
40158
|
+
/** @description Not found */
|
|
40159
|
+
404: {
|
|
40160
|
+
headers: {
|
|
40161
|
+
[name: string]: unknown;
|
|
40162
|
+
};
|
|
40163
|
+
content: {
|
|
40164
|
+
"application/json": components["schemas"]["Error"];
|
|
40165
|
+
};
|
|
40166
|
+
};
|
|
40167
|
+
/** @description Internal server error */
|
|
40168
|
+
500: {
|
|
40169
|
+
headers: {
|
|
40170
|
+
[name: string]: unknown;
|
|
40171
|
+
};
|
|
40172
|
+
content: {
|
|
40173
|
+
"application/json": components["schemas"]["Error"];
|
|
40174
|
+
};
|
|
40175
|
+
};
|
|
40176
|
+
};
|
|
40177
|
+
};
|
|
40178
|
+
delete?: never;
|
|
40179
|
+
options?: never;
|
|
40180
|
+
head?: never;
|
|
40181
|
+
patch?: never;
|
|
40182
|
+
trace?: never;
|
|
40183
|
+
};
|
|
40184
|
+
"/v1/products/{id}/surfaces/{surfaceId}/webhook-learning": {
|
|
40185
|
+
parameters: {
|
|
40186
|
+
query?: never;
|
|
40187
|
+
header?: never;
|
|
40188
|
+
path?: never;
|
|
40189
|
+
cookie?: never;
|
|
40190
|
+
};
|
|
40191
|
+
get?: never;
|
|
40192
|
+
put?: never;
|
|
40193
|
+
/**
|
|
40194
|
+
* Toggle webhook learning mode
|
|
40195
|
+
* @description Enable or disable learning mode for a webhook surface.
|
|
40196
|
+
*/
|
|
40197
|
+
post: {
|
|
40198
|
+
parameters: {
|
|
40199
|
+
query?: never;
|
|
40200
|
+
header?: never;
|
|
40201
|
+
path: {
|
|
40202
|
+
/** @description Product ID */
|
|
40203
|
+
id: string;
|
|
40204
|
+
/** @description Surface ID */
|
|
40205
|
+
surfaceId: string;
|
|
40206
|
+
};
|
|
40207
|
+
cookie?: never;
|
|
40208
|
+
};
|
|
40209
|
+
requestBody: {
|
|
40210
|
+
content: {
|
|
40211
|
+
"application/json": {
|
|
40212
|
+
enabled: boolean;
|
|
40213
|
+
};
|
|
40214
|
+
};
|
|
40215
|
+
};
|
|
40216
|
+
responses: {
|
|
40217
|
+
/** @description Learning mode toggled */
|
|
40218
|
+
200: {
|
|
40219
|
+
headers: {
|
|
40220
|
+
[name: string]: unknown;
|
|
40221
|
+
};
|
|
40222
|
+
content: {
|
|
40223
|
+
"application/json": {
|
|
40224
|
+
learningState: string;
|
|
40225
|
+
observationCount: number;
|
|
40226
|
+
};
|
|
40227
|
+
};
|
|
40228
|
+
};
|
|
40229
|
+
/** @description Invalid request */
|
|
40230
|
+
400: {
|
|
40231
|
+
headers: {
|
|
40232
|
+
[name: string]: unknown;
|
|
40233
|
+
};
|
|
40234
|
+
content: {
|
|
40235
|
+
"application/json": components["schemas"]["Error"];
|
|
40236
|
+
};
|
|
40237
|
+
};
|
|
40238
|
+
/** @description Unauthorized */
|
|
40239
|
+
401: {
|
|
40240
|
+
headers: {
|
|
40241
|
+
[name: string]: unknown;
|
|
40242
|
+
};
|
|
40243
|
+
content: {
|
|
40244
|
+
"application/json": components["schemas"]["Error"];
|
|
40245
|
+
};
|
|
40246
|
+
};
|
|
40247
|
+
/** @description Not found */
|
|
40248
|
+
404: {
|
|
40249
|
+
headers: {
|
|
40250
|
+
[name: string]: unknown;
|
|
40251
|
+
};
|
|
40252
|
+
content: {
|
|
40253
|
+
"application/json": components["schemas"]["Error"];
|
|
40254
|
+
};
|
|
40255
|
+
};
|
|
40256
|
+
/** @description Internal server error */
|
|
40257
|
+
500: {
|
|
40258
|
+
headers: {
|
|
40259
|
+
[name: string]: unknown;
|
|
40260
|
+
};
|
|
40261
|
+
content: {
|
|
40262
|
+
"application/json": components["schemas"]["Error"];
|
|
40263
|
+
};
|
|
40264
|
+
};
|
|
40265
|
+
};
|
|
40266
|
+
};
|
|
40267
|
+
delete?: never;
|
|
40268
|
+
options?: never;
|
|
40269
|
+
head?: never;
|
|
40270
|
+
patch?: never;
|
|
40271
|
+
trace?: never;
|
|
40272
|
+
};
|
|
40273
|
+
"/v1/products/{id}/surfaces/{surfaceId}/webhook-mappings": {
|
|
40274
|
+
parameters: {
|
|
40275
|
+
query?: never;
|
|
40276
|
+
header?: never;
|
|
40277
|
+
path?: never;
|
|
40278
|
+
cookie?: never;
|
|
40279
|
+
};
|
|
40280
|
+
/**
|
|
40281
|
+
* Get webhook field mappings
|
|
40282
|
+
* @description Get field mappings for all surface items on a webhook surface.
|
|
40283
|
+
*/
|
|
40284
|
+
get: {
|
|
40285
|
+
parameters: {
|
|
40286
|
+
query?: never;
|
|
40287
|
+
header?: never;
|
|
40288
|
+
path: {
|
|
40289
|
+
/** @description Product ID */
|
|
40290
|
+
id: string;
|
|
40291
|
+
/** @description Surface ID */
|
|
40292
|
+
surfaceId: string;
|
|
40293
|
+
};
|
|
40294
|
+
cookie?: never;
|
|
40295
|
+
};
|
|
40296
|
+
requestBody?: never;
|
|
40297
|
+
responses: {
|
|
40298
|
+
/** @description Mappings returned */
|
|
40299
|
+
200: {
|
|
40300
|
+
headers: {
|
|
40301
|
+
[name: string]: unknown;
|
|
40302
|
+
};
|
|
40303
|
+
content: {
|
|
40304
|
+
"application/json": {
|
|
40305
|
+
items: {
|
|
40306
|
+
capabilityId: string;
|
|
40307
|
+
exposedName: string | null;
|
|
40308
|
+
fieldMappings: unknown[];
|
|
40309
|
+
id: string;
|
|
40310
|
+
}[];
|
|
40311
|
+
};
|
|
40312
|
+
};
|
|
40313
|
+
};
|
|
40314
|
+
/** @description Unauthorized */
|
|
40315
|
+
401: {
|
|
40316
|
+
headers: {
|
|
40317
|
+
[name: string]: unknown;
|
|
40318
|
+
};
|
|
40319
|
+
content: {
|
|
40320
|
+
"application/json": components["schemas"]["Error"];
|
|
40321
|
+
};
|
|
40322
|
+
};
|
|
40323
|
+
/** @description Not found */
|
|
40324
|
+
404: {
|
|
40325
|
+
headers: {
|
|
40326
|
+
[name: string]: unknown;
|
|
40327
|
+
};
|
|
40328
|
+
content: {
|
|
40329
|
+
"application/json": components["schemas"]["Error"];
|
|
40330
|
+
};
|
|
40331
|
+
};
|
|
40332
|
+
};
|
|
40333
|
+
};
|
|
40334
|
+
/**
|
|
40335
|
+
* Update webhook field mappings
|
|
40336
|
+
* @description Update field mappings for a specific surface item.
|
|
40337
|
+
*/
|
|
40338
|
+
put: {
|
|
40339
|
+
parameters: {
|
|
40340
|
+
query?: never;
|
|
40341
|
+
header?: never;
|
|
40342
|
+
path: {
|
|
40343
|
+
/** @description Product ID */
|
|
40344
|
+
id: string;
|
|
40345
|
+
/** @description Surface ID */
|
|
40346
|
+
surfaceId: string;
|
|
40347
|
+
};
|
|
40348
|
+
cookie?: never;
|
|
40349
|
+
};
|
|
40350
|
+
requestBody: {
|
|
40351
|
+
content: {
|
|
40352
|
+
"application/json": {
|
|
40353
|
+
itemId: string;
|
|
40354
|
+
mappings: {
|
|
40355
|
+
defaultValue?: unknown;
|
|
40356
|
+
source: string;
|
|
40357
|
+
target: string;
|
|
40358
|
+
transform?: string;
|
|
40359
|
+
/** @enum {string} */
|
|
40360
|
+
type?: "string" | "number" | "boolean" | "json";
|
|
40361
|
+
}[];
|
|
40362
|
+
};
|
|
40363
|
+
};
|
|
40364
|
+
};
|
|
40365
|
+
responses: {
|
|
40366
|
+
/** @description Mappings updated */
|
|
40367
|
+
200: {
|
|
40368
|
+
headers: {
|
|
40369
|
+
[name: string]: unknown;
|
|
40370
|
+
};
|
|
40371
|
+
content: {
|
|
40372
|
+
"application/json": {
|
|
40373
|
+
fieldMappings: unknown[];
|
|
40374
|
+
id: string;
|
|
40375
|
+
};
|
|
40376
|
+
};
|
|
40377
|
+
};
|
|
40172
40378
|
/** @description Unauthorized */
|
|
40173
40379
|
401: {
|
|
40174
40380
|
headers: {
|
|
@@ -40953,6 +41159,568 @@ interface paths {
|
|
|
40953
41159
|
patch?: never;
|
|
40954
41160
|
trace?: never;
|
|
40955
41161
|
};
|
|
41162
|
+
"/v1/products/{productId}/surfaces/{surfaceId}/cli/graduation": {
|
|
41163
|
+
parameters: {
|
|
41164
|
+
query?: never;
|
|
41165
|
+
header?: never;
|
|
41166
|
+
path?: never;
|
|
41167
|
+
cookie?: never;
|
|
41168
|
+
};
|
|
41169
|
+
get?: never;
|
|
41170
|
+
put?: never;
|
|
41171
|
+
/**
|
|
41172
|
+
* Start CLI graduation
|
|
41173
|
+
* @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.
|
|
41174
|
+
*/
|
|
41175
|
+
post: {
|
|
41176
|
+
parameters: {
|
|
41177
|
+
query?: never;
|
|
41178
|
+
header?: never;
|
|
41179
|
+
path: {
|
|
41180
|
+
productId: string;
|
|
41181
|
+
surfaceId: string;
|
|
41182
|
+
};
|
|
41183
|
+
cookie?: never;
|
|
41184
|
+
};
|
|
41185
|
+
requestBody: {
|
|
41186
|
+
content: {
|
|
41187
|
+
"application/json": {
|
|
41188
|
+
/** @description Your npm package, `@acme/cli` or `acme`; never `@rtype/*` */
|
|
41189
|
+
packageName: string;
|
|
41190
|
+
};
|
|
41191
|
+
};
|
|
41192
|
+
};
|
|
41193
|
+
responses: {
|
|
41194
|
+
/** @description Token minted */
|
|
41195
|
+
200: {
|
|
41196
|
+
headers: {
|
|
41197
|
+
[name: string]: unknown;
|
|
41198
|
+
};
|
|
41199
|
+
content: {
|
|
41200
|
+
"application/json": components["schemas"]["CliGraduationGrant"];
|
|
41201
|
+
};
|
|
41202
|
+
};
|
|
41203
|
+
/** @description Invalid IDs or package name, or no command name */
|
|
41204
|
+
400: {
|
|
41205
|
+
headers: {
|
|
41206
|
+
[name: string]: unknown;
|
|
41207
|
+
};
|
|
41208
|
+
content: {
|
|
41209
|
+
"application/json": {
|
|
41210
|
+
code?: string;
|
|
41211
|
+
error: string;
|
|
41212
|
+
issues?: {
|
|
41213
|
+
code: string;
|
|
41214
|
+
message: string;
|
|
41215
|
+
verdict: string;
|
|
41216
|
+
}[];
|
|
41217
|
+
/**
|
|
41218
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41219
|
+
* @enum {string}
|
|
41220
|
+
*/
|
|
41221
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41222
|
+
};
|
|
41223
|
+
};
|
|
41224
|
+
};
|
|
41225
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_GRADUATION_DISABLED` */
|
|
41226
|
+
403: {
|
|
41227
|
+
headers: {
|
|
41228
|
+
[name: string]: unknown;
|
|
41229
|
+
};
|
|
41230
|
+
content: {
|
|
41231
|
+
"application/json": {
|
|
41232
|
+
code?: string;
|
|
41233
|
+
error: string;
|
|
41234
|
+
issues?: {
|
|
41235
|
+
code: string;
|
|
41236
|
+
message: string;
|
|
41237
|
+
verdict: string;
|
|
41238
|
+
}[];
|
|
41239
|
+
/**
|
|
41240
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41241
|
+
* @enum {string}
|
|
41242
|
+
*/
|
|
41243
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41244
|
+
};
|
|
41245
|
+
};
|
|
41246
|
+
};
|
|
41247
|
+
/** @description CLI surface not found */
|
|
41248
|
+
404: {
|
|
41249
|
+
headers: {
|
|
41250
|
+
[name: string]: unknown;
|
|
41251
|
+
};
|
|
41252
|
+
content: {
|
|
41253
|
+
"application/json": components["schemas"]["Error"];
|
|
41254
|
+
};
|
|
41255
|
+
};
|
|
41256
|
+
/** @description `CLI_SURFACE_NOT_MANAGED` */
|
|
41257
|
+
409: {
|
|
41258
|
+
headers: {
|
|
41259
|
+
[name: string]: unknown;
|
|
41260
|
+
};
|
|
41261
|
+
content: {
|
|
41262
|
+
"application/json": {
|
|
41263
|
+
code?: string;
|
|
41264
|
+
error: string;
|
|
41265
|
+
issues?: {
|
|
41266
|
+
code: string;
|
|
41267
|
+
message: string;
|
|
41268
|
+
verdict: string;
|
|
41269
|
+
}[];
|
|
41270
|
+
/**
|
|
41271
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41272
|
+
* @enum {string}
|
|
41273
|
+
*/
|
|
41274
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41275
|
+
};
|
|
41276
|
+
};
|
|
41277
|
+
};
|
|
41278
|
+
/** @description `CLI_GRADUATION_NOT_CONFIGURED`: no signing key */
|
|
41279
|
+
503: {
|
|
41280
|
+
headers: {
|
|
41281
|
+
[name: string]: unknown;
|
|
41282
|
+
};
|
|
41283
|
+
content: {
|
|
41284
|
+
"application/json": {
|
|
41285
|
+
code?: string;
|
|
41286
|
+
error: string;
|
|
41287
|
+
issues?: {
|
|
41288
|
+
code: string;
|
|
41289
|
+
message: string;
|
|
41290
|
+
verdict: string;
|
|
41291
|
+
}[];
|
|
41292
|
+
/**
|
|
41293
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41294
|
+
* @enum {string}
|
|
41295
|
+
*/
|
|
41296
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41297
|
+
};
|
|
41298
|
+
};
|
|
41299
|
+
};
|
|
41300
|
+
};
|
|
41301
|
+
};
|
|
41302
|
+
delete?: never;
|
|
41303
|
+
options?: never;
|
|
41304
|
+
head?: never;
|
|
41305
|
+
patch?: never;
|
|
41306
|
+
trace?: never;
|
|
41307
|
+
};
|
|
41308
|
+
"/v1/products/{productId}/surfaces/{surfaceId}/cli/graduation/complete": {
|
|
41309
|
+
parameters: {
|
|
41310
|
+
query?: never;
|
|
41311
|
+
header?: never;
|
|
41312
|
+
path?: never;
|
|
41313
|
+
cookie?: never;
|
|
41314
|
+
};
|
|
41315
|
+
get?: never;
|
|
41316
|
+
put?: never;
|
|
41317
|
+
/**
|
|
41318
|
+
* Complete CLI graduation
|
|
41319
|
+
* @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.
|
|
41320
|
+
*/
|
|
41321
|
+
post: {
|
|
41322
|
+
parameters: {
|
|
41323
|
+
query?: never;
|
|
41324
|
+
header?: never;
|
|
41325
|
+
path: {
|
|
41326
|
+
productId: string;
|
|
41327
|
+
surfaceId: string;
|
|
41328
|
+
};
|
|
41329
|
+
cookie?: never;
|
|
41330
|
+
};
|
|
41331
|
+
requestBody: {
|
|
41332
|
+
content: {
|
|
41333
|
+
"application/json": {
|
|
41334
|
+
/** @description Your npm package, `@acme/cli` or `acme`; never `@rtype/*` */
|
|
41335
|
+
packageName: string;
|
|
41336
|
+
};
|
|
41337
|
+
};
|
|
41338
|
+
};
|
|
41339
|
+
responses: {
|
|
41340
|
+
/** @description Switched over */
|
|
41341
|
+
200: {
|
|
41342
|
+
headers: {
|
|
41343
|
+
[name: string]: unknown;
|
|
41344
|
+
};
|
|
41345
|
+
content: {
|
|
41346
|
+
"application/json": components["schemas"]["CliGraduationResult"];
|
|
41347
|
+
};
|
|
41348
|
+
};
|
|
41349
|
+
/** @description Invalid IDs or package name, or no command name */
|
|
41350
|
+
400: {
|
|
41351
|
+
headers: {
|
|
41352
|
+
[name: string]: unknown;
|
|
41353
|
+
};
|
|
41354
|
+
content: {
|
|
41355
|
+
"application/json": {
|
|
41356
|
+
code?: string;
|
|
41357
|
+
error: string;
|
|
41358
|
+
issues?: {
|
|
41359
|
+
code: string;
|
|
41360
|
+
message: string;
|
|
41361
|
+
verdict: string;
|
|
41362
|
+
}[];
|
|
41363
|
+
/**
|
|
41364
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41365
|
+
* @enum {string}
|
|
41366
|
+
*/
|
|
41367
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41368
|
+
};
|
|
41369
|
+
};
|
|
41370
|
+
};
|
|
41371
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_GRADUATION_DISABLED` */
|
|
41372
|
+
403: {
|
|
41373
|
+
headers: {
|
|
41374
|
+
[name: string]: unknown;
|
|
41375
|
+
};
|
|
41376
|
+
content: {
|
|
41377
|
+
"application/json": {
|
|
41378
|
+
code?: string;
|
|
41379
|
+
error: string;
|
|
41380
|
+
issues?: {
|
|
41381
|
+
code: string;
|
|
41382
|
+
message: string;
|
|
41383
|
+
verdict: string;
|
|
41384
|
+
}[];
|
|
41385
|
+
/**
|
|
41386
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41387
|
+
* @enum {string}
|
|
41388
|
+
*/
|
|
41389
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41390
|
+
};
|
|
41391
|
+
};
|
|
41392
|
+
};
|
|
41393
|
+
/** @description CLI surface not found */
|
|
41394
|
+
404: {
|
|
41395
|
+
headers: {
|
|
41396
|
+
[name: string]: unknown;
|
|
41397
|
+
};
|
|
41398
|
+
content: {
|
|
41399
|
+
"application/json": components["schemas"]["Error"];
|
|
41400
|
+
};
|
|
41401
|
+
};
|
|
41402
|
+
/** @description `CLI_SURFACE_NOT_MANAGED`, `CLI_GRADUATION_TOKEN_NOT_FOUND`, `CLI_GRADUATION_PRERELEASE`, `CLI_GRADUATION_REJECTED` or `CLI_GRADUATION_CONFLICT` */
|
|
41403
|
+
409: {
|
|
41404
|
+
headers: {
|
|
41405
|
+
[name: string]: unknown;
|
|
41406
|
+
};
|
|
41407
|
+
content: {
|
|
41408
|
+
"application/json": {
|
|
41409
|
+
code?: string;
|
|
41410
|
+
error: string;
|
|
41411
|
+
issues?: {
|
|
41412
|
+
code: string;
|
|
41413
|
+
message: string;
|
|
41414
|
+
verdict: string;
|
|
41415
|
+
}[];
|
|
41416
|
+
/**
|
|
41417
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41418
|
+
* @enum {string}
|
|
41419
|
+
*/
|
|
41420
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41421
|
+
};
|
|
41422
|
+
};
|
|
41423
|
+
};
|
|
41424
|
+
/** @description `CLI_NPM_UNAVAILABLE` */
|
|
41425
|
+
502: {
|
|
41426
|
+
headers: {
|
|
41427
|
+
[name: string]: unknown;
|
|
41428
|
+
};
|
|
41429
|
+
content: {
|
|
41430
|
+
"application/json": {
|
|
41431
|
+
code?: string;
|
|
41432
|
+
error: string;
|
|
41433
|
+
issues?: {
|
|
41434
|
+
code: string;
|
|
41435
|
+
message: string;
|
|
41436
|
+
verdict: string;
|
|
41437
|
+
}[];
|
|
41438
|
+
/**
|
|
41439
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41440
|
+
* @enum {string}
|
|
41441
|
+
*/
|
|
41442
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41443
|
+
};
|
|
41444
|
+
};
|
|
41445
|
+
};
|
|
41446
|
+
/** @description `CLI_GRADUATION_NOT_CONFIGURED`: no signing key */
|
|
41447
|
+
503: {
|
|
41448
|
+
headers: {
|
|
41449
|
+
[name: string]: unknown;
|
|
41450
|
+
};
|
|
41451
|
+
content: {
|
|
41452
|
+
"application/json": {
|
|
41453
|
+
code?: string;
|
|
41454
|
+
error: string;
|
|
41455
|
+
issues?: {
|
|
41456
|
+
code: string;
|
|
41457
|
+
message: string;
|
|
41458
|
+
verdict: string;
|
|
41459
|
+
}[];
|
|
41460
|
+
/**
|
|
41461
|
+
* @description Why `CLI_GRADUATION_REJECTED` refused the token
|
|
41462
|
+
* @enum {string}
|
|
41463
|
+
*/
|
|
41464
|
+
reason?: "malformed" | "bad_signature" | "wrong_surface" | "wrong_package" | "expired" | "consumed" | "bin_changed";
|
|
41465
|
+
};
|
|
41466
|
+
};
|
|
41467
|
+
};
|
|
41468
|
+
};
|
|
41469
|
+
};
|
|
41470
|
+
delete?: never;
|
|
41471
|
+
options?: never;
|
|
41472
|
+
head?: never;
|
|
41473
|
+
patch?: never;
|
|
41474
|
+
trace?: never;
|
|
41475
|
+
};
|
|
41476
|
+
"/v1/products/{productId}/surfaces/{surfaceId}/cli/publish": {
|
|
41477
|
+
parameters: {
|
|
41478
|
+
query?: never;
|
|
41479
|
+
header?: never;
|
|
41480
|
+
path?: never;
|
|
41481
|
+
cookie?: never;
|
|
41482
|
+
};
|
|
41483
|
+
/**
|
|
41484
|
+
* Get CLI publish status
|
|
41485
|
+
* @description Whether the install host serves this `cli` surface, and the commands that install it. Read live from the install host's bucket.
|
|
41486
|
+
*/
|
|
41487
|
+
get: {
|
|
41488
|
+
parameters: {
|
|
41489
|
+
query?: never;
|
|
41490
|
+
header?: never;
|
|
41491
|
+
path: {
|
|
41492
|
+
productId: string;
|
|
41493
|
+
surfaceId: string;
|
|
41494
|
+
};
|
|
41495
|
+
cookie?: never;
|
|
41496
|
+
};
|
|
41497
|
+
requestBody?: never;
|
|
41498
|
+
responses: {
|
|
41499
|
+
/** @description Publish status */
|
|
41500
|
+
200: {
|
|
41501
|
+
headers: {
|
|
41502
|
+
[name: string]: unknown;
|
|
41503
|
+
};
|
|
41504
|
+
content: {
|
|
41505
|
+
"application/json": components["schemas"]["CliPublishStatus"];
|
|
41506
|
+
};
|
|
41507
|
+
};
|
|
41508
|
+
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41509
|
+
400: {
|
|
41510
|
+
headers: {
|
|
41511
|
+
[name: string]: unknown;
|
|
41512
|
+
};
|
|
41513
|
+
content: {
|
|
41514
|
+
"application/json": {
|
|
41515
|
+
code?: string;
|
|
41516
|
+
error: string;
|
|
41517
|
+
issues?: {
|
|
41518
|
+
code: string;
|
|
41519
|
+
message: string;
|
|
41520
|
+
/** @enum {string} */
|
|
41521
|
+
verdict: "review" | "reject";
|
|
41522
|
+
}[];
|
|
41523
|
+
};
|
|
41524
|
+
};
|
|
41525
|
+
};
|
|
41526
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account */
|
|
41527
|
+
403: {
|
|
41528
|
+
headers: {
|
|
41529
|
+
[name: string]: unknown;
|
|
41530
|
+
};
|
|
41531
|
+
content: {
|
|
41532
|
+
"application/json": {
|
|
41533
|
+
code?: string;
|
|
41534
|
+
error: string;
|
|
41535
|
+
issues?: {
|
|
41536
|
+
code: string;
|
|
41537
|
+
message: string;
|
|
41538
|
+
/** @enum {string} */
|
|
41539
|
+
verdict: "review" | "reject";
|
|
41540
|
+
}[];
|
|
41541
|
+
};
|
|
41542
|
+
};
|
|
41543
|
+
};
|
|
41544
|
+
/** @description Product or CLI surface not found */
|
|
41545
|
+
404: {
|
|
41546
|
+
headers: {
|
|
41547
|
+
[name: string]: unknown;
|
|
41548
|
+
};
|
|
41549
|
+
content: {
|
|
41550
|
+
"application/json": components["schemas"]["Error"];
|
|
41551
|
+
};
|
|
41552
|
+
};
|
|
41553
|
+
/** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
|
|
41554
|
+
502: {
|
|
41555
|
+
headers: {
|
|
41556
|
+
[name: string]: unknown;
|
|
41557
|
+
};
|
|
41558
|
+
content: {
|
|
41559
|
+
"application/json": {
|
|
41560
|
+
code?: string;
|
|
41561
|
+
error: string;
|
|
41562
|
+
issues?: {
|
|
41563
|
+
code: string;
|
|
41564
|
+
message: string;
|
|
41565
|
+
/** @enum {string} */
|
|
41566
|
+
verdict: "review" | "reject";
|
|
41567
|
+
}[];
|
|
41568
|
+
};
|
|
41569
|
+
};
|
|
41570
|
+
};
|
|
41571
|
+
/** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
|
|
41572
|
+
503: {
|
|
41573
|
+
headers: {
|
|
41574
|
+
[name: string]: unknown;
|
|
41575
|
+
};
|
|
41576
|
+
content: {
|
|
41577
|
+
"application/json": {
|
|
41578
|
+
code?: string;
|
|
41579
|
+
error: string;
|
|
41580
|
+
issues?: {
|
|
41581
|
+
code: string;
|
|
41582
|
+
message: string;
|
|
41583
|
+
/** @enum {string} */
|
|
41584
|
+
verdict: "review" | "reject";
|
|
41585
|
+
}[];
|
|
41586
|
+
};
|
|
41587
|
+
};
|
|
41588
|
+
};
|
|
41589
|
+
};
|
|
41590
|
+
};
|
|
41591
|
+
put?: never;
|
|
41592
|
+
/**
|
|
41593
|
+
* Publish a CLI surface
|
|
41594
|
+
* @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. The first version is 1.0.0; changed files bump the patch version. A slug belongs to the first surface that publishes it, and a name close to a protected brand needs a manual review first.
|
|
41595
|
+
*/
|
|
41596
|
+
post: {
|
|
41597
|
+
parameters: {
|
|
41598
|
+
query?: never;
|
|
41599
|
+
header?: never;
|
|
41600
|
+
path: {
|
|
41601
|
+
productId: string;
|
|
41602
|
+
surfaceId: string;
|
|
41603
|
+
};
|
|
41604
|
+
cookie?: never;
|
|
41605
|
+
};
|
|
41606
|
+
requestBody?: never;
|
|
41607
|
+
responses: {
|
|
41608
|
+
/** @description Published or unchanged */
|
|
41609
|
+
200: {
|
|
41610
|
+
headers: {
|
|
41611
|
+
[name: string]: unknown;
|
|
41612
|
+
};
|
|
41613
|
+
content: {
|
|
41614
|
+
"application/json": components["schemas"]["CliPublishResult"];
|
|
41615
|
+
};
|
|
41616
|
+
};
|
|
41617
|
+
/** @description Invalid IDs, or a name or package the publish refuses */
|
|
41618
|
+
400: {
|
|
41619
|
+
headers: {
|
|
41620
|
+
[name: string]: unknown;
|
|
41621
|
+
};
|
|
41622
|
+
content: {
|
|
41623
|
+
"application/json": {
|
|
41624
|
+
code?: string;
|
|
41625
|
+
error: string;
|
|
41626
|
+
issues?: {
|
|
41627
|
+
code: string;
|
|
41628
|
+
message: string;
|
|
41629
|
+
/** @enum {string} */
|
|
41630
|
+
verdict: "review" | "reject";
|
|
41631
|
+
}[];
|
|
41632
|
+
};
|
|
41633
|
+
};
|
|
41634
|
+
};
|
|
41635
|
+
/** @description Insufficient permissions, or `CLI_SURFACE_PUBLISH_DISABLED` while publishing is off for the account */
|
|
41636
|
+
403: {
|
|
41637
|
+
headers: {
|
|
41638
|
+
[name: string]: unknown;
|
|
41639
|
+
};
|
|
41640
|
+
content: {
|
|
41641
|
+
"application/json": {
|
|
41642
|
+
code?: string;
|
|
41643
|
+
error: string;
|
|
41644
|
+
issues?: {
|
|
41645
|
+
code: string;
|
|
41646
|
+
message: string;
|
|
41647
|
+
/** @enum {string} */
|
|
41648
|
+
verdict: "review" | "reject";
|
|
41649
|
+
}[];
|
|
41650
|
+
};
|
|
41651
|
+
};
|
|
41652
|
+
};
|
|
41653
|
+
/** @description Product or CLI surface not found */
|
|
41654
|
+
404: {
|
|
41655
|
+
headers: {
|
|
41656
|
+
[name: string]: unknown;
|
|
41657
|
+
};
|
|
41658
|
+
content: {
|
|
41659
|
+
"application/json": components["schemas"]["Error"];
|
|
41660
|
+
};
|
|
41661
|
+
};
|
|
41662
|
+
/** @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`), its name needs a brand review (`CLI_NAME_NEEDS_REVIEW`), or a concurrent publish changed it (`CLI_PUBLISH_CONFLICT`) */
|
|
41663
|
+
409: {
|
|
41664
|
+
headers: {
|
|
41665
|
+
[name: string]: unknown;
|
|
41666
|
+
};
|
|
41667
|
+
content: {
|
|
41668
|
+
"application/json": {
|
|
41669
|
+
code?: string;
|
|
41670
|
+
error: string;
|
|
41671
|
+
issues?: {
|
|
41672
|
+
code: string;
|
|
41673
|
+
message: string;
|
|
41674
|
+
/** @enum {string} */
|
|
41675
|
+
verdict: "review" | "reject";
|
|
41676
|
+
}[];
|
|
41677
|
+
};
|
|
41678
|
+
};
|
|
41679
|
+
};
|
|
41680
|
+
/** @description `CLI_DIST_UNAVAILABLE`: the install host's storage failed */
|
|
41681
|
+
502: {
|
|
41682
|
+
headers: {
|
|
41683
|
+
[name: string]: unknown;
|
|
41684
|
+
};
|
|
41685
|
+
content: {
|
|
41686
|
+
"application/json": {
|
|
41687
|
+
code?: string;
|
|
41688
|
+
error: string;
|
|
41689
|
+
issues?: {
|
|
41690
|
+
code: string;
|
|
41691
|
+
message: string;
|
|
41692
|
+
/** @enum {string} */
|
|
41693
|
+
verdict: "review" | "reject";
|
|
41694
|
+
}[];
|
|
41695
|
+
};
|
|
41696
|
+
};
|
|
41697
|
+
};
|
|
41698
|
+
/** @description `CLI_DIST_NOT_CONFIGURED`: this deployment has no `CLI_DIST` bucket or install host */
|
|
41699
|
+
503: {
|
|
41700
|
+
headers: {
|
|
41701
|
+
[name: string]: unknown;
|
|
41702
|
+
};
|
|
41703
|
+
content: {
|
|
41704
|
+
"application/json": {
|
|
41705
|
+
code?: string;
|
|
41706
|
+
error: string;
|
|
41707
|
+
issues?: {
|
|
41708
|
+
code: string;
|
|
41709
|
+
message: string;
|
|
41710
|
+
/** @enum {string} */
|
|
41711
|
+
verdict: "review" | "reject";
|
|
41712
|
+
}[];
|
|
41713
|
+
};
|
|
41714
|
+
};
|
|
41715
|
+
};
|
|
41716
|
+
};
|
|
41717
|
+
};
|
|
41718
|
+
delete?: never;
|
|
41719
|
+
options?: never;
|
|
41720
|
+
head?: never;
|
|
41721
|
+
patch?: never;
|
|
41722
|
+
trace?: never;
|
|
41723
|
+
};
|
|
40956
41724
|
"/v1/products/{productId}/surfaces/{surfaceId}/discovered-tools": {
|
|
40957
41725
|
parameters: {
|
|
40958
41726
|
query?: never;
|
|
@@ -41169,6 +41937,8 @@ interface paths {
|
|
|
41169
41937
|
authorization_servers: string[];
|
|
41170
41938
|
bearer_methods_supported: string[];
|
|
41171
41939
|
resource: string;
|
|
41940
|
+
resource_name?: string;
|
|
41941
|
+
scopes_supported?: string[];
|
|
41172
41942
|
};
|
|
41173
41943
|
};
|
|
41174
41944
|
};
|
|
@@ -45211,7 +45981,7 @@ interface paths {
|
|
|
45211
45981
|
put?: never;
|
|
45212
45982
|
/**
|
|
45213
45983
|
* Bulk edit records
|
|
45214
|
-
* @description Bulk update or delete metadata fields on multiple records.
|
|
45984
|
+
* @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.
|
|
45215
45985
|
*/
|
|
45216
45986
|
post: {
|
|
45217
45987
|
parameters: {
|
|
@@ -45291,13 +46061,13 @@ interface paths {
|
|
|
45291
46061
|
};
|
|
45292
46062
|
};
|
|
45293
46063
|
};
|
|
45294
|
-
/** @description Validation error */
|
|
46064
|
+
/** @description Validation error, or the edit targets more than 5,000 records (`bulk_edit_too_many_records`) */
|
|
45295
46065
|
400: {
|
|
45296
46066
|
headers: {
|
|
45297
46067
|
[name: string]: unknown;
|
|
45298
46068
|
};
|
|
45299
46069
|
content: {
|
|
45300
|
-
"application/json": components["schemas"]["
|
|
46070
|
+
"application/json": components["schemas"]["BulkEditError"];
|
|
45301
46071
|
};
|
|
45302
46072
|
};
|
|
45303
46073
|
/** @description Unauthorized */
|
|
@@ -53474,11 +54244,14 @@ interface paths {
|
|
|
53474
54244
|
};
|
|
53475
54245
|
/**
|
|
53476
54246
|
* List runs for a schedule
|
|
53477
|
-
* @description Returns the run history for a specific schedule, including batch execution summaries.
|
|
54247
|
+
* @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.
|
|
53478
54248
|
*/
|
|
53479
54249
|
get: {
|
|
53480
54250
|
parameters: {
|
|
53481
|
-
query?:
|
|
54251
|
+
query?: {
|
|
54252
|
+
limit?: string;
|
|
54253
|
+
cursor?: string;
|
|
54254
|
+
};
|
|
53482
54255
|
header?: never;
|
|
53483
54256
|
path: {
|
|
53484
54257
|
id: string;
|
|
@@ -53511,10 +54284,12 @@ interface paths {
|
|
|
53511
54284
|
status: string;
|
|
53512
54285
|
totalRecords: number | null;
|
|
53513
54286
|
}[];
|
|
54287
|
+
hasMore: boolean;
|
|
54288
|
+
nextCursor: string | null;
|
|
53514
54289
|
};
|
|
53515
54290
|
};
|
|
53516
54291
|
};
|
|
53517
|
-
/** @description Invalid ID format */
|
|
54292
|
+
/** @description Invalid ID format, limit, or cursor */
|
|
53518
54293
|
400: {
|
|
53519
54294
|
headers: {
|
|
53520
54295
|
[name: string]: unknown;
|
|
@@ -59883,12 +60658,19 @@ interface paths {
|
|
|
59883
60658
|
enableAgentSkills: boolean;
|
|
59884
60659
|
enableCanvasOnboarding: boolean;
|
|
59885
60660
|
enableChromeSurface: boolean;
|
|
60661
|
+
enableCliSurface?: boolean;
|
|
60662
|
+
enableCliSurfaceGraduation?: boolean;
|
|
60663
|
+
enableCliSurfacePublish?: boolean;
|
|
59886
60664
|
enableDashboardAssistant: boolean;
|
|
59887
60665
|
enableDecisionModelsDashboard: boolean;
|
|
59888
60666
|
enableDelegateToOtto?: boolean;
|
|
59889
60667
|
enableDelegateToRuntype?: boolean;
|
|
59890
60668
|
enableEndUserUsageAnalytics: boolean;
|
|
59891
60669
|
enableMassiveWebRender: boolean;
|
|
60670
|
+
enableMcpSurfaceCustomerIdp?: boolean;
|
|
60671
|
+
enableMcpSurfaceDeviceGrant?: boolean;
|
|
60672
|
+
enableMcpSurfaceOobApprovals?: boolean;
|
|
60673
|
+
enableMcpSurfaceSignIn?: boolean;
|
|
59892
60674
|
enableOnboardingIntentGate: boolean;
|
|
59893
60675
|
enableRuntown: boolean;
|
|
59894
60676
|
enableRuntypeApps: boolean;
|
|
@@ -61096,6 +61878,12 @@ interface components {
|
|
|
61096
61878
|
toolId: string;
|
|
61097
61879
|
toolName: string;
|
|
61098
61880
|
};
|
|
61881
|
+
BulkEditError: components["schemas"]["Error"] & {
|
|
61882
|
+
/** @description On `bulk_edit_too_many_records`: the most records one bulk edit can target (5000). */
|
|
61883
|
+
limit?: number;
|
|
61884
|
+
/** @description On `bulk_edit_too_many_records`: what was refused and how to narrow the edit. */
|
|
61885
|
+
message?: string;
|
|
61886
|
+
};
|
|
61099
61887
|
BusyMessageRouteReport: {
|
|
61100
61888
|
/** @description The decision model that answered. */
|
|
61101
61889
|
model?: string;
|
|
@@ -61198,6 +61986,78 @@ interface components {
|
|
|
61198
61986
|
/** @description ISO timestamp of the provider message. */
|
|
61199
61987
|
timestamp: string;
|
|
61200
61988
|
};
|
|
61989
|
+
CliGraduationGrant: {
|
|
61990
|
+
binName: string;
|
|
61991
|
+
/** @description Publish the version carrying the token before this */
|
|
61992
|
+
expiresAt: string;
|
|
61993
|
+
packageJson: {
|
|
61994
|
+
rtype: {
|
|
61995
|
+
graduationToken: string;
|
|
61996
|
+
surfaceId: string;
|
|
61997
|
+
};
|
|
61998
|
+
};
|
|
61999
|
+
packageName: string;
|
|
62000
|
+
surfaceId: string;
|
|
62001
|
+
token: string;
|
|
62002
|
+
};
|
|
62003
|
+
CliGraduationResult: {
|
|
62004
|
+
/** @description The `npm deprecate` a Runtype maintainer runs (it needs 2FA) */
|
|
62005
|
+
deprecation: {
|
|
62006
|
+
command: string;
|
|
62007
|
+
message: string;
|
|
62008
|
+
packageName: string;
|
|
62009
|
+
} | null;
|
|
62010
|
+
/** @description The final `@rtype/<binName>` release, forwarding to your package */
|
|
62011
|
+
forwarding: {
|
|
62012
|
+
commitSha: string | null;
|
|
62013
|
+
message: string;
|
|
62014
|
+
packageName: string;
|
|
62015
|
+
/** @enum {string} */
|
|
62016
|
+
state: "committed" | "unchanged" | "retried" | "not_published" | "skipped" | "not_configured" | "failed";
|
|
62017
|
+
version: string | null;
|
|
62018
|
+
};
|
|
62019
|
+
graduatedAt: string;
|
|
62020
|
+
/**
|
|
62021
|
+
* @description `retried`: already switched to this package, so only forwarding ran again
|
|
62022
|
+
* @enum {string}
|
|
62023
|
+
*/
|
|
62024
|
+
outcome: "graduated" | "retried";
|
|
62025
|
+
packageName: string;
|
|
62026
|
+
version: string;
|
|
62027
|
+
};
|
|
62028
|
+
CliInstallCommands: {
|
|
62029
|
+
/** @description The Windows install command: `irm <url>/install.ps1 | iex` */
|
|
62030
|
+
powershell: string;
|
|
62031
|
+
/** @description The macOS and Linux install command: `curl -fsSL <url> | sh` */
|
|
62032
|
+
sh: string;
|
|
62033
|
+
/** @description `GET` serves the POSIX install script, e.g. `https://get.runtype.com/<slug>` */
|
|
62034
|
+
url: string;
|
|
62035
|
+
} | null;
|
|
62036
|
+
CliPublishResult: {
|
|
62037
|
+
install: components["schemas"]["CliInstallCommands"];
|
|
62038
|
+
/**
|
|
62039
|
+
* @description `unchanged`: the files match the last publish, so the version stays; every file is still rewritten
|
|
62040
|
+
* @enum {string}
|
|
62041
|
+
*/
|
|
62042
|
+
outcome: "published" | "unchanged";
|
|
62043
|
+
publishedAt: string;
|
|
62044
|
+
slug: string;
|
|
62045
|
+
version: string;
|
|
62046
|
+
};
|
|
62047
|
+
CliPublishStatus: {
|
|
62048
|
+
install: components["schemas"]["CliInstallCommands"];
|
|
62049
|
+
/** @description When the files last changed */
|
|
62050
|
+
publishedAt: string | null;
|
|
62051
|
+
/** @description The install slug, which is the surface's command name; null while it has none */
|
|
62052
|
+
slug: string | null;
|
|
62053
|
+
/**
|
|
62054
|
+
* @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.
|
|
62055
|
+
* @enum {string}
|
|
62056
|
+
*/
|
|
62057
|
+
state: "not_published" | "published";
|
|
62058
|
+
/** @description The version in the published `cli.json` */
|
|
62059
|
+
version: string | null;
|
|
62060
|
+
};
|
|
61201
62061
|
ClientInputDeliveryReceipt: {
|
|
61202
62062
|
deliveryId: string;
|
|
61203
62063
|
executionId: string;
|
|
@@ -63834,7 +64694,7 @@ interface components {
|
|
|
63834
64694
|
[key: string]: unknown;
|
|
63835
64695
|
};
|
|
63836
64696
|
/** @enum {string} */
|
|
63837
|
-
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";
|
|
64697
|
+
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";
|
|
63838
64698
|
/** @description JSON Schema for the occurrence `data` */
|
|
63839
64699
|
payloadSchema: {
|
|
63840
64700
|
[key: string]: unknown;
|
|
@@ -63859,7 +64719,7 @@ interface components {
|
|
|
63859
64719
|
/** @description Occurrence id (typeid, `pev_` prefix) */
|
|
63860
64720
|
eventId: string;
|
|
63861
64721
|
/** @enum {string} */
|
|
63862
|
-
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";
|
|
64722
|
+
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";
|
|
63863
64723
|
/** @description When it happened (ISO 8601) */
|
|
63864
64724
|
timestamp: string;
|
|
63865
64725
|
};
|
|
@@ -63888,6 +64748,10 @@ interface components {
|
|
|
63888
64748
|
ref: string;
|
|
63889
64749
|
/** @enum {string} */
|
|
63890
64750
|
result: "created" | "updated" | "unchanged" | "failed" | "skipped" | "pruned";
|
|
64751
|
+
/** @description Surface apply only: the signed-in sessions an identity provider or issuer change ended. */
|
|
64752
|
+
sessionsSignedOut?: number;
|
|
64753
|
+
/** @description Surface dryRun only: applying it changes the identity provider or issuer and signs out every session. */
|
|
64754
|
+
signsOutSessions?: boolean;
|
|
63891
64755
|
/** @description Non-blocking advisories, e.g. SCHEDULE_AGENT_CONFIG_UNSUPPORTED when converging an agent moved `live` onto a version its active schedules cannot run. */
|
|
63892
64756
|
warnings?: string[];
|
|
63893
64757
|
}[];
|
|
@@ -65248,6 +66112,8 @@ interface components {
|
|
|
65248
66112
|
contentHash: string;
|
|
65249
66113
|
/** @enum {string} */
|
|
65250
66114
|
result: "unchanged" | "created" | "updated";
|
|
66115
|
+
/** @description Present when the update changed the identity provider or issuer: the number of signed-in sessions it ended. */
|
|
66116
|
+
sessionsSignedOut?: number;
|
|
65251
66117
|
surfaceId: string;
|
|
65252
66118
|
} | {
|
|
65253
66119
|
/** @enum {string} */
|
|
@@ -65260,6 +66126,8 @@ interface components {
|
|
|
65260
66126
|
remoteHash?: string;
|
|
65261
66127
|
/** @enum {string} */
|
|
65262
66128
|
result: "plan";
|
|
66129
|
+
/** @description True when applying this plan changes the identity provider or issuer and signs out every session. */
|
|
66130
|
+
signsOutSessions?: boolean;
|
|
65263
66131
|
surfaceId?: string;
|
|
65264
66132
|
};
|
|
65265
66133
|
SurfacePullResponse: {
|
|
@@ -65282,12 +66150,29 @@ interface components {
|
|
|
65282
66150
|
/** @enum {string} */
|
|
65283
66151
|
status?: "draft" | "active" | "paused";
|
|
65284
66152
|
/** @enum {string} */
|
|
65285
|
-
type: "chat" | "mcp" | "mcp_code" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
66153
|
+
type: "chat" | "mcp" | "mcp_code" | "cli" | "api" | "webhook" | "schedule" | "a2a" | "email" | "slack" | "sms" | "imessage" | "discord" | "whatsapp" | "telegram" | "hosted-page" | "chrome_extension";
|
|
65286
66154
|
};
|
|
65287
66155
|
lastModifiedSource: string | null;
|
|
65288
66156
|
surfaceId: string;
|
|
65289
66157
|
updatedAt: string | null;
|
|
65290
66158
|
};
|
|
66159
|
+
SurfaceSession: {
|
|
66160
|
+
/** @description The MCP client the user authorized. */
|
|
66161
|
+
clientId: string;
|
|
66162
|
+
/** Format: date-time */
|
|
66163
|
+
createdAt: string;
|
|
66164
|
+
email: string;
|
|
66165
|
+
endUserCredentialId: string;
|
|
66166
|
+
/**
|
|
66167
|
+
* Format: date-time
|
|
66168
|
+
* @description When the current refresh token expires.
|
|
66169
|
+
*/
|
|
66170
|
+
expiresAt: string;
|
|
66171
|
+
/** Format: date-time */
|
|
66172
|
+
lastRefreshedAt: string;
|
|
66173
|
+
/** @description The refresh-token family; revoking it ends the session. */
|
|
66174
|
+
sessionId: string;
|
|
66175
|
+
};
|
|
65291
66176
|
TokenAudiencePolicy: {
|
|
65292
66177
|
agentId: string;
|
|
65293
66178
|
entries: components["schemas"]["TokenAudiencePolicyEntry"][];
|
|
@@ -69268,6 +70153,16 @@ export interface ScheduleRunNowResponse {
|
|
|
69268
70153
|
* Generated from the OpenAPI spec — GET /v1/schedules/{id}/runs list item.
|
|
69269
70154
|
*/
|
|
69270
70155
|
export type ScheduleRun = paths['/v1/schedules/{id}/runs']['get']['responses'][200]['content']['application/json']['data'][number];
|
|
70156
|
+
/**
|
|
70157
|
+
* One response from a schedule's run history: the runs, whether older runs remain, and the cursor to read them.
|
|
70158
|
+
* Generated from the OpenAPI spec — GET /v1/schedules/{id}/runs.
|
|
70159
|
+
*/
|
|
70160
|
+
export type ScheduleRunsPage = paths['/v1/schedules/{id}/runs']['get']['responses'][200]['content']['application/json'];
|
|
70161
|
+
/** Paging for a schedule's run history. Omit both to read every run; `limit` is at most 500. */
|
|
70162
|
+
export interface ScheduleRunsListParams {
|
|
70163
|
+
limit?: number;
|
|
70164
|
+
cursor?: string;
|
|
70165
|
+
}
|
|
69271
70166
|
export interface ScheduleListParams extends ListParams {
|
|
69272
70167
|
search?: string;
|
|
69273
70168
|
status?: 'active' | 'paused';
|
|
@@ -70941,7 +71836,8 @@ export declare class RecordsEndpoint {
|
|
|
70941
71836
|
notFoundIds?: string[];
|
|
70942
71837
|
}>;
|
|
70943
71838
|
/**
|
|
70944
|
-
* Bulk edit multiple records
|
|
71839
|
+
* Bulk edit multiple records. At most 5,000 targets per call, dry runs included; a larger set
|
|
71840
|
+
* returns 400 `bulk_edit_too_many_records`, so narrow the filter and edit in batches.
|
|
70945
71841
|
*/
|
|
70946
71842
|
bulkEdit(data: BulkEditRequest): Promise<BulkEditResponse>;
|
|
70947
71843
|
/**
|
|
@@ -73522,11 +74418,10 @@ export declare class SchedulesEndpoint {
|
|
|
73522
74418
|
*/
|
|
73523
74419
|
resume(id: string): Promise<ScheduleStatusResponse>;
|
|
73524
74420
|
/**
|
|
73525
|
-
* List the run history for a specific schedule.
|
|
74421
|
+
* List the run history for a specific schedule, newest first. Without `params` it returns every run.
|
|
74422
|
+
* Pass `limit` (at most 500) to page, then pass `nextCursor` as `cursor` while `hasMore` is true.
|
|
73526
74423
|
*/
|
|
73527
|
-
listRuns(id: string): Promise<
|
|
73528
|
-
data: ScheduleRun[];
|
|
73529
|
-
}>;
|
|
74424
|
+
listRuns(id: string, params?: ScheduleRunsListParams): Promise<ScheduleRunsPage>;
|
|
73530
74425
|
/**
|
|
73531
74426
|
* Get statistics (success rate, average duration/cost, 7-day history) for a schedule.
|
|
73532
74427
|
*/
|
|
@@ -78080,7 +78975,7 @@ interface SurfaceContentInput {
|
|
|
78080
78975
|
status?: string | null;
|
|
78081
78976
|
}
|
|
78082
78977
|
/** The surface types `ensure` accepts (mirrors the server's createSurfaceSchema). */
|
|
78083
|
-
type SurfaceDefinitionType = 'chat' | 'mcp' | 'mcp_code' | 'api' | 'webhook' | 'schedule' | 'a2a' | 'email' | 'slack' | 'sms' | 'imessage' | 'discord' | 'whatsapp' | 'telegram' | 'hosted-page' | 'chrome_extension';
|
|
78978
|
+
type SurfaceDefinitionType = 'chat' | 'mcp' | 'mcp_code' | 'cli' | 'api' | 'webhook' | 'schedule' | 'a2a' | 'email' | 'slack' | 'sms' | 'imessage' | 'discord' | 'whatsapp' | 'telegram' | 'hosted-page' | 'chrome_extension';
|
|
78084
78979
|
type SurfaceDefinitionStatus = 'draft' | 'active' | 'paused';
|
|
78085
78980
|
/** `defineSurface` input: identity (name) + the convergeable content fields. */
|
|
78086
78981
|
interface DefineSurfaceInput {
|
|
@@ -78142,6 +79037,8 @@ interface EnsureSurfaceConverged {
|
|
|
78142
79037
|
surfaceId: string;
|
|
78143
79038
|
/** The server-computed canonical hash (echo this — never your own). */
|
|
78144
79039
|
contentHash: string;
|
|
79040
|
+
/** Present when the update changed the identity provider or issuer: the signed-in sessions it ended. */
|
|
79041
|
+
sessionsSignedOut?: number;
|
|
78145
79042
|
}
|
|
78146
79043
|
interface EnsureSurfacePlan {
|
|
78147
79044
|
result: 'plan';
|
|
@@ -78150,6 +79047,8 @@ interface EnsureSurfacePlan {
|
|
|
78150
79047
|
contentHash: string;
|
|
78151
79048
|
remoteHash?: string;
|
|
78152
79049
|
surfaceId?: string;
|
|
79050
|
+
/** True when applying this plan changes the identity provider or issuer and signs out every session. */
|
|
79051
|
+
signsOutSessions?: boolean;
|
|
78153
79052
|
}
|
|
78154
79053
|
type EnsureSurfaceResult = EnsureSurfaceConverged | EnsureSurfacePlan;
|
|
78155
79054
|
interface SurfacePullResult {
|