@opencode-ai/sdk 0.0.0-dev-202512080004 → 0.0.0-dev-202512080113

package/dist/v2/gen/sdk.gen.d.ts

@@ -27,19 +27,25 @@ declare class HeyApiRegistry<T> {
 }
 export declare class Global extends HeyApiClient {
     /**
-     * Get events
+     * Get global events
+     *
+     * Subscribe to global events from the OpenCode system using server-sent events.
      */
     event<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): Promise<import("./core/serverSentEvents.gen.js").ServerSentEventsResult<GlobalEventResponses, unknown>>;
 }
 export declare class Project extends HeyApiClient {
     /**
      * List all projects
+     *
+     * Get a list of projects that have been opened with OpenCode.
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProjectListResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Get the current project
+     * Get current project
+     *
+     * Retrieve the currently active project that OpenCode is working with.
      */
     current<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -47,13 +53,17 @@ export declare class Project extends HeyApiClient {
 }
 export declare class Pty extends HeyApiClient {
     /**
-     * List all PTY sessions
+     * List PTY sessions
+     *
+     * Get a list of all active pseudo-terminal (PTY) sessions managed by OpenCode.
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyListResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Create a new PTY session
+     * Create PTY session
+     *
+     * Create a new pseudo-terminal (PTY) session for running shell commands and processes.
      */
     create<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -66,14 +76,18 @@ export declare class Pty extends HeyApiClient {
         };
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyCreateResponses, PtyCreateErrors, ThrowOnError, "fields">;
     /**
-     * Remove a PTY session
+     * Remove PTY session
+     *
+     * Remove and terminate a specific pseudo-terminal (PTY) session.
      */
     remove<ThrowOnError extends boolean = false>(parameters: {
         ptyID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyRemoveResponses, PtyRemoveErrors, ThrowOnError, "fields">;
     /**
-     * Get PTY session info
+     * Get PTY session
+     *
+     * Retrieve detailed information about a specific pseudo-terminal (PTY) session.
      */
     get<ThrowOnError extends boolean = false>(parameters: {
         ptyID: string;
@@ -81,6 +95,8 @@ export declare class Pty extends HeyApiClient {
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyGetResponses, PtyGetErrors, ThrowOnError, "fields">;
     /**
      * Update PTY session
+     *
+     * Update properties of an existing pseudo-terminal (PTY) session.
      */
     update<ThrowOnError extends boolean = false>(parameters: {
         ptyID: string;
@@ -92,7 +108,9 @@ export declare class Pty extends HeyApiClient {
         };
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<PtyUpdateResponses, PtyUpdateErrors, ThrowOnError, "fields">;
     /**
-     * Connect to a PTY session
+     * Connect to PTY session
+     *
+     * Establish a WebSocket connection to interact with a pseudo-terminal (PTY) session in real-time.
      */
     connect<ThrowOnError extends boolean = false>(parameters: {
         ptyID: string;
@@ -101,20 +119,26 @@ export declare class Pty extends HeyApiClient {
 }
 export declare class Config extends HeyApiClient {
     /**
-     * Get config info
+     * Get configuration
+     *
+     * Retrieve the current OpenCode configuration settings and preferences.
      */
     get<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigGetResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Update config
+     * Update configuration
+     *
+     * Update OpenCode configuration settings and preferences.
      */
     update<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
         config?: Config2;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ConfigUpdateResponses, ConfigUpdateErrors, ThrowOnError, "fields">;
     /**
-     * List all providers
+     * List config providers
+     *
+     * Get a list of all configured AI providers and their default models.
      */
     providers<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -122,13 +146,17 @@ export declare class Config extends HeyApiClient {
 }
 export declare class Tool extends HeyApiClient {
     /**
-     * List all tool IDs (including built-in and dynamically registered)
+     * List tool IDs
+     *
+     * Get a list of all available tool IDs, including both built-in tools and dynamically registered tools.
      */
     ids<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ToolIdsResponses, ToolIdsErrors, ThrowOnError, "fields">;
     /**
-     * List tools with JSON schema parameters for a provider/model
+     * List tools
+     *
+     * Get a list of available tools with their JSON schema parameters for a specific provider and model combination.
      */
     list<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
@@ -138,7 +166,9 @@ export declare class Tool extends HeyApiClient {
 }
 export declare class Instance extends HeyApiClient {
     /**
-     * Dispose the current instance
+     * Dispose instance
+     *
+     * Clean up and dispose the current OpenCode instance, releasing all resources.
      */
     dispose<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -146,7 +176,9 @@ export declare class Instance extends HeyApiClient {
 }
 export declare class Path extends HeyApiClient {
     /**
-     * Get the current path
+     * Get paths
+     *
+     * Retrieve the current working directory and related path information for the OpenCode instance.
      */
     get<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -154,7 +186,9 @@ export declare class Path extends HeyApiClient {
 }
 export declare class Vcs extends HeyApiClient {
     /**
-     * Get VCS info for the current instance
+     * Get VCS info
+     *
+     * Retrieve version control system (VCS) information for the current project, such as git branch.
      */
     get<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -162,13 +196,17 @@ export declare class Vcs extends HeyApiClient {
 }
 export declare class Session extends HeyApiClient {
     /**
-     * List all sessions
+     * List sessions
+     *
+     * Get a list of all OpenCode sessions, sorted by most recently updated.
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionListResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Create a new session
+     * Create session
+     *
+     * Create a new OpenCode session for interacting with AI assistants and managing conversations.
      */
     create<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -177,12 +215,16 @@ export declare class Session extends HeyApiClient {
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCreateResponses, SessionCreateErrors, ThrowOnError, "fields">;
     /**
      * Get session status
+     *
+     * Retrieve the current status of all sessions, including active, idle, and completed states.
      */
     status<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionStatusResponses, SessionStatusErrors, ThrowOnError, "fields">;
     /**
-     * Delete a session and all its data
+     * Delete session
+     *
+     * Delete a session and permanently remove all associated data, including messages and history.
      */
     delete<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -190,13 +232,17 @@ export declare class Session extends HeyApiClient {
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDeleteResponses, SessionDeleteErrors, ThrowOnError, "fields">;
     /**
      * Get session
+     *
+     * Retrieve detailed information about a specific OpenCode session.
      */
     get<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionGetResponses, SessionGetErrors, ThrowOnError, "fields">;
     /**
-     * Update session properties
+     * Update session
+     *
+     * Update properties of an existing session, such as title or other metadata.
      */
     update<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -204,21 +250,27 @@ export declare class Session extends HeyApiClient {
         title?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUpdateResponses, SessionUpdateErrors, ThrowOnError, "fields">;
     /**
-     * Get a session's children
+     * Get session children
+     *
+     * Retrieve all child sessions that were forked from the specified parent session.
      */
     children<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionChildrenResponses, SessionChildrenErrors, ThrowOnError, "fields">;
     /**
-     * Get the todo list for a session
+     * Get session todos
+     *
+     * Retrieve the todo list associated with a specific session, showing tasks and action items.
      */
     todo<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionTodoResponses, SessionTodoErrors, ThrowOnError, "fields">;
     /**
-     * Analyze the app and create an AGENTS.md file
+     * Initialize session
+     *
+     * Analyze the current application and create an AGENTS.md file with project-specific agent configurations.
      */
     init<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -228,7 +280,9 @@ export declare class Session extends HeyApiClient {
         messageID?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionInitResponses, SessionInitErrors, ThrowOnError, "fields">;
     /**
-     * Fork an existing session at a specific message
+     * Fork session
+     *
+     * Create a new session by forking an existing session at a specific message point.
      */
     fork<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -236,28 +290,36 @@ export declare class Session extends HeyApiClient {
         messageID?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionForkResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Abort a session
+     * Abort session
+     *
+     * Abort an active session and stop any ongoing AI processing or command execution.
      */
     abort<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionAbortResponses, SessionAbortErrors, ThrowOnError, "fields">;
     /**
-     * Unshare the session
+     * Unshare session
+     *
+     * Remove the shareable link for a session, making it private again.
      */
     unshare<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionUnshareResponses, SessionUnshareErrors, ThrowOnError, "fields">;
     /**
-     * Share a session
+     * Share session
+     *
+     * Create a shareable link for a session, allowing others to view the conversation.
      */
     share<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShareResponses, SessionShareErrors, ThrowOnError, "fields">;
     /**
-     * Get the diff for this session
+     * Get session diff
+     *
+     * Get all file changes (diffs) made during this session.
      */
     diff<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -265,7 +327,9 @@ export declare class Session extends HeyApiClient {
         messageID?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionDiffResponses, SessionDiffErrors, ThrowOnError, "fields">;
     /**
-     * Summarize the session
+     * Summarize session
+     *
+     * Generate a concise summary of the session using AI compaction to preserve key information.
      */
     summarize<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -274,7 +338,9 @@ export declare class Session extends HeyApiClient {
         modelID?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionSummarizeResponses, SessionSummarizeErrors, ThrowOnError, "fields">;
     /**
-     * List messages for a session
+     * Get session messages
+     *
+     * Retrieve all messages in a session, including user prompts and AI responses.
      */
     messages<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -282,7 +348,9 @@ export declare class Session extends HeyApiClient {
         limit?: number;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessagesResponses, SessionMessagesErrors, ThrowOnError, "fields">;
     /**
-     * Create and send a new message to a session
+     * Send message
+     *
+     * Create and send a new message to a session, streaming the AI response.
      */
     prompt<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -301,7 +369,9 @@ export declare class Session extends HeyApiClient {
         parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptResponses, SessionPromptErrors, ThrowOnError, "fields">;
     /**
-     * Get a message from a session
+     * Get message
+     *
+     * Retrieve a specific message from a session by its message ID.
      */
     message<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -309,7 +379,9 @@ export declare class Session extends HeyApiClient {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionMessageResponses, SessionMessageErrors, ThrowOnError, "fields">;
     /**
-     * Create and send a new message to a session, start if needed and return immediately
+     * Send async message
+     *
+     * Create and send a new message to a session asynchronously, starting the session if needed and returning immediately.
      */
     promptAsync<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -328,7 +400,9 @@ export declare class Session extends HeyApiClient {
         parts?: Array<TextPartInput | FilePartInput | AgentPartInput | SubtaskPartInput>;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionPromptAsyncResponses, SessionPromptAsyncErrors, ThrowOnError, "fields">;
     /**
-     * Send a new command to a session
+     * Send command
+     *
+     * Send a new command to a session for execution by the AI assistant.
      */
     command<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -340,7 +414,9 @@ export declare class Session extends HeyApiClient {
         command?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionCommandResponses, SessionCommandErrors, ThrowOnError, "fields">;
     /**
-     * Run a shell command
+     * Run shell command
+     *
+     * Execute a shell command within the session context and return the AI's response.
      */
     shell<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -353,7 +429,9 @@ export declare class Session extends HeyApiClient {
         command?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionShellResponses, SessionShellErrors, ThrowOnError, "fields">;
     /**
-     * Revert a message
+     * Revert message
+     *
+     * Revert a specific message in a session, undoing its effects and restoring the previous state.
      */
     revert<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -362,7 +440,9 @@ export declare class Session extends HeyApiClient {
         partID?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<SessionRevertResponses, SessionRevertErrors, ThrowOnError, "fields">;
     /**
-     * Restore all reverted messages
+     * Restore reverted messages
+     *
+     * Restore all previously reverted messages in a session.
      */
     unrevert<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -371,7 +451,9 @@ export declare class Session extends HeyApiClient {
 }
 export declare class Permission extends HeyApiClient {
     /**
-     * Respond to a permission request
+     * Respond to permission
+     *
+     * Approve or deny a permission request from the AI assistant.
      */
     respond<ThrowOnError extends boolean = false>(parameters: {
         sessionID: string;
@@ -382,7 +464,9 @@ export declare class Permission extends HeyApiClient {
 }
 export declare class Command extends HeyApiClient {
     /**
-     * List all commands
+     * List commands
+     *
+     * Get a list of all available commands in the OpenCode system.
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -390,7 +474,9 @@ export declare class Command extends HeyApiClient {
 }
 export declare class Oauth extends HeyApiClient {
     /**
-     * Authorize a provider using OAuth
+     * OAuth authorize
+     *
+     * Initiate OAuth authorization for a specific AI provider to get an authorization URL.
      */
     authorize<ThrowOnError extends boolean = false>(parameters: {
         providerID: string;
@@ -398,7 +484,9 @@ export declare class Oauth extends HeyApiClient {
         method?: number;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderOauthAuthorizeResponses, ProviderOauthAuthorizeErrors, ThrowOnError, "fields">;
     /**
-     * Handle OAuth callback for a provider
+     * OAuth callback
+     *
+     * Handle the OAuth callback from a provider after user authorization.
      */
     callback<ThrowOnError extends boolean = false>(parameters: {
         providerID: string;
@@ -409,13 +497,17 @@ export declare class Oauth extends HeyApiClient {
 }
 export declare class Provider extends HeyApiClient {
     /**
-     * List all providers
+     * List providers
+     *
+     * Get a list of all available AI providers, including both available and connected ones.
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<ProviderListResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Get provider authentication methods
+     * Get provider auth methods
+     *
+     * Retrieve available authentication methods for all AI providers.
      */
     auth<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -424,7 +516,9 @@ export declare class Provider extends HeyApiClient {
 }
 export declare class Find extends HeyApiClient {
     /**
-     * Find text in files
+     * Find text
+     *
+     * Search for text patterns across files in the project using ripgrep.
      */
     text<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
@@ -432,6 +526,8 @@ export declare class Find extends HeyApiClient {
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindTextResponses, unknown, ThrowOnError, "fields">;
     /**
      * Find files
+     *
+     * Search for files by name or pattern in the project directory.
      */
     files<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
@@ -439,7 +535,9 @@ export declare class Find extends HeyApiClient {
         dirs?: "true" | "false";
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FindFilesResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Find workspace symbols
+     * Find symbols
+     *
+     * Search for workspace symbols like functions, classes, and variables using LSP.
      */
     symbols<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
@@ -448,14 +546,18 @@ export declare class Find extends HeyApiClient {
 }
 export declare class File extends HeyApiClient {
     /**
-     * List files and directories
+     * List files
+     *
+     * List files and directories in a specified path.
      */
     list<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
         path: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileListResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Read a file
+     * Read file
+     *
+     * Read the content of a specified file.
      */
     read<ThrowOnError extends boolean = false>(parameters: {
         directory?: string;
@@ -463,6 +565,8 @@ export declare class File extends HeyApiClient {
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<FileReadResponses, unknown, ThrowOnError, "fields">;
     /**
      * Get file status
+     *
+     * Get the git status of all files in the project.
      */
     status<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -470,7 +574,9 @@ export declare class File extends HeyApiClient {
 }
 export declare class App extends HeyApiClient {
     /**
-     * Write a log entry to the server logs
+     * Write log
+     *
+     * Write a log entry to the server logs with specified level and metadata.
      */
     log<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -482,7 +588,9 @@ export declare class App extends HeyApiClient {
         };
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<AppLogResponses, AppLogErrors, ThrowOnError, "fields">;
     /**
-     * List all agents
+     * List agents
+     *
+     * Get a list of all available AI agents in the OpenCode system.
      */
     agents<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -490,6 +598,8 @@ export declare class App extends HeyApiClient {
 }
 export declare class Auth extends HeyApiClient {
     /**
+     * Remove MCP OAuth
+     *
      * Remove OAuth credentials for an MCP server
      */
     remove<ThrowOnError extends boolean = false>(parameters: {
@@ -497,14 +607,18 @@ export declare class Auth extends HeyApiClient {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthRemoveResponses, McpAuthRemoveErrors, ThrowOnError, "fields">;
     /**
-     * Start OAuth authentication flow for an MCP server
+     * Start MCP OAuth
+     *
+     * Start OAuth authentication flow for a Model Context Protocol (MCP) server.
      */
     start<ThrowOnError extends boolean = false>(parameters: {
         name: string;
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthStartResponses, McpAuthStartErrors, ThrowOnError, "fields">;
     /**
-     * Complete OAuth authentication with authorization code
+     * Complete MCP OAuth
+     *
+     * Complete OAuth authentication for a Model Context Protocol (MCP) server using the authorization code.
      */
     callback<ThrowOnError extends boolean = false>(parameters: {
         name: string;
@@ -512,6 +626,8 @@ export declare class Auth extends HeyApiClient {
         code?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthCallbackResponses, McpAuthCallbackErrors, ThrowOnError, "fields">;
     /**
+     * Authenticate MCP OAuth
+     *
      * Start OAuth flow and wait for callback (opens browser)
      */
     authenticate<ThrowOnError extends boolean = false>(parameters: {
@@ -519,6 +635,8 @@ export declare class Auth extends HeyApiClient {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpAuthAuthenticateResponses, McpAuthAuthenticateErrors, ThrowOnError, "fields">;
     /**
+     * Set auth credentials
+     *
      * Set authentication credentials
      */
     set<ThrowOnError extends boolean = false>(parameters: {
@@ -529,13 +647,17 @@ export declare class Auth extends HeyApiClient {
 }
 export declare class Mcp extends HeyApiClient {
     /**
-     * Get MCP server status
+     * Get MCP status
+     *
+     * Get the status of all Model Context Protocol (MCP) servers.
      */
     status<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<McpStatusResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Add MCP server dynamically
+     * Add MCP server
+     *
+     * Dynamically add a new Model Context Protocol (MCP) server to the system.
      */
     add<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -546,6 +668,8 @@ export declare class Mcp extends HeyApiClient {
 }
 export declare class Lsp extends HeyApiClient {
     /**
+     * Get LSP status
+     *
      * Get LSP server status
      */
     status<ThrowOnError extends boolean = false>(parameters?: {
@@ -554,6 +678,8 @@ export declare class Lsp extends HeyApiClient {
 }
 export declare class Formatter extends HeyApiClient {
     /**
+     * Get formatter status
+     *
      * Get formatter status
      */
     status<ThrowOnError extends boolean = false>(parameters?: {
@@ -562,13 +688,17 @@ export declare class Formatter extends HeyApiClient {
 }
 export declare class Control extends HeyApiClient {
     /**
-     * Get the next TUI request from the queue
+     * Get next TUI request
+     *
+     * Retrieve the next TUI (Terminal User Interface) request from the queue for processing.
      */
     next<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiControlNextResponses, unknown, ThrowOnError, "fields">;
     /**
-     * Submit a response to the TUI request queue
+     * Submit TUI response
+     *
+     * Submit a response to the TUI request queue to complete a pending request.
      */
     response<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
@@ -577,6 +707,8 @@ export declare class Control extends HeyApiClient {
 }
 export declare class Tui extends HeyApiClient {
     /**
+     * Append TUI prompt
+     *
      * Append prompt to the TUI
      */
     appendPrompt<ThrowOnError extends boolean = false>(parameters?: {
@@ -584,42 +716,56 @@ export declare class Tui extends HeyApiClient {
         text?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiAppendPromptResponses, TuiAppendPromptErrors, ThrowOnError, "fields">;
     /**
-     * Open the help dialog
+     * Open help dialog
+     *
+     * Open the help dialog in the TUI to display user assistance information.
      */
     openHelp<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenHelpResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Open sessions dialog
+     *
      * Open the session dialog
      */
     openSessions<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenSessionsResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Open themes dialog
+     *
      * Open the theme dialog
      */
     openThemes<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenThemesResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Open models dialog
+     *
      * Open the model dialog
      */
     openModels<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiOpenModelsResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Submit TUI prompt
+     *
      * Submit the prompt
      */
     submitPrompt<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiSubmitPromptResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Clear TUI prompt
+     *
      * Clear the prompt
      */
     clearPrompt<ThrowOnError extends boolean = false>(parameters?: {
         directory?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiClearPromptResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Execute TUI command
+     *
      * Execute a TUI command (e.g. agent_cycle)
      */
     executeCommand<ThrowOnError extends boolean = false>(parameters?: {
@@ -627,6 +773,8 @@ export declare class Tui extends HeyApiClient {
         command?: string;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiExecuteCommandResponses, TuiExecuteCommandErrors, ThrowOnError, "fields">;
     /**
+     * Show TUI toast
+     *
      * Show a toast notification in the TUI
      */
     showToast<ThrowOnError extends boolean = false>(parameters?: {
@@ -637,6 +785,8 @@ export declare class Tui extends HeyApiClient {
         duration?: number;
     }, options?: Options<never, ThrowOnError>): import("./client/types.gen.js").RequestResult<TuiShowToastResponses, unknown, ThrowOnError, "fields">;
     /**
+     * Publish TUI event
+     *
      * Publish a TUI event
      */
     publish<ThrowOnError extends boolean = false>(parameters?: {
@@ -647,6 +797,8 @@ export declare class Tui extends HeyApiClient {
 }
 export declare class Event extends HeyApiClient {
     /**
+     * Subscribe to events
+     *
      * Get events
      */
     subscribe<ThrowOnError extends boolean = false>(parameters?: {