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

opencode/resources/experimental.py

@@ -0,0 +1,760 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``experimental`` resource."""
+
+from __future__ import annotations
+
+import builtins
+from collections.abc import Mapping, Sequence
+from functools import cached_property
+from typing import cast
+
+from .._base_client import RequestOptions
+from .._qs import encode_path_segment
+from .._resource import AsyncAPIResource, SyncAPIResource
+from .._types import NOT_GIVEN, Body, Headers, NotGiven, Query, Timeout
+from ..types import (
+    ExperimentalPersistentPtyCreateSize,
+    ExperimentalPersistentPtyHandoffResponse,
+    ExperimentalPersistentPtyUpdateSize,
+    PersistentPtyInfo,
+    PersistentPtyReadLines,
+    PersistentPtyReadResult,
+    PersistentPtySnapshot,
+    PtyID,
+    PtyTicketConnectToken,
+    SessionID,
+)
+
+__all__ = ["ExperimentalResource", "AsyncExperimentalResource"]
+
+
+class ExperimentalPersistentPtyResource(SyncAPIResource):
+    """Operations under ``client.experimental.persistent_pty`` (OpenCode ``experimental.persistentPty``)."""
+
+    def read(
+        self,
+        session_id: SessionID,
+        *,
+        lines: PersistentPtyReadLines | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyReadResult | None:
+        """Read the session's most recently controlled terminal.
+
+        Read the last physical rows without changing selection or taking control. Omitted lines uses the live terminal height; larger counts include retained history. Blank rows are preserved. Screen dimensions and cursor remain relative to the live screen. Returns null when no current terminal exists. Selection is server-local and resets on restart. Experimental: may change without compatibility guarantees.
+
+        This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/session/:sessionID/terminal/read``
+        """
+        return cast(
+            "PersistentPtyReadResult | None",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal/read",
+                    query={"lines": lines},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyReadResult | None,
+                unwrap=True,
+            ),
+        )
+
+    def list(
+        self,
+        session_id: SessionID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[PersistentPtyInfo]:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/session/:sessionID/terminal``
+        """
+        return cast(
+            "builtins.list[PersistentPtyInfo]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PersistentPtyInfo],
+                unwrap=True,
+            ),
+        )
+
+    def create(
+        self,
+        session_id: SessionID,
+        *,
+        args: Sequence[str],
+        title: str,
+        env: Mapping[str, str],
+        command: str | NotGiven = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        size: ExperimentalPersistentPtyCreateSize | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/session/:sessionID/terminal``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal",
+                    body={"command": command, "args": args, "cwd": cwd, "title": title, "env": env, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    def shutdown(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/shutdown``
+        """
+        self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/experimental/persistent-pty/shutdown",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    def handoff(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ExperimentalPersistentPtyHandoffResponse:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/handoff``
+        """
+        return cast(
+            "ExperimentalPersistentPtyHandoffResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/experimental/persistent-pty/handoff",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ExperimentalPersistentPtyHandoffResponse,
+            ),
+        )
+
+    def get(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/persistent-pty/:ptyID``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    def update(
+        self,
+        pty_id: PtyID,
+        *,
+        size: ExperimentalPersistentPtyUpdateSize,
+        attachment_id: str | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``PUT /api/experimental/persistent-pty/:ptyID``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            self._client.request(
+                RequestOptions(
+                    method="PUT",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                    body={"attachmentID": attachment_id, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    def snapshot(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtySnapshot:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/persistent-pty/:ptyID/snapshot``
+        """
+        return cast(
+            "PersistentPtySnapshot",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}/snapshot",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtySnapshot,
+                unwrap=True,
+            ),
+        )
+
+    def remove(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``DELETE /api/experimental/persistent-pty/:ptyID``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    def connect_token(
+        self,
+        pty_id: PtyID,
+        *,
+        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,
+    ) -> PtyTicketConnectToken:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ForbiddenError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/:ptyID/connect-token``
+        """
+        return cast(
+            "PtyTicketConnectToken",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}/connect-token",
+                    headers={"x-opencode-ticket": x_opencode_ticket},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PtyTicketConnectToken,
+                unwrap=True,
+            ),
+        )
+
+
+class ExperimentalResource(SyncAPIResource):
+    """Operations under ``client.experimental`` (OpenCode ``experimental``)."""
+
+    @cached_property
+    def persistent_pty(self) -> ExperimentalPersistentPtyResource:
+        return ExperimentalPersistentPtyResource(self._client)
+
+
+class AsyncExperimentalPersistentPtyResource(AsyncAPIResource):
+    """Operations under ``client.experimental.persistent_pty`` (OpenCode ``experimental.persistentPty``)."""
+
+    async def read(
+        self,
+        session_id: SessionID,
+        *,
+        lines: PersistentPtyReadLines | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyReadResult | None:
+        """Read the session's most recently controlled terminal.
+
+        Read the last physical rows without changing selection or taking control. Omitted lines uses the live terminal height; larger counts include retained history. Blank rows are preserved. Screen dimensions and cursor remain relative to the live screen. Returns null when no current terminal exists. Selection is server-local and resets on restart. Experimental: may change without compatibility guarantees.
+
+        This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/session/:sessionID/terminal/read``
+        """
+        return cast(
+            "PersistentPtyReadResult | None",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal/read",
+                    query={"lines": lines},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyReadResult | None,
+                unwrap=True,
+            ),
+        )
+
+    async def list(
+        self,
+        session_id: SessionID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[PersistentPtyInfo]:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/session/:sessionID/terminal``
+        """
+        return cast(
+            "builtins.list[PersistentPtyInfo]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PersistentPtyInfo],
+                unwrap=True,
+            ),
+        )
+
+    async def create(
+        self,
+        session_id: SessionID,
+        *,
+        args: Sequence[str],
+        title: str,
+        env: Mapping[str, str],
+        command: str | NotGiven = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        size: ExperimentalPersistentPtyCreateSize | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/session/:sessionID/terminal``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/experimental/session/{encode_path_segment(session_id)}/terminal",
+                    body={"command": command, "args": args, "cwd": cwd, "title": title, "env": env, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    async def shutdown(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/shutdown``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/experimental/persistent-pty/shutdown",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    async def handoff(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ExperimentalPersistentPtyHandoffResponse:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/handoff``
+        """
+        return cast(
+            "ExperimentalPersistentPtyHandoffResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/experimental/persistent-pty/handoff",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ExperimentalPersistentPtyHandoffResponse,
+            ),
+        )
+
+    async def get(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/persistent-pty/:ptyID``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    async def update(
+        self,
+        pty_id: PtyID,
+        *,
+        size: ExperimentalPersistentPtyUpdateSize,
+        attachment_id: str | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtyInfo:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``PUT /api/experimental/persistent-pty/:ptyID``
+        """
+        return cast(
+            "PersistentPtyInfo",
+            await self._client.request(
+                RequestOptions(
+                    method="PUT",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                    body={"attachmentID": attachment_id, "size": size},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtyInfo,
+                unwrap=True,
+            ),
+        )
+
+    async def snapshot(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PersistentPtySnapshot:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``GET /api/experimental/persistent-pty/:ptyID/snapshot``
+        """
+        return cast(
+            "PersistentPtySnapshot",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}/snapshot",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PersistentPtySnapshot,
+                unwrap=True,
+            ),
+        )
+
+    async def remove(
+        self,
+        pty_id: PtyID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``DELETE /api/experimental/persistent-pty/:ptyID``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    async def connect_token(
+        self,
+        pty_id: PtyID,
+        *,
+        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,
+    ) -> PtyTicketConnectToken:
+        """This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ForbiddenError
+          PtyNotFoundError
+          ServiceUnavailableError
+
+        ``POST /api/experimental/persistent-pty/:ptyID/connect-token``
+        """
+        return cast(
+            "PtyTicketConnectToken",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/experimental/persistent-pty/{encode_path_segment(pty_id)}/connect-token",
+                    headers={"x-opencode-ticket": x_opencode_ticket},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PtyTicketConnectToken,
+                unwrap=True,
+            ),
+        )
+
+
+class AsyncExperimentalResource(AsyncAPIResource):
+    """Operations under ``client.experimental`` (OpenCode ``experimental``)."""
+
+    @cached_property
+    def persistent_pty(self) -> AsyncExperimentalPersistentPtyResource:
+        return AsyncExperimentalPersistentPtyResource(self._client)