opencode-python-sdk 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

opencode/resources/integration.py

@@ -49,9 +49,9 @@ class IntegrationWellknownResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/integration/wellknown``
         """
@@ -91,10 +91,10 @@ class IntegrationConnectResource(SyncAPIResource):
         Run a key authentication method and store the resulting credential.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/key``
         """
@@ -130,10 +130,10 @@ class IntegrationConnectResource(SyncAPIResource):
         Run an external authentication method and store a reference to its credential source.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/external``
         """
@@ -173,9 +173,9 @@ class IntegrationOauthResource(SyncAPIResource):
         Start an OAuth attempt and return the authorization details.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/oauth``
         """
@@ -212,11 +212,11 @@ class IntegrationOauthResource(SyncAPIResource):
         Poll the current status of an OAuth attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID/connect/oauth/:attemptID``
         """
@@ -253,11 +253,11 @@ class IntegrationOauthResource(SyncAPIResource):
         Complete a code-based OAuth attempt and store the resulting credential.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/oauth/:attemptID/complete``
         """
@@ -291,9 +291,9 @@ class IntegrationOauthResource(SyncAPIResource):
         Cancel an OAuth attempt and release its resources.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/integration/:integrationID/connect/oauth/:attemptID``
         """
@@ -331,11 +331,11 @@ class IntegrationCommandResource(SyncAPIResource):
         Start a command authentication attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationMethodNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationMethodNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/command``
         """
@@ -372,11 +372,11 @@ class IntegrationCommandResource(SyncAPIResource):
         Poll the current status and output of a command authentication attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID/connect/command/:attemptID``
         """
@@ -412,9 +412,9 @@ class IntegrationCommandResource(SyncAPIResource):
         Cancel a command authentication attempt and terminate its process.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/integration/:integrationID/connect/command/:attemptID``
         """
@@ -437,18 +437,22 @@ class IntegrationResource(SyncAPIResource):
 
     @cached_property
     def wellknown(self) -> IntegrationWellknownResource:
+        """Operations under ``client.integration.wellknown``."""
         return IntegrationWellknownResource(self._client)
 
     @cached_property
     def connect(self) -> IntegrationConnectResource:
+        """Operations under ``client.integration.connect``."""
         return IntegrationConnectResource(self._client)
 
     @cached_property
     def oauth(self) -> IntegrationOauthResource:
+        """Operations under ``client.integration.oauth``."""
         return IntegrationOauthResource(self._client)
 
     @cached_property
     def command(self) -> IntegrationCommandResource:
+        """Operations under ``client.integration.command``."""
         return IntegrationCommandResource(self._client)
 
     def list(
@@ -465,9 +469,9 @@ class IntegrationResource(SyncAPIResource):
         Retrieve available integrations and their authentication methods.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration``
         """
@@ -502,10 +506,10 @@ class IntegrationResource(SyncAPIResource):
         Retrieve one integration and its authentication methods.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID``
         """
@@ -546,9 +550,9 @@ class AsyncIntegrationWellknownResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/integration/wellknown``
         """
@@ -588,10 +592,10 @@ class AsyncIntegrationConnectResource(AsyncAPIResource):
         Run a key authentication method and store the resulting credential.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/key``
         """
@@ -627,10 +631,10 @@ class AsyncIntegrationConnectResource(AsyncAPIResource):
         Run an external authentication method and store a reference to its credential source.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/external``
         """
@@ -670,9 +674,9 @@ class AsyncIntegrationOauthResource(AsyncAPIResource):
         Start an OAuth attempt and return the authorization details.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/oauth``
         """
@@ -709,11 +713,11 @@ class AsyncIntegrationOauthResource(AsyncAPIResource):
         Poll the current status of an OAuth attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID/connect/oauth/:attemptID``
         """
@@ -750,11 +754,11 @@ class AsyncIntegrationOauthResource(AsyncAPIResource):
         Complete a code-based OAuth attempt and store the resulting credential.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/oauth/:attemptID/complete``
         """
@@ -788,9 +792,9 @@ class AsyncIntegrationOauthResource(AsyncAPIResource):
         Cancel an OAuth attempt and release its resources.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/integration/:integrationID/connect/oauth/:attemptID``
         """
@@ -828,11 +832,11 @@ class AsyncIntegrationCommandResource(AsyncAPIResource):
         Start a command authentication attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationMethodNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationMethodNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/integration/:integrationID/connect/command``
         """
@@ -869,11 +873,11 @@ class AsyncIntegrationCommandResource(AsyncAPIResource):
         Poll the current status and output of a command authentication attempt.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          IntegrationAttemptNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          IntegrationAttemptNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID/connect/command/:attemptID``
         """
@@ -909,9 +913,9 @@ class AsyncIntegrationCommandResource(AsyncAPIResource):
         Cancel a command authentication attempt and terminate its process.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/integration/:integrationID/connect/command/:attemptID``
         """
@@ -934,18 +938,22 @@ class AsyncIntegrationResource(AsyncAPIResource):
 
     @cached_property
     def wellknown(self) -> AsyncIntegrationWellknownResource:
+        """Operations under ``client.integration.wellknown``."""
         return AsyncIntegrationWellknownResource(self._client)
 
     @cached_property
     def connect(self) -> AsyncIntegrationConnectResource:
+        """Operations under ``client.integration.connect``."""
         return AsyncIntegrationConnectResource(self._client)
 
     @cached_property
     def oauth(self) -> AsyncIntegrationOauthResource:
+        """Operations under ``client.integration.oauth``."""
         return AsyncIntegrationOauthResource(self._client)
 
     @cached_property
     def command(self) -> AsyncIntegrationCommandResource:
+        """Operations under ``client.integration.command``."""
         return AsyncIntegrationCommandResource(self._client)
 
     async def list(
@@ -962,9 +970,9 @@ class AsyncIntegrationResource(AsyncAPIResource):
         Retrieve available integrations and their authentication methods.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration``
         """
@@ -999,10 +1007,10 @@ class AsyncIntegrationResource(AsyncAPIResource):
         Retrieve one integration and its authentication methods.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          IntegrationNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          IntegrationNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/integration/:integrationID``
         """

opencode/resources/location.py

@@ -35,9 +35,9 @@ class LocationResource(SyncAPIResource):
         Resolve the requested location or the server default location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/location``
         """
@@ -70,9 +70,9 @@ class LocationResource(SyncAPIResource):
         Shut down and rebuild every loaded location. Pending permissions and forms are cancelled; running sessions continue with fresh services at the next step boundary. Emits location.shutdown for client recovery and responds once all replacement builds settle.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/location/reload``
         """
@@ -106,9 +106,9 @@ class AsyncLocationResource(AsyncAPIResource):
         Resolve the requested location or the server default location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/location``
         """
@@ -141,9 +141,9 @@ class AsyncLocationResource(AsyncAPIResource):
         Shut down and rebuild every loaded location. Pending permissions and forms are cancelled; running sessions continue with fresh services at the next step boundary. Emits location.shutdown for client recovery and responds once all replacement builds settle.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/location/reload``
         """

opencode/resources/mcp.py

@@ -39,9 +39,9 @@ class McpResourceResource(SyncAPIResource):
         Retrieve resources and resource templates from connected MCP servers.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/mcp/resource``
         """
@@ -67,6 +67,7 @@ class McpResource(SyncAPIResource):
 
     @cached_property
     def resource(self) -> McpResourceResource:
+        """Operations under ``client.mcp.resource``."""
         return McpResourceResource(self._client)
 
     def list(
@@ -83,9 +84,9 @@ class McpResource(SyncAPIResource):
         Retrieve configured MCP servers and their connection status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/mcp``
         """
@@ -123,9 +124,9 @@ class McpResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``PUT /api/experimental/mcp/:server``
         """
@@ -160,10 +161,10 @@ class McpResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/experimental/mcp/:server``
         """
@@ -197,10 +198,10 @@ class McpResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/mcp/:server/connect``
         """
@@ -234,10 +235,10 @@ class McpResource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/mcp/:server/disconnect``
         """
@@ -272,9 +273,9 @@ class AsyncMcpResourceResource(AsyncAPIResource):
         Retrieve resources and resource templates from connected MCP servers.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/mcp/resource``
         """
@@ -300,6 +301,7 @@ class AsyncMcpResource(AsyncAPIResource):
 
     @cached_property
     def resource(self) -> AsyncMcpResourceResource:
+        """Operations under ``client.mcp.resource``."""
         return AsyncMcpResourceResource(self._client)
 
     async def list(
@@ -316,9 +318,9 @@ class AsyncMcpResource(AsyncAPIResource):
         Retrieve configured MCP servers and their connection status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/mcp``
         """
@@ -356,9 +358,9 @@ class AsyncMcpResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``PUT /api/experimental/mcp/:server``
         """
@@ -393,10 +395,10 @@ class AsyncMcpResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/experimental/mcp/:server``
         """
@@ -430,10 +432,10 @@ class AsyncMcpResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/mcp/:server/connect``
         """
@@ -467,10 +469,10 @@ class AsyncMcpResource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          McpServerNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          McpServerNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/experimental/mcp/:server/disconnect``
         """

opencode/resources/message.py

@@ -64,11 +64,11 @@ class MessageResource(SyncAPIResource):
           type: Filter by message type before pagination. When omitted, all message types are returned. Pass the same type when following cursors.
 
         Raises:
-          InvalidCursorError
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          UnknownError
+          InvalidCursorError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          UnknownError: The server answered 500.
 
         ``GET /api/session/:sessionID/message``
         """
@@ -129,11 +129,11 @@ class AsyncMessageResource(AsyncAPIResource):
           type: Filter by message type before pagination. When omitted, all message types are returned. Pass the same type when following cursors.
 
         Raises:
-          InvalidCursorError
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          UnknownError
+          InvalidCursorError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          UnknownError: The server answered 500.
 
         ``GET /api/session/:sessionID/message``
         """