@runtypelabs/sdk 11.17.0 → 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.d.cts 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: {
@@ -32878,6 +32878,8 @@ interface paths {
32878
32878
  supportsCustomKey?: boolean;
32879
32879
  supportsSearch?: boolean;
32880
32880
  supportsStreaming?: boolean;
32881
+ /** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
32882
+ supportsToolUse?: boolean;
32881
32883
  updatedAt: string;
32882
32884
  /** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
32883
32885
  userId: string | null;
@@ -33052,6 +33054,8 @@ interface paths {
33052
33054
  supportsCustomKey?: boolean;
33053
33055
  supportsSearch?: boolean;
33054
33056
  supportsStreaming?: boolean;
33057
+ /** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
33058
+ supportsToolUse?: boolean;
33055
33059
  updatedAt: string;
33056
33060
  /** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
33057
33061
  userId: string | null;
@@ -33756,6 +33760,8 @@ interface paths {
33756
33760
  supportsCustomKey?: boolean;
33757
33761
  supportsSearch?: boolean;
33758
33762
  supportsStreaming?: boolean;
33763
+ /** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
33764
+ supportsToolUse?: boolean;
33759
33765
  updatedAt: string;
33760
33766
  /** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
33761
33767
  userId: string | null;
@@ -34035,6 +34041,8 @@ interface paths {
34035
34041
  supportsCustomKey?: boolean;
34036
34042
  supportsSearch?: boolean;
34037
34043
  supportsStreaming?: boolean;
34044
+ /** @description True when the model catalog lists the model as supporting tool calls; absent otherwise. */
34045
+ supportsToolUse?: boolean;
34038
34046
  updatedAt: string;
34039
34047
  /** @description Legacy actor owner for personal/compatibility rows. Null for organization-owned model configurations. */
34040
34048
  userId: string | null;
@@ -34487,6 +34495,7 @@ interface paths {
34487
34495
  limit?: string;
34488
34496
  cursor?: string;
34489
34497
  search?: string;
34498
+ sort?: "activity" | "name";
34490
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 `…`. */
34491
34500
  view?: "full" | "compact";
34492
34501
  };
@@ -34864,7 +34873,7 @@ interface paths {
34864
34873
  "application/json": components["schemas"]["Error"];
34865
34874
  };
34866
34875
  };
34867
- /** @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`) */
34868
34877
  403: {
34869
34878
  headers: {
34870
34879
  [name: string]: unknown;
@@ -37408,7 +37417,7 @@ interface paths {
37408
37417
  /** @enum {string} */
37409
37418
  status?: "draft" | "active" | "paused";
37410
37419
  /** @enum {string} */
37411
- 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";
37412
37421
  };
37413
37422
  };
37414
37423
  };
@@ -37466,7 +37475,7 @@ interface paths {
37466
37475
  "application/json": components["schemas"]["Error"];
37467
37476
  };
37468
37477
  };
37469
- /** @description Insufficient permissions */
37478
+ /** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
37470
37479
  403: {
37471
37480
  headers: {
37472
37481
  [name: string]: unknown;
@@ -37545,7 +37554,7 @@ interface paths {
37545
37554
  /** @enum {string} */
37546
37555
  status?: "draft" | "active" | "paused";
37547
37556
  /** @enum {string} */
37548
- 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";
37549
37558
  };
37550
37559
  dryRun?: boolean;
37551
37560
  expectedRemoteHash?: string;
@@ -37583,7 +37592,7 @@ interface paths {
37583
37592
  "application/json": components["schemas"]["Error"];
37584
37593
  };
37585
37594
  };
37586
- /** @description Insufficient permissions */
37595
+ /** @description Insufficient permissions, or `CLI_SURFACE_DISABLED`: a `cli` surface while CLI surfaces are not enabled for the account */
37587
37596
  403: {
37588
37597
  headers: {
37589
37598
  [name: string]: unknown;
@@ -39729,7 +39738,7 @@ interface paths {
39729
39738
  patch?: never;
39730
39739
  trace?: never;
39731
39740
  };
39732
- "/v1/products/{id}/surfaces/{surfaceId}/setup": {
39741
+ "/v1/products/{id}/surfaces/{surfaceId}/sessions": {
39733
39742
  parameters: {
39734
39743
  query?: never;
39735
39744
  header?: never;
@@ -39737,12 +39746,17 @@ interface paths {
39737
39746
  cookie?: never;
39738
39747
  };
39739
39748
  /**
39740
- * Get surface setup readiness
39741
- * @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.
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.
39742
39751
  */
39743
39752
  get: {
39744
39753
  parameters: {
39745
- query?: never;
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
+ };
39746
39760
  header?: never;
39747
39761
  path: {
39748
39762
  id: string;
@@ -39752,93 +39766,20 @@ interface paths {
39752
39766
  };
39753
39767
  requestBody?: never;
39754
39768
  responses: {
39755
- /** @description Surface setup readiness */
39769
+ /** @description Live sessions, newest first */
39756
39770
  200: {
39757
39771
  headers: {
39758
39772
  [name: string]: unknown;
39759
39773
  };
39760
39774
  content: {
39761
39775
  "application/json": {
39762
- name: string;
39763
- pendingCount: number;
39764
- /** @enum {string} */
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;
39776
+ data: components["schemas"]["SurfaceSession"][];
39777
+ /** @description Pass as `cursor` to read the next page; null on the last page. */
39778
+ nextCursor: string | null;
39838
39779
  };
39839
39780
  };
39840
39781
  };
39841
- /** @description Invalid product ID */
39782
+ /** @description Invalid ID */
39842
39783
  400: {
39843
39784
  headers: {
39844
39785
  [name: string]: unknown;
@@ -39856,7 +39797,16 @@ interface paths {
39856
39797
  "application/json": components["schemas"]["Error"];
39857
39798
  };
39858
39799
  };
39859
- /** @description Product or surface not found */
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 */
39860
39810
  404: {
39861
39811
  headers: {
39862
39812
  [name: string]: unknown;
@@ -39884,7 +39834,7 @@ interface paths {
39884
39834
  patch?: never;
39885
39835
  trace?: never;
39886
39836
  };
39887
- "/v1/products/{id}/surfaces/{surfaceId}/webhook-infer": {
39837
+ "/v1/products/{id}/surfaces/{surfaceId}/sessions/{sessionId}": {
39888
39838
  parameters: {
39889
39839
  query?: never;
39890
39840
  header?: never;
@@ -39893,45 +39843,36 @@ interface paths {
39893
39843
  };
39894
39844
  get?: never;
39895
39845
  put?: never;
39846
+ post?: never;
39896
39847
  /**
39897
- * Infer schema from JSON payload
39898
- * @description Infer a webhook schema from a pasted JSON payload.
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.
39899
39850
  */
39900
- post: {
39851
+ delete: {
39901
39852
  parameters: {
39902
39853
  query?: never;
39903
39854
  header?: never;
39904
39855
  path: {
39905
- /** @description Product ID */
39906
39856
  id: string;
39907
- /** @description Surface ID */
39908
39857
  surfaceId: string;
39858
+ sessionId: string;
39909
39859
  };
39910
39860
  cookie?: never;
39911
39861
  };
39912
- requestBody: {
39913
- content: {
39914
- "application/json": {
39915
- payload?: unknown;
39916
- };
39917
- };
39918
- };
39862
+ requestBody?: never;
39919
39863
  responses: {
39920
- /** @description Schema inferred */
39864
+ /** @description Session revoked */
39921
39865
  200: {
39922
39866
  headers: {
39923
39867
  [name: string]: unknown;
39924
39868
  };
39925
39869
  content: {
39926
39870
  "application/json": {
39927
- jsonSchema?: unknown;
39928
- learningState: string;
39929
- mappingSuggestions: unknown[];
39930
- schema?: unknown;
39871
+ success: boolean;
39931
39872
  };
39932
39873
  };
39933
39874
  };
39934
- /** @description Invalid request */
39875
+ /** @description Invalid ID */
39935
39876
  400: {
39936
39877
  headers: {
39937
39878
  [name: string]: unknown;
@@ -39949,7 +39890,16 @@ interface paths {
39949
39890
  "application/json": components["schemas"]["Error"];
39950
39891
  };
39951
39892
  };
39952
- /** @description Not found */
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 */
39953
39903
  404: {
39954
39904
  headers: {
39955
39905
  [name: string]: unknown;
@@ -39969,58 +39919,121 @@ interface paths {
39969
39919
  };
39970
39920
  };
39971
39921
  };
39972
- delete?: never;
39973
39922
  options?: never;
39974
39923
  head?: never;
39975
39924
  patch?: never;
39976
39925
  trace?: never;
39977
39926
  };
39978
- "/v1/products/{id}/surfaces/{surfaceId}/webhook-learning": {
39927
+ "/v1/products/{id}/surfaces/{surfaceId}/setup": {
39979
39928
  parameters: {
39980
39929
  query?: never;
39981
39930
  header?: never;
39982
39931
  path?: never;
39983
39932
  cookie?: never;
39984
39933
  };
39985
- get?: never;
39986
- put?: never;
39987
39934
  /**
39988
- * Toggle webhook learning mode
39989
- * @description Enable or disable learning mode for a webhook surface.
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.
39990
39937
  */
39991
- post: {
39938
+ get: {
39992
39939
  parameters: {
39993
39940
  query?: never;
39994
39941
  header?: never;
39995
39942
  path: {
39996
- /** @description Product ID */
39997
39943
  id: string;
39998
- /** @description Surface ID */
39999
39944
  surfaceId: string;
40000
39945
  };
40001
39946
  cookie?: never;
40002
39947
  };
40003
- requestBody: {
40004
- content: {
40005
- "application/json": {
40006
- enabled: boolean;
40007
- };
40008
- };
40009
- };
39948
+ requestBody?: never;
40010
39949
  responses: {
40011
- /** @description Learning mode toggled */
39950
+ /** @description Surface setup readiness */
40012
39951
  200: {
40013
39952
  headers: {
40014
39953
  [name: string]: unknown;
40015
39954
  };
40016
39955
  content: {
40017
39956
  "application/json": {
40018
- learningState: string;
40019
- observationCount: number;
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;
40020
40033
  };
40021
40034
  };
40022
40035
  };
40023
- /** @description Invalid request */
40036
+ /** @description Invalid product ID */
40024
40037
  400: {
40025
40038
  headers: {
40026
40039
  [name: string]: unknown;
@@ -40038,7 +40051,7 @@ interface paths {
40038
40051
  "application/json": components["schemas"]["Error"];
40039
40052
  };
40040
40053
  };
40041
- /** @description Not found */
40054
+ /** @description Product or surface not found */
40042
40055
  404: {
40043
40056
  headers: {
40044
40057
  [name: string]: unknown;
@@ -40058,24 +40071,28 @@ interface paths {
40058
40071
  };
40059
40072
  };
40060
40073
  };
40074
+ put?: never;
40075
+ post?: never;
40061
40076
  delete?: never;
40062
40077
  options?: never;
40063
40078
  head?: never;
40064
40079
  patch?: never;
40065
40080
  trace?: never;
40066
40081
  };
40067
- "/v1/products/{id}/surfaces/{surfaceId}/webhook-mappings": {
40082
+ "/v1/products/{id}/surfaces/{surfaceId}/webhook-infer": {
40068
40083
  parameters: {
40069
40084
  query?: never;
40070
40085
  header?: never;
40071
40086
  path?: never;
40072
40087
  cookie?: never;
40073
40088
  };
40089
+ get?: never;
40090
+ put?: never;
40074
40091
  /**
40075
- * Get webhook field mappings
40076
- * @description Get field mappings for all surface items on a webhook surface.
40092
+ * Infer schema from JSON payload
40093
+ * @description Infer a webhook schema from a pasted JSON payload.
40077
40094
  */
40078
- get: {
40095
+ post: {
40079
40096
  parameters: {
40080
40097
  query?: never;
40081
40098
  header?: never;
@@ -40087,35 +40104,30 @@ interface paths {
40087
40104
  };
40088
40105
  cookie?: never;
40089
40106
  };
40090
- requestBody?: never;
40107
+ requestBody: {
40108
+ content: {
40109
+ "application/json": {
40110
+ payload?: unknown;
40111
+ };
40112
+ };
40113
+ };
40091
40114
  responses: {
40092
- /** @description Mappings returned */
40115
+ /** @description Schema inferred */
40093
40116
  200: {
40094
40117
  headers: {
40095
40118
  [name: string]: unknown;
40096
40119
  };
40097
40120
  content: {
40098
40121
  "application/json": {
40099
- items: {
40100
- capabilityId: string;
40101
- exposedName: string | null;
40102
- fieldMappings: unknown[];
40103
- id: string;
40104
- }[];
40122
+ jsonSchema?: unknown;
40123
+ learningState: string;
40124
+ mappingSuggestions: unknown[];
40125
+ schema?: unknown;
40105
40126
  };
40106
40127
  };
40107
40128
  };
40108
- /** @description Unauthorized */
40109
- 401: {
40110
- headers: {
40111
- [name: string]: unknown;
40112
- };
40113
- content: {
40114
- "application/json": components["schemas"]["Error"];
40115
- };
40116
- };
40117
- /** @description Not found */
40118
- 404: {
40129
+ /** @description Invalid request */
40130
+ 400: {
40119
40131
  headers: {
40120
40132
  [name: string]: unknown;
40121
40133
  };
@@ -40123,52 +40135,235 @@ interface paths {
40123
40135
  "application/json": components["schemas"]["Error"];
40124
40136
  };
40125
40137
  };
40126
- };
40127
- };
40128
- /**
40129
- * Update webhook field mappings
40130
- * @description Update field mappings for a specific surface item.
40131
- */
40132
- put: {
40133
- parameters: {
40134
- query?: never;
40135
- header?: never;
40136
- path: {
40137
- /** @description Product ID */
40138
- id: string;
40139
- /** @description Surface ID */
40140
- surfaceId: string;
40141
- };
40142
- cookie?: never;
40143
- };
40144
- requestBody: {
40145
- content: {
40146
- "application/json": {
40147
- itemId: string;
40148
- mappings: {
40149
- defaultValue?: unknown;
40150
- source: string;
40151
- target: string;
40152
- transform?: string;
40153
- /** @enum {string} */
40154
- type?: "string" | "number" | "boolean" | "json";
40155
- }[];
40156
- };
40157
- };
40158
- };
40159
- responses: {
40160
- /** @description Mappings updated */
40161
- 200: {
40162
- headers: {
40163
- [name: string]: unknown;
40164
- };
40165
- content: {
40166
- "application/json": {
40167
- fieldMappings: unknown[];
40168
- id: string;
40169
- };
40170
- };
40171
- };
40138
+ /** @description Unauthorized */
40139
+ 401: {
40140
+ headers: {
40141
+ [name: string]: unknown;
40142
+ };
40143
+ content: {
40144
+ "application/json": components["schemas"]["Error"];
40145
+ };
40146
+ };
40147
+ /** @description Not found */
40148
+ 404: {
40149
+ headers: {
40150
+ [name: string]: unknown;
40151
+ };
40152
+ content: {
40153
+ "application/json": components["schemas"]["Error"];
40154
+ };
40155
+ };
40156
+ /** @description Internal server error */
40157
+ 500: {
40158
+ headers: {
40159
+ [name: string]: unknown;
40160
+ };
40161
+ content: {
40162
+ "application/json": components["schemas"]["Error"];
40163
+ };
40164
+ };
40165
+ };
40166
+ };
40167
+ delete?: never;
40168
+ options?: never;
40169
+ head?: never;
40170
+ patch?: never;
40171
+ trace?: never;
40172
+ };
40173
+ "/v1/products/{id}/surfaces/{surfaceId}/webhook-learning": {
40174
+ parameters: {
40175
+ query?: never;
40176
+ header?: never;
40177
+ path?: never;
40178
+ cookie?: never;
40179
+ };
40180
+ get?: never;
40181
+ put?: never;
40182
+ /**
40183
+ * Toggle webhook learning mode
40184
+ * @description Enable or disable learning mode for a webhook surface.
40185
+ */
40186
+ post: {
40187
+ parameters: {
40188
+ query?: never;
40189
+ header?: never;
40190
+ path: {
40191
+ /** @description Product ID */
40192
+ id: string;
40193
+ /** @description Surface ID */
40194
+ surfaceId: string;
40195
+ };
40196
+ cookie?: never;
40197
+ };
40198
+ requestBody: {
40199
+ content: {
40200
+ "application/json": {
40201
+ enabled: boolean;
40202
+ };
40203
+ };
40204
+ };
40205
+ responses: {
40206
+ /** @description Learning mode toggled */
40207
+ 200: {
40208
+ headers: {
40209
+ [name: string]: unknown;
40210
+ };
40211
+ content: {
40212
+ "application/json": {
40213
+ learningState: string;
40214
+ observationCount: number;
40215
+ };
40216
+ };
40217
+ };
40218
+ /** @description Invalid request */
40219
+ 400: {
40220
+ headers: {
40221
+ [name: string]: unknown;
40222
+ };
40223
+ content: {
40224
+ "application/json": components["schemas"]["Error"];
40225
+ };
40226
+ };
40227
+ /** @description Unauthorized */
40228
+ 401: {
40229
+ headers: {
40230
+ [name: string]: unknown;
40231
+ };
40232
+ content: {
40233
+ "application/json": components["schemas"]["Error"];
40234
+ };
40235
+ };
40236
+ /** @description Not found */
40237
+ 404: {
40238
+ headers: {
40239
+ [name: string]: unknown;
40240
+ };
40241
+ content: {
40242
+ "application/json": components["schemas"]["Error"];
40243
+ };
40244
+ };
40245
+ /** @description Internal server error */
40246
+ 500: {
40247
+ headers: {
40248
+ [name: string]: unknown;
40249
+ };
40250
+ content: {
40251
+ "application/json": components["schemas"]["Error"];
40252
+ };
40253
+ };
40254
+ };
40255
+ };
40256
+ delete?: never;
40257
+ options?: never;
40258
+ head?: never;
40259
+ patch?: never;
40260
+ trace?: never;
40261
+ };
40262
+ "/v1/products/{id}/surfaces/{surfaceId}/webhook-mappings": {
40263
+ parameters: {
40264
+ query?: never;
40265
+ header?: never;
40266
+ path?: never;
40267
+ cookie?: never;
40268
+ };
40269
+ /**
40270
+ * Get webhook field mappings
40271
+ * @description Get field mappings for all surface items on a webhook surface.
40272
+ */
40273
+ get: {
40274
+ parameters: {
40275
+ query?: never;
40276
+ header?: never;
40277
+ path: {
40278
+ /** @description Product ID */
40279
+ id: string;
40280
+ /** @description Surface ID */
40281
+ surfaceId: string;
40282
+ };
40283
+ cookie?: never;
40284
+ };
40285
+ requestBody?: never;
40286
+ responses: {
40287
+ /** @description Mappings returned */
40288
+ 200: {
40289
+ headers: {
40290
+ [name: string]: unknown;
40291
+ };
40292
+ content: {
40293
+ "application/json": {
40294
+ items: {
40295
+ capabilityId: string;
40296
+ exposedName: string | null;
40297
+ fieldMappings: unknown[];
40298
+ id: string;
40299
+ }[];
40300
+ };
40301
+ };
40302
+ };
40303
+ /** @description Unauthorized */
40304
+ 401: {
40305
+ headers: {
40306
+ [name: string]: unknown;
40307
+ };
40308
+ content: {
40309
+ "application/json": components["schemas"]["Error"];
40310
+ };
40311
+ };
40312
+ /** @description Not found */
40313
+ 404: {
40314
+ headers: {
40315
+ [name: string]: unknown;
40316
+ };
40317
+ content: {
40318
+ "application/json": components["schemas"]["Error"];
40319
+ };
40320
+ };
40321
+ };
40322
+ };
40323
+ /**
40324
+ * Update webhook field mappings
40325
+ * @description Update field mappings for a specific surface item.
40326
+ */
40327
+ put: {
40328
+ parameters: {
40329
+ query?: never;
40330
+ header?: never;
40331
+ path: {
40332
+ /** @description Product ID */
40333
+ id: string;
40334
+ /** @description Surface ID */
40335
+ surfaceId: string;
40336
+ };
40337
+ cookie?: never;
40338
+ };
40339
+ requestBody: {
40340
+ content: {
40341
+ "application/json": {
40342
+ itemId: string;
40343
+ mappings: {
40344
+ defaultValue?: unknown;
40345
+ source: string;
40346
+ target: string;
40347
+ transform?: string;
40348
+ /** @enum {string} */
40349
+ type?: "string" | "number" | "boolean" | "json";
40350
+ }[];
40351
+ };
40352
+ };
40353
+ };
40354
+ responses: {
40355
+ /** @description Mappings updated */
40356
+ 200: {
40357
+ headers: {
40358
+ [name: string]: unknown;
40359
+ };
40360
+ content: {
40361
+ "application/json": {
40362
+ fieldMappings: unknown[];
40363
+ id: string;
40364
+ };
40365
+ };
40366
+ };
40172
40367
  /** @description Unauthorized */
40173
40368
  401: {
40174
40369
  headers: {
@@ -40953,6 +41148,568 @@ interface paths {
40953
41148
  patch?: never;
40954
41149
  trace?: never;
40955
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
+ };
40956
41713
  "/v1/products/{productId}/surfaces/{surfaceId}/discovered-tools": {
40957
41714
  parameters: {
40958
41715
  query?: never;
@@ -41169,6 +41926,8 @@ interface paths {
41169
41926
  authorization_servers: string[];
41170
41927
  bearer_methods_supported: string[];
41171
41928
  resource: string;
41929
+ resource_name?: string;
41930
+ scopes_supported?: string[];
41172
41931
  };
41173
41932
  };
41174
41933
  };
@@ -59883,12 +60642,19 @@ interface paths {
59883
60642
  enableAgentSkills: boolean;
59884
60643
  enableCanvasOnboarding: boolean;
59885
60644
  enableChromeSurface: boolean;
60645
+ enableCliSurface?: boolean;
60646
+ enableCliSurfaceGraduation?: boolean;
60647
+ enableCliSurfacePublish?: boolean;
59886
60648
  enableDashboardAssistant: boolean;
59887
60649
  enableDecisionModelsDashboard: boolean;
59888
60650
  enableDelegateToOtto?: boolean;
59889
60651
  enableDelegateToRuntype?: boolean;
59890
60652
  enableEndUserUsageAnalytics: boolean;
59891
60653
  enableMassiveWebRender: boolean;
60654
+ enableMcpSurfaceCustomerIdp?: boolean;
60655
+ enableMcpSurfaceDeviceGrant?: boolean;
60656
+ enableMcpSurfaceOobApprovals?: boolean;
60657
+ enableMcpSurfaceSignIn?: boolean;
59892
60658
  enableOnboardingIntentGate: boolean;
59893
60659
  enableRuntown: boolean;
59894
60660
  enableRuntypeApps: boolean;
@@ -61198,6 +61964,73 @@ interface components {
61198
61964
  /** @description ISO timestamp of the provider message. */
61199
61965
  timestamp: string;
61200
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
+ };
61201
62034
  ClientInputDeliveryReceipt: {
61202
62035
  deliveryId: string;
61203
62036
  executionId: string;
@@ -65282,12 +66115,29 @@ interface components {
65282
66115
  /** @enum {string} */
65283
66116
  status?: "draft" | "active" | "paused";
65284
66117
  /** @enum {string} */
65285
- 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";
65286
66119
  };
65287
66120
  lastModifiedSource: string | null;
65288
66121
  surfaceId: string;
65289
66122
  updatedAt: string | null;
65290
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
+ };
65291
66141
  TokenAudiencePolicy: {
65292
66142
  agentId: string;
65293
66143
  entries: components["schemas"]["TokenAudiencePolicyEntry"][];
@@ -78080,7 +78930,7 @@ interface SurfaceContentInput {
78080
78930
  status?: string | null;
78081
78931
  }
78082
78932
  /** 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';
78933
+ type SurfaceDefinitionType = 'chat' | 'mcp' | 'mcp_code' | 'cli' | 'api' | 'webhook' | 'schedule' | 'a2a' | 'email' | 'slack' | 'sms' | 'imessage' | 'discord' | 'whatsapp' | 'telegram' | 'hosted-page' | 'chrome_extension';
78084
78934
  type SurfaceDefinitionStatus = 'draft' | 'active' | 'paused';
78085
78935
  /** `defineSurface` input: identity (name) + the convergeable content fields. */
78086
78936
  interface DefineSurfaceInput {