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

opencode/resources/plugin.py

@@ -0,0 +1,250 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``plugin`` resource."""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+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,
+        PluginCheckResponse,
+        PluginListResponse,
+    )
+
+__all__ = ["PluginResource", "AsyncPluginResource"]
+
+
+class PluginResource(SyncAPIResource):
+    """Operations under ``client.plugin`` (OpenCode ``plugin``)."""
+
+    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,
+    ) -> PluginListResponse:
+        """List plugins.
+
+        Retrieve enabled server plugins and their current status.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/plugin``
+        """
+        return cast(
+            "PluginListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/plugin",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PluginListResponse",
+            ),
+        )
+
+    def check(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        target: 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,
+    ) -> PluginCheckResponse:
+        """Check plugin updates.
+
+        Check one or all package plugins for available updates.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``POST /api/plugin/check``
+        """
+        return cast(
+            "PluginCheckResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/plugin/check",
+                    query={"location": self._location(location)},
+                    body={"target": target},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PluginCheckResponse",
+            ),
+        )
+
+    def update(
+        self,
+        *,
+        targets: Sequence[str],
+        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:
+        """Update plugins.
+
+        Update package plugins concurrently and notify active locations to reload them. Responds once every update has finished; fails when any update fails.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``POST /api/plugin/update``
+        """
+        self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/plugin/update",
+                query={"location": self._location(location)},
+                body={"targets": targets},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncPluginResource(AsyncAPIResource):
+    """Operations under ``client.plugin`` (OpenCode ``plugin``)."""
+
+    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,
+    ) -> PluginListResponse:
+        """List plugins.
+
+        Retrieve enabled server plugins and their current status.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/plugin``
+        """
+        return cast(
+            "PluginListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/plugin",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PluginListResponse",
+            ),
+        )
+
+    async def check(
+        self,
+        *,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        target: 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,
+    ) -> PluginCheckResponse:
+        """Check plugin updates.
+
+        Check one or all package plugins for available updates.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``POST /api/plugin/check``
+        """
+        return cast(
+            "PluginCheckResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/plugin/check",
+                    query={"location": self._location(location)},
+                    body={"target": target},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="PluginCheckResponse",
+            ),
+        )
+
+    async def update(
+        self,
+        *,
+        targets: Sequence[str],
+        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:
+        """Update plugins.
+
+        Update package plugins concurrently and notify active locations to reload them. Responds once every update has finished; fails when any update fails.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``POST /api/plugin/update``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/plugin/update",
+                query={"location": self._location(location)},
+                body={"targets": targets},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )

opencode/resources/project.py

@@ -0,0 +1,187 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``project`` resource."""
+
+from __future__ import annotations
+
+import builtins
+from typing import TYPE_CHECKING, 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
+
+if TYPE_CHECKING:
+    from ..types import (
+        AbsolutePath,
+        Project,
+        ProjectCommands,
+        ProjectIcon,
+        ProjectID,
+    )
+
+__all__ = ["ProjectResource", "AsyncProjectResource"]
+
+
+class ProjectResource(SyncAPIResource):
+    """Operations under ``client.project`` (OpenCode ``project``)."""
+
+    def list(
+        self,
+        *,
+        archived: bool | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[Project]:
+        """List projects.
+
+        List known projects. Archived projects are excluded unless archived=true.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/project``
+        """
+        return cast(
+            "builtins.list[Project]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/project",
+                    query={"archived": archived},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[Project]",
+            ),
+        )
+
+    def update(
+        self,
+        project_id: ProjectID,
+        *,
+        canonical: AbsolutePath | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        icon: ProjectIcon | NotGiven = NOT_GIVEN,
+        commands: ProjectCommands | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> Project:
+        """Update project.
+
+        Update the project canonical directory, display metadata, and workspace commands.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``PATCH /api/project/:projectID``
+        """
+        return cast(
+            "Project",
+            self._client.request(
+                RequestOptions(
+                    method="PATCH",
+                    path=f"/api/project/{encode_path_segment(project_id)}",
+                    body={"canonical": canonical, "name": name, "icon": icon, "commands": commands},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="Project",
+            ),
+        )
+
+
+class AsyncProjectResource(AsyncAPIResource):
+    """Operations under ``client.project`` (OpenCode ``project``)."""
+
+    async def list(
+        self,
+        *,
+        archived: bool | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[Project]:
+        """List projects.
+
+        List known projects. Archived projects are excluded unless archived=true.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/project``
+        """
+        return cast(
+            "builtins.list[Project]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/project",
+                    query={"archived": archived},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[Project]",
+            ),
+        )
+
+    async def update(
+        self,
+        project_id: ProjectID,
+        *,
+        canonical: AbsolutePath | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        icon: ProjectIcon | NotGiven = NOT_GIVEN,
+        commands: ProjectCommands | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> Project:
+        """Update project.
+
+        Update the project canonical directory, display metadata, and workspace commands.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+          LocationNotFoundError: The server answered 404.
+
+        ``PATCH /api/project/:projectID``
+        """
+        return cast(
+            "Project",
+            await self._client.request(
+                RequestOptions(
+                    method="PATCH",
+                    path=f"/api/project/{encode_path_segment(project_id)}",
+                    body={"canonical": canonical, "name": name, "icon": icon, "commands": commands},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="Project",
+            ),
+        )

opencode/resources/provider.py

@@ -0,0 +1,183 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``provider`` resource."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, 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
+
+if TYPE_CHECKING:
+    from ..types import (
+        Location,
+        ProviderGetResponse,
+        ProviderID,
+        ProviderListResponse,
+    )
+
+__all__ = ["ProviderResource", "AsyncProviderResource"]
+
+
+class ProviderResource(SyncAPIResource):
+    """Operations under ``client.provider`` (OpenCode ``provider``)."""
+
+    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,
+    ) -> ProviderListResponse:
+        """List providers.
+
+        Retrieve active AI providers so clients can show provider availability and configuration.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``GET /api/provider``
+        """
+        return cast(
+            "ProviderListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/provider",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ProviderListResponse",
+            ),
+        )
+
+    def get(
+        self,
+        provider_id: ProviderID,
+        *,
+        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,
+    ) -> ProviderGetResponse:
+        """Get provider.
+
+        Retrieve a single AI provider so clients can inspect its availability and endpoint settings.
+
+        Raises:
+          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``
+        """
+        return cast(
+            "ProviderGetResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/provider/{encode_path_segment(provider_id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ProviderGetResponse",
+            ),
+        )
+
+
+class AsyncProviderResource(AsyncAPIResource):
+    """Operations under ``client.provider`` (OpenCode ``provider``)."""
+
+    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,
+    ) -> ProviderListResponse:
+        """List providers.
+
+        Retrieve active AI providers so clients can show provider availability and configuration.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``GET /api/provider``
+        """
+        return cast(
+            "ProviderListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/provider",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ProviderListResponse",
+            ),
+        )
+
+    async def get(
+        self,
+        provider_id: ProviderID,
+        *,
+        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,
+    ) -> ProviderGetResponse:
+        """Get provider.
+
+        Retrieve a single AI provider so clients can inspect its availability and endpoint settings.
+
+        Raises:
+          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``
+        """
+        return cast(
+            "ProviderGetResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/provider/{encode_path_segment(provider_id)}",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="ProviderGetResponse",
+            ),
+        )