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

opencode/resources/migration.py

@@ -38,8 +38,8 @@ class MigrationV1Resource(SyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /api/experimental/migration/v1``
         """
@@ -66,6 +66,7 @@ class MigrationResource(SyncAPIResource):
 
     @cached_property
     def v1(self) -> MigrationV1Resource:
+        """Operations under ``client.migration.v1``."""
         return MigrationV1Resource(self._client)
 
 
@@ -87,8 +88,8 @@ class AsyncMigrationV1Resource(AsyncAPIResource):
         This endpoint is experimental in OpenCode and may change without notice.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /api/experimental/migration/v1``
         """
@@ -115,4 +116,5 @@ class AsyncMigrationResource(AsyncAPIResource):
 
     @cached_property
     def v1(self) -> AsyncMigrationV1Resource:
+        """Operations under ``client.migration.v1``."""
         return AsyncMigrationV1Resource(self._client)

opencode/resources/model.py

@@ -36,10 +36,10 @@ class ModelResource(SyncAPIResource):
         Retrieve the current snapshot of available models ordered by release date. The snapshot may precede initial plugin settlement.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/model``
         """
@@ -73,10 +73,10 @@ class ModelResource(SyncAPIResource):
         Retrieve the model used when a session has no explicit model selection.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/model/default``
         """
@@ -114,10 +114,10 @@ class AsyncModelResource(AsyncAPIResource):
         Retrieve the current snapshot of available models ordered by release date. The snapshot may precede initial plugin settlement.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/model``
         """
@@ -151,10 +151,10 @@ class AsyncModelResource(AsyncAPIResource):
         Retrieve the model used when a session has no explicit model selection.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/model/default``
         """

opencode/resources/permission.py

@@ -49,9 +49,9 @@ class PermissionRequestResource(SyncAPIResource):
         Retrieve pending permission requests for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/permission/request``
         """
@@ -89,9 +89,9 @@ class PermissionSavedResource(SyncAPIResource):
         Retrieve saved permissions, optionally filtered by project.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/permission/saved``
         """
@@ -128,11 +128,11 @@ class PermissionSavedResource(SyncAPIResource):
         Change the action or resource of a saved permission. Fails with a conflict when the project already has a saved permission with the same action and resource.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PermissionSavedNotFoundError
-          LocationNotFoundError
-          ConflictError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PermissionSavedNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+          ConflictError: The server answered 409.
 
         ``PATCH /api/permission/saved/:id``
         """
@@ -167,9 +167,9 @@ class PermissionSavedResource(SyncAPIResource):
         Remove a saved permission by ID.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/permission/saved/:id``
         """
@@ -191,10 +191,12 @@ class PermissionResource(SyncAPIResource):
 
     @cached_property
     def request_(self) -> PermissionRequestResource:
+        """Operations under ``client.permission.request``."""
         return PermissionRequestResource(self._client)
 
     @cached_property
     def saved(self) -> PermissionSavedResource:
+        """Operations under ``client.permission.saved``."""
         return PermissionSavedResource(self._client)
 
     def create(
@@ -218,10 +220,10 @@ class PermissionResource(SyncAPIResource):
         Evaluate and, when approval is required, create a permission request for a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/session/:sessionID/permission``
         """
@@ -264,10 +266,10 @@ class PermissionResource(SyncAPIResource):
         Retrieve pending permission requests owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/session/:sessionID/permission``
         """
@@ -302,11 +304,11 @@ class PermissionResource(SyncAPIResource):
         Retrieve a pending permission request owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          PermissionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          PermissionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/session/:sessionID/permission/:requestID``
         """
@@ -343,11 +345,11 @@ class PermissionResource(SyncAPIResource):
         Respond to a pending permission request owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          PermissionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          PermissionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/session/:sessionID/permission/:requestID/reply``
         """
@@ -382,9 +384,9 @@ class AsyncPermissionRequestResource(AsyncAPIResource):
         Retrieve pending permission requests for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/permission/request``
         """
@@ -422,9 +424,9 @@ class AsyncPermissionSavedResource(AsyncAPIResource):
         Retrieve saved permissions, optionally filtered by project.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/permission/saved``
         """
@@ -461,11 +463,11 @@ class AsyncPermissionSavedResource(AsyncAPIResource):
         Change the action or resource of a saved permission. Fails with a conflict when the project already has a saved permission with the same action and resource.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PermissionSavedNotFoundError
-          LocationNotFoundError
-          ConflictError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PermissionSavedNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+          ConflictError: The server answered 409.
 
         ``PATCH /api/permission/saved/:id``
         """
@@ -500,9 +502,9 @@ class AsyncPermissionSavedResource(AsyncAPIResource):
         Remove a saved permission by ID.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/permission/saved/:id``
         """
@@ -524,10 +526,12 @@ class AsyncPermissionResource(AsyncAPIResource):
 
     @cached_property
     def request_(self) -> AsyncPermissionRequestResource:
+        """Operations under ``client.permission.request``."""
         return AsyncPermissionRequestResource(self._client)
 
     @cached_property
     def saved(self) -> AsyncPermissionSavedResource:
+        """Operations under ``client.permission.saved``."""
         return AsyncPermissionSavedResource(self._client)
 
     async def create(
@@ -551,10 +555,10 @@ class AsyncPermissionResource(AsyncAPIResource):
         Evaluate and, when approval is required, create a permission request for a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/session/:sessionID/permission``
         """
@@ -597,10 +601,10 @@ class AsyncPermissionResource(AsyncAPIResource):
         Retrieve pending permission requests owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/session/:sessionID/permission``
         """
@@ -635,11 +639,11 @@ class AsyncPermissionResource(AsyncAPIResource):
         Retrieve a pending permission request owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          PermissionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          PermissionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/session/:sessionID/permission/:requestID``
         """
@@ -676,11 +680,11 @@ class AsyncPermissionResource(AsyncAPIResource):
         Respond to a pending permission request owned by a session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          SessionNotFoundError
-          PermissionNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          SessionNotFoundError: The server answered 404.
+          PermissionNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/session/:sessionID/permission/:requestID/reply``
         """

opencode/resources/plugin.py

@@ -37,9 +37,9 @@ class PluginResource(SyncAPIResource):
         Retrieve enabled server plugins and their current status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/plugin``
         """
@@ -74,9 +74,9 @@ class PluginResource(SyncAPIResource):
         Check one or all package plugins for available updates.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/plugin/check``
         """
@@ -112,10 +112,10 @@ class PluginResource(SyncAPIResource):
         Update package plugins concurrently and notify active locations to reload them. Responds once every update has finished; fails when any update fails.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/plugin/update``
         """
@@ -151,9 +151,9 @@ class AsyncPluginResource(AsyncAPIResource):
         Retrieve enabled server plugins and their current status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/plugin``
         """
@@ -188,9 +188,9 @@ class AsyncPluginResource(AsyncAPIResource):
         Check one or all package plugins for available updates.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/plugin/check``
         """
@@ -226,10 +226,10 @@ class AsyncPluginResource(AsyncAPIResource):
         Update package plugins concurrently and notify active locations to reload them. Responds once every update has finished; fails when any update fails.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``POST /api/plugin/update``
         """

opencode/resources/project.py

@@ -40,9 +40,9 @@ class ProjectResource(SyncAPIResource):
         List known projects. Archived projects are excluded unless archived=true.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/project``
         """
@@ -80,10 +80,10 @@ class ProjectResource(SyncAPIResource):
         Update the project canonical directory, display metadata, and workspace commands.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ProjectNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``PATCH /api/project/:projectID``
         """
@@ -121,9 +121,9 @@ class AsyncProjectResource(AsyncAPIResource):
         List known projects. Archived projects are excluded unless archived=true.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/project``
         """
@@ -161,10 +161,10 @@ class AsyncProjectResource(AsyncAPIResource):
         Update the project canonical directory, display metadata, and workspace commands.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ProjectNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``PATCH /api/project/:projectID``
         """

opencode/resources/provider.py

@@ -38,10 +38,10 @@ class ProviderResource(SyncAPIResource):
         Retrieve active AI providers so clients can show provider availability and configuration.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/provider``
         """
@@ -76,11 +76,11 @@ class ProviderResource(SyncAPIResource):
         Retrieve a single AI provider so clients can inspect its availability and endpoint settings.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ProviderNotFoundError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProviderNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/provider/:providerID``
         """
@@ -118,10 +118,10 @@ class AsyncProviderResource(AsyncAPIResource):
         Retrieve active AI providers so clients can show provider availability and configuration.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/provider``
         """
@@ -156,11 +156,11 @@ class AsyncProviderResource(AsyncAPIResource):
         Retrieve a single AI provider so clients can inspect its availability and endpoint settings.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ProviderNotFoundError
-          LocationNotFoundError
-          ServiceUnavailableError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProviderNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
 
         ``GET /api/provider/:providerID``
         """