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

opencode/resources/shell.py

@@ -0,0 +1,410 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``shell`` resource."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, 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 (
+    Location,
+    ShellCreateResponse,
+    ShellGetResponse,
+    ShellID,
+    ShellListResponse,
+    ShellOutputResponse,
+)
+
+__all__ = ["ShellResource", "AsyncShellResource"]
+
+
+class ShellResource(SyncAPIResource):
+    """Operations under ``client.shell`` (OpenCode ``shell``)."""
+
+    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,
+    ) -> ShellListResponse:
+        """List running shell commands.
+
+        List currently running shell commands for a location. Exited commands are not included.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/shell``
+        """
+        return cast(
+            "ShellListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/shell",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellListResponse,
+            ),
+        )
+
+    def create(
+        self,
+        *,
+        command: str,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        timeout_: int | NotGiven = NOT_GIVEN,
+        metadata: Mapping[str, Any] | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ShellCreateResponse:
+        """Run shell command.
+
+        Spawn one non-interactive shell command for a location. Combined stdout/stderr is captured to a file pageable via output.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``POST /api/shell``
+        """
+        return cast(
+            "ShellCreateResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/shell",
+                    query={"location": self._location(location)},
+                    body={"command": command, "cwd": cwd, "timeout": timeout_, "metadata": metadata},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellCreateResponse,
+            ),
+        )
+
+    def get(
+        self,
+        id: ShellID,
+        *,
+        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,
+    ) -> ShellGetResponse:
+        """Get shell command.
+
+        Get one shell command, including its status and exit code once exited.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ShellNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/shell/:id``
+        """
+        return cast(
+            "ShellGetResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/shell/{encode_path_segment(id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellGetResponse,
+            ),
+        )
+
+    def output(
+        self,
+        id: ShellID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        cursor: int | NotGiven | None = NOT_GIVEN,
+        limit: int | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ShellOutputResponse:
+        """Read shell output.
+
+        Page through captured combined output by absolute byte cursor.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ShellNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/shell/:id/output``
+        """
+        return cast(
+            "ShellOutputResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/shell/{encode_path_segment(id)}/output",
+                    query={"location": self._location(location), "cursor": cursor, "limit": limit},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellOutputResponse,
+            ),
+        )
+
+    def remove(
+        self,
+        id: ShellID,
+        *,
+        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 shell command.
+
+        Terminate and remove one shell command and its retained output.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``DELETE /api/shell/:id``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/shell/{encode_path_segment(id)}",
+                query={"location": self._location(location)},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncShellResource(AsyncAPIResource):
+    """Operations under ``client.shell`` (OpenCode ``shell``)."""
+
+    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,
+    ) -> ShellListResponse:
+        """List running shell commands.
+
+        List currently running shell commands for a location. Exited commands are not included.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/shell``
+        """
+        return cast(
+            "ShellListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/shell",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellListResponse,
+            ),
+        )
+
+    async def create(
+        self,
+        *,
+        command: str,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        cwd: str | NotGiven = NOT_GIVEN,
+        timeout_: int | NotGiven = NOT_GIVEN,
+        metadata: Mapping[str, Any] | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ShellCreateResponse:
+        """Run shell command.
+
+        Spawn one non-interactive shell command for a location. Combined stdout/stderr is captured to a file pageable via output.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``POST /api/shell``
+        """
+        return cast(
+            "ShellCreateResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/shell",
+                    query={"location": self._location(location)},
+                    body={"command": command, "cwd": cwd, "timeout": timeout_, "metadata": metadata},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellCreateResponse,
+            ),
+        )
+
+    async def get(
+        self,
+        id: ShellID,
+        *,
+        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,
+    ) -> ShellGetResponse:
+        """Get shell command.
+
+        Get one shell command, including its status and exit code once exited.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ShellNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/shell/:id``
+        """
+        return cast(
+            "ShellGetResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/shell/{encode_path_segment(id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellGetResponse,
+            ),
+        )
+
+    async def output(
+        self,
+        id: ShellID,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        cursor: int | NotGiven | None = NOT_GIVEN,
+        limit: int | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> ShellOutputResponse:
+        """Read shell output.
+
+        Page through captured combined output by absolute byte cursor.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          ShellNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/shell/:id/output``
+        """
+        return cast(
+            "ShellOutputResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/shell/{encode_path_segment(id)}/output",
+                    query={"location": self._location(location), "cursor": cursor, "limit": limit},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=ShellOutputResponse,
+            ),
+        )
+
+    async def remove(
+        self,
+        id: ShellID,
+        *,
+        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 shell command.
+
+        Terminate and remove one shell command and its retained output.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``DELETE /api/shell/:id``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/shell/{encode_path_segment(id)}",
+                query={"location": self._location(location)},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )

opencode/resources/skill.py

@@ -0,0 +1,98 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``skill`` resource."""
+
+from __future__ import annotations
+
+from typing import cast
+
+from .._base_client import RequestOptions
+from .._resource import AsyncAPIResource, SyncAPIResource
+from .._types import NOT_GIVEN, Body, Headers, NotGiven, Query, Timeout
+from ..types import (
+    Location,
+    SkillListResponse,
+)
+
+__all__ = ["SkillResource", "AsyncSkillResource"]
+
+
+class SkillResource(SyncAPIResource):
+    """Operations under ``client.skill`` (OpenCode ``skill``)."""
+
+    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,
+    ) -> SkillListResponse:
+        """List skills.
+
+        Retrieve currently registered skills.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/skill``
+        """
+        return cast(
+            "SkillListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/skill",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=SkillListResponse,
+            ),
+        )
+
+
+class AsyncSkillResource(AsyncAPIResource):
+    """Operations under ``client.skill`` (OpenCode ``skill``)."""
+
+    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,
+    ) -> SkillListResponse:
+        """List skills.
+
+        Retrieve currently registered skills.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/skill``
+        """
+        return cast(
+            "SkillListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/skill",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=SkillListResponse,
+            ),
+        )