@opencode-ai/sdk 1.0.134 → 1.0.137
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/client.d.ts +1 -1
- package/dist/client.js +7 -6
- package/dist/gen/sdk.gen.d.ts +32 -7
- package/dist/gen/sdk.gen.js +74 -15
- package/dist/gen/types.gen.d.ts +184 -1
- package/dist/v2/client.d.ts +7 -0
- package/dist/v2/client.js +25 -0
- package/dist/v2/gen/client/client.gen.d.ts +2 -0
- package/dist/v2/gen/client/client.gen.js +225 -0
- package/dist/v2/gen/client/index.d.ts +8 -0
- package/dist/v2/gen/client/index.js +6 -0
- package/dist/v2/gen/client/types.gen.d.ts +117 -0
- package/dist/v2/gen/client/types.gen.js +2 -0
- package/dist/v2/gen/client/utils.gen.d.ts +33 -0
- package/dist/v2/gen/client/utils.gen.js +226 -0
- package/dist/v2/gen/client.gen.d.ts +12 -0
- package/dist/v2/gen/client.gen.js +3 -0
- package/dist/v2/gen/core/auth.gen.d.ts +18 -0
- package/dist/v2/gen/core/auth.gen.js +14 -0
- package/dist/v2/gen/core/bodySerializer.gen.d.ts +25 -0
- package/dist/v2/gen/core/bodySerializer.gen.js +57 -0
- package/dist/v2/gen/core/params.gen.d.ts +43 -0
- package/dist/v2/gen/core/params.gen.js +102 -0
- package/dist/v2/gen/core/pathSerializer.gen.d.ts +33 -0
- package/dist/v2/gen/core/pathSerializer.gen.js +106 -0
- package/dist/v2/gen/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/v2/gen/core/queryKeySerializer.gen.js +93 -0
- package/dist/v2/gen/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/v2/gen/core/serverSentEvents.gen.js +131 -0
- package/dist/v2/gen/core/types.gen.d.ts +78 -0
- package/dist/v2/gen/core/types.gen.js +2 -0
- package/dist/v2/gen/core/utils.gen.d.ts +19 -0
- package/dist/v2/gen/core/utils.gen.js +87 -0
- package/dist/v2/gen/sdk.gen.d.ts +850 -0
- package/dist/v2/gen/sdk.gen.js +1626 -0
- package/dist/v2/gen/types.gen.d.ts +3356 -0
- package/dist/v2/gen/types.gen.js +2 -0
- package/dist/v2/index.d.ts +10 -0
- package/dist/v2/index.js +16 -0
- package/dist/v2/server.d.ts +23 -0
- package/dist/v2/server.js +91 -0
- package/package.json +15 -3
|
@@ -0,0 +1,850 @@
|
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from "./client/index.js";
|
|
2
|
+
import type { AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, Auth as Auth2, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config2, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses, EventTuiCommandExecute, EventTuiPromptAppend, EventTuiToastShow, FileListResponses, FilePartInput, FileReadResponses, FileStatusResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GlobalEventResponses, InstanceDisposeResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, PathGetResponses, PermissionRespondErrors, PermissionRespondResponses, ProjectCurrentResponses, ProjectListResponses, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyUpdateErrors, PtyUpdateResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteResponses, SessionDiffErrors, SessionDiffResponses, SessionForkResponses, SessionGetErrors, SessionGetResponses, SessionInitErrors, SessionInitResponses, SessionListResponses, SessionMessageErrors, SessionMessageResponses, SessionMessagesErrors, SessionMessagesResponses, SessionPromptAsyncErrors, SessionPromptAsyncResponses, SessionPromptErrors, SessionPromptResponses, SessionRevertErrors, SessionRevertResponses, SessionShareErrors, SessionShareResponses, SessionShellErrors, SessionShellResponses, SessionStatusErrors, SessionStatusResponses, SessionSummarizeErrors, SessionSummarizeResponses, SessionTodoErrors, SessionTodoResponses, SessionUnrevertErrors, SessionUnrevertResponses, SessionUnshareErrors, SessionUnshareResponses, SessionUpdateErrors, SessionUpdateResponses, SubtaskPartInput, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, TuiAppendPromptErrors, TuiAppendPromptResponses, TuiClearPromptResponses, TuiControlNextResponses, TuiControlResponseResponses, TuiExecuteCommandErrors, TuiExecuteCommandResponses, TuiOpenHelpResponses, TuiOpenModelsResponses, TuiOpenSessionsResponses, TuiOpenThemesResponses, TuiPublishErrors, TuiPublishResponses, TuiShowToastResponses, TuiSubmitPromptResponses, VcsGetResponses } from "./types.gen.js";
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
declare class HeyApiClient {
|
|
17
|
+
protected client: Client;
|
|
18
|
+
constructor(args?: {
|
|
19
|
+
client?: Client;
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
declare class HeyApiRegistry<T> {
|
|
23
|
+
private readonly defaultKey;
|
|
24
|
+
private readonly instances;
|
|
25
|
+
get(key?: string): T;
|
|
26
|
+
set(value: T, key?: string): void;
|
|
27
|
+
}
|
|
28
|
+
export declare class Global extends HeyApiClient {
|
|
29
|
+
/**
|
|
30
|
+
* Get global events
|
|
31
|
+
*
|
|
32
|
+
* Subscribe to global events from the OpenCode system using server-sent events.
|
|
33
|
+
*/
|
|
34
|
+
event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<GlobalEventResponses, unknown>>;
|
|
35
|
+
}
|
|
36
|
+
export declare class Project extends HeyApiClient {
|
|
37
|
+
/**
|
|
38
|
+
* List all projects
|
|
39
|
+
*
|
|
40
|
+
* Get a list of projects that have been opened with OpenCode.
|
|
41
|
+
*/
|
|
42
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
43
|
+
directory?: string;
|
|
44
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectListResponses, unknown, ThrowOnError, "fields">;
|
|
45
|
+
/**
|
|
46
|
+
* Get current project
|
|
47
|
+
*
|
|
48
|
+
* Retrieve the currently active project that OpenCode is working with.
|
|
49
|
+
*/
|
|
50
|
+
current<ThrowOnError extends boolean = false>(parameters?: {
|
|
51
|
+
directory?: string;
|
|
52
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectCurrentResponses, unknown, ThrowOnError, "fields">;
|
|
53
|
+
}
|
|
54
|
+
export declare class Pty extends HeyApiClient {
|
|
55
|
+
/**
|
|
56
|
+
* List PTY sessions
|
|
57
|
+
*
|
|
58
|
+
* Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.
|
|
59
|
+
*/
|
|
60
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
61
|
+
directory?: string;
|
|
62
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyListResponses, unknown, ThrowOnError, "fields">;
|
|
63
|
+
/**
|
|
64
|
+
* Create PTY session
|
|
65
|
+
*
|
|
66
|
+
* Create a new pseudo-terminal (PTY) session for running shell commands and processes.
|
|
67
|
+
*/
|
|
68
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
69
|
+
directory?: string;
|
|
70
|
+
command?: string;
|
|
71
|
+
args?: Array<string>;
|
|
72
|
+
cwd?: string;
|
|
73
|
+
title?: string;
|
|
74
|
+
env?: {
|
|
75
|
+
[key: string]: string;
|
|
76
|
+
};
|
|
77
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError, "fields">;
|
|
78
|
+
/**
|
|
79
|
+
* Remove PTY session
|
|
80
|
+
*
|
|
81
|
+
* Remove and terminate a specific pseudo-terminal (PTY) session.
|
|
82
|
+
*/
|
|
83
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
84
|
+
ptyID: string;
|
|
85
|
+
directory?: string;
|
|
86
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError, "fields">;
|
|
87
|
+
/**
|
|
88
|
+
* Get PTY session
|
|
89
|
+
*
|
|
90
|
+
* Retrieve detailed information about a specific pseudo-terminal (PTY) session.
|
|
91
|
+
*/
|
|
92
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
93
|
+
ptyID: string;
|
|
94
|
+
directory?: string;
|
|
95
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyGetResponses, PtyGetErrors, ThrowOnError, "fields">;
|
|
96
|
+
/**
|
|
97
|
+
* Update PTY session
|
|
98
|
+
*
|
|
99
|
+
* Update properties of an existing pseudo-terminal (PTY) session.
|
|
100
|
+
*/
|
|
101
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
102
|
+
ptyID: string;
|
|
103
|
+
directory?: string;
|
|
104
|
+
title?: string;
|
|
105
|
+
size?: {
|
|
106
|
+
rows: number;
|
|
107
|
+
cols: number;
|
|
108
|
+
};
|
|
109
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError, "fields">;
|
|
110
|
+
/**
|
|
111
|
+
* Connect to PTY session
|
|
112
|
+
*
|
|
113
|
+
* Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
|
|
114
|
+
*/
|
|
115
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
116
|
+
ptyID: string;
|
|
117
|
+
directory?: string;
|
|
118
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyConnectResponses, PtyConnectErrors, ThrowOnError, "fields">;
|
|
119
|
+
}
|
|
120
|
+
export declare class Config extends HeyApiClient {
|
|
121
|
+
/**
|
|
122
|
+
* Get configuration
|
|
123
|
+
*
|
|
124
|
+
* Retrieve the current OpenCode configuration settings and preferences.
|
|
125
|
+
*/
|
|
126
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
127
|
+
directory?: string;
|
|
128
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigGetResponses, unknown, ThrowOnError, "fields">;
|
|
129
|
+
/**
|
|
130
|
+
* Update configuration
|
|
131
|
+
*
|
|
132
|
+
* Update OpenCode configuration settings and preferences.
|
|
133
|
+
*/
|
|
134
|
+
update<ThrowOnError extends boolean = false>(parameters?: {
|
|
135
|
+
directory?: string;
|
|
136
|
+
config?: Config2;
|
|
137
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError, "fields">;
|
|
138
|
+
/**
|
|
139
|
+
* List config providers
|
|
140
|
+
*
|
|
141
|
+
* Get a list of all configured AI providers and their default models.
|
|
142
|
+
*/
|
|
143
|
+
providers<ThrowOnError extends boolean = false>(parameters?: {
|
|
144
|
+
directory?: string;
|
|
145
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigProvidersResponses, unknown, ThrowOnError, "fields">;
|
|
146
|
+
}
|
|
147
|
+
export declare class Tool extends HeyApiClient {
|
|
148
|
+
/**
|
|
149
|
+
* List tool IDs
|
|
150
|
+
*
|
|
151
|
+
* Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
|
|
152
|
+
*/
|
|
153
|
+
ids<ThrowOnError extends boolean = false>(parameters?: {
|
|
154
|
+
directory?: string;
|
|
155
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolIdsResponses, ToolIdsErrors, ThrowOnError, "fields">;
|
|
156
|
+
/**
|
|
157
|
+
* List tools
|
|
158
|
+
*
|
|
159
|
+
* Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
|
|
160
|
+
*/
|
|
161
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
162
|
+
directory?: string;
|
|
163
|
+
provider: string;
|
|
164
|
+
model: string;
|
|
165
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolListResponses, ToolListErrors, ThrowOnError, "fields">;
|
|
166
|
+
}
|
|
167
|
+
export declare class Instance extends HeyApiClient {
|
|
168
|
+
/**
|
|
169
|
+
* Dispose instance
|
|
170
|
+
*
|
|
171
|
+
* Clean up and dispose the current OpenCode instance, releasing all resources.
|
|
172
|
+
*/
|
|
173
|
+
dispose<ThrowOnError extends boolean = false>(parameters?: {
|
|
174
|
+
directory?: string;
|
|
175
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InstanceDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
176
|
+
}
|
|
177
|
+
export declare class Path extends HeyApiClient {
|
|
178
|
+
/**
|
|
179
|
+
* Get paths
|
|
180
|
+
*
|
|
181
|
+
* Retrieve the current working directory and related path information for the OpenCode instance.
|
|
182
|
+
*/
|
|
183
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
184
|
+
directory?: string;
|
|
185
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PathGetResponses, unknown, ThrowOnError, "fields">;
|
|
186
|
+
}
|
|
187
|
+
export declare class Vcs extends HeyApiClient {
|
|
188
|
+
/**
|
|
189
|
+
* Get VCS info
|
|
190
|
+
*
|
|
191
|
+
* Retrieve version control system (VCS) information for the current project, such as git branch.
|
|
192
|
+
*/
|
|
193
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
194
|
+
directory?: string;
|
|
195
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsGetResponses, unknown, ThrowOnError, "fields">;
|
|
196
|
+
}
|
|
197
|
+
export declare class Session extends HeyApiClient {
|
|
198
|
+
/**
|
|
199
|
+
* List sessions
|
|
200
|
+
*
|
|
201
|
+
* Get a list of all OpenCode sessions, sorted by most recently updated.
|
|
202
|
+
*/
|
|
203
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
204
|
+
directory?: string;
|
|
205
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionListResponses, unknown, ThrowOnError, "fields">;
|
|
206
|
+
/**
|
|
207
|
+
* Create session
|
|
208
|
+
*
|
|
209
|
+
* Create a new OpenCode session for interacting with AI assistants and managing conversations.
|
|
210
|
+
*/
|
|
211
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
212
|
+
directory?: string;
|
|
213
|
+
parentID?: string;
|
|
214
|
+
title?: string;
|
|
215
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError, "fields">;
|
|
216
|
+
/**
|
|
217
|
+
* Get session status
|
|
218
|
+
*
|
|
219
|
+
* Retrieve the current status of all sessions, including active, idle, and completed states.
|
|
220
|
+
*/
|
|
221
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
222
|
+
directory?: string;
|
|
223
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionStatusResponses, SessionStatusErrors, ThrowOnError, "fields">;
|
|
224
|
+
/**
|
|
225
|
+
* Delete session
|
|
226
|
+
*
|
|
227
|
+
* Delete a session and permanently remove all associated data, including messages and history.
|
|
228
|
+
*/
|
|
229
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
230
|
+
sessionID: string;
|
|
231
|
+
directory?: string;
|
|
232
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError, "fields">;
|
|
233
|
+
/**
|
|
234
|
+
* Get session
|
|
235
|
+
*
|
|
236
|
+
* Retrieve detailed information about a specific OpenCode session.
|
|
237
|
+
*/
|
|
238
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
239
|
+
sessionID: string;
|
|
240
|
+
directory?: string;
|
|
241
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionGetResponses, SessionGetErrors, ThrowOnError, "fields">;
|
|
242
|
+
/**
|
|
243
|
+
* Update session
|
|
244
|
+
*
|
|
245
|
+
* Update properties of an existing session, such as title or other metadata.
|
|
246
|
+
*/
|
|
247
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
248
|
+
sessionID: string;
|
|
249
|
+
directory?: string;
|
|
250
|
+
title?: string;
|
|
251
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError, "fields">;
|
|
252
|
+
/**
|
|
253
|
+
* Get session children
|
|
254
|
+
*
|
|
255
|
+
* Retrieve all child sessions that were forked from the specified parent session.
|
|
256
|
+
*/
|
|
257
|
+
children<ThrowOnError extends boolean = false>(parameters: {
|
|
258
|
+
sessionID: string;
|
|
259
|
+
directory?: string;
|
|
260
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError, "fields">;
|
|
261
|
+
/**
|
|
262
|
+
* Get session todos
|
|
263
|
+
*
|
|
264
|
+
* Retrieve the todo list associated with a specific session, showing tasks and action items.
|
|
265
|
+
*/
|
|
266
|
+
todo<ThrowOnError extends boolean = false>(parameters: {
|
|
267
|
+
sessionID: string;
|
|
268
|
+
directory?: string;
|
|
269
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionTodoResponses, SessionTodoErrors, ThrowOnError, "fields">;
|
|
270
|
+
/**
|
|
271
|
+
* Initialize session
|
|
272
|
+
*
|
|
273
|
+
* Analyze the current application and create an AGENTS.md file with project-specific agent configurations.
|
|
274
|
+
*/
|
|
275
|
+
init<ThrowOnError extends boolean = false>(parameters: {
|
|
276
|
+
sessionID: string;
|
|
277
|
+
directory?: string;
|
|
278
|
+
modelID?: string;
|
|
279
|
+
providerID?: string;
|
|
280
|
+
messageID?: string;
|
|
281
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionInitResponses, SessionInitErrors, ThrowOnError, "fields">;
|
|
282
|
+
/**
|
|
283
|
+
* Fork session
|
|
284
|
+
*
|
|
285
|
+
* Create a new session by forking an existing session at a specific message point.
|
|
286
|
+
*/
|
|
287
|
+
fork<ThrowOnError extends boolean = false>(parameters: {
|
|
288
|
+
sessionID: string;
|
|
289
|
+
directory?: string;
|
|
290
|
+
messageID?: string;
|
|
291
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionForkResponses, unknown, ThrowOnError, "fields">;
|
|
292
|
+
/**
|
|
293
|
+
* Abort session
|
|
294
|
+
*
|
|
295
|
+
* Abort an active session and stop any ongoing AI processing or command execution.
|
|
296
|
+
*/
|
|
297
|
+
abort<ThrowOnError extends boolean = false>(parameters: {
|
|
298
|
+
sessionID: string;
|
|
299
|
+
directory?: string;
|
|
300
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionAbortResponses, SessionAbortErrors, ThrowOnError, "fields">;
|
|
301
|
+
/**
|
|
302
|
+
* Unshare session
|
|
303
|
+
*
|
|
304
|
+
* Remove the shareable link for a session, making it private again.
|
|
305
|
+
*/
|
|
306
|
+
unshare<ThrowOnError extends boolean = false>(parameters: {
|
|
307
|
+
sessionID: string;
|
|
308
|
+
directory?: string;
|
|
309
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError, "fields">;
|
|
310
|
+
/**
|
|
311
|
+
* Share session
|
|
312
|
+
*
|
|
313
|
+
* Create a shareable link for a session, allowing others to view the conversation.
|
|
314
|
+
*/
|
|
315
|
+
share<ThrowOnError extends boolean = false>(parameters: {
|
|
316
|
+
sessionID: string;
|
|
317
|
+
directory?: string;
|
|
318
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShareResponses, SessionShareErrors, ThrowOnError, "fields">;
|
|
319
|
+
/**
|
|
320
|
+
* Get session diff
|
|
321
|
+
*
|
|
322
|
+
* Get all file changes (diffs) made during this session.
|
|
323
|
+
*/
|
|
324
|
+
diff<ThrowOnError extends boolean = false>(parameters: {
|
|
325
|
+
sessionID: string;
|
|
326
|
+
directory?: string;
|
|
327
|
+
messageID?: string;
|
|
328
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDiffResponses, SessionDiffErrors, ThrowOnError, "fields">;
|
|
329
|
+
/**
|
|
330
|
+
* Summarize session
|
|
331
|
+
*
|
|
332
|
+
* Generate a concise summary of the session using AI compaction to preserve key information.
|
|
333
|
+
*/
|
|
334
|
+
summarize<ThrowOnError extends boolean = false>(parameters: {
|
|
335
|
+
sessionID: string;
|
|
336
|
+
directory?: string;
|
|
337
|
+
providerID?: string;
|
|
338
|
+
modelID?: string;
|
|
339
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError, "fields">;
|
|
340
|
+
/**
|
|
341
|
+
* Get session messages
|
|
342
|
+
*
|
|
343
|
+
* Retrieve all messages in a session, including user prompts and AI responses.
|
|
344
|
+
*/
|
|
345
|
+
messages<ThrowOnError extends boolean = false>(parameters: {
|
|
346
|
+
sessionID: string;
|
|
347
|
+
directory?: string;
|
|
348
|
+
limit?: number;
|
|
349
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessagesResponses, SessionMessagesErrors, ThrowOnError, "fields">;
|
|
350
|
+
/**
|
|
351
|
+
* Send message
|
|
352
|
+
*
|
|
353
|
+
* Create and send a new message to a session, streaming the AI response.
|
|
354
|
+
*/
|
|
355
|
+
prompt<ThrowOnError extends boolean = false>(parameters: {
|
|
356
|
+
sessionID: string;
|
|
357
|
+
directory?: string;
|
|
358
|
+
messageID?: string;
|
|
359
|
+
model?: {
|
|
360
|
+
providerID: string;
|
|
361
|
+
modelID: string;
|
|
362
|
+
};
|
|
363
|
+
agent?: string;
|
|
364
|
+
noReply?: boolean;
|
|
365
|
+
system?: string;
|
|
366
|
+
tools?: {
|
|
367
|
+
[key: string]: boolean;
|
|
368
|
+
};
|
|
369
|
+
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
|
|
370
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptResponses, SessionPromptErrors, ThrowOnError, "fields">;
|
|
371
|
+
/**
|
|
372
|
+
* Get message
|
|
373
|
+
*
|
|
374
|
+
* Retrieve a specific message from a session by its message ID.
|
|
375
|
+
*/
|
|
376
|
+
message<ThrowOnError extends boolean = false>(parameters: {
|
|
377
|
+
sessionID: string;
|
|
378
|
+
messageID: string;
|
|
379
|
+
directory?: string;
|
|
380
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessageResponses, SessionMessageErrors, ThrowOnError, "fields">;
|
|
381
|
+
/**
|
|
382
|
+
* Send async message
|
|
383
|
+
*
|
|
384
|
+
* Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.
|
|
385
|
+
*/
|
|
386
|
+
promptAsync<ThrowOnError extends boolean = false>(parameters: {
|
|
387
|
+
sessionID: string;
|
|
388
|
+
directory?: string;
|
|
389
|
+
messageID?: string;
|
|
390
|
+
model?: {
|
|
391
|
+
providerID: string;
|
|
392
|
+
modelID: string;
|
|
393
|
+
};
|
|
394
|
+
agent?: string;
|
|
395
|
+
noReply?: boolean;
|
|
396
|
+
system?: string;
|
|
397
|
+
tools?: {
|
|
398
|
+
[key: string]: boolean;
|
|
399
|
+
};
|
|
400
|
+
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
|
|
401
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptAsyncResponses, SessionPromptAsyncErrors, ThrowOnError, "fields">;
|
|
402
|
+
/**
|
|
403
|
+
* Send command
|
|
404
|
+
*
|
|
405
|
+
* Send a new command to a session for execution by the AI assistant.
|
|
406
|
+
*/
|
|
407
|
+
command<ThrowOnError extends boolean = false>(parameters: {
|
|
408
|
+
sessionID: string;
|
|
409
|
+
directory?: string;
|
|
410
|
+
messageID?: string;
|
|
411
|
+
agent?: string;
|
|
412
|
+
model?: string;
|
|
413
|
+
arguments?: string;
|
|
414
|
+
command?: string;
|
|
415
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCommandResponses, SessionCommandErrors, ThrowOnError, "fields">;
|
|
416
|
+
/**
|
|
417
|
+
* Run shell command
|
|
418
|
+
*
|
|
419
|
+
* Execute a shell command within the session context and return the AI's response.
|
|
420
|
+
*/
|
|
421
|
+
shell<ThrowOnError extends boolean = false>(parameters: {
|
|
422
|
+
sessionID: string;
|
|
423
|
+
directory?: string;
|
|
424
|
+
agent?: string;
|
|
425
|
+
model?: {
|
|
426
|
+
providerID: string;
|
|
427
|
+
modelID: string;
|
|
428
|
+
};
|
|
429
|
+
command?: string;
|
|
430
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShellResponses, SessionShellErrors, ThrowOnError, "fields">;
|
|
431
|
+
/**
|
|
432
|
+
* Revert message
|
|
433
|
+
*
|
|
434
|
+
* Revert a specific message in a session, undoing its effects and restoring the previous state.
|
|
435
|
+
*/
|
|
436
|
+
revert<ThrowOnError extends boolean = false>(parameters: {
|
|
437
|
+
sessionID: string;
|
|
438
|
+
directory?: string;
|
|
439
|
+
messageID?: string;
|
|
440
|
+
partID?: string;
|
|
441
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError, "fields">;
|
|
442
|
+
/**
|
|
443
|
+
* Restore reverted messages
|
|
444
|
+
*
|
|
445
|
+
* Restore all previously reverted messages in a session.
|
|
446
|
+
*/
|
|
447
|
+
unrevert<ThrowOnError extends boolean = false>(parameters: {
|
|
448
|
+
sessionID: string;
|
|
449
|
+
directory?: string;
|
|
450
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError, "fields">;
|
|
451
|
+
}
|
|
452
|
+
export declare class Permission extends HeyApiClient {
|
|
453
|
+
/**
|
|
454
|
+
* Respond to permission
|
|
455
|
+
*
|
|
456
|
+
* Approve or deny a permission request from the AI assistant.
|
|
457
|
+
*/
|
|
458
|
+
respond<ThrowOnError extends boolean = false>(parameters: {
|
|
459
|
+
sessionID: string;
|
|
460
|
+
permissionID: string;
|
|
461
|
+
directory?: string;
|
|
462
|
+
response?: "once" | "always" | "reject";
|
|
463
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError, "fields">;
|
|
464
|
+
}
|
|
465
|
+
export declare class Command extends HeyApiClient {
|
|
466
|
+
/**
|
|
467
|
+
* List commands
|
|
468
|
+
*
|
|
469
|
+
* Get a list of all available commands in the OpenCode system.
|
|
470
|
+
*/
|
|
471
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
472
|
+
directory?: string;
|
|
473
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<CommandListResponses, unknown, ThrowOnError, "fields">;
|
|
474
|
+
}
|
|
475
|
+
export declare class Oauth extends HeyApiClient {
|
|
476
|
+
/**
|
|
477
|
+
* OAuth authorize
|
|
478
|
+
*
|
|
479
|
+
* Initiate OAuth authorization for a specific AI provider to get an authorization URL.
|
|
480
|
+
*/
|
|
481
|
+
authorize<ThrowOnError extends boolean = false>(parameters: {
|
|
482
|
+
providerID: string;
|
|
483
|
+
directory?: string;
|
|
484
|
+
method?: number;
|
|
485
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError, "fields">;
|
|
486
|
+
/**
|
|
487
|
+
* OAuth callback
|
|
488
|
+
*
|
|
489
|
+
* Handle the OAuth callback from a provider after user authorization.
|
|
490
|
+
*/
|
|
491
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
492
|
+
providerID: string;
|
|
493
|
+
directory?: string;
|
|
494
|
+
method?: number;
|
|
495
|
+
code?: string;
|
|
496
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthCallbackResponses, ProviderOauthCallbackErrors, ThrowOnError, "fields">;
|
|
497
|
+
}
|
|
498
|
+
export declare class Provider extends HeyApiClient {
|
|
499
|
+
/**
|
|
500
|
+
* List providers
|
|
501
|
+
*
|
|
502
|
+
* Get a list of all available AI providers, including both available and connected ones.
|
|
503
|
+
*/
|
|
504
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
505
|
+
directory?: string;
|
|
506
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderListResponses, unknown, ThrowOnError, "fields">;
|
|
507
|
+
/**
|
|
508
|
+
* Get provider auth methods
|
|
509
|
+
*
|
|
510
|
+
* Retrieve available authentication methods for all AI providers.
|
|
511
|
+
*/
|
|
512
|
+
auth<ThrowOnError extends boolean = false>(parameters?: {
|
|
513
|
+
directory?: string;
|
|
514
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderAuthResponses, unknown, ThrowOnError, "fields">;
|
|
515
|
+
oauth: Oauth;
|
|
516
|
+
}
|
|
517
|
+
export declare class Find extends HeyApiClient {
|
|
518
|
+
/**
|
|
519
|
+
* Find text
|
|
520
|
+
*
|
|
521
|
+
* Search for text patterns across files in the project using ripgrep.
|
|
522
|
+
*/
|
|
523
|
+
text<ThrowOnError extends boolean = false>(parameters: {
|
|
524
|
+
directory?: string;
|
|
525
|
+
pattern: string;
|
|
526
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindTextResponses, unknown, ThrowOnError, "fields">;
|
|
527
|
+
/**
|
|
528
|
+
* Find files
|
|
529
|
+
*
|
|
530
|
+
* Search for files by name or pattern in the project directory.
|
|
531
|
+
*/
|
|
532
|
+
files<ThrowOnError extends boolean = false>(parameters: {
|
|
533
|
+
directory?: string;
|
|
534
|
+
query: string;
|
|
535
|
+
dirs?: "true" | "false";
|
|
536
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindFilesResponses, unknown, ThrowOnError, "fields">;
|
|
537
|
+
/**
|
|
538
|
+
* Find symbols
|
|
539
|
+
*
|
|
540
|
+
* Search for workspace symbols like functions, classes, and variables using LSP.
|
|
541
|
+
*/
|
|
542
|
+
symbols<ThrowOnError extends boolean = false>(parameters: {
|
|
543
|
+
directory?: string;
|
|
544
|
+
query: string;
|
|
545
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindSymbolsResponses, unknown, ThrowOnError, "fields">;
|
|
546
|
+
}
|
|
547
|
+
export declare class File extends HeyApiClient {
|
|
548
|
+
/**
|
|
549
|
+
* List files
|
|
550
|
+
*
|
|
551
|
+
* List files and directories in a specified path.
|
|
552
|
+
*/
|
|
553
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
554
|
+
directory?: string;
|
|
555
|
+
path: string;
|
|
556
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileListResponses, unknown, ThrowOnError, "fields">;
|
|
557
|
+
/**
|
|
558
|
+
* Read file
|
|
559
|
+
*
|
|
560
|
+
* Read the content of a specified file.
|
|
561
|
+
*/
|
|
562
|
+
read<ThrowOnError extends boolean = false>(parameters: {
|
|
563
|
+
directory?: string;
|
|
564
|
+
path: string;
|
|
565
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReadResponses, unknown, ThrowOnError, "fields">;
|
|
566
|
+
/**
|
|
567
|
+
* Get file status
|
|
568
|
+
*
|
|
569
|
+
* Get the git status of all files in the project.
|
|
570
|
+
*/
|
|
571
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
572
|
+
directory?: string;
|
|
573
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileStatusResponses, unknown, ThrowOnError, "fields">;
|
|
574
|
+
}
|
|
575
|
+
export declare class App extends HeyApiClient {
|
|
576
|
+
/**
|
|
577
|
+
* Write log
|
|
578
|
+
*
|
|
579
|
+
* Write a log entry to the server logs with specified level and metadata.
|
|
580
|
+
*/
|
|
581
|
+
log<ThrowOnError extends boolean = false>(parameters?: {
|
|
582
|
+
directory?: string;
|
|
583
|
+
service?: string;
|
|
584
|
+
level?: "debug" | "info" | "error" | "warn";
|
|
585
|
+
message?: string;
|
|
586
|
+
extra?: {
|
|
587
|
+
[key: string]: unknown;
|
|
588
|
+
};
|
|
589
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AppLogResponses, AppLogErrors, ThrowOnError, "fields">;
|
|
590
|
+
/**
|
|
591
|
+
* List agents
|
|
592
|
+
*
|
|
593
|
+
* Get a list of all available AI agents in the OpenCode system.
|
|
594
|
+
*/
|
|
595
|
+
agents<ThrowOnError extends boolean = false>(parameters?: {
|
|
596
|
+
directory?: string;
|
|
597
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AppAgentsResponses, unknown, ThrowOnError, "fields">;
|
|
598
|
+
}
|
|
599
|
+
export declare class Auth extends HeyApiClient {
|
|
600
|
+
/**
|
|
601
|
+
* Remove MCP OAuth
|
|
602
|
+
*
|
|
603
|
+
* Remove OAuth credentials for an MCP server
|
|
604
|
+
*/
|
|
605
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
606
|
+
name: string;
|
|
607
|
+
directory?: string;
|
|
608
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError, "fields">;
|
|
609
|
+
/**
|
|
610
|
+
* Start MCP OAuth
|
|
611
|
+
*
|
|
612
|
+
* Start OAuth authentication flow for a Model Context Protocol (MCP) server.
|
|
613
|
+
*/
|
|
614
|
+
start<ThrowOnError extends boolean = false>(parameters: {
|
|
615
|
+
name: string;
|
|
616
|
+
directory?: string;
|
|
617
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError, "fields">;
|
|
618
|
+
/**
|
|
619
|
+
* Complete MCP OAuth
|
|
620
|
+
*
|
|
621
|
+
* Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
|
|
622
|
+
*/
|
|
623
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
624
|
+
name: string;
|
|
625
|
+
directory?: string;
|
|
626
|
+
code?: string;
|
|
627
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError, "fields">;
|
|
628
|
+
/**
|
|
629
|
+
* Authenticate MCP OAuth
|
|
630
|
+
*
|
|
631
|
+
* Start OAuth flow and wait for callback (opens browser)
|
|
632
|
+
*/
|
|
633
|
+
authenticate<ThrowOnError extends boolean = false>(parameters: {
|
|
634
|
+
name: string;
|
|
635
|
+
directory?: string;
|
|
636
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError, "fields">;
|
|
637
|
+
/**
|
|
638
|
+
* Set auth credentials
|
|
639
|
+
*
|
|
640
|
+
* Set authentication credentials
|
|
641
|
+
*/
|
|
642
|
+
set<ThrowOnError extends boolean = false>(parameters: {
|
|
643
|
+
providerID: string;
|
|
644
|
+
directory?: string;
|
|
645
|
+
auth?: Auth2;
|
|
646
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AuthSetResponses, AuthSetErrors, ThrowOnError, "fields">;
|
|
647
|
+
}
|
|
648
|
+
export declare class Mcp extends HeyApiClient {
|
|
649
|
+
/**
|
|
650
|
+
* Get MCP status
|
|
651
|
+
*
|
|
652
|
+
* Get the status of all Model Context Protocol (MCP) servers.
|
|
653
|
+
*/
|
|
654
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
655
|
+
directory?: string;
|
|
656
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpStatusResponses, unknown, ThrowOnError, "fields">;
|
|
657
|
+
/**
|
|
658
|
+
* Add MCP server
|
|
659
|
+
*
|
|
660
|
+
* Dynamically add a new Model Context Protocol (MCP) server to the system.
|
|
661
|
+
*/
|
|
662
|
+
add<ThrowOnError extends boolean = false>(parameters?: {
|
|
663
|
+
directory?: string;
|
|
664
|
+
name?: string;
|
|
665
|
+
config?: McpLocalConfig | McpRemoteConfig;
|
|
666
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAddResponses, McpAddErrors, ThrowOnError, "fields">;
|
|
667
|
+
/**
|
|
668
|
+
* Connect an MCP server
|
|
669
|
+
*/
|
|
670
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
671
|
+
name: string;
|
|
672
|
+
directory?: string;
|
|
673
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpConnectResponses, unknown, ThrowOnError, "fields">;
|
|
674
|
+
/**
|
|
675
|
+
* Disconnect an MCP server
|
|
676
|
+
*/
|
|
677
|
+
disconnect<ThrowOnError extends boolean = false>(parameters: {
|
|
678
|
+
name: string;
|
|
679
|
+
directory?: string;
|
|
680
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpDisconnectResponses, unknown, ThrowOnError, "fields">;
|
|
681
|
+
auth: Auth;
|
|
682
|
+
}
|
|
683
|
+
export declare class Lsp extends HeyApiClient {
|
|
684
|
+
/**
|
|
685
|
+
* Get LSP status
|
|
686
|
+
*
|
|
687
|
+
* Get LSP server status
|
|
688
|
+
*/
|
|
689
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
690
|
+
directory?: string;
|
|
691
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<LspStatusResponses, unknown, ThrowOnError, "fields">;
|
|
692
|
+
}
|
|
693
|
+
export declare class Formatter extends HeyApiClient {
|
|
694
|
+
/**
|
|
695
|
+
* Get formatter status
|
|
696
|
+
*
|
|
697
|
+
* Get formatter status
|
|
698
|
+
*/
|
|
699
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
700
|
+
directory?: string;
|
|
701
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FormatterStatusResponses, unknown, ThrowOnError, "fields">;
|
|
702
|
+
}
|
|
703
|
+
export declare class Control extends HeyApiClient {
|
|
704
|
+
/**
|
|
705
|
+
* Get next TUI request
|
|
706
|
+
*
|
|
707
|
+
* Retrieve the next TUI (Terminal User Interface) request from the queue for processing.
|
|
708
|
+
*/
|
|
709
|
+
next<ThrowOnError extends boolean = false>(parameters?: {
|
|
710
|
+
directory?: string;
|
|
711
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiControlNextResponses, unknown, ThrowOnError, "fields">;
|
|
712
|
+
/**
|
|
713
|
+
* Submit TUI response
|
|
714
|
+
*
|
|
715
|
+
* Submit a response to the TUI request queue to complete a pending request.
|
|
716
|
+
*/
|
|
717
|
+
response<ThrowOnError extends boolean = false>(parameters?: {
|
|
718
|
+
directory?: string;
|
|
719
|
+
body?: unknown;
|
|
720
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiControlResponseResponses, unknown, ThrowOnError, "fields">;
|
|
721
|
+
}
|
|
722
|
+
export declare class Tui extends HeyApiClient {
|
|
723
|
+
/**
|
|
724
|
+
* Append TUI prompt
|
|
725
|
+
*
|
|
726
|
+
* Append prompt to the TUI
|
|
727
|
+
*/
|
|
728
|
+
appendPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
729
|
+
directory?: string;
|
|
730
|
+
text?: string;
|
|
731
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiAppendPromptResponses, TuiAppendPromptErrors, ThrowOnError, "fields">;
|
|
732
|
+
/**
|
|
733
|
+
* Open help dialog
|
|
734
|
+
*
|
|
735
|
+
* Open the help dialog in the TUI to display user assistance information.
|
|
736
|
+
*/
|
|
737
|
+
openHelp<ThrowOnError extends boolean = false>(parameters?: {
|
|
738
|
+
directory?: string;
|
|
739
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenHelpResponses, unknown, ThrowOnError, "fields">;
|
|
740
|
+
/**
|
|
741
|
+
* Open sessions dialog
|
|
742
|
+
*
|
|
743
|
+
* Open the session dialog
|
|
744
|
+
*/
|
|
745
|
+
openSessions<ThrowOnError extends boolean = false>(parameters?: {
|
|
746
|
+
directory?: string;
|
|
747
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenSessionsResponses, unknown, ThrowOnError, "fields">;
|
|
748
|
+
/**
|
|
749
|
+
* Open themes dialog
|
|
750
|
+
*
|
|
751
|
+
* Open the theme dialog
|
|
752
|
+
*/
|
|
753
|
+
openThemes<ThrowOnError extends boolean = false>(parameters?: {
|
|
754
|
+
directory?: string;
|
|
755
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenThemesResponses, unknown, ThrowOnError, "fields">;
|
|
756
|
+
/**
|
|
757
|
+
* Open models dialog
|
|
758
|
+
*
|
|
759
|
+
* Open the model dialog
|
|
760
|
+
*/
|
|
761
|
+
openModels<ThrowOnError extends boolean = false>(parameters?: {
|
|
762
|
+
directory?: string;
|
|
763
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenModelsResponses, unknown, ThrowOnError, "fields">;
|
|
764
|
+
/**
|
|
765
|
+
* Submit TUI prompt
|
|
766
|
+
*
|
|
767
|
+
* Submit the prompt
|
|
768
|
+
*/
|
|
769
|
+
submitPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
770
|
+
directory?: string;
|
|
771
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiSubmitPromptResponses, unknown, ThrowOnError, "fields">;
|
|
772
|
+
/**
|
|
773
|
+
* Clear TUI prompt
|
|
774
|
+
*
|
|
775
|
+
* Clear the prompt
|
|
776
|
+
*/
|
|
777
|
+
clearPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
778
|
+
directory?: string;
|
|
779
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiClearPromptResponses, unknown, ThrowOnError, "fields">;
|
|
780
|
+
/**
|
|
781
|
+
* Execute TUI command
|
|
782
|
+
*
|
|
783
|
+
* Execute a TUI command (e.g. agent_cycle)
|
|
784
|
+
*/
|
|
785
|
+
executeCommand<ThrowOnError extends boolean = false>(parameters?: {
|
|
786
|
+
directory?: string;
|
|
787
|
+
command?: string;
|
|
788
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiExecuteCommandResponses, TuiExecuteCommandErrors, ThrowOnError, "fields">;
|
|
789
|
+
/**
|
|
790
|
+
* Show TUI toast
|
|
791
|
+
*
|
|
792
|
+
* Show a toast notification in the TUI
|
|
793
|
+
*/
|
|
794
|
+
showToast<ThrowOnError extends boolean = false>(parameters?: {
|
|
795
|
+
directory?: string;
|
|
796
|
+
title?: string;
|
|
797
|
+
message?: string;
|
|
798
|
+
variant?: "info" | "success" | "warning" | "error";
|
|
799
|
+
duration?: number;
|
|
800
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiShowToastResponses, unknown, ThrowOnError, "fields">;
|
|
801
|
+
/**
|
|
802
|
+
* Publish TUI event
|
|
803
|
+
*
|
|
804
|
+
* Publish a TUI event
|
|
805
|
+
*/
|
|
806
|
+
publish<ThrowOnError extends boolean = false>(parameters?: {
|
|
807
|
+
directory?: string;
|
|
808
|
+
body?: EventTuiPromptAppend | EventTuiCommandExecute | EventTuiToastShow;
|
|
809
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiPublishResponses, TuiPublishErrors, ThrowOnError, "fields">;
|
|
810
|
+
control: Control;
|
|
811
|
+
}
|
|
812
|
+
export declare class Event extends HeyApiClient {
|
|
813
|
+
/**
|
|
814
|
+
* Subscribe to events
|
|
815
|
+
*
|
|
816
|
+
* Get events
|
|
817
|
+
*/
|
|
818
|
+
subscribe<ThrowOnError extends boolean = false>(parameters?: {
|
|
819
|
+
directory?: string;
|
|
820
|
+
}, options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<EventSubscribeResponses, unknown>>;
|
|
821
|
+
}
|
|
822
|
+
export declare class OpencodeClient extends HeyApiClient {
|
|
823
|
+
static readonly __registry: HeyApiRegistry<OpencodeClient>;
|
|
824
|
+
constructor(args?: {
|
|
825
|
+
client?: Client;
|
|
826
|
+
key?: string;
|
|
827
|
+
});
|
|
828
|
+
global: Global;
|
|
829
|
+
project: Project;
|
|
830
|
+
pty: Pty;
|
|
831
|
+
config: Config;
|
|
832
|
+
tool: Tool;
|
|
833
|
+
instance: Instance;
|
|
834
|
+
path: Path;
|
|
835
|
+
vcs: Vcs;
|
|
836
|
+
session: Session;
|
|
837
|
+
permission: Permission;
|
|
838
|
+
command: Command;
|
|
839
|
+
provider: Provider;
|
|
840
|
+
find: Find;
|
|
841
|
+
file: File;
|
|
842
|
+
app: App;
|
|
843
|
+
mcp: Mcp;
|
|
844
|
+
lsp: Lsp;
|
|
845
|
+
formatter: Formatter;
|
|
846
|
+
tui: Tui;
|
|
847
|
+
auth: Auth;
|
|
848
|
+
event: Event;
|
|
849
|
+
}
|
|
850
|
+
export {};
|