@opencode-ai/sdk 0.0.0-dev-202605030205 → 0.0.0-dev-202605030312
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/v2/gen/sdk.gen.d.ts +806 -731
- package/dist/v2/gen/sdk.gen.js +1127 -981
- package/dist/v2/gen/types.gen.d.ts +2941 -2064
- package/package.json +1 -1
package/dist/v2/gen/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type Options as Options2, type TDataShape } from "./client/index.js";
|
|
2
|
-
import type { AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillsResponses, Auth as Auth3, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config3, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses,
|
|
2
|
+
import type { AgentPartInput, AppAgentsResponses, AppLogErrors, AppLogResponses, AppSkillsResponses, Auth as Auth3, AuthRemoveErrors, AuthRemoveResponses, AuthSetErrors, AuthSetResponses, CommandListResponses, Config as Config3, ConfigGetResponses, ConfigProvidersResponses, ConfigUpdateErrors, ConfigUpdateResponses, EventSubscribeResponses, EventTuiCommandExecute2, EventTuiPromptAppend2, EventTuiSessionSelect2, EventTuiToastShow2, ExperimentalConsoleGetResponses, ExperimentalConsoleListOrgsResponses, ExperimentalConsoleSwitchOrgResponses, ExperimentalResourceListResponses, ExperimentalSessionListResponses, ExperimentalWorkspaceAdapterListResponses, ExperimentalWorkspaceCreateErrors, ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceListResponses, ExperimentalWorkspaceRemoveErrors, ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceSessionRestoreErrors, ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceStatusResponses, FileListResponses, FilePartInput, FilePartSource, FileReadResponses, FileStatusResponses, FindFilesResponses, FindSymbolsResponses, FindTextResponses, FormatterStatusResponses, GlobalConfigGetResponses, GlobalConfigUpdateErrors, GlobalConfigUpdateResponses, GlobalDisposeResponses, GlobalEventResponses, GlobalHealthResponses, GlobalUpgradeErrors, GlobalUpgradeResponses, InstanceDisposeResponses, LspStatusResponses, McpAddErrors, McpAddResponses, McpAuthAuthenticateErrors, McpAuthAuthenticateResponses, McpAuthCallbackErrors, McpAuthCallbackResponses, McpAuthRemoveErrors, McpAuthRemoveResponses, McpAuthStartErrors, McpAuthStartResponses, McpConnectResponses, McpDisconnectResponses, McpLocalConfig, McpRemoteConfig, McpStatusResponses, OutputFormat, Part as Part2, PartDeleteErrors, PartDeleteResponses, PartUpdateErrors, PartUpdateResponses, PathGetResponses, PermissionListResponses, PermissionReplyErrors, PermissionReplyResponses, PermissionRespondErrors, PermissionRespondResponses, PermissionRuleset, ProjectCurrentResponses, ProjectInitGitResponses, ProjectListResponses, ProjectUpdateErrors, ProjectUpdateResponses, Prompt, ProviderAuthResponses, ProviderListResponses, ProviderOauthAuthorizeErrors, ProviderOauthAuthorizeResponses, ProviderOauthCallbackErrors, ProviderOauthCallbackResponses, PtyConnectErrors, PtyConnectResponses, PtyCreateErrors, PtyCreateResponses, PtyGetErrors, PtyGetResponses, PtyListResponses, PtyRemoveErrors, PtyRemoveResponses, PtyShellsResponses, PtyUpdateErrors, PtyUpdateResponses, QuestionAnswer, QuestionListResponses, QuestionRejectErrors, QuestionRejectResponses, QuestionReplyErrors, QuestionReplyResponses, SessionAbortErrors, SessionAbortResponses, SessionChildrenErrors, SessionChildrenResponses, SessionCommandErrors, SessionCommandResponses, SessionCreateErrors, SessionCreateResponses, SessionDeleteErrors, SessionDeleteMessageErrors, SessionDeleteMessageResponses, SessionDeleteResponses, SessionDelivery, 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, SyncHistoryListErrors, SyncHistoryListResponses, SyncReplayErrors, SyncReplayResponses, SyncStartResponses, TextPartInput, ToolIdsErrors, ToolIdsResponses, ToolListErrors, ToolListResponses, TuiAppendPromptErrors, TuiAppendPromptResponses, TuiClearPromptResponses, TuiControlNextResponses, TuiControlResponseResponses, TuiExecuteCommandErrors, TuiExecuteCommandResponses, TuiOpenHelpResponses, TuiOpenModelsResponses, TuiOpenSessionsResponses, TuiOpenThemesResponses, TuiPublishErrors, TuiPublishResponses, TuiSelectSessionErrors, TuiSelectSessionResponses, TuiShowToastResponses, TuiSubmitPromptResponses, V2SessionCompactResponses, V2SessionContextResponses, V2SessionListErrors, V2SessionListResponses, V2SessionMessagesErrors, V2SessionMessagesResponses, V2SessionPromptResponses, V2SessionWaitResponses, VcsDiffResponses, VcsGetResponses, WorktreeCreateErrors, WorktreeCreateInput, WorktreeCreateResponses, WorktreeListResponses, WorktreeRemoveErrors, WorktreeRemoveInput, WorktreeRemoveResponses, WorktreeResetErrors, WorktreeResetInput, WorktreeResetResponses } from "./types.gen.js";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -25,52 +25,6 @@ declare class HeyApiRegistry<T> {
|
|
|
25
25
|
get(key?: string): T;
|
|
26
26
|
set(value: T, key?: string): void;
|
|
27
27
|
}
|
|
28
|
-
export declare class Config extends HeyApiClient {
|
|
29
|
-
/**
|
|
30
|
-
* Get global configuration
|
|
31
|
-
*
|
|
32
|
-
* Retrieve the current global OpenCode configuration settings and preferences.
|
|
33
|
-
*/
|
|
34
|
-
get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalConfigGetResponses, unknown, ThrowOnError, "fields">;
|
|
35
|
-
/**
|
|
36
|
-
* Update global configuration
|
|
37
|
-
*
|
|
38
|
-
* Update global OpenCode configuration settings and preferences.
|
|
39
|
-
*/
|
|
40
|
-
update<ThrowOnError extends boolean = false>(parameters?: {
|
|
41
|
-
config?: Config3;
|
|
42
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalConfigUpdateResponses, GlobalConfigUpdateErrors, ThrowOnError, "fields">;
|
|
43
|
-
}
|
|
44
|
-
export declare class Global extends HeyApiClient {
|
|
45
|
-
/**
|
|
46
|
-
* Get health
|
|
47
|
-
*
|
|
48
|
-
* Get health information about the OpenCode server.
|
|
49
|
-
*/
|
|
50
|
-
health<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalHealthResponses, unknown, ThrowOnError, "fields">;
|
|
51
|
-
/**
|
|
52
|
-
* Get global events
|
|
53
|
-
*
|
|
54
|
-
* Subscribe to global events from the OpenCode system using server-sent events.
|
|
55
|
-
*/
|
|
56
|
-
event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<GlobalEventResponses, unknown>>;
|
|
57
|
-
/**
|
|
58
|
-
* Dispose instance
|
|
59
|
-
*
|
|
60
|
-
* Clean up and dispose all OpenCode instances, releasing all resources.
|
|
61
|
-
*/
|
|
62
|
-
dispose<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
63
|
-
/**
|
|
64
|
-
* Upgrade opencode
|
|
65
|
-
*
|
|
66
|
-
* Upgrade opencode to the specified version or latest if not specified.
|
|
67
|
-
*/
|
|
68
|
-
upgrade<ThrowOnError extends boolean = false>(parameters?: {
|
|
69
|
-
target?: string;
|
|
70
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalUpgradeResponses, GlobalUpgradeErrors, ThrowOnError, "fields">;
|
|
71
|
-
private _config?;
|
|
72
|
-
get config(): Config;
|
|
73
|
-
}
|
|
74
28
|
export declare class Auth extends HeyApiClient {
|
|
75
29
|
/**
|
|
76
30
|
* Remove auth credentials
|
|
@@ -125,72 +79,92 @@ export declare class App extends HeyApiClient {
|
|
|
125
79
|
workspace?: string;
|
|
126
80
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AppSkillsResponses, unknown, ThrowOnError, "fields">;
|
|
127
81
|
}
|
|
128
|
-
export declare class
|
|
82
|
+
export declare class Config extends HeyApiClient {
|
|
129
83
|
/**
|
|
130
|
-
*
|
|
84
|
+
* Get global configuration
|
|
131
85
|
*
|
|
132
|
-
*
|
|
86
|
+
* Retrieve the current global OpenCode configuration settings and preferences.
|
|
133
87
|
*/
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
88
|
+
get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalConfigGetResponses, unknown, ThrowOnError, "fields">;
|
|
89
|
+
/**
|
|
90
|
+
* Update global configuration
|
|
91
|
+
*
|
|
92
|
+
* Update global OpenCode configuration settings and preferences.
|
|
93
|
+
*/
|
|
94
|
+
update<ThrowOnError extends boolean = false>(parameters?: {
|
|
95
|
+
config?: Config3;
|
|
96
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalConfigUpdateResponses, GlobalConfigUpdateErrors, ThrowOnError, "fields">;
|
|
138
97
|
}
|
|
139
|
-
export declare class
|
|
98
|
+
export declare class Global extends HeyApiClient {
|
|
140
99
|
/**
|
|
141
|
-
*
|
|
100
|
+
* Get health
|
|
142
101
|
*
|
|
143
|
-
*
|
|
102
|
+
* Get health information about the OpenCode server.
|
|
144
103
|
*/
|
|
145
|
-
|
|
146
|
-
directory?: string;
|
|
147
|
-
workspace?: string;
|
|
148
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceListResponses, unknown, ThrowOnError, "fields">;
|
|
104
|
+
health<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalHealthResponses, unknown, ThrowOnError, "fields">;
|
|
149
105
|
/**
|
|
150
|
-
*
|
|
106
|
+
* Get global events
|
|
151
107
|
*
|
|
152
|
-
*
|
|
108
|
+
* Subscribe to global events from the OpenCode system using server-sent events.
|
|
153
109
|
*/
|
|
154
|
-
|
|
110
|
+
event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<GlobalEventResponses, unknown>>;
|
|
111
|
+
/**
|
|
112
|
+
* Dispose instance
|
|
113
|
+
*
|
|
114
|
+
* Clean up and dispose all OpenCode instances, releasing all resources.
|
|
115
|
+
*/
|
|
116
|
+
dispose<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
117
|
+
/**
|
|
118
|
+
* Upgrade opencode
|
|
119
|
+
*
|
|
120
|
+
* Upgrade opencode to the specified version or latest if not specified.
|
|
121
|
+
*/
|
|
122
|
+
upgrade<ThrowOnError extends boolean = false>(parameters?: {
|
|
123
|
+
target?: string;
|
|
124
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<GlobalUpgradeResponses, GlobalUpgradeErrors, ThrowOnError, "fields">;
|
|
125
|
+
private _config?;
|
|
126
|
+
get config(): Config;
|
|
127
|
+
}
|
|
128
|
+
export declare class Event extends HeyApiClient {
|
|
129
|
+
/**
|
|
130
|
+
* Subscribe to events
|
|
131
|
+
*
|
|
132
|
+
* Get events
|
|
133
|
+
*/
|
|
134
|
+
subscribe<ThrowOnError extends boolean = false>(parameters?: {
|
|
155
135
|
directory?: string;
|
|
156
136
|
workspace?: string;
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
extra?: unknown | null;
|
|
161
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceCreateErrors, ThrowOnError, "fields">;
|
|
137
|
+
}, options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<EventSubscribeResponses, unknown>>;
|
|
138
|
+
}
|
|
139
|
+
export declare class Config2 extends HeyApiClient {
|
|
162
140
|
/**
|
|
163
|
-
*
|
|
141
|
+
* Get configuration
|
|
164
142
|
*
|
|
165
|
-
*
|
|
143
|
+
* Retrieve the current OpenCode configuration settings and preferences.
|
|
166
144
|
*/
|
|
167
|
-
|
|
145
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
168
146
|
directory?: string;
|
|
169
147
|
workspace?: string;
|
|
170
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
148
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigGetResponses, unknown, ThrowOnError, "fields">;
|
|
171
149
|
/**
|
|
172
|
-
*
|
|
150
|
+
* Update configuration
|
|
173
151
|
*
|
|
174
|
-
*
|
|
152
|
+
* Update OpenCode configuration settings and preferences.
|
|
175
153
|
*/
|
|
176
|
-
|
|
177
|
-
id: string;
|
|
154
|
+
update<ThrowOnError extends boolean = false>(parameters?: {
|
|
178
155
|
directory?: string;
|
|
179
156
|
workspace?: string;
|
|
180
|
-
|
|
157
|
+
config?: Config3;
|
|
158
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError, "fields">;
|
|
181
159
|
/**
|
|
182
|
-
*
|
|
160
|
+
* List config providers
|
|
183
161
|
*
|
|
184
|
-
*
|
|
162
|
+
* Get a list of all configured AI providers and their default models.
|
|
185
163
|
*/
|
|
186
|
-
|
|
187
|
-
id: string;
|
|
164
|
+
providers<ThrowOnError extends boolean = false>(parameters?: {
|
|
188
165
|
directory?: string;
|
|
189
166
|
workspace?: string;
|
|
190
|
-
|
|
191
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceSessionRestoreErrors, ThrowOnError, "fields">;
|
|
192
|
-
private _adapter?;
|
|
193
|
-
get adapter(): Adapter;
|
|
167
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigProvidersResponses, unknown, ThrowOnError, "fields">;
|
|
194
168
|
}
|
|
195
169
|
export declare class Console extends HeyApiClient {
|
|
196
170
|
/**
|
|
@@ -251,412 +225,732 @@ export declare class Resource extends HeyApiClient {
|
|
|
251
225
|
workspace?: string;
|
|
252
226
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalResourceListResponses, unknown, ThrowOnError, "fields">;
|
|
253
227
|
}
|
|
254
|
-
export declare class
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
228
|
+
export declare class Adapter extends HeyApiClient {
|
|
229
|
+
/**
|
|
230
|
+
* List workspace adapters
|
|
231
|
+
*
|
|
232
|
+
* List all available workspace adapters for the current project.
|
|
233
|
+
*/
|
|
234
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
235
|
+
directory?: string;
|
|
236
|
+
workspace?: string;
|
|
237
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceAdapterListResponses, unknown, ThrowOnError, "fields">;
|
|
263
238
|
}
|
|
264
|
-
export declare class
|
|
239
|
+
export declare class Workspace extends HeyApiClient {
|
|
265
240
|
/**
|
|
266
|
-
* List
|
|
241
|
+
* List workspaces
|
|
267
242
|
*
|
|
268
|
-
*
|
|
243
|
+
* List all workspaces.
|
|
269
244
|
*/
|
|
270
245
|
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
271
246
|
directory?: string;
|
|
272
247
|
workspace?: string;
|
|
273
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
248
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceListResponses, unknown, ThrowOnError, "fields">;
|
|
274
249
|
/**
|
|
275
|
-
*
|
|
250
|
+
* Create workspace
|
|
276
251
|
*
|
|
277
|
-
*
|
|
252
|
+
* Create a workspace for the current project.
|
|
278
253
|
*/
|
|
279
|
-
|
|
254
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
280
255
|
directory?: string;
|
|
281
256
|
workspace?: string;
|
|
282
|
-
|
|
257
|
+
id?: string;
|
|
258
|
+
type?: string;
|
|
259
|
+
branch?: string | null;
|
|
260
|
+
extra?: unknown | null;
|
|
261
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceCreateResponses, ExperimentalWorkspaceCreateErrors, ThrowOnError, "fields">;
|
|
283
262
|
/**
|
|
284
|
-
*
|
|
263
|
+
* Workspace status
|
|
285
264
|
*
|
|
286
|
-
*
|
|
265
|
+
* Get connection status for workspaces in the current project.
|
|
287
266
|
*/
|
|
288
|
-
|
|
267
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
289
268
|
directory?: string;
|
|
290
269
|
workspace?: string;
|
|
291
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
270
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceStatusResponses, unknown, ThrowOnError, "fields">;
|
|
292
271
|
/**
|
|
293
|
-
*
|
|
272
|
+
* Remove workspace
|
|
294
273
|
*
|
|
295
|
-
*
|
|
274
|
+
* Remove an existing workspace.
|
|
296
275
|
*/
|
|
297
|
-
|
|
298
|
-
|
|
276
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
277
|
+
id: string;
|
|
299
278
|
directory?: string;
|
|
300
279
|
workspace?: string;
|
|
301
|
-
|
|
302
|
-
icon?: {
|
|
303
|
-
url?: string;
|
|
304
|
-
override?: string;
|
|
305
|
-
color?: string;
|
|
306
|
-
};
|
|
307
|
-
commands?: {
|
|
308
|
-
/**
|
|
309
|
-
* Startup script to run when creating a new workspace (worktree)
|
|
310
|
-
*/
|
|
311
|
-
start?: string;
|
|
312
|
-
};
|
|
313
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectUpdateResponses, ProjectUpdateErrors, ThrowOnError, "fields">;
|
|
314
|
-
}
|
|
315
|
-
export declare class Pty extends HeyApiClient {
|
|
280
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceRemoveResponses, ExperimentalWorkspaceRemoveErrors, ThrowOnError, "fields">;
|
|
316
281
|
/**
|
|
317
|
-
*
|
|
282
|
+
* Restore session into workspace
|
|
318
283
|
*
|
|
319
|
-
*
|
|
284
|
+
* Replay a session's sync events into the target workspace in batches.
|
|
320
285
|
*/
|
|
321
|
-
|
|
286
|
+
sessionRestore<ThrowOnError extends boolean = false>(parameters: {
|
|
287
|
+
id: string;
|
|
322
288
|
directory?: string;
|
|
323
289
|
workspace?: string;
|
|
324
|
-
|
|
290
|
+
sessionID?: string;
|
|
291
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ExperimentalWorkspaceSessionRestoreResponses, ExperimentalWorkspaceSessionRestoreErrors, ThrowOnError, "fields">;
|
|
292
|
+
private _adapter?;
|
|
293
|
+
get adapter(): Adapter;
|
|
294
|
+
}
|
|
295
|
+
export declare class Experimental extends HeyApiClient {
|
|
296
|
+
private _console?;
|
|
297
|
+
get console(): Console;
|
|
298
|
+
private _session?;
|
|
299
|
+
get session(): Session;
|
|
300
|
+
private _resource?;
|
|
301
|
+
get resource(): Resource;
|
|
302
|
+
private _workspace?;
|
|
303
|
+
get workspace(): Workspace;
|
|
304
|
+
}
|
|
305
|
+
export declare class Tool extends HeyApiClient {
|
|
325
306
|
/**
|
|
326
|
-
* List
|
|
307
|
+
* List tools
|
|
327
308
|
*
|
|
328
|
-
* Get a list of
|
|
309
|
+
* Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
|
|
329
310
|
*/
|
|
330
|
-
list<ThrowOnError extends boolean = false>(parameters
|
|
311
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
331
312
|
directory?: string;
|
|
332
313
|
workspace?: string;
|
|
333
|
-
|
|
314
|
+
provider: string;
|
|
315
|
+
model: string;
|
|
316
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolListResponses, ToolListErrors, ThrowOnError, "fields">;
|
|
334
317
|
/**
|
|
335
|
-
*
|
|
318
|
+
* List tool IDs
|
|
336
319
|
*
|
|
337
|
-
*
|
|
320
|
+
* Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
|
|
338
321
|
*/
|
|
339
|
-
|
|
322
|
+
ids<ThrowOnError extends boolean = false>(parameters?: {
|
|
340
323
|
directory?: string;
|
|
341
324
|
workspace?: string;
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
title?: string;
|
|
346
|
-
env?: {
|
|
347
|
-
[key: string]: string;
|
|
348
|
-
};
|
|
349
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError, "fields">;
|
|
325
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolIdsResponses, ToolIdsErrors, ThrowOnError, "fields">;
|
|
326
|
+
}
|
|
327
|
+
export declare class Worktree extends HeyApiClient {
|
|
350
328
|
/**
|
|
351
|
-
* Remove
|
|
329
|
+
* Remove worktree
|
|
352
330
|
*
|
|
353
|
-
* Remove
|
|
331
|
+
* Remove a git worktree and delete its branch.
|
|
354
332
|
*/
|
|
355
|
-
remove<ThrowOnError extends boolean = false>(parameters
|
|
356
|
-
ptyID: string;
|
|
333
|
+
remove<ThrowOnError extends boolean = false>(parameters?: {
|
|
357
334
|
directory?: string;
|
|
358
335
|
workspace?: string;
|
|
359
|
-
|
|
336
|
+
worktreeRemoveInput?: WorktreeRemoveInput;
|
|
337
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeRemoveResponses, WorktreeRemoveErrors, ThrowOnError, "fields">;
|
|
360
338
|
/**
|
|
361
|
-
*
|
|
339
|
+
* List worktrees
|
|
362
340
|
*
|
|
363
|
-
*
|
|
341
|
+
* List all sandbox worktrees for the current project.
|
|
364
342
|
*/
|
|
365
|
-
|
|
366
|
-
ptyID: string;
|
|
343
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
367
344
|
directory?: string;
|
|
368
345
|
workspace?: string;
|
|
369
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
346
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeListResponses, unknown, ThrowOnError, "fields">;
|
|
370
347
|
/**
|
|
371
|
-
*
|
|
348
|
+
* Create worktree
|
|
372
349
|
*
|
|
373
|
-
*
|
|
350
|
+
* Create a new git worktree for the current project and run any configured startup scripts.
|
|
374
351
|
*/
|
|
375
|
-
|
|
376
|
-
ptyID: string;
|
|
352
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
377
353
|
directory?: string;
|
|
378
354
|
workspace?: string;
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
rows: number;
|
|
382
|
-
cols: number;
|
|
383
|
-
};
|
|
384
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError, "fields">;
|
|
355
|
+
worktreeCreateInput?: WorktreeCreateInput;
|
|
356
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeCreateResponses, WorktreeCreateErrors, ThrowOnError, "fields">;
|
|
385
357
|
/**
|
|
386
|
-
*
|
|
358
|
+
* Reset worktree
|
|
387
359
|
*
|
|
388
|
-
*
|
|
360
|
+
* Reset a worktree branch to the primary default branch.
|
|
389
361
|
*/
|
|
390
|
-
|
|
391
|
-
ptyID: string;
|
|
362
|
+
reset<ThrowOnError extends boolean = false>(parameters?: {
|
|
392
363
|
directory?: string;
|
|
393
364
|
workspace?: string;
|
|
394
|
-
|
|
365
|
+
worktreeResetInput?: WorktreeResetInput;
|
|
366
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeResetResponses, WorktreeResetErrors, ThrowOnError, "fields">;
|
|
395
367
|
}
|
|
396
|
-
export declare class
|
|
368
|
+
export declare class Find extends HeyApiClient {
|
|
397
369
|
/**
|
|
398
|
-
*
|
|
370
|
+
* Find text
|
|
399
371
|
*
|
|
400
|
-
*
|
|
372
|
+
* Search for text patterns across files in the project using ripgrep.
|
|
401
373
|
*/
|
|
402
|
-
|
|
374
|
+
text<ThrowOnError extends boolean = false>(parameters: {
|
|
403
375
|
directory?: string;
|
|
404
376
|
workspace?: string;
|
|
405
|
-
|
|
377
|
+
pattern: string;
|
|
378
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindTextResponses, unknown, ThrowOnError, "fields">;
|
|
406
379
|
/**
|
|
407
|
-
*
|
|
380
|
+
* Find files
|
|
408
381
|
*
|
|
409
|
-
*
|
|
382
|
+
* Search for files or directories by name or pattern in the project directory.
|
|
410
383
|
*/
|
|
411
|
-
|
|
384
|
+
files<ThrowOnError extends boolean = false>(parameters: {
|
|
412
385
|
directory?: string;
|
|
413
386
|
workspace?: string;
|
|
414
|
-
|
|
415
|
-
|
|
387
|
+
query: string;
|
|
388
|
+
dirs?: "true" | "false";
|
|
389
|
+
type?: "file" | "directory";
|
|
390
|
+
limit?: number;
|
|
391
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindFilesResponses, unknown, ThrowOnError, "fields">;
|
|
416
392
|
/**
|
|
417
|
-
*
|
|
393
|
+
* Find symbols
|
|
418
394
|
*
|
|
419
|
-
*
|
|
395
|
+
* Search for workspace symbols like functions, classes, and variables using LSP.
|
|
420
396
|
*/
|
|
421
|
-
|
|
397
|
+
symbols<ThrowOnError extends boolean = false>(parameters: {
|
|
422
398
|
directory?: string;
|
|
423
399
|
workspace?: string;
|
|
424
|
-
|
|
400
|
+
query: string;
|
|
401
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindSymbolsResponses, unknown, ThrowOnError, "fields">;
|
|
425
402
|
}
|
|
426
|
-
export declare class
|
|
403
|
+
export declare class File extends HeyApiClient {
|
|
427
404
|
/**
|
|
428
|
-
* List
|
|
405
|
+
* List files
|
|
429
406
|
*
|
|
430
|
-
*
|
|
407
|
+
* List files and directories in a specified path.
|
|
431
408
|
*/
|
|
432
|
-
|
|
409
|
+
list<ThrowOnError extends boolean = false>(parameters: {
|
|
433
410
|
directory?: string;
|
|
434
411
|
workspace?: string;
|
|
435
|
-
|
|
412
|
+
path: string;
|
|
413
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileListResponses, unknown, ThrowOnError, "fields">;
|
|
436
414
|
/**
|
|
437
|
-
*
|
|
415
|
+
* Read file
|
|
438
416
|
*
|
|
439
|
-
*
|
|
417
|
+
* Read the content of a specified file.
|
|
440
418
|
*/
|
|
441
|
-
|
|
419
|
+
read<ThrowOnError extends boolean = false>(parameters: {
|
|
442
420
|
directory?: string;
|
|
443
421
|
workspace?: string;
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
422
|
+
path: string;
|
|
423
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReadResponses, unknown, ThrowOnError, "fields">;
|
|
424
|
+
/**
|
|
425
|
+
* Get file status
|
|
426
|
+
*
|
|
427
|
+
* Get the git status of all files in the project.
|
|
428
|
+
*/
|
|
429
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
430
|
+
directory?: string;
|
|
431
|
+
workspace?: string;
|
|
432
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileStatusResponses, unknown, ThrowOnError, "fields">;
|
|
447
433
|
}
|
|
448
|
-
export declare class
|
|
434
|
+
export declare class Instance extends HeyApiClient {
|
|
449
435
|
/**
|
|
450
|
-
*
|
|
436
|
+
* Dispose instance
|
|
451
437
|
*
|
|
452
|
-
*
|
|
438
|
+
* Clean up and dispose the current OpenCode instance, releasing all resources.
|
|
453
439
|
*/
|
|
454
|
-
|
|
440
|
+
dispose<ThrowOnError extends boolean = false>(parameters?: {
|
|
455
441
|
directory?: string;
|
|
456
442
|
workspace?: string;
|
|
457
|
-
|
|
458
|
-
|
|
443
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InstanceDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
444
|
+
}
|
|
445
|
+
export declare class Path extends HeyApiClient {
|
|
459
446
|
/**
|
|
460
|
-
*
|
|
447
|
+
* Get paths
|
|
461
448
|
*
|
|
462
|
-
*
|
|
449
|
+
* Retrieve the current working directory and related path information for the OpenCode instance.
|
|
463
450
|
*/
|
|
464
|
-
|
|
451
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
465
452
|
directory?: string;
|
|
466
453
|
workspace?: string;
|
|
467
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
454
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PathGetResponses, unknown, ThrowOnError, "fields">;
|
|
455
|
+
}
|
|
456
|
+
export declare class Vcs extends HeyApiClient {
|
|
468
457
|
/**
|
|
469
|
-
*
|
|
458
|
+
* Get VCS info
|
|
470
459
|
*
|
|
471
|
-
*
|
|
460
|
+
* Retrieve version control system (VCS) information for the current project, such as git branch.
|
|
472
461
|
*/
|
|
473
|
-
|
|
462
|
+
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
474
463
|
directory?: string;
|
|
475
464
|
workspace?: string;
|
|
476
|
-
|
|
477
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<WorktreeCreateResponses, WorktreeCreateErrors, ThrowOnError, "fields">;
|
|
465
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsGetResponses, unknown, ThrowOnError, "fields">;
|
|
478
466
|
/**
|
|
479
|
-
*
|
|
467
|
+
* Get VCS diff
|
|
480
468
|
*
|
|
481
|
-
*
|
|
469
|
+
* Retrieve the current git diff for the working tree or against the default branch.
|
|
482
470
|
*/
|
|
483
|
-
|
|
471
|
+
diff<ThrowOnError extends boolean = false>(parameters: {
|
|
484
472
|
directory?: string;
|
|
485
473
|
workspace?: string;
|
|
486
|
-
|
|
487
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
474
|
+
mode: "git" | "branch";
|
|
475
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsDiffResponses, unknown, ThrowOnError, "fields">;
|
|
488
476
|
}
|
|
489
|
-
export declare class
|
|
477
|
+
export declare class Command extends HeyApiClient {
|
|
490
478
|
/**
|
|
491
|
-
* List
|
|
479
|
+
* List commands
|
|
492
480
|
*
|
|
493
|
-
* Get a list of all
|
|
481
|
+
* Get a list of all available commands in the OpenCode system.
|
|
494
482
|
*/
|
|
495
483
|
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
496
484
|
directory?: string;
|
|
497
485
|
workspace?: string;
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
start?: number;
|
|
502
|
-
search?: string;
|
|
503
|
-
limit?: number;
|
|
504
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionListResponses, unknown, ThrowOnError, "fields">;
|
|
486
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<CommandListResponses, unknown, ThrowOnError, "fields">;
|
|
487
|
+
}
|
|
488
|
+
export declare class Lsp extends HeyApiClient {
|
|
505
489
|
/**
|
|
506
|
-
*
|
|
490
|
+
* Get LSP status
|
|
507
491
|
*
|
|
508
|
-
*
|
|
492
|
+
* Get LSP server status
|
|
509
493
|
*/
|
|
510
|
-
|
|
494
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
511
495
|
directory?: string;
|
|
512
496
|
workspace?: string;
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
workspaceID?: string;
|
|
517
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError, "fields">;
|
|
497
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<LspStatusResponses, unknown, ThrowOnError, "fields">;
|
|
498
|
+
}
|
|
499
|
+
export declare class Formatter extends HeyApiClient {
|
|
518
500
|
/**
|
|
519
|
-
* Get
|
|
501
|
+
* Get formatter status
|
|
520
502
|
*
|
|
521
|
-
*
|
|
503
|
+
* Get formatter status
|
|
522
504
|
*/
|
|
523
505
|
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
524
506
|
directory?: string;
|
|
525
507
|
workspace?: string;
|
|
526
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
508
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FormatterStatusResponses, unknown, ThrowOnError, "fields">;
|
|
509
|
+
}
|
|
510
|
+
export declare class Auth2 extends HeyApiClient {
|
|
527
511
|
/**
|
|
528
|
-
*
|
|
512
|
+
* Remove MCP OAuth
|
|
529
513
|
*
|
|
530
|
-
*
|
|
514
|
+
* Remove OAuth credentials for an MCP server.
|
|
531
515
|
*/
|
|
532
|
-
|
|
533
|
-
|
|
516
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
517
|
+
name: string;
|
|
534
518
|
directory?: string;
|
|
535
519
|
workspace?: string;
|
|
536
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
520
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError, "fields">;
|
|
537
521
|
/**
|
|
538
|
-
*
|
|
522
|
+
* Start MCP OAuth
|
|
539
523
|
*
|
|
540
|
-
*
|
|
524
|
+
* Start OAuth authentication flow for a Model Context Protocol (MCP) server.
|
|
541
525
|
*/
|
|
542
|
-
|
|
543
|
-
|
|
526
|
+
start<ThrowOnError extends boolean = false>(parameters: {
|
|
527
|
+
name: string;
|
|
544
528
|
directory?: string;
|
|
545
529
|
workspace?: string;
|
|
546
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
530
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError, "fields">;
|
|
547
531
|
/**
|
|
548
|
-
*
|
|
532
|
+
* Complete MCP OAuth
|
|
549
533
|
*
|
|
550
|
-
*
|
|
534
|
+
* Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
|
|
551
535
|
*/
|
|
552
|
-
|
|
553
|
-
|
|
536
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
537
|
+
name: string;
|
|
554
538
|
directory?: string;
|
|
555
539
|
workspace?: string;
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
time?: {
|
|
559
|
-
archived?: number;
|
|
560
|
-
};
|
|
561
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError, "fields">;
|
|
540
|
+
code?: string;
|
|
541
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError, "fields">;
|
|
562
542
|
/**
|
|
563
|
-
*
|
|
543
|
+
* Authenticate MCP OAuth
|
|
564
544
|
*
|
|
565
|
-
*
|
|
545
|
+
* Start OAuth flow and wait for callback (opens browser).
|
|
566
546
|
*/
|
|
567
|
-
|
|
568
|
-
|
|
547
|
+
authenticate<ThrowOnError extends boolean = false>(parameters: {
|
|
548
|
+
name: string;
|
|
569
549
|
directory?: string;
|
|
570
550
|
workspace?: string;
|
|
571
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
551
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError, "fields">;
|
|
552
|
+
}
|
|
553
|
+
export declare class Mcp extends HeyApiClient {
|
|
572
554
|
/**
|
|
573
|
-
* Get
|
|
555
|
+
* Get MCP status
|
|
574
556
|
*
|
|
575
|
-
*
|
|
557
|
+
* Get the status of all Model Context Protocol (MCP) servers.
|
|
576
558
|
*/
|
|
577
|
-
|
|
578
|
-
sessionID: string;
|
|
559
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
579
560
|
directory?: string;
|
|
580
561
|
workspace?: string;
|
|
581
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
562
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpStatusResponses, unknown, ThrowOnError, "fields">;
|
|
582
563
|
/**
|
|
583
|
-
*
|
|
564
|
+
* Add MCP server
|
|
584
565
|
*
|
|
585
|
-
*
|
|
566
|
+
* Dynamically add a new Model Context Protocol (MCP) server to the system.
|
|
586
567
|
*/
|
|
587
|
-
|
|
568
|
+
add<ThrowOnError extends boolean = false>(parameters?: {
|
|
569
|
+
directory?: string;
|
|
570
|
+
workspace?: string;
|
|
571
|
+
name?: string;
|
|
572
|
+
config?: McpLocalConfig | McpRemoteConfig;
|
|
573
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAddResponses, McpAddErrors, ThrowOnError, "fields">;
|
|
574
|
+
/**
|
|
575
|
+
* Connect an MCP server.
|
|
576
|
+
*/
|
|
577
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
578
|
+
name: string;
|
|
579
|
+
directory?: string;
|
|
580
|
+
workspace?: string;
|
|
581
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpConnectResponses, unknown, ThrowOnError, "fields">;
|
|
582
|
+
/**
|
|
583
|
+
* Disconnect an MCP server.
|
|
584
|
+
*/
|
|
585
|
+
disconnect<ThrowOnError extends boolean = false>(parameters: {
|
|
586
|
+
name: string;
|
|
587
|
+
directory?: string;
|
|
588
|
+
workspace?: string;
|
|
589
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpDisconnectResponses, unknown, ThrowOnError, "fields">;
|
|
590
|
+
private _auth?;
|
|
591
|
+
get auth(): Auth2;
|
|
592
|
+
}
|
|
593
|
+
export declare class Project extends HeyApiClient {
|
|
594
|
+
/**
|
|
595
|
+
* List all projects
|
|
596
|
+
*
|
|
597
|
+
* Get a list of projects that have been opened with OpenCode.
|
|
598
|
+
*/
|
|
599
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
600
|
+
directory?: string;
|
|
601
|
+
workspace?: string;
|
|
602
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectListResponses, unknown, ThrowOnError, "fields">;
|
|
603
|
+
/**
|
|
604
|
+
* Get current project
|
|
605
|
+
*
|
|
606
|
+
* Retrieve the currently active project that OpenCode is working with.
|
|
607
|
+
*/
|
|
608
|
+
current<ThrowOnError extends boolean = false>(parameters?: {
|
|
609
|
+
directory?: string;
|
|
610
|
+
workspace?: string;
|
|
611
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectCurrentResponses, unknown, ThrowOnError, "fields">;
|
|
612
|
+
/**
|
|
613
|
+
* Initialize git repository
|
|
614
|
+
*
|
|
615
|
+
* Create a git repository for the current project and return the refreshed project info.
|
|
616
|
+
*/
|
|
617
|
+
initGit<ThrowOnError extends boolean = false>(parameters?: {
|
|
618
|
+
directory?: string;
|
|
619
|
+
workspace?: string;
|
|
620
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectInitGitResponses, unknown, ThrowOnError, "fields">;
|
|
621
|
+
/**
|
|
622
|
+
* Update project
|
|
623
|
+
*
|
|
624
|
+
* Update project properties such as name, icon, and commands.
|
|
625
|
+
*/
|
|
626
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
627
|
+
projectID: string;
|
|
628
|
+
directory?: string;
|
|
629
|
+
workspace?: string;
|
|
630
|
+
name?: string;
|
|
631
|
+
icon?: {
|
|
632
|
+
url?: string;
|
|
633
|
+
override?: string;
|
|
634
|
+
color?: string;
|
|
635
|
+
};
|
|
636
|
+
commands?: {
|
|
637
|
+
/**
|
|
638
|
+
* Startup script to run when creating a new workspace (worktree)
|
|
639
|
+
*/
|
|
640
|
+
start?: string;
|
|
641
|
+
};
|
|
642
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectUpdateResponses, ProjectUpdateErrors, ThrowOnError, "fields">;
|
|
643
|
+
}
|
|
644
|
+
export declare class Pty extends HeyApiClient {
|
|
645
|
+
/**
|
|
646
|
+
* List available shells
|
|
647
|
+
*
|
|
648
|
+
* Get a list of available shells on the system.
|
|
649
|
+
*/
|
|
650
|
+
shells<ThrowOnError extends boolean = false>(parameters?: {
|
|
651
|
+
directory?: string;
|
|
652
|
+
workspace?: string;
|
|
653
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyShellsResponses, unknown, ThrowOnError, "fields">;
|
|
654
|
+
/**
|
|
655
|
+
* List PTY sessions
|
|
656
|
+
*
|
|
657
|
+
* Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.
|
|
658
|
+
*/
|
|
659
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
660
|
+
directory?: string;
|
|
661
|
+
workspace?: string;
|
|
662
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyListResponses, unknown, ThrowOnError, "fields">;
|
|
663
|
+
/**
|
|
664
|
+
* Create PTY session
|
|
665
|
+
*
|
|
666
|
+
* Create a new pseudo-terminal (PTY) session for running shell commands and processes.
|
|
667
|
+
*/
|
|
668
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
669
|
+
directory?: string;
|
|
670
|
+
workspace?: string;
|
|
671
|
+
command?: string;
|
|
672
|
+
args?: Array<string>;
|
|
673
|
+
cwd?: string;
|
|
674
|
+
title?: string;
|
|
675
|
+
env?: {
|
|
676
|
+
[key: string]: string;
|
|
677
|
+
};
|
|
678
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError, "fields">;
|
|
679
|
+
/**
|
|
680
|
+
* Remove PTY session
|
|
681
|
+
*
|
|
682
|
+
* Remove and terminate a specific pseudo-terminal (PTY) session.
|
|
683
|
+
*/
|
|
684
|
+
remove<ThrowOnError extends boolean = false>(parameters: {
|
|
685
|
+
ptyID: string;
|
|
686
|
+
directory?: string;
|
|
687
|
+
workspace?: string;
|
|
688
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError, "fields">;
|
|
689
|
+
/**
|
|
690
|
+
* Get PTY session
|
|
691
|
+
*
|
|
692
|
+
* Retrieve detailed information about a specific pseudo-terminal (PTY) session.
|
|
693
|
+
*/
|
|
694
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
695
|
+
ptyID: string;
|
|
696
|
+
directory?: string;
|
|
697
|
+
workspace?: string;
|
|
698
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyGetResponses, PtyGetErrors, ThrowOnError, "fields">;
|
|
699
|
+
/**
|
|
700
|
+
* Update PTY session
|
|
701
|
+
*
|
|
702
|
+
* Update properties of an existing pseudo-terminal (PTY) session.
|
|
703
|
+
*/
|
|
704
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
705
|
+
ptyID: string;
|
|
706
|
+
directory?: string;
|
|
707
|
+
workspace?: string;
|
|
708
|
+
title?: string;
|
|
709
|
+
size?: {
|
|
710
|
+
rows: number;
|
|
711
|
+
cols: number;
|
|
712
|
+
};
|
|
713
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError, "fields">;
|
|
714
|
+
/**
|
|
715
|
+
* Connect to PTY session
|
|
716
|
+
*
|
|
717
|
+
* Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
|
|
718
|
+
*/
|
|
719
|
+
connect<ThrowOnError extends boolean = false>(parameters: {
|
|
720
|
+
ptyID: string;
|
|
721
|
+
directory?: string;
|
|
722
|
+
workspace?: string;
|
|
723
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyConnectResponses, PtyConnectErrors, ThrowOnError, "fields">;
|
|
724
|
+
}
|
|
725
|
+
export declare class Question extends HeyApiClient {
|
|
726
|
+
/**
|
|
727
|
+
* List pending questions
|
|
728
|
+
*
|
|
729
|
+
* Get all pending question requests across all sessions.
|
|
730
|
+
*/
|
|
731
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
732
|
+
directory?: string;
|
|
733
|
+
workspace?: string;
|
|
734
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionListResponses, unknown, ThrowOnError, "fields">;
|
|
735
|
+
/**
|
|
736
|
+
* Reply to question request
|
|
737
|
+
*
|
|
738
|
+
* Provide answers to a question request from the AI assistant.
|
|
739
|
+
*/
|
|
740
|
+
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
741
|
+
requestID: string;
|
|
742
|
+
directory?: string;
|
|
743
|
+
workspace?: string;
|
|
744
|
+
answers?: Array<QuestionAnswer>;
|
|
745
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionReplyResponses, QuestionReplyErrors, ThrowOnError, "fields">;
|
|
746
|
+
/**
|
|
747
|
+
* Reject question request
|
|
748
|
+
*
|
|
749
|
+
* Reject a question request from the AI assistant.
|
|
750
|
+
*/
|
|
751
|
+
reject<ThrowOnError extends boolean = false>(parameters: {
|
|
752
|
+
requestID: string;
|
|
753
|
+
directory?: string;
|
|
754
|
+
workspace?: string;
|
|
755
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionRejectResponses, QuestionRejectErrors, ThrowOnError, "fields">;
|
|
756
|
+
}
|
|
757
|
+
export declare class Permission extends HeyApiClient {
|
|
758
|
+
/**
|
|
759
|
+
* List pending permissions
|
|
760
|
+
*
|
|
761
|
+
* Get all pending permission requests across all sessions.
|
|
762
|
+
*/
|
|
763
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
764
|
+
directory?: string;
|
|
765
|
+
workspace?: string;
|
|
766
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionListResponses, unknown, ThrowOnError, "fields">;
|
|
767
|
+
/**
|
|
768
|
+
* Respond to permission request
|
|
769
|
+
*
|
|
770
|
+
* Approve or deny a permission request from the AI assistant.
|
|
771
|
+
*/
|
|
772
|
+
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
773
|
+
requestID: string;
|
|
774
|
+
directory?: string;
|
|
775
|
+
workspace?: string;
|
|
776
|
+
reply?: "once" | "always" | "reject";
|
|
777
|
+
message?: string;
|
|
778
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionReplyResponses, PermissionReplyErrors, ThrowOnError, "fields">;
|
|
779
|
+
/**
|
|
780
|
+
* Respond to permission
|
|
781
|
+
*
|
|
782
|
+
* Approve or deny a permission request from the AI assistant.
|
|
783
|
+
*
|
|
784
|
+
* @deprecated
|
|
785
|
+
*/
|
|
786
|
+
respond<ThrowOnError extends boolean = false>(parameters: {
|
|
588
787
|
sessionID: string;
|
|
788
|
+
permissionID: string;
|
|
589
789
|
directory?: string;
|
|
590
790
|
workspace?: string;
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
791
|
+
response?: "once" | "always" | "reject";
|
|
792
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError, "fields">;
|
|
793
|
+
}
|
|
794
|
+
export declare class Oauth extends HeyApiClient {
|
|
595
795
|
/**
|
|
596
|
-
*
|
|
796
|
+
* Start OAuth authorization
|
|
597
797
|
*
|
|
598
|
-
*
|
|
798
|
+
* Start the OAuth authorization flow for a provider.
|
|
599
799
|
*/
|
|
600
|
-
|
|
800
|
+
authorize<ThrowOnError extends boolean = false>(parameters: {
|
|
801
|
+
providerID: string;
|
|
802
|
+
directory?: string;
|
|
803
|
+
workspace?: string;
|
|
804
|
+
method?: number;
|
|
805
|
+
inputs?: {
|
|
806
|
+
[key: string]: string;
|
|
807
|
+
};
|
|
808
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError, "fields">;
|
|
809
|
+
/**
|
|
810
|
+
* Handle OAuth callback
|
|
811
|
+
*
|
|
812
|
+
* Handle the OAuth callback from a provider after user authorization.
|
|
813
|
+
*/
|
|
814
|
+
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
815
|
+
providerID: string;
|
|
816
|
+
directory?: string;
|
|
817
|
+
workspace?: string;
|
|
818
|
+
method?: number;
|
|
819
|
+
code?: string;
|
|
820
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthCallbackResponses, ProviderOauthCallbackErrors, ThrowOnError, "fields">;
|
|
821
|
+
}
|
|
822
|
+
export declare class Provider extends HeyApiClient {
|
|
823
|
+
/**
|
|
824
|
+
* List providers
|
|
825
|
+
*
|
|
826
|
+
* Get a list of all available AI providers, including both available and connected ones.
|
|
827
|
+
*/
|
|
828
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
829
|
+
directory?: string;
|
|
830
|
+
workspace?: string;
|
|
831
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderListResponses, unknown, ThrowOnError, "fields">;
|
|
832
|
+
/**
|
|
833
|
+
* Get provider auth methods
|
|
834
|
+
*
|
|
835
|
+
* Retrieve available authentication methods for all AI providers.
|
|
836
|
+
*/
|
|
837
|
+
auth<ThrowOnError extends boolean = false>(parameters?: {
|
|
838
|
+
directory?: string;
|
|
839
|
+
workspace?: string;
|
|
840
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderAuthResponses, unknown, ThrowOnError, "fields">;
|
|
841
|
+
private _oauth?;
|
|
842
|
+
get oauth(): Oauth;
|
|
843
|
+
}
|
|
844
|
+
export declare class Session2 extends HeyApiClient {
|
|
845
|
+
/**
|
|
846
|
+
* List sessions
|
|
847
|
+
*
|
|
848
|
+
* Get a list of all OpenCode sessions, sorted by most recently updated.
|
|
849
|
+
*/
|
|
850
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
851
|
+
directory?: string;
|
|
852
|
+
workspace?: string;
|
|
853
|
+
scope?: "project";
|
|
854
|
+
path?: string;
|
|
855
|
+
roots?: boolean | "true" | "false";
|
|
856
|
+
start?: number;
|
|
857
|
+
search?: string;
|
|
858
|
+
limit?: number;
|
|
859
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionListResponses, unknown, ThrowOnError, "fields">;
|
|
860
|
+
/**
|
|
861
|
+
* Create session
|
|
862
|
+
*
|
|
863
|
+
* Create a new OpenCode session for interacting with AI assistants and managing conversations.
|
|
864
|
+
*/
|
|
865
|
+
create<ThrowOnError extends boolean = false>(parameters?: {
|
|
866
|
+
directory?: string;
|
|
867
|
+
workspace?: string;
|
|
868
|
+
parentID?: string;
|
|
869
|
+
title?: string;
|
|
870
|
+
agent?: string;
|
|
871
|
+
model?: {
|
|
872
|
+
id: string;
|
|
873
|
+
providerID: string;
|
|
874
|
+
variant?: string;
|
|
875
|
+
};
|
|
876
|
+
permission?: PermissionRuleset;
|
|
877
|
+
workspaceID?: string;
|
|
878
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError, "fields">;
|
|
879
|
+
/**
|
|
880
|
+
* Get session status
|
|
881
|
+
*
|
|
882
|
+
* Retrieve the current status of all sessions, including active, idle, and completed states.
|
|
883
|
+
*/
|
|
884
|
+
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
885
|
+
directory?: string;
|
|
886
|
+
workspace?: string;
|
|
887
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionStatusResponses, SessionStatusErrors, ThrowOnError, "fields">;
|
|
888
|
+
/**
|
|
889
|
+
* Delete session
|
|
890
|
+
*
|
|
891
|
+
* Delete a session and permanently remove all associated data, including messages and history.
|
|
892
|
+
*/
|
|
893
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
601
894
|
sessionID: string;
|
|
602
895
|
directory?: string;
|
|
603
896
|
workspace?: string;
|
|
604
|
-
|
|
605
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionForkResponses, unknown, ThrowOnError, "fields">;
|
|
897
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError, "fields">;
|
|
606
898
|
/**
|
|
607
|
-
*
|
|
899
|
+
* Get session
|
|
608
900
|
*
|
|
609
|
-
*
|
|
901
|
+
* Retrieve detailed information about a specific OpenCode session.
|
|
610
902
|
*/
|
|
611
|
-
|
|
903
|
+
get<ThrowOnError extends boolean = false>(parameters: {
|
|
612
904
|
sessionID: string;
|
|
613
905
|
directory?: string;
|
|
614
906
|
workspace?: string;
|
|
615
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
907
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionGetResponses, SessionGetErrors, ThrowOnError, "fields">;
|
|
616
908
|
/**
|
|
617
|
-
*
|
|
909
|
+
* Update session
|
|
618
910
|
*
|
|
619
|
-
*
|
|
911
|
+
* Update properties of an existing session, such as title or other metadata.
|
|
620
912
|
*/
|
|
621
|
-
|
|
913
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
622
914
|
sessionID: string;
|
|
623
915
|
directory?: string;
|
|
624
916
|
workspace?: string;
|
|
625
|
-
|
|
917
|
+
title?: string;
|
|
918
|
+
permission?: PermissionRuleset;
|
|
919
|
+
time?: {
|
|
920
|
+
archived?: number;
|
|
921
|
+
};
|
|
922
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError, "fields">;
|
|
626
923
|
/**
|
|
627
|
-
*
|
|
924
|
+
* Get session children
|
|
628
925
|
*
|
|
629
|
-
*
|
|
926
|
+
* Retrieve all child sessions that were forked from the specified parent session.
|
|
630
927
|
*/
|
|
631
|
-
|
|
928
|
+
children<ThrowOnError extends boolean = false>(parameters: {
|
|
632
929
|
sessionID: string;
|
|
633
930
|
directory?: string;
|
|
634
931
|
workspace?: string;
|
|
635
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
932
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError, "fields">;
|
|
636
933
|
/**
|
|
637
|
-
* Get
|
|
934
|
+
* Get session todos
|
|
638
935
|
*
|
|
639
|
-
*
|
|
936
|
+
* Retrieve the todo list associated with a specific session, showing tasks and action items.
|
|
640
937
|
*/
|
|
641
|
-
|
|
938
|
+
todo<ThrowOnError extends boolean = false>(parameters: {
|
|
642
939
|
sessionID: string;
|
|
643
940
|
directory?: string;
|
|
644
941
|
workspace?: string;
|
|
645
|
-
|
|
646
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDiffResponses, unknown, ThrowOnError, "fields">;
|
|
942
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionTodoResponses, SessionTodoErrors, ThrowOnError, "fields">;
|
|
647
943
|
/**
|
|
648
|
-
*
|
|
944
|
+
* Get message diff
|
|
649
945
|
*
|
|
650
|
-
*
|
|
946
|
+
* Get the file changes (diff) that resulted from a specific user message in the session.
|
|
651
947
|
*/
|
|
652
|
-
|
|
948
|
+
diff<ThrowOnError extends boolean = false>(parameters: {
|
|
653
949
|
sessionID: string;
|
|
654
950
|
directory?: string;
|
|
655
951
|
workspace?: string;
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
auto?: boolean;
|
|
659
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError, "fields">;
|
|
952
|
+
messageID?: string;
|
|
953
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDiffResponses, unknown, ThrowOnError, "fields">;
|
|
660
954
|
/**
|
|
661
955
|
* Get session messages
|
|
662
956
|
*
|
|
@@ -694,27 +988,94 @@ export declare class Session2 extends HeyApiClient {
|
|
|
694
988
|
parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
|
|
695
989
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptResponses, SessionPromptErrors, ThrowOnError, "fields">;
|
|
696
990
|
/**
|
|
697
|
-
* Delete message
|
|
991
|
+
* Delete message
|
|
992
|
+
*
|
|
993
|
+
* Permanently delete a specific message and all of its parts from a session without reverting file changes.
|
|
994
|
+
*/
|
|
995
|
+
deleteMessage<ThrowOnError extends boolean = false>(parameters: {
|
|
996
|
+
sessionID: string;
|
|
997
|
+
messageID: string;
|
|
998
|
+
directory?: string;
|
|
999
|
+
workspace?: string;
|
|
1000
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDeleteMessageResponses, SessionDeleteMessageErrors, ThrowOnError, "fields">;
|
|
1001
|
+
/**
|
|
1002
|
+
* Get message
|
|
1003
|
+
*
|
|
1004
|
+
* Retrieve a specific message from a session by its message ID.
|
|
1005
|
+
*/
|
|
1006
|
+
message<ThrowOnError extends boolean = false>(parameters: {
|
|
1007
|
+
sessionID: string;
|
|
1008
|
+
messageID: string;
|
|
1009
|
+
directory?: string;
|
|
1010
|
+
workspace?: string;
|
|
1011
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessageResponses, SessionMessageErrors, ThrowOnError, "fields">;
|
|
1012
|
+
/**
|
|
1013
|
+
* Fork session
|
|
1014
|
+
*
|
|
1015
|
+
* Create a new session by forking an existing session at a specific message point.
|
|
1016
|
+
*/
|
|
1017
|
+
fork<ThrowOnError extends boolean = false>(parameters: {
|
|
1018
|
+
sessionID: string;
|
|
1019
|
+
directory?: string;
|
|
1020
|
+
workspace?: string;
|
|
1021
|
+
messageID?: string;
|
|
1022
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionForkResponses, unknown, ThrowOnError, "fields">;
|
|
1023
|
+
/**
|
|
1024
|
+
* Abort session
|
|
1025
|
+
*
|
|
1026
|
+
* Abort an active session and stop any ongoing AI processing or command execution.
|
|
1027
|
+
*/
|
|
1028
|
+
abort<ThrowOnError extends boolean = false>(parameters: {
|
|
1029
|
+
sessionID: string;
|
|
1030
|
+
directory?: string;
|
|
1031
|
+
workspace?: string;
|
|
1032
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionAbortResponses, SessionAbortErrors, ThrowOnError, "fields">;
|
|
1033
|
+
/**
|
|
1034
|
+
* Initialize session
|
|
1035
|
+
*
|
|
1036
|
+
* Analyze the current application and create an AGENTS.md file with project-specific agent configurations.
|
|
1037
|
+
*/
|
|
1038
|
+
init<ThrowOnError extends boolean = false>(parameters: {
|
|
1039
|
+
sessionID: string;
|
|
1040
|
+
directory?: string;
|
|
1041
|
+
workspace?: string;
|
|
1042
|
+
modelID?: string;
|
|
1043
|
+
providerID?: string;
|
|
1044
|
+
messageID?: string;
|
|
1045
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionInitResponses, SessionInitErrors, ThrowOnError, "fields">;
|
|
1046
|
+
/**
|
|
1047
|
+
* Unshare session
|
|
1048
|
+
*
|
|
1049
|
+
* Remove the shareable link for a session, making it private again.
|
|
1050
|
+
*/
|
|
1051
|
+
unshare<ThrowOnError extends boolean = false>(parameters: {
|
|
1052
|
+
sessionID: string;
|
|
1053
|
+
directory?: string;
|
|
1054
|
+
workspace?: string;
|
|
1055
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError, "fields">;
|
|
1056
|
+
/**
|
|
1057
|
+
* Share session
|
|
698
1058
|
*
|
|
699
|
-
*
|
|
1059
|
+
* Create a shareable link for a session, allowing others to view the conversation.
|
|
700
1060
|
*/
|
|
701
|
-
|
|
1061
|
+
share<ThrowOnError extends boolean = false>(parameters: {
|
|
702
1062
|
sessionID: string;
|
|
703
|
-
messageID: string;
|
|
704
1063
|
directory?: string;
|
|
705
1064
|
workspace?: string;
|
|
706
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
1065
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShareResponses, SessionShareErrors, ThrowOnError, "fields">;
|
|
707
1066
|
/**
|
|
708
|
-
*
|
|
1067
|
+
* Summarize session
|
|
709
1068
|
*
|
|
710
|
-
*
|
|
1069
|
+
* Generate a concise summary of the session using AI compaction to preserve key information.
|
|
711
1070
|
*/
|
|
712
|
-
|
|
1071
|
+
summarize<ThrowOnError extends boolean = false>(parameters: {
|
|
713
1072
|
sessionID: string;
|
|
714
|
-
messageID: string;
|
|
715
1073
|
directory?: string;
|
|
716
1074
|
workspace?: string;
|
|
717
|
-
|
|
1075
|
+
providerID?: string;
|
|
1076
|
+
modelID?: string;
|
|
1077
|
+
auto?: boolean;
|
|
1078
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError, "fields">;
|
|
718
1079
|
/**
|
|
719
1080
|
* Send async message
|
|
720
1081
|
*
|
|
@@ -787,375 +1148,163 @@ export declare class Session2 extends HeyApiClient {
|
|
|
787
1148
|
*/
|
|
788
1149
|
revert<ThrowOnError extends boolean = false>(parameters: {
|
|
789
1150
|
sessionID: string;
|
|
790
|
-
directory?: string;
|
|
791
|
-
workspace?: string;
|
|
792
|
-
messageID?: string;
|
|
793
|
-
partID?: string;
|
|
794
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError, "fields">;
|
|
795
|
-
/**
|
|
796
|
-
* Restore reverted messages
|
|
797
|
-
*
|
|
798
|
-
* Restore all previously reverted messages in a session.
|
|
799
|
-
*/
|
|
800
|
-
unrevert<ThrowOnError extends boolean = false>(parameters: {
|
|
801
|
-
sessionID: string;
|
|
802
|
-
directory?: string;
|
|
803
|
-
workspace?: string;
|
|
804
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError, "fields">;
|
|
805
|
-
}
|
|
806
|
-
export declare class Part extends HeyApiClient {
|
|
807
|
-
/**
|
|
808
|
-
* Delete a part from a message
|
|
809
|
-
*/
|
|
810
|
-
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
811
|
-
sessionID: string;
|
|
812
|
-
messageID: string;
|
|
813
|
-
partID: string;
|
|
814
|
-
directory?: string;
|
|
815
|
-
workspace?: string;
|
|
816
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartDeleteResponses, PartDeleteErrors, ThrowOnError, "fields">;
|
|
817
|
-
/**
|
|
818
|
-
* Update a part in a message
|
|
819
|
-
*/
|
|
820
|
-
update<ThrowOnError extends boolean = false>(parameters: {
|
|
821
|
-
sessionID: string;
|
|
822
|
-
messageID: string;
|
|
823
|
-
partID: string;
|
|
824
|
-
directory?: string;
|
|
825
|
-
workspace?: string;
|
|
826
|
-
part?: Part2;
|
|
827
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartUpdateResponses, PartUpdateErrors, ThrowOnError, "fields">;
|
|
828
|
-
}
|
|
829
|
-
export declare class Permission extends HeyApiClient {
|
|
830
|
-
/**
|
|
831
|
-
* Respond to permission
|
|
832
|
-
*
|
|
833
|
-
* Approve or deny a permission request from the AI assistant.
|
|
834
|
-
*
|
|
835
|
-
* @deprecated
|
|
836
|
-
*/
|
|
837
|
-
respond<ThrowOnError extends boolean = false>(parameters: {
|
|
838
|
-
sessionID: string;
|
|
839
|
-
permissionID: string;
|
|
840
|
-
directory?: string;
|
|
841
|
-
workspace?: string;
|
|
842
|
-
response?: "once" | "always" | "reject";
|
|
843
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionRespondResponses, PermissionRespondErrors, ThrowOnError, "fields">;
|
|
844
|
-
/**
|
|
845
|
-
* Respond to permission request
|
|
846
|
-
*
|
|
847
|
-
* Approve or deny a permission request from the AI assistant.
|
|
848
|
-
*/
|
|
849
|
-
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
850
|
-
requestID: string;
|
|
851
|
-
directory?: string;
|
|
852
|
-
workspace?: string;
|
|
853
|
-
reply?: "once" | "always" | "reject";
|
|
854
|
-
message?: string;
|
|
855
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionReplyResponses, PermissionReplyErrors, ThrowOnError, "fields">;
|
|
856
|
-
/**
|
|
857
|
-
* List pending permissions
|
|
858
|
-
*
|
|
859
|
-
* Get all pending permission requests across all sessions.
|
|
860
|
-
*/
|
|
861
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
862
|
-
directory?: string;
|
|
863
|
-
workspace?: string;
|
|
864
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PermissionListResponses, unknown, ThrowOnError, "fields">;
|
|
865
|
-
}
|
|
866
|
-
export declare class Question extends HeyApiClient {
|
|
867
|
-
/**
|
|
868
|
-
* List pending questions
|
|
869
|
-
*
|
|
870
|
-
* Get all pending question requests across all sessions.
|
|
871
|
-
*/
|
|
872
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
873
|
-
directory?: string;
|
|
874
|
-
workspace?: string;
|
|
875
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionListResponses, unknown, ThrowOnError, "fields">;
|
|
876
|
-
/**
|
|
877
|
-
* Reply to question request
|
|
878
|
-
*
|
|
879
|
-
* Provide answers to a question request from the AI assistant.
|
|
880
|
-
*/
|
|
881
|
-
reply<ThrowOnError extends boolean = false>(parameters: {
|
|
882
|
-
requestID: string;
|
|
883
|
-
directory?: string;
|
|
884
|
-
workspace?: string;
|
|
885
|
-
answers?: Array<QuestionAnswer>;
|
|
886
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionReplyResponses, QuestionReplyErrors, ThrowOnError, "fields">;
|
|
887
|
-
/**
|
|
888
|
-
* Reject question request
|
|
889
|
-
*
|
|
890
|
-
* Reject a question request from the AI assistant.
|
|
891
|
-
*/
|
|
892
|
-
reject<ThrowOnError extends boolean = false>(parameters: {
|
|
893
|
-
requestID: string;
|
|
894
|
-
directory?: string;
|
|
895
|
-
workspace?: string;
|
|
896
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<QuestionRejectResponses, QuestionRejectErrors, ThrowOnError, "fields">;
|
|
897
|
-
}
|
|
898
|
-
export declare class Oauth extends HeyApiClient {
|
|
899
|
-
/**
|
|
900
|
-
* OAuth authorize
|
|
901
|
-
*
|
|
902
|
-
* Initiate OAuth authorization for a specific AI provider to get an authorization URL.
|
|
903
|
-
*/
|
|
904
|
-
authorize<ThrowOnError extends boolean = false>(parameters: {
|
|
905
|
-
providerID: string;
|
|
906
|
-
directory?: string;
|
|
907
|
-
workspace?: string;
|
|
908
|
-
method?: number;
|
|
909
|
-
inputs?: {
|
|
910
|
-
[key: string]: string;
|
|
911
|
-
};
|
|
912
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError, "fields">;
|
|
913
|
-
/**
|
|
914
|
-
* OAuth callback
|
|
915
|
-
*
|
|
916
|
-
* Handle the OAuth callback from a provider after user authorization.
|
|
917
|
-
*/
|
|
918
|
-
callback<ThrowOnError extends boolean = false>(parameters: {
|
|
919
|
-
providerID: string;
|
|
920
|
-
directory?: string;
|
|
921
|
-
workspace?: string;
|
|
922
|
-
method?: number;
|
|
923
|
-
code?: string;
|
|
924
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthCallbackResponses, ProviderOauthCallbackErrors, ThrowOnError, "fields">;
|
|
925
|
-
}
|
|
926
|
-
export declare class Provider extends HeyApiClient {
|
|
927
|
-
/**
|
|
928
|
-
* List providers
|
|
929
|
-
*
|
|
930
|
-
* Get a list of all available AI providers, including both available and connected ones.
|
|
931
|
-
*/
|
|
932
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
933
|
-
directory?: string;
|
|
934
|
-
workspace?: string;
|
|
935
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderListResponses, unknown, ThrowOnError, "fields">;
|
|
936
|
-
/**
|
|
937
|
-
* Get provider auth methods
|
|
938
|
-
*
|
|
939
|
-
* Retrieve available authentication methods for all AI providers.
|
|
940
|
-
*/
|
|
941
|
-
auth<ThrowOnError extends boolean = false>(parameters?: {
|
|
942
|
-
directory?: string;
|
|
943
|
-
workspace?: string;
|
|
944
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderAuthResponses, unknown, ThrowOnError, "fields">;
|
|
945
|
-
private _oauth?;
|
|
946
|
-
get oauth(): Oauth;
|
|
947
|
-
}
|
|
948
|
-
export declare class History extends HeyApiClient {
|
|
949
|
-
/**
|
|
950
|
-
* List sync events
|
|
951
|
-
*
|
|
952
|
-
* List sync events for all aggregates. Keys are aggregate IDs the client already knows about, values are the last known sequence ID. Events with seq > value are returned for those aggregates. Aggregates not listed in the input get their full history.
|
|
953
|
-
*/
|
|
954
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
955
|
-
directory?: string;
|
|
956
|
-
workspace?: string;
|
|
957
|
-
body?: {
|
|
958
|
-
[key: string]: number;
|
|
959
|
-
};
|
|
960
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncHistoryListResponses, SyncHistoryListErrors, ThrowOnError, "fields">;
|
|
961
|
-
}
|
|
962
|
-
export declare class Sync extends HeyApiClient {
|
|
963
|
-
/**
|
|
964
|
-
* Start workspace sync
|
|
965
|
-
*
|
|
966
|
-
* Start sync loops for workspaces in the current project that have active sessions.
|
|
967
|
-
*/
|
|
968
|
-
start<ThrowOnError extends boolean = false>(parameters?: {
|
|
969
|
-
directory?: string;
|
|
970
|
-
workspace?: string;
|
|
971
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncStartResponses, unknown, ThrowOnError, "fields">;
|
|
972
|
-
/**
|
|
973
|
-
* Replay sync events
|
|
974
|
-
*
|
|
975
|
-
* Validate and replay a complete sync event history.
|
|
976
|
-
*/
|
|
977
|
-
replay<ThrowOnError extends boolean = false>(parameters?: {
|
|
978
|
-
query_directory?: string;
|
|
979
|
-
workspace?: string;
|
|
980
|
-
body_directory?: string;
|
|
981
|
-
events?: Array<{
|
|
982
|
-
id: string;
|
|
983
|
-
aggregateID: string;
|
|
984
|
-
seq: number;
|
|
985
|
-
type: string;
|
|
986
|
-
data: {
|
|
987
|
-
[key: string]: unknown;
|
|
988
|
-
};
|
|
989
|
-
}>;
|
|
990
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncReplayResponses, SyncReplayErrors, ThrowOnError, "fields">;
|
|
991
|
-
private _history?;
|
|
992
|
-
get history(): History;
|
|
993
|
-
}
|
|
994
|
-
export declare class Find extends HeyApiClient {
|
|
995
|
-
/**
|
|
996
|
-
* Find text
|
|
997
|
-
*
|
|
998
|
-
* Search for text patterns across files in the project using ripgrep.
|
|
999
|
-
*/
|
|
1000
|
-
text<ThrowOnError extends boolean = false>(parameters: {
|
|
1001
|
-
directory?: string;
|
|
1002
|
-
workspace?: string;
|
|
1003
|
-
pattern: string;
|
|
1004
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindTextResponses, unknown, ThrowOnError, "fields">;
|
|
1005
|
-
/**
|
|
1006
|
-
* Find files
|
|
1007
|
-
*
|
|
1008
|
-
* Search for files or directories by name or pattern in the project directory.
|
|
1009
|
-
*/
|
|
1010
|
-
files<ThrowOnError extends boolean = false>(parameters: {
|
|
1011
|
-
directory?: string;
|
|
1012
|
-
workspace?: string;
|
|
1013
|
-
query: string;
|
|
1014
|
-
dirs?: "true" | "false";
|
|
1015
|
-
type?: "file" | "directory";
|
|
1016
|
-
limit?: number;
|
|
1017
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindFilesResponses, unknown, ThrowOnError, "fields">;
|
|
1018
|
-
/**
|
|
1019
|
-
* Find symbols
|
|
1020
|
-
*
|
|
1021
|
-
* Search for workspace symbols like functions, classes, and variables using LSP.
|
|
1022
|
-
*/
|
|
1023
|
-
symbols<ThrowOnError extends boolean = false>(parameters: {
|
|
1024
|
-
directory?: string;
|
|
1025
|
-
workspace?: string;
|
|
1026
|
-
query: string;
|
|
1027
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindSymbolsResponses, unknown, ThrowOnError, "fields">;
|
|
1028
|
-
}
|
|
1029
|
-
export declare class File extends HeyApiClient {
|
|
1151
|
+
directory?: string;
|
|
1152
|
+
workspace?: string;
|
|
1153
|
+
messageID?: string;
|
|
1154
|
+
partID?: string;
|
|
1155
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError, "fields">;
|
|
1030
1156
|
/**
|
|
1031
|
-
*
|
|
1157
|
+
* Restore reverted messages
|
|
1032
1158
|
*
|
|
1033
|
-
*
|
|
1159
|
+
* Restore all previously reverted messages in a session.
|
|
1034
1160
|
*/
|
|
1035
|
-
|
|
1161
|
+
unrevert<ThrowOnError extends boolean = false>(parameters: {
|
|
1162
|
+
sessionID: string;
|
|
1036
1163
|
directory?: string;
|
|
1037
1164
|
workspace?: string;
|
|
1038
|
-
|
|
1039
|
-
|
|
1165
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnrevertResponses, SessionUnrevertErrors, ThrowOnError, "fields">;
|
|
1166
|
+
}
|
|
1167
|
+
export declare class Part extends HeyApiClient {
|
|
1040
1168
|
/**
|
|
1041
|
-
*
|
|
1042
|
-
*
|
|
1043
|
-
* Read the content of a specified file.
|
|
1169
|
+
* Delete a part from a message.
|
|
1044
1170
|
*/
|
|
1045
|
-
|
|
1171
|
+
delete<ThrowOnError extends boolean = false>(parameters: {
|
|
1172
|
+
sessionID: string;
|
|
1173
|
+
messageID: string;
|
|
1174
|
+
partID: string;
|
|
1046
1175
|
directory?: string;
|
|
1047
1176
|
workspace?: string;
|
|
1048
|
-
|
|
1049
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReadResponses, unknown, ThrowOnError, "fields">;
|
|
1177
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartDeleteResponses, PartDeleteErrors, ThrowOnError, "fields">;
|
|
1050
1178
|
/**
|
|
1051
|
-
*
|
|
1052
|
-
*
|
|
1053
|
-
* Get the git status of all files in the project.
|
|
1179
|
+
* Update a part in a message.
|
|
1054
1180
|
*/
|
|
1055
|
-
|
|
1181
|
+
update<ThrowOnError extends boolean = false>(parameters: {
|
|
1182
|
+
sessionID: string;
|
|
1183
|
+
messageID: string;
|
|
1184
|
+
partID: string;
|
|
1056
1185
|
directory?: string;
|
|
1057
1186
|
workspace?: string;
|
|
1058
|
-
|
|
1187
|
+
part?: Part2;
|
|
1188
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PartUpdateResponses, PartUpdateErrors, ThrowOnError, "fields">;
|
|
1059
1189
|
}
|
|
1060
|
-
export declare class
|
|
1190
|
+
export declare class History extends HeyApiClient {
|
|
1061
1191
|
/**
|
|
1062
|
-
*
|
|
1192
|
+
* List sync events
|
|
1063
1193
|
*
|
|
1064
|
-
*
|
|
1194
|
+
* List sync events for all aggregates. Keys are aggregate IDs the client already knows about, values are the last known sequence ID. Events with seq > value are returned for those aggregates. Aggregates not listed in the input get their full history.
|
|
1065
1195
|
*/
|
|
1066
|
-
|
|
1196
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1067
1197
|
directory?: string;
|
|
1068
1198
|
workspace?: string;
|
|
1069
|
-
|
|
1199
|
+
body?: {
|
|
1200
|
+
[key: string]: number;
|
|
1201
|
+
};
|
|
1202
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncHistoryListResponses, SyncHistoryListErrors, ThrowOnError, "fields">;
|
|
1070
1203
|
}
|
|
1071
|
-
export declare class
|
|
1204
|
+
export declare class Sync extends HeyApiClient {
|
|
1072
1205
|
/**
|
|
1073
|
-
*
|
|
1206
|
+
* Start workspace sync
|
|
1074
1207
|
*
|
|
1075
|
-
*
|
|
1208
|
+
* Start sync loops for workspaces in the current project that have active sessions.
|
|
1076
1209
|
*/
|
|
1077
|
-
|
|
1078
|
-
name: string;
|
|
1210
|
+
start<ThrowOnError extends boolean = false>(parameters?: {
|
|
1079
1211
|
directory?: string;
|
|
1080
1212
|
workspace?: string;
|
|
1081
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
1213
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncStartResponses, unknown, ThrowOnError, "fields">;
|
|
1082
1214
|
/**
|
|
1083
|
-
*
|
|
1215
|
+
* Replay sync events
|
|
1084
1216
|
*
|
|
1085
|
-
*
|
|
1217
|
+
* Validate and replay a complete sync event history.
|
|
1086
1218
|
*/
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
directory?: string;
|
|
1219
|
+
replay<ThrowOnError extends boolean = false>(parameters?: {
|
|
1220
|
+
query_directory?: string;
|
|
1090
1221
|
workspace?: string;
|
|
1091
|
-
|
|
1222
|
+
body_directory?: string;
|
|
1223
|
+
events?: Array<{
|
|
1224
|
+
id: string;
|
|
1225
|
+
aggregateID: string;
|
|
1226
|
+
seq: number;
|
|
1227
|
+
type: string;
|
|
1228
|
+
data: {
|
|
1229
|
+
[key: string]: unknown;
|
|
1230
|
+
};
|
|
1231
|
+
}>;
|
|
1232
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SyncReplayResponses, SyncReplayErrors, ThrowOnError, "fields">;
|
|
1233
|
+
private _history?;
|
|
1234
|
+
get history(): History;
|
|
1235
|
+
}
|
|
1236
|
+
export declare class Session3 extends HeyApiClient {
|
|
1092
1237
|
/**
|
|
1093
|
-
*
|
|
1238
|
+
* List v2 sessions
|
|
1094
1239
|
*
|
|
1095
|
-
*
|
|
1240
|
+
* Retrieve sessions in the requested order. Items keep that order across pages; use cursor.next or cursor.previous to move through the ordered list.
|
|
1096
1241
|
*/
|
|
1097
|
-
|
|
1098
|
-
name: string;
|
|
1242
|
+
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1099
1243
|
directory?: string;
|
|
1100
1244
|
workspace?: string;
|
|
1101
|
-
|
|
1102
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError, "fields">;
|
|
1245
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionListResponses, V2SessionListErrors, ThrowOnError, "fields">;
|
|
1103
1246
|
/**
|
|
1104
|
-
*
|
|
1247
|
+
* Send v2 message
|
|
1105
1248
|
*
|
|
1106
|
-
*
|
|
1249
|
+
* Create a v2 session message and queue it for the agent loop.
|
|
1107
1250
|
*/
|
|
1108
|
-
|
|
1109
|
-
|
|
1251
|
+
prompt<ThrowOnError extends boolean = false>(parameters: {
|
|
1252
|
+
sessionID: string;
|
|
1110
1253
|
directory?: string;
|
|
1111
1254
|
workspace?: string;
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1255
|
+
prompt?: Prompt;
|
|
1256
|
+
delivery?: SessionDelivery;
|
|
1257
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionPromptResponses, unknown, ThrowOnError, "fields">;
|
|
1115
1258
|
/**
|
|
1116
|
-
*
|
|
1259
|
+
* Compact v2 session
|
|
1117
1260
|
*
|
|
1118
|
-
*
|
|
1261
|
+
* Compact a v2 session conversation.
|
|
1119
1262
|
*/
|
|
1120
|
-
|
|
1263
|
+
compact<ThrowOnError extends boolean = false>(parameters: {
|
|
1264
|
+
sessionID: string;
|
|
1121
1265
|
directory?: string;
|
|
1122
1266
|
workspace?: string;
|
|
1123
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
1267
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionCompactResponses, unknown, ThrowOnError, "fields">;
|
|
1124
1268
|
/**
|
|
1125
|
-
*
|
|
1269
|
+
* Wait for v2 session
|
|
1126
1270
|
*
|
|
1127
|
-
*
|
|
1271
|
+
* Wait for a v2 session agent loop to become idle.
|
|
1128
1272
|
*/
|
|
1129
|
-
|
|
1273
|
+
wait<ThrowOnError extends boolean = false>(parameters: {
|
|
1274
|
+
sessionID: string;
|
|
1130
1275
|
directory?: string;
|
|
1131
1276
|
workspace?: string;
|
|
1132
|
-
|
|
1133
|
-
config?: McpLocalConfig | McpRemoteConfig;
|
|
1134
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAddResponses, McpAddErrors, ThrowOnError, "fields">;
|
|
1277
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionWaitResponses, unknown, ThrowOnError, "fields">;
|
|
1135
1278
|
/**
|
|
1136
|
-
*
|
|
1279
|
+
* Get v2 session context
|
|
1280
|
+
*
|
|
1281
|
+
* Retrieve the active context messages for a v2 session (all messages after the last compaction).
|
|
1137
1282
|
*/
|
|
1138
|
-
|
|
1139
|
-
|
|
1283
|
+
context<ThrowOnError extends boolean = false>(parameters: {
|
|
1284
|
+
sessionID: string;
|
|
1140
1285
|
directory?: string;
|
|
1141
1286
|
workspace?: string;
|
|
1142
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
1287
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionContextResponses, unknown, ThrowOnError, "fields">;
|
|
1143
1288
|
/**
|
|
1144
|
-
*
|
|
1289
|
+
* Get v2 session messages
|
|
1290
|
+
*
|
|
1291
|
+
* Retrieve projected v2 messages for a session. Items keep the requested order across pages; use cursor.next or cursor.previous to move through the ordered timeline.
|
|
1145
1292
|
*/
|
|
1146
|
-
|
|
1147
|
-
|
|
1293
|
+
messages<ThrowOnError extends boolean = false>(parameters: {
|
|
1294
|
+
sessionID: string;
|
|
1148
1295
|
directory?: string;
|
|
1149
1296
|
workspace?: string;
|
|
1150
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<
|
|
1151
|
-
|
|
1152
|
-
|
|
1297
|
+
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<V2SessionMessagesResponses, V2SessionMessagesErrors, ThrowOnError, "fields">;
|
|
1298
|
+
}
|
|
1299
|
+
export declare class V2 extends HeyApiClient {
|
|
1300
|
+
private _session?;
|
|
1301
|
+
get session(): Session3;
|
|
1153
1302
|
}
|
|
1154
1303
|
export declare class Control extends HeyApiClient {
|
|
1155
1304
|
/**
|
|
1156
1305
|
* Get next TUI request
|
|
1157
1306
|
*
|
|
1158
|
-
* Retrieve the next TUI
|
|
1307
|
+
* Retrieve the next TUI request from the queue for processing.
|
|
1159
1308
|
*/
|
|
1160
1309
|
next<ThrowOnError extends boolean = false>(parameters?: {
|
|
1161
1310
|
directory?: string;
|
|
@@ -1176,7 +1325,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1176
1325
|
/**
|
|
1177
1326
|
* Append TUI prompt
|
|
1178
1327
|
*
|
|
1179
|
-
* Append prompt to the TUI
|
|
1328
|
+
* Append prompt to the TUI.
|
|
1180
1329
|
*/
|
|
1181
1330
|
appendPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
1182
1331
|
directory?: string;
|
|
@@ -1195,7 +1344,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1195
1344
|
/**
|
|
1196
1345
|
* Open sessions dialog
|
|
1197
1346
|
*
|
|
1198
|
-
* Open the session dialog
|
|
1347
|
+
* Open the session dialog.
|
|
1199
1348
|
*/
|
|
1200
1349
|
openSessions<ThrowOnError extends boolean = false>(parameters?: {
|
|
1201
1350
|
directory?: string;
|
|
@@ -1204,7 +1353,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1204
1353
|
/**
|
|
1205
1354
|
* Open themes dialog
|
|
1206
1355
|
*
|
|
1207
|
-
* Open the theme dialog
|
|
1356
|
+
* Open the theme dialog.
|
|
1208
1357
|
*/
|
|
1209
1358
|
openThemes<ThrowOnError extends boolean = false>(parameters?: {
|
|
1210
1359
|
directory?: string;
|
|
@@ -1213,7 +1362,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1213
1362
|
/**
|
|
1214
1363
|
* Open models dialog
|
|
1215
1364
|
*
|
|
1216
|
-
* Open the model dialog
|
|
1365
|
+
* Open the model dialog.
|
|
1217
1366
|
*/
|
|
1218
1367
|
openModels<ThrowOnError extends boolean = false>(parameters?: {
|
|
1219
1368
|
directory?: string;
|
|
@@ -1222,7 +1371,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1222
1371
|
/**
|
|
1223
1372
|
* Submit TUI prompt
|
|
1224
1373
|
*
|
|
1225
|
-
* Submit the prompt
|
|
1374
|
+
* Submit the prompt.
|
|
1226
1375
|
*/
|
|
1227
1376
|
submitPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
1228
1377
|
directory?: string;
|
|
@@ -1231,7 +1380,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1231
1380
|
/**
|
|
1232
1381
|
* Clear TUI prompt
|
|
1233
1382
|
*
|
|
1234
|
-
* Clear the prompt
|
|
1383
|
+
* Clear the prompt.
|
|
1235
1384
|
*/
|
|
1236
1385
|
clearPrompt<ThrowOnError extends boolean = false>(parameters?: {
|
|
1237
1386
|
directory?: string;
|
|
@@ -1240,7 +1389,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1240
1389
|
/**
|
|
1241
1390
|
* Execute TUI command
|
|
1242
1391
|
*
|
|
1243
|
-
* Execute a TUI command
|
|
1392
|
+
* Execute a TUI command.
|
|
1244
1393
|
*/
|
|
1245
1394
|
executeCommand<ThrowOnError extends boolean = false>(parameters?: {
|
|
1246
1395
|
directory?: string;
|
|
@@ -1250,7 +1399,7 @@ export declare class Tui extends HeyApiClient {
|
|
|
1250
1399
|
/**
|
|
1251
1400
|
* Show TUI toast
|
|
1252
1401
|
*
|
|
1253
|
-
* Show a toast notification in the TUI
|
|
1402
|
+
* Show a toast notification in the TUI.
|
|
1254
1403
|
*/
|
|
1255
1404
|
showToast<ThrowOnError extends boolean = false>(parameters?: {
|
|
1256
1405
|
directory?: string;
|
|
@@ -1263,12 +1412,12 @@ export declare class Tui extends HeyApiClient {
|
|
|
1263
1412
|
/**
|
|
1264
1413
|
* Publish TUI event
|
|
1265
1414
|
*
|
|
1266
|
-
* Publish a TUI event
|
|
1415
|
+
* Publish a TUI event.
|
|
1267
1416
|
*/
|
|
1268
1417
|
publish<ThrowOnError extends boolean = false>(parameters?: {
|
|
1269
1418
|
directory?: string;
|
|
1270
1419
|
workspace?: string;
|
|
1271
|
-
body?:
|
|
1420
|
+
body?: EventTuiPromptAppend2 | EventTuiCommandExecute2 | EventTuiToastShow2 | EventTuiSessionSelect2;
|
|
1272
1421
|
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiPublishResponses, TuiPublishErrors, ThrowOnError, "fields">;
|
|
1273
1422
|
/**
|
|
1274
1423
|
* Select session
|
|
@@ -1283,128 +1432,32 @@ export declare class Tui extends HeyApiClient {
|
|
|
1283
1432
|
private _control?;
|
|
1284
1433
|
get control(): Control;
|
|
1285
1434
|
}
|
|
1286
|
-
export declare class Instance extends HeyApiClient {
|
|
1287
|
-
/**
|
|
1288
|
-
* Dispose instance
|
|
1289
|
-
*
|
|
1290
|
-
* Clean up and dispose the current OpenCode instance, releasing all resources.
|
|
1291
|
-
*/
|
|
1292
|
-
dispose<ThrowOnError extends boolean = false>(parameters?: {
|
|
1293
|
-
directory?: string;
|
|
1294
|
-
workspace?: string;
|
|
1295
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<InstanceDisposeResponses, unknown, ThrowOnError, "fields">;
|
|
1296
|
-
}
|
|
1297
|
-
export declare class Path extends HeyApiClient {
|
|
1298
|
-
/**
|
|
1299
|
-
* Get paths
|
|
1300
|
-
*
|
|
1301
|
-
* Retrieve the current working directory and related path information for the OpenCode instance.
|
|
1302
|
-
*/
|
|
1303
|
-
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
1304
|
-
directory?: string;
|
|
1305
|
-
workspace?: string;
|
|
1306
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PathGetResponses, unknown, ThrowOnError, "fields">;
|
|
1307
|
-
}
|
|
1308
|
-
export declare class Vcs extends HeyApiClient {
|
|
1309
|
-
/**
|
|
1310
|
-
* Get VCS info
|
|
1311
|
-
*
|
|
1312
|
-
* Retrieve version control system (VCS) information for the current project, such as git branch.
|
|
1313
|
-
*/
|
|
1314
|
-
get<ThrowOnError extends boolean = false>(parameters?: {
|
|
1315
|
-
directory?: string;
|
|
1316
|
-
workspace?: string;
|
|
1317
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsGetResponses, unknown, ThrowOnError, "fields">;
|
|
1318
|
-
/**
|
|
1319
|
-
* Get VCS diff
|
|
1320
|
-
*
|
|
1321
|
-
* Retrieve the current git diff for the working tree or against the default branch.
|
|
1322
|
-
*/
|
|
1323
|
-
diff<ThrowOnError extends boolean = false>(parameters: {
|
|
1324
|
-
directory?: string;
|
|
1325
|
-
workspace?: string;
|
|
1326
|
-
mode: "git" | "branch";
|
|
1327
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<VcsDiffResponses, unknown, ThrowOnError, "fields">;
|
|
1328
|
-
}
|
|
1329
|
-
export declare class Command extends HeyApiClient {
|
|
1330
|
-
/**
|
|
1331
|
-
* List commands
|
|
1332
|
-
*
|
|
1333
|
-
* Get a list of all available commands in the OpenCode system.
|
|
1334
|
-
*/
|
|
1335
|
-
list<ThrowOnError extends boolean = false>(parameters?: {
|
|
1336
|
-
directory?: string;
|
|
1337
|
-
workspace?: string;
|
|
1338
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<CommandListResponses, unknown, ThrowOnError, "fields">;
|
|
1339
|
-
}
|
|
1340
|
-
export declare class Lsp extends HeyApiClient {
|
|
1341
|
-
/**
|
|
1342
|
-
* Get LSP status
|
|
1343
|
-
*
|
|
1344
|
-
* Get LSP server status
|
|
1345
|
-
*/
|
|
1346
|
-
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
1347
|
-
directory?: string;
|
|
1348
|
-
workspace?: string;
|
|
1349
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<LspStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1350
|
-
}
|
|
1351
|
-
export declare class Formatter extends HeyApiClient {
|
|
1352
|
-
/**
|
|
1353
|
-
* Get formatter status
|
|
1354
|
-
*
|
|
1355
|
-
* Get formatter status
|
|
1356
|
-
*/
|
|
1357
|
-
status<ThrowOnError extends boolean = false>(parameters?: {
|
|
1358
|
-
directory?: string;
|
|
1359
|
-
workspace?: string;
|
|
1360
|
-
}, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FormatterStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1361
|
-
}
|
|
1362
1435
|
export declare class OpencodeClient extends HeyApiClient {
|
|
1363
1436
|
static readonly __registry: HeyApiRegistry<OpencodeClient>;
|
|
1364
1437
|
constructor(args?: {
|
|
1365
1438
|
client?: Client;
|
|
1366
1439
|
key?: string;
|
|
1367
1440
|
});
|
|
1368
|
-
private _global?;
|
|
1369
|
-
get global(): Global;
|
|
1370
1441
|
private _auth?;
|
|
1371
1442
|
get auth(): Auth;
|
|
1372
1443
|
private _app?;
|
|
1373
1444
|
get app(): App;
|
|
1374
|
-
private
|
|
1375
|
-
get
|
|
1376
|
-
private
|
|
1377
|
-
get
|
|
1378
|
-
private _pty?;
|
|
1379
|
-
get pty(): Pty;
|
|
1445
|
+
private _global?;
|
|
1446
|
+
get global(): Global;
|
|
1447
|
+
private _event?;
|
|
1448
|
+
get event(): Event;
|
|
1380
1449
|
private _config?;
|
|
1381
1450
|
get config(): Config2;
|
|
1451
|
+
private _experimental?;
|
|
1452
|
+
get experimental(): Experimental;
|
|
1382
1453
|
private _tool?;
|
|
1383
1454
|
get tool(): Tool;
|
|
1384
1455
|
private _worktree?;
|
|
1385
1456
|
get worktree(): Worktree;
|
|
1386
|
-
private _session?;
|
|
1387
|
-
get session(): Session2;
|
|
1388
|
-
private _part?;
|
|
1389
|
-
get part(): Part;
|
|
1390
|
-
private _permission?;
|
|
1391
|
-
get permission(): Permission;
|
|
1392
|
-
private _question?;
|
|
1393
|
-
get question(): Question;
|
|
1394
|
-
private _provider?;
|
|
1395
|
-
get provider(): Provider;
|
|
1396
|
-
private _sync?;
|
|
1397
|
-
get sync(): Sync;
|
|
1398
1457
|
private _find?;
|
|
1399
1458
|
get find(): Find;
|
|
1400
1459
|
private _file?;
|
|
1401
1460
|
get file(): File;
|
|
1402
|
-
private _event?;
|
|
1403
|
-
get event(): Event;
|
|
1404
|
-
private _mcp?;
|
|
1405
|
-
get mcp(): Mcp;
|
|
1406
|
-
private _tui?;
|
|
1407
|
-
get tui(): Tui;
|
|
1408
1461
|
private _instance?;
|
|
1409
1462
|
get instance(): Instance;
|
|
1410
1463
|
private _path?;
|
|
@@ -1417,5 +1470,27 @@ export declare class OpencodeClient extends HeyApiClient {
|
|
|
1417
1470
|
get lsp(): Lsp;
|
|
1418
1471
|
private _formatter?;
|
|
1419
1472
|
get formatter(): Formatter;
|
|
1473
|
+
private _mcp?;
|
|
1474
|
+
get mcp(): Mcp;
|
|
1475
|
+
private _project?;
|
|
1476
|
+
get project(): Project;
|
|
1477
|
+
private _pty?;
|
|
1478
|
+
get pty(): Pty;
|
|
1479
|
+
private _question?;
|
|
1480
|
+
get question(): Question;
|
|
1481
|
+
private _permission?;
|
|
1482
|
+
get permission(): Permission;
|
|
1483
|
+
private _provider?;
|
|
1484
|
+
get provider(): Provider;
|
|
1485
|
+
private _session?;
|
|
1486
|
+
get session(): Session2;
|
|
1487
|
+
private _part?;
|
|
1488
|
+
get part(): Part;
|
|
1489
|
+
private _sync?;
|
|
1490
|
+
get sync(): Sync;
|
|
1491
|
+
private _v2?;
|
|
1492
|
+
get v2(): V2;
|
|
1493
|
+
private _tui?;
|
|
1494
|
+
get tui(): Tui;
|
|
1420
1495
|
}
|
|
1421
1496
|
export {};
|