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

opencode/resources/pty.py

@@ -46,11 +46,11 @@ class PtyConnectResource(SyncAPIResource):
         Create a short-lived single-use ticket for opening a PTY WebSocket connection.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ForbiddenError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ForbiddenError: The server answered 403.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/pty/:ptyID/connect-token``
         """
@@ -77,6 +77,7 @@ class PtyResource(SyncAPIResource):
 
     @cached_property
     def connect(self) -> PtyConnectResource:
+        """Operations under ``client.pty.connect``."""
         return PtyConnectResource(self._client)
 
     def list(
@@ -93,9 +94,9 @@ class PtyResource(SyncAPIResource):
         List PTY sessions for a location, including exited sessions retained until removal.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/pty``
         """
@@ -134,9 +135,9 @@ class PtyResource(SyncAPIResource):
         Create a pseudo-terminal session for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/pty``
         """
@@ -172,10 +173,10 @@ class PtyResource(SyncAPIResource):
         Get one PTY session, including its exit code once exited.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/pty/:ptyID``
         """
@@ -212,10 +213,10 @@ class PtyResource(SyncAPIResource):
         Update the title or viewport size of one PTY session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``PUT /api/pty/:ptyID``
         """
@@ -251,10 +252,10 @@ class PtyResource(SyncAPIResource):
         Terminate and remove one PTY session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/pty/:ptyID``
         """
@@ -291,11 +292,11 @@ class AsyncPtyConnectResource(AsyncAPIResource):
         Create a short-lived single-use ticket for opening a PTY WebSocket connection.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          ForbiddenError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ForbiddenError: The server answered 403.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/pty/:ptyID/connect-token``
         """
@@ -322,6 +323,7 @@ class AsyncPtyResource(AsyncAPIResource):
 
     @cached_property
     def connect(self) -> AsyncPtyConnectResource:
+        """Operations under ``client.pty.connect``."""
         return AsyncPtyConnectResource(self._client)
 
     async def list(
@@ -338,9 +340,9 @@ class AsyncPtyResource(AsyncAPIResource):
         List PTY sessions for a location, including exited sessions retained until removal.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/pty``
         """
@@ -379,9 +381,9 @@ class AsyncPtyResource(AsyncAPIResource):
         Create a pseudo-terminal session for a location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``POST /api/pty``
         """
@@ -417,10 +419,10 @@ class AsyncPtyResource(AsyncAPIResource):
         Get one PTY session, including its exit code once exited.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/pty/:ptyID``
         """
@@ -457,10 +459,10 @@ class AsyncPtyResource(AsyncAPIResource):
         Update the title or viewport size of one PTY session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``PUT /api/pty/:ptyID``
         """
@@ -496,10 +498,10 @@ class AsyncPtyResource(AsyncAPIResource):
         Terminate and remove one PTY session.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          PtyNotFoundError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
 
         ``DELETE /api/pty/:ptyID``
         """

opencode/resources/reference.py

@@ -35,9 +35,9 @@ class ReferenceResource(SyncAPIResource):
         List references available in the requested location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/reference``
         """
@@ -75,9 +75,9 @@ class AsyncReferenceResource(AsyncAPIResource):
         List references available in the requested location.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
 
         ``GET /api/reference``
         """

opencode/resources/rpc.py

@@ -39,11 +39,11 @@ class RpcResource(SyncAPIResource):
         Dispatch a method to the currently registered RPC at the requested location.
 
         Raises:
-          RpcError
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          RpcInternalError
+          RpcError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          RpcInternalError: The server answered 500.
 
         ``POST /api/rpc/:rpcID/:method``
         """
@@ -85,11 +85,11 @@ class AsyncRpcResource(AsyncAPIResource):
         Dispatch a method to the currently registered RPC at the requested location.
 
         Raises:
-          RpcError
-          InvalidRequestError
-          UnauthorizedError
-          LocationNotFoundError
-          RpcInternalError
+          RpcError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          RpcInternalError: The server answered 500.
 
         ``POST /api/rpc/:rpcID/:method``
         """

opencode/resources/server.py

@@ -36,8 +36,8 @@ class ServerResource(SyncAPIResource):
         Return the server identity, connection URLs, paths, and readiness status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /api/info``
         """
@@ -69,8 +69,8 @@ class ServerResource(SyncAPIResource):
         Create a short-lived, single-use code for a /auth/connect/:code pairing link.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``POST /api/pair``
         """
@@ -103,8 +103,8 @@ class ServerResource(SyncAPIResource):
         Redeem a pairing code. Browsers receive a session cookie and a redirect to the web app; requests that accept JSON receive a session token to use as the password.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /auth/connect/:code``
         """
@@ -140,8 +140,8 @@ class AsyncServerResource(AsyncAPIResource):
         Return the server identity, connection URLs, paths, and readiness status.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /api/info``
         """
@@ -173,8 +173,8 @@ class AsyncServerResource(AsyncAPIResource):
         Create a short-lived, single-use code for a /auth/connect/:code pairing link.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``POST /api/pair``
         """
@@ -207,8 +207,8 @@ class AsyncServerResource(AsyncAPIResource):
         Redeem a pairing code. Browsers receive a session cookie and a redirect to the web app; requests that accept JSON receive a session token to use as the password.
 
         Raises:
-          InvalidRequestError
-          UnauthorizedError
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
 
         ``GET /auth/connect/:code``
         """