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

opencode/resources/config.py

@@ -0,0 +1,240 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``config`` resource."""
+
+from __future__ import annotations
+
+import builtins
+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 (
+        ConfigEntry,
+        ConfigShellOption,
+        Location,
+    )
+
+__all__ = ["ConfigResource", "AsyncConfigResource"]
+
+
+class ConfigResource(SyncAPIResource):
+    """Operations under ``client.config`` (OpenCode ``config``)."""
+
+    def get(
+        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,
+    ) -> builtins.list[ConfigEntry]:
+        """Get configuration.
+
+        Return configuration documents and discovery sources for the requested location, from lowest to highest priority.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/config``
+        """
+        return cast(
+            "builtins.list[ConfigEntry]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/config",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[ConfigEntry]",
+            ),
+        )
+
+    def shells(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[ConfigShellOption]:
+        """List available shells.
+
+        Return shells available to terminal and agent execution.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/config/shell``
+        """
+        return cast(
+            "builtins.list[ConfigShellOption]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/config/shell",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[ConfigShellOption]",
+            ),
+        )
+
+    def update(
+        self,
+        *,
+        shell: str | None,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Update global configuration.
+
+        Patch supported fields in the highest-precedence global configuration document.
+
+        This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``PATCH /api/experimental/config``
+        """
+        self._client.request(
+            RequestOptions(
+                method="PATCH",
+                path="/api/experimental/config",
+                body={"shell": shell},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncConfigResource(AsyncAPIResource):
+    """Operations under ``client.config`` (OpenCode ``config``)."""
+
+    async def get(
+        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,
+    ) -> builtins.list[ConfigEntry]:
+        """Get configuration.
+
+        Return configuration documents and discovery sources for the requested location, from lowest to highest priority.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/config``
+        """
+        return cast(
+            "builtins.list[ConfigEntry]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/config",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[ConfigEntry]",
+            ),
+        )
+
+    async def shells(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[ConfigShellOption]:
+        """List available shells.
+
+        Return shells available to terminal and agent execution.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``GET /api/config/shell``
+        """
+        return cast(
+            "builtins.list[ConfigShellOption]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/config/shell",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[ConfigShellOption]",
+            ),
+        )
+
+    async def update(
+        self,
+        *,
+        shell: str | None,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Update global configuration.
+
+        Patch supported fields in the highest-precedence global configuration document.
+
+        This endpoint is experimental in OpenCode and may change without notice.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+
+        ``PATCH /api/experimental/config``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="PATCH",
+                path="/api/experimental/config",
+                body={"shell": shell},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )

opencode/resources/credential.py

@@ -0,0 +1,384 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``credential`` 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 (
+        CredentialEntry,
+        CredentialID,
+        CredentialValue,
+        IntegrationID,
+    )
+
+__all__ = ["CredentialResource", "AsyncCredentialResource"]
+
+
+class CredentialResource(SyncAPIResource):
+    """Operations under ``client.credential`` (OpenCode ``credential``)."""
+
+    def list(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[CredentialEntry]:
+        """List credentials.
+
+        List every stored integration credential, including its secret value.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``GET /api/credential``
+        """
+        return cast(
+            "builtins.list[CredentialEntry]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/credential",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[CredentialEntry]",
+                unwrap=True,
+            ),
+        )
+
+    def create(
+        self,
+        *,
+        integration_id: IntegrationID,
+        value: CredentialValue,
+        id: CredentialID | NotGiven = NOT_GIVEN,
+        label: str | NotGiven = NOT_GIVEN,
+        activate: bool | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> CredentialEntry:
+        """Create credential.
+
+        Store an integration credential. It becomes the integration's active credential unless activate is false and the integration already has one. Fails with a conflict when the requested ID already exists.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ConflictError: The server answered 409.
+
+        ``POST /api/credential``
+        """
+        return cast(
+            "CredentialEntry",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/credential",
+                    body={
+                        "id": id,
+                        "integrationID": integration_id,
+                        "label": label,
+                        "value": value,
+                        "activate": activate,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="CredentialEntry",
+                unwrap=True,
+            ),
+        )
+
+    def update(
+        self,
+        credential_id: CredentialID,
+        *,
+        label: str,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Update credential.
+
+        Update a stored credential label.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``PATCH /api/credential/:credentialID``
+        """
+        self._client.request(
+            RequestOptions(
+                method="PATCH",
+                path=f"/api/credential/{encode_path_segment(credential_id)}",
+                body={"label": label},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    def activate(
+        self,
+        credential_id: CredentialID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Activate credential.
+
+        Activate a stored integration credential.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``POST /api/credential/:credentialID/activate``
+        """
+        self._client.request(
+            RequestOptions(
+                method="POST",
+                path=f"/api/credential/{encode_path_segment(credential_id)}/activate",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    def remove(
+        self,
+        credential_id: CredentialID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove credential.
+
+        Remove a stored integration credential.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``DELETE /api/credential/:credentialID``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/credential/{encode_path_segment(credential_id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncCredentialResource(AsyncAPIResource):
+    """Operations under ``client.credential`` (OpenCode ``credential``)."""
+
+    async def list(
+        self,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> builtins.list[CredentialEntry]:
+        """List credentials.
+
+        List every stored integration credential, including its secret value.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``GET /api/credential``
+        """
+        return cast(
+            "builtins.list[CredentialEntry]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/credential",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="builtins.list[CredentialEntry]",
+                unwrap=True,
+            ),
+        )
+
+    async def create(
+        self,
+        *,
+        integration_id: IntegrationID,
+        value: CredentialValue,
+        id: CredentialID | NotGiven = NOT_GIVEN,
+        label: str | NotGiven = NOT_GIVEN,
+        activate: bool | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> CredentialEntry:
+        """Create credential.
+
+        Store an integration credential. It becomes the integration's active credential unless activate is false and the integration already has one. Fails with a conflict when the requested ID already exists.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ConflictError: The server answered 409.
+
+        ``POST /api/credential``
+        """
+        return cast(
+            "CredentialEntry",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/credential",
+                    body={
+                        "id": id,
+                        "integrationID": integration_id,
+                        "label": label,
+                        "value": value,
+                        "activate": activate,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="CredentialEntry",
+                unwrap=True,
+            ),
+        )
+
+    async def update(
+        self,
+        credential_id: CredentialID,
+        *,
+        label: str,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Update credential.
+
+        Update a stored credential label.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``PATCH /api/credential/:credentialID``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="PATCH",
+                path=f"/api/credential/{encode_path_segment(credential_id)}",
+                body={"label": label},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    async def activate(
+        self,
+        credential_id: CredentialID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Activate credential.
+
+        Activate a stored integration credential.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``POST /api/credential/:credentialID/activate``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="POST",
+                path=f"/api/credential/{encode_path_segment(credential_id)}/activate",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    async def remove(
+        self,
+        credential_id: CredentialID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove credential.
+
+        Remove a stored integration credential.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+
+        ``DELETE /api/credential/:credentialID``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/credential/{encode_path_segment(credential_id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )