Module: OpencodeClient

Defined in:
lib/opencode_client/version.rb,
lib/opencode_client.rb,
lib/opencode_client/api_error.rb,
lib/opencode_client/api_client.rb,
lib/opencode_client/models/pty.rb,
lib/opencode_client/models/auth.rb,
lib/opencode_client/models/file.rb,
lib/opencode_client/models/part.rb,
lib/opencode_client/models/path.rb,
lib/opencode_client/models/todo.rb,
lib/opencode_client/models/agent.rb,
lib/opencode_client/models/event.rb,
lib/opencode_client/models/model.rb,
lib/opencode_client/models/range.rb,
lib/opencode_client/configuration.rb,
lib/opencode_client/models/config.rb,
lib/opencode_client/models/o_auth.rb,
lib/opencode_client/models/symbol.rb,
lib/opencode_client/api_model_base.rb,
lib/opencode_client/models/command.rb,
lib/opencode_client/models/message.rb,
lib/opencode_client/models/project.rb,
lib/opencode_client/models/session.rb,
lib/opencode_client/api/default_api.rb,
lib/opencode_client/api/session_api.rb,
lib/opencode_client/models/api_auth.rb,
lib/opencode_client/models/provider.rb,
lib/opencode_client/models/vcs_info.rb,
lib/opencode_client/models/api_error.rb,
lib/opencode_client/models/file_diff.rb,
lib/opencode_client/models/file_node.rb,
lib/opencode_client/models/file_part.rb,
lib/opencode_client/models/log_level.rb,
lib/opencode_client/models/model_api.rb,
lib/opencode_client/models/text_part.rb,
lib/opencode_client/models/tool_part.rb,
lib/opencode_client/models/agent_part.rb,
lib/opencode_client/models/config_lsp.rb,
lib/opencode_client/models/config_tui.rb,
lib/opencode_client/models/lsp_status.rb,
lib/opencode_client/models/mcp_status.rb,
lib/opencode_client/models/model_cost.rb,
lib/opencode_client/models/patch_part.rb,
lib/opencode_client/models/permission.rb,
lib/opencode_client/models/retry_part.rb,
lib/opencode_client/models/tool_state.rb,
lib/opencode_client/models/config_mode.rb,
lib/opencode_client/models/file_source.rb,
lib/opencode_client/models/part_any_of.rb,
lib/opencode_client/models/range_start.rb,
lib/opencode_client/models/agent_config.rb,
lib/opencode_client/models/config_agent.rb,
lib/opencode_client/models/file_content.rb,
lib/opencode_client/models/global_event.rb,
lib/opencode_client/models/project_time.rb,
lib/opencode_client/models/session_time.rb,
lib/opencode_client/models/user_message.rb,
lib/opencode_client/models/layout_config.rb,
lib/opencode_client/models/server_config.rb,
lib/opencode_client/models/session_share.rb,
lib/opencode_client/models/snapshot_part.rb,
lib/opencode_client/models/symbol_source.rb,
lib/opencode_client/models/unknown_error.rb,
lib/opencode_client/models/api_error_data.rb,
lib/opencode_client/models/config_watcher.rb,
lib/opencode_client/models/reasoning_part.rb,
lib/opencode_client/models/session_revert.rb,
lib/opencode_client/models/session_status.rb,
lib/opencode_client/models/text_part_time.rb,
lib/opencode_client/models/tool_list_item.rb,
lib/opencode_client/models/app_log_request.rb,
lib/opencode_client/models/compaction_part.rb,
lib/opencode_client/models/file_part_input.rb,
lib/opencode_client/models/keybinds_config.rb,
lib/opencode_client/models/mcp_add_request.rb,
lib/opencode_client/models/not_found_error.rb,
lib/opencode_client/models/provider_config.rb,
lib/opencode_client/models/session_summary.rb,
lib/opencode_client/models/step_start_part.rb,
lib/opencode_client/models/symbol_location.rb,
lib/opencode_client/models/text_part_input.rb,
lib/opencode_client/models/well_known_auth.rb,
lib/opencode_client/models/agent_part_input.rb,
lib/opencode_client/models/agent_permission.rb,
lib/opencode_client/models/config_formatter.rb,
lib/opencode_client/models/event_pty_exited.rb,
lib/opencode_client/models/file_part_source.rb,
lib/opencode_client/models/formatter_status.rb,
lib/opencode_client/models/mcp_local_config.rb,
lib/opencode_client/models/step_finish_part.rb,
lib/opencode_client/models/tool_state_error.rb,
lib/opencode_client/models/agent_part_source.rb,
lib/opencode_client/models/assistant_message.rb,
lib/opencode_client/models/bad_request_error.rb,
lib/opencode_client/models/config_autoupdate.rb,
lib/opencode_client/models/config_compaction.rb,
lib/opencode_client/models/config_enterprise.rb,
lib/opencode_client/models/event_file_edited.rb,
lib/opencode_client/models/event_lsp_updated.rb,
lib/opencode_client/models/event_pty_created.rb,
lib/opencode_client/models/event_pty_deleted.rb,
lib/opencode_client/models/event_pty_updated.rb,
lib/opencode_client/models/mcp_o_auth_config.rb,
lib/opencode_client/models/mcp_remote_config.rb,
lib/opencode_client/models/mcp_status_failed.rb,
lib/opencode_client/models/user_message_time.rb,
lib/opencode_client/models/event_session_diff.rb,
lib/opencode_client/models/event_session_idle.rb,
lib/opencode_client/models/event_todo_updated.rb,
lib/opencode_client/models/file_content_patch.rb,
lib/opencode_client/models/model_capabilities.rb,
lib/opencode_client/models/permission_pattern.rb,
lib/opencode_client/models/pty_create_request.rb,
lib/opencode_client/models/pty_update_request.rb,
lib/opencode_client/models/subtask_part_input.rb,
lib/opencode_client/models/tool_state_pending.rb,
lib/opencode_client/models/tool_state_running.rb,
lib/opencode_client/models/unknown_error_data.rb,
lib/opencode_client/models/config_experimental.rb,
lib/opencode_client/models/event_session_error.rb,
lib/opencode_client/models/mcp_status_disabled.rb,
lib/opencode_client/models/provider_auth_error.rb,
lib/opencode_client/models/tui_publish_request.rb,
lib/opencode_client/models/config_command_value.rb,
lib/opencode_client/models/event_session_status.rb,
lib/opencode_client/models/event_tui_toast_show.rb,
lib/opencode_client/models/mcp_status_connected.rb,
lib/opencode_client/models/provider_auth_method.rb,
lib/opencode_client/models/session_fork_request.rb,
lib/opencode_client/models/session_init_request.rb,
lib/opencode_client/models/tool_state_completed.rb,
lib/opencode_client/models/user_message_summary.rb,
lib/opencode_client/models/event_global_disposed.rb,
lib/opencode_client/models/event_message_removed.rb,
lib/opencode_client/models/event_message_updated.rb,
lib/opencode_client/models/event_project_updated.rb,
lib/opencode_client/models/event_session_created.rb,
lib/opencode_client/models/event_session_deleted.rb,
lib/opencode_client/models/event_session_updated.rb,
lib/opencode_client/models/file_part_source_text.rb,
lib/opencode_client/models/mcp_status_needs_auth.rb,
lib/opencode_client/models/message_aborted_error.rb,
lib/opencode_client/models/session_shell_request.rb,
lib/opencode_client/models/session_status_any_of.rb,
lib/opencode_client/models/tool_state_error_time.rb,
lib/opencode_client/models/assistant_message_path.rb,
lib/opencode_client/models/assistant_message_time.rb,
lib/opencode_client/models/event_command_executed.rb,
lib/opencode_client/models/event_server_connected.rb,
lib/opencode_client/models/mcp_add_request_config.rb,
lib/opencode_client/models/project_update_request.rb,
lib/opencode_client/models/session_create_request.rb,
lib/opencode_client/models/session_prompt_request.rb,
lib/opencode_client/models/session_revert_request.rb,
lib/opencode_client/models/session_status_any_of1.rb,
lib/opencode_client/models/session_status_any_of2.rb,
lib/opencode_client/models/session_update_request.rb,
lib/opencode_client/models/tui_show_toast_request.rb,
lib/opencode_client/models/agent_config_permission.rb,
lib/opencode_client/models/assistant_message_error.rb,
lib/opencode_client/models/config_lsp_any_of_value.rb,
lib/opencode_client/models/event_mcp_tools_changed.rb,
lib/opencode_client/models/event_session_compacted.rb,
lib/opencode_client/models/event_tui_prompt_append.rb,
lib/opencode_client/models/mcp_remote_config_oauth.rb,
lib/opencode_client/models/provider_config_options.rb,
lib/opencode_client/models/pty_update_request_size.rb,
lib/opencode_client/models/session_command_request.rb,
lib/opencode_client/models/tool_state_running_time.rb,
lib/opencode_client/models/assistant_message_tokens.rb,
lib/opencode_client/models/config_experimental_hook.rb,
lib/opencode_client/models/event_permission_replied.rb,
lib/opencode_client/models/event_permission_updated.rb,
lib/opencode_client/models/event_vcs_branch_updated.rb,
lib/opencode_client/models/model_capabilities_input.rb,
lib/opencode_client/models/provider_auth_error_data.rb,
lib/opencode_client/models/event_tui_command_execute.rb,
lib/opencode_client/models/global_health200_response.rb,
lib/opencode_client/models/mcp_auth_callback_request.rb,
lib/opencode_client/models/provider_list200_response.rb,
lib/opencode_client/models/session_summarize_request.rb,
lib/opencode_client/models/tool_state_completed_time.rb,
lib/opencode_client/models/event_file_watcher_updated.rb,
lib/opencode_client/models/event_installation_updated.rb,
lib/opencode_client/models/event_message_part_removed.rb,
lib/opencode_client/models/event_message_part_updated.rb,
lib/opencode_client/models/mcp_auth_start200_response.rb,
lib/opencode_client/models/permission_respond_request.rb,
lib/opencode_client/models/session_prompt200_response.rb,
lib/opencode_client/models/event_pty_exited_properties.rb,
lib/opencode_client/models/find_text200_response_inner.rb,
lib/opencode_client/models/mcp_auth_remove200_response.rb,
lib/opencode_client/models/message_output_length_error.rb,
lib/opencode_client/models/project_update_request_icon.rb,
lib/opencode_client/models/provider_auth_authorization.rb,
lib/opencode_client/models/session_update_request_time.rb,
lib/opencode_client/models/tui_execute_command_request.rb,
lib/opencode_client/models/agent_config_permission_bash.rb,
lib/opencode_client/models/config_providers200_response.rb,
lib/opencode_client/models/event_file_edited_properties.rb,
lib/opencode_client/models/event_lsp_client_diagnostics.rb,
lib/opencode_client/models/event_pty_created_properties.rb,
lib/opencode_client/models/event_pty_deleted_properties.rb,
lib/opencode_client/models/provider_config_models_value.rb,
lib/opencode_client/models/session_prompt_request_model.rb,
lib/opencode_client/models/tui_control_next200_response.rb,
lib/opencode_client/models/config_formatter_any_of_value.rb,
lib/opencode_client/models/event_session_diff_properties.rb,
lib/opencode_client/models/event_session_idle_properties.rb,
lib/opencode_client/models/event_todo_updated_properties.rb,
lib/opencode_client/models/assistant_message_tokens_cache.rb,
lib/opencode_client/models/config_lsp_any_of_value_any_of.rb,
lib/opencode_client/models/config_tui_scroll_acceleration.rb,
lib/opencode_client/models/event_server_instance_disposed.rb,
lib/opencode_client/models/event_session_error_properties.rb,
lib/opencode_client/models/file_content_patch_hunks_inner.rb,
lib/opencode_client/models/model_capabilities_interleaved.rb,
lib/opencode_client/models/config_lsp_any_of_value_any_of1.rb,
lib/opencode_client/models/event_session_status_properties.rb,
lib/opencode_client/models/provider_config_options_timeout.rb,
lib/opencode_client/models/provider_oauth_callback_request.rb,
lib/opencode_client/models/event_message_removed_properties.rb,
lib/opencode_client/models/event_message_updated_properties.rb,
lib/opencode_client/models/event_session_created_properties.rb,
lib/opencode_client/models/find_text200_response_inner_path.rb,
lib/opencode_client/models/provider_oauth_authorize_request.rb,
lib/opencode_client/models/event_command_executed_properties.rb,
lib/opencode_client/models/model_cost_experimental_over200_k.rb,
lib/opencode_client/models/event_mcp_tools_changed_properties.rb,
lib/opencode_client/models/session_messages200_response_inner.rb,
lib/opencode_client/models/session_prompt_request_parts_inner.rb,
lib/opencode_client/models/event_installation_update_available.rb,
lib/opencode_client/models/event_permission_replied_properties.rb,
lib/opencode_client/models/event_vcs_branch_updated_properties.rb,
lib/opencode_client/models/provider_list200_response_all_inner.rb,
lib/opencode_client/models/event_tui_command_execute_properties.rb,
lib/opencode_client/models/mcp_status_needs_client_registration.rb,
lib/opencode_client/models/event_file_watcher_updated_properties.rb,
lib/opencode_client/models/event_installation_updated_properties.rb,
lib/opencode_client/models/event_message_part_removed_properties.rb,
lib/opencode_client/models/event_message_part_updated_properties.rb,
lib/opencode_client/models/model_capabilities_interleaved_any_of.rb,
lib/opencode_client/models/event_lsp_client_diagnostics_properties.rb,
lib/opencode_client/models/provider_config_models_value_interleaved.rb,
lib/opencode_client/models/event_server_instance_disposed_properties.rb,
lib/opencode_client/models/event_tui_command_execute_properties_command.rb,
lib/opencode_client/models/find_text200_response_inner_submatches_inner.rb,
lib/opencode_client/models/provider_config_models_value_interleaved_any_of.rb,
lib/opencode_client/models/config_experimental_hook_file_edited_value_inner.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_cost.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_limit.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_provider.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_modalities.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_interleaved.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_interleaved_any_of.rb,
lib/opencode_client/models/provider_list200_response_all_inner_models_value_cost_context_over200k.rb

Overview

#opencode

#opencode api

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech Generator version: 7.18.0

Defined Under Namespace

Modules: AgentConfigPermissionBash, AssistantMessageError, Auth, ConfigAutoupdate, ConfigFormatter, ConfigLsp, ConfigLspAnyOfValue, Event, EventTuiCommandExecutePropertiesCommand, FilePartSource, MCPStatus, McpAddRequestConfig, McpRemoteConfigOauth, Message, ModelCapabilitiesInterleaved, Part, PermissionPattern, ProviderConfigModelsValueInterleaved, ProviderConfigOptionsTimeout, ProviderList200ResponseAllInnerModelsValueInterleaved, SessionPromptRequestPartsInner, SessionStatus, ToolState, TuiPublishRequest Classes: APIError, APIErrorData, Agent, AgentConfig, AgentConfigPermission, AgentPart, AgentPartInput, AgentPartSource, AgentPermission, ApiAuth, ApiClient, ApiError, ApiModelBase, AppLogRequest, AssistantMessage, AssistantMessagePath, AssistantMessageTime, AssistantMessageTokens, AssistantMessageTokensCache, BadRequestError, Command, CompactionPart, Config, ConfigAgent, ConfigCommandValue, ConfigCompaction, ConfigEnterprise, ConfigExperimental, ConfigExperimentalHook, ConfigExperimentalHookFileEditedValueInner, ConfigFormatterAnyOfValue, ConfigLspAnyOfValueAnyOf, ConfigLspAnyOfValueAnyOf1, ConfigMode, ConfigProviders200Response, ConfigTui, ConfigTuiScrollAcceleration, ConfigWatcher, Configuration, DefaultApi, EventCommandExecuted, EventCommandExecutedProperties, EventFileEdited, EventFileEditedProperties, EventFileWatcherUpdated, EventFileWatcherUpdatedProperties, EventGlobalDisposed, EventInstallationUpdateAvailable, EventInstallationUpdated, EventInstallationUpdatedProperties, EventLspClientDiagnostics, EventLspClientDiagnosticsProperties, EventLspUpdated, EventMcpToolsChanged, EventMcpToolsChangedProperties, EventMessagePartRemoved, EventMessagePartRemovedProperties, EventMessagePartUpdated, EventMessagePartUpdatedProperties, EventMessageRemoved, EventMessageRemovedProperties, EventMessageUpdated, EventMessageUpdatedProperties, EventPermissionReplied, EventPermissionRepliedProperties, EventPermissionUpdated, EventProjectUpdated, EventPtyCreated, EventPtyCreatedProperties, EventPtyDeleted, EventPtyDeletedProperties, EventPtyExited, EventPtyExitedProperties, EventPtyUpdated, EventServerConnected, EventServerInstanceDisposed, EventServerInstanceDisposedProperties, EventSessionCompacted, EventSessionCreated, EventSessionCreatedProperties, EventSessionDeleted, EventSessionDiff, EventSessionDiffProperties, EventSessionError, EventSessionErrorProperties, EventSessionIdle, EventSessionIdleProperties, EventSessionStatus, EventSessionStatusProperties, EventSessionUpdated, EventTodoUpdated, EventTodoUpdatedProperties, EventTuiCommandExecute, EventTuiCommandExecuteProperties, EventTuiPromptAppend, EventTuiToastShow, EventVcsBranchUpdated, EventVcsBranchUpdatedProperties, File, FileContent, FileContentPatch, FileContentPatchHunksInner, FileDiff, FileNode, FilePart, FilePartInput, FilePartSourceText, FileSource, FindText200ResponseInner, FindText200ResponseInnerPath, FindText200ResponseInnerSubmatchesInner, FormatterStatus, GlobalEvent, GlobalHealth200Response, KeybindsConfig, LSPStatus, LayoutConfig, LogLevel, MCPStatusConnected, MCPStatusDisabled, MCPStatusFailed, MCPStatusNeedsAuth, MCPStatusNeedsClientRegistration, McpAddRequest, McpAuthCallbackRequest, McpAuthRemove200Response, McpAuthStart200Response, McpLocalConfig, McpOAuthConfig, McpRemoteConfig, MessageAbortedError, MessageOutputLengthError, Model, ModelApi, ModelCapabilities, ModelCapabilitiesInput, ModelCapabilitiesInterleavedAnyOf, ModelCost, ModelCostExperimentalOver200K, NotFoundError, OAuth, PartAnyOf, PatchPart, Path, Permission, PermissionRespondRequest, Project, ProjectTime, ProjectUpdateRequest, ProjectUpdateRequestIcon, Provider, ProviderAuthAuthorization, ProviderAuthError, ProviderAuthErrorData, ProviderAuthMethod, ProviderConfig, ProviderConfigModelsValue, ProviderConfigModelsValueInterleavedAnyOf, ProviderConfigOptions, ProviderList200Response, ProviderList200ResponseAllInner, ProviderList200ResponseAllInnerModelsValue, ProviderList200ResponseAllInnerModelsValueCost, ProviderList200ResponseAllInnerModelsValueCostContextOver200k, ProviderList200ResponseAllInnerModelsValueInterleavedAnyOf, ProviderList200ResponseAllInnerModelsValueLimit, ProviderList200ResponseAllInnerModelsValueModalities, ProviderList200ResponseAllInnerModelsValueProvider, ProviderOauthAuthorizeRequest, ProviderOauthCallbackRequest, Pty, PtyCreateRequest, PtyUpdateRequest, PtyUpdateRequestSize, Range, RangeStart, ReasoningPart, RetryPart, ServerConfig, Session, SessionApi, SessionCommandRequest, SessionCreateRequest, SessionForkRequest, SessionInitRequest, SessionMessages200ResponseInner, SessionPrompt200Response, SessionPromptRequest, SessionPromptRequestModel, SessionRevert, SessionRevertRequest, SessionShare, SessionShellRequest, SessionStatusAnyOf, SessionStatusAnyOf1, SessionStatusAnyOf2, SessionSummarizeRequest, SessionSummary, SessionTime, SessionUpdateRequest, SessionUpdateRequestTime, SnapshotPart, StepFinishPart, StepStartPart, SubtaskPartInput, Symbol, SymbolLocation, SymbolSource, TextPart, TextPartInput, TextPartTime, Todo, ToolListItem, ToolPart, ToolStateCompleted, ToolStateCompletedTime, ToolStateError, ToolStateErrorTime, ToolStatePending, ToolStateRunning, ToolStateRunningTime, TuiControlNext200Response, TuiExecuteCommandRequest, TuiShowToastRequest, UnknownError, UnknownErrorData, UserMessage, UserMessageSummary, UserMessageTime, VcsInfo, WellKnownAuth

Constant Summary collapse

VERSION =
'1.0.3'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

OpencodeClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



283
284
285
286
287
288
289
# File 'lib/opencode_client.rb', line 283

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end