opencode-python-sdk 0.0.1.dev1__py3-none-any.whl

opencode/resources/pty.py

@@ -0,0 +1,522 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``pty`` resource."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+from functools import cached_property
+from typing import TYPE_CHECKING, cast
+
+from .._base_client import RequestOptions
+from .._pty import AsyncPtyAttachMixin, PtyAttachMixin
+from .._qs import encode_path_segment
+from .._resource import AsyncAPIResource, SyncAPIResource
+from .._types import NOT_GIVEN, Body, Headers, NotGiven, Query, Timeout
+
+if TYPE_CHECKING:
+    from ..types import (
+        Location,
+        PtyConnectTokenResponse,
+        PtyCreateResponse,
+        PtyGetResponse,
+        PtyID,
+        PtyListResponse,
+        PtyUpdateResponse,
+        PtyUpdateSize,
+    )
+
+__all__ = ["PtyResource", "AsyncPtyResource"]
+
+
+class PtyConnectResource(SyncAPIResource):
+    """Operations under ``client.pty.connect`` (OpenCode ``pty.connect``)."""
+
+    def token(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        x_opencode_ticket: str | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyConnectTokenResponse:
+        """Create PTY WebSocket token.
+
+        Create a short-lived single-use ticket for opening a PTY WebSocket connection.
+
+        Raises:
+          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``
+        """
+        return cast(
+            "PtyConnectTokenResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}/connect-token",
+                    query={"location": self._location(location)},
+                    headers={"x-opencode-ticket": x_opencode_ticket},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyConnectTokenResponse",
+            ),
+        )
+
+
+class PtyResource(PtyAttachMixin):
+    """Operations under ``client.pty`` (OpenCode ``pty``)."""
+
+    @cached_property
+    def connect(self) -> PtyConnectResource:
+        """Operations under ``client.pty.connect``."""
+        return PtyConnectResource(self._client)
+
+    def list(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyListResponse:
+        """List PTY sessions.
+
+        List PTY sessions for a location, including exited sessions retained until removal.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/pty``
+        """
+        return cast(
+            "PtyListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/pty",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyListResponse",
+            ),
+        )
+
+    def create(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        command: str | NotGiven = NOT_GIVEN,
+        args: Sequence[str] | NotGiven = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        title: str | NotGiven = NOT_GIVEN,
+        env: Mapping[str, str] | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyCreateResponse:
+        """Create PTY session.
+
+        Create a pseudo-terminal session for a location.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``POST /api/pty``
+        """
+        return cast(
+            "PtyCreateResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/pty",
+                    query={"location": self._location(location)},
+                    body={"command": command, "args": args, "cwd": cwd, "title": title, "env": env},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyCreateResponse",
+            ),
+        )
+
+    def get(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyGetResponse:
+        """Get PTY session.
+
+        Get one PTY session, including its exit code once exited.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/pty/:ptyID``
+        """
+        return cast(
+            "PtyGetResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyGetResponse",
+            ),
+        )
+
+    def update(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        title: str | NotGiven = NOT_GIVEN,
+        size: PtyUpdateSize | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyUpdateResponse:
+        """Update PTY session.
+
+        Update the title or viewport size of one PTY session.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``PUT /api/pty/:ptyID``
+        """
+        return cast(
+            "PtyUpdateResponse",
+            self._client.request(
+                RequestOptions(
+                    method="PUT",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}",
+                    query={"location": self._location(location)},
+                    body={"title": title, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyUpdateResponse",
+            ),
+        )
+
+    def remove(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove PTY session.
+
+        Terminate and remove one PTY session.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``DELETE /api/pty/:ptyID``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/pty/{encode_path_segment(pty_id)}",
+                query={"location": self._location(location)},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncPtyConnectResource(AsyncAPIResource):
+    """Operations under ``client.pty.connect`` (OpenCode ``pty.connect``)."""
+
+    async def token(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        x_opencode_ticket: str | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyConnectTokenResponse:
+        """Create PTY WebSocket token.
+
+        Create a short-lived single-use ticket for opening a PTY WebSocket connection.
+
+        Raises:
+          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``
+        """
+        return cast(
+            "PtyConnectTokenResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}/connect-token",
+                    query={"location": self._location(location)},
+                    headers={"x-opencode-ticket": x_opencode_ticket},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyConnectTokenResponse",
+            ),
+        )
+
+
+class AsyncPtyResource(AsyncPtyAttachMixin):
+    """Operations under ``client.pty`` (OpenCode ``pty``)."""
+
+    @cached_property
+    def connect(self) -> AsyncPtyConnectResource:
+        """Operations under ``client.pty.connect``."""
+        return AsyncPtyConnectResource(self._client)
+
+    async def list(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyListResponse:
+        """List PTY sessions.
+
+        List PTY sessions for a location, including exited sessions retained until removal.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/pty``
+        """
+        return cast(
+            "PtyListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/pty",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyListResponse",
+            ),
+        )
+
+    async def create(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        command: str | NotGiven = NOT_GIVEN,
+        args: Sequence[str] | NotGiven = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        title: str | NotGiven = NOT_GIVEN,
+        env: Mapping[str, str] | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyCreateResponse:
+        """Create PTY session.
+
+        Create a pseudo-terminal session for a location.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``POST /api/pty``
+        """
+        return cast(
+            "PtyCreateResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/pty",
+                    query={"location": self._location(location)},
+                    body={"command": command, "args": args, "cwd": cwd, "title": title, "env": env},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyCreateResponse",
+            ),
+        )
+
+    async def get(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyGetResponse:
+        """Get PTY session.
+
+        Get one PTY session, including its exit code once exited.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/pty/:ptyID``
+        """
+        return cast(
+            "PtyGetResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyGetResponse",
+            ),
+        )
+
+    async def update(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        title: str | NotGiven = NOT_GIVEN,
+        size: PtyUpdateSize | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PtyUpdateResponse:
+        """Update PTY session.
+
+        Update the title or viewport size of one PTY session.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``PUT /api/pty/:ptyID``
+        """
+        return cast(
+            "PtyUpdateResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="PUT",
+                    path=f"/api/pty/{encode_path_segment(pty_id)}",
+                    query={"location": self._location(location)},
+                    body={"title": title, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PtyUpdateResponse",
+            ),
+        )
+
+    async def remove(
+        self,
+        pty_id: PtyID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove PTY session.
+
+        Terminate and remove one PTY session.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          PtyNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``DELETE /api/pty/:ptyID``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/pty/{encode_path_segment(pty_id)}",
+                query={"location": self._location(location)},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )

opencode/resources/reference.py

@@ -0,0 +1,100 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``reference`` resource."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, cast
+
+from .._base_client import RequestOptions
+from .._resource import AsyncAPIResource, SyncAPIResource
+from .._types import NOT_GIVEN, Body, Headers, NotGiven, Query, Timeout
+
+if TYPE_CHECKING:
+    from ..types import (
+        Location,
+        ReferenceListResponse,
+    )
+
+__all__ = ["ReferenceResource", "AsyncReferenceResource"]
+
+
+class ReferenceResource(SyncAPIResource):
+    """Operations under ``client.reference`` (OpenCode ``reference``)."""
+
+    def list(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ReferenceListResponse:
+        """List references.
+
+        List references available in the requested location.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/reference``
+        """
+        return cast(
+            "ReferenceListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/reference",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ReferenceListResponse",
+            ),
+        )
+
+
+class AsyncReferenceResource(AsyncAPIResource):
+    """Operations under ``client.reference`` (OpenCode ``reference``)."""
+
+    async def list(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ReferenceListResponse:
+        """List references.
+
+        List references available in the requested location.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/reference``
+        """
+        return cast(
+            "ReferenceListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/reference",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ReferenceListResponse",
+            ),
+        )