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

opencode/resources/websearch.py

@@ -0,0 +1,184 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``websearch`` 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,
+        WebSearchID,
+        WebsearchProvidersResponse,
+        WebsearchQueryResponse,
+    )
+
+__all__ = ["WebsearchResource", "AsyncWebsearchResource"]
+
+
+class WebsearchResource(SyncAPIResource):
+    """Operations under ``client.websearch`` (OpenCode ``websearch``)."""
+
+    def providers(
+        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,
+    ) -> WebsearchProvidersResponse:
+        """List web search providers.
+
+        Return the registered web search providers.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``GET /api/websearch/provider``
+        """
+        return cast(
+            "WebsearchProvidersResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/websearch/provider",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WebsearchProvidersResponse",
+            ),
+        )
+
+    def query(
+        self,
+        *,
+        query: str,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        provider_id: WebSearchID | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WebsearchQueryResponse:
+        """Search the web.
+
+        Run one web search through the selected provider. Specify a provider to override the configured default.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``POST /api/websearch``
+        """
+        return cast(
+            "WebsearchQueryResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/websearch",
+                    query={"location": self._location(location)},
+                    body={"query": query, "providerID": provider_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WebsearchQueryResponse",
+            ),
+        )
+
+
+class AsyncWebsearchResource(AsyncAPIResource):
+    """Operations under ``client.websearch`` (OpenCode ``websearch``)."""
+
+    async def providers(
+        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,
+    ) -> WebsearchProvidersResponse:
+        """List web search providers.
+
+        Return the registered web search providers.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``GET /api/websearch/provider``
+        """
+        return cast(
+            "WebsearchProvidersResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/websearch/provider",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WebsearchProvidersResponse",
+            ),
+        )
+
+    async def query(
+        self,
+        *,
+        query: str,
+        location: Location | NotGiven | None = NOT_GIVEN,
+        provider_id: WebSearchID | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WebsearchQueryResponse:
+        """Search the web.
+
+        Run one web search through the selected provider. Specify a provider to override the configured default.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          LocationNotFoundError: The server answered 404.
+          ServiceUnavailableError: The server answered 503.
+
+        ``POST /api/websearch``
+        """
+        return cast(
+            "WebsearchQueryResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/websearch",
+                    query={"location": self._location(location)},
+                    body={"query": query, "providerID": provider_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WebsearchQueryResponse",
+            ),
+        )

opencode/resources/worktree.py

@@ -0,0 +1,336 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``worktree`` 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 (
+        AbsolutePath,
+        ProjectID,
+        WorktreeInfo,
+        WorktreeList,
+    )
+
+__all__ = ["WorktreeResource", "AsyncWorktreeResource"]
+
+
+class WorktreeResource(SyncAPIResource):
+    """Operations under ``client.worktree`` (OpenCode ``worktree``)."""
+
+    def list(
+        self,
+        *,
+        project_id: ProjectID,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WorktreeList:
+        """List worktrees.
+
+        Return the project's saved worktree inventory without loading configuration or running discovery.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``GET /api/worktree``
+        """
+        return cast(
+            "WorktreeList",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/worktree",
+                    query={"projectID": project_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WorktreeList",
+            ),
+        )
+
+    def create(
+        self,
+        *,
+        project_id: ProjectID,
+        from_: AbsolutePath | NotGiven = NOT_GIVEN,
+        branch: str | NotGiven = NOT_GIVEN,
+        directory: AbsolutePath | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WorktreeInfo:
+        """Create worktree.
+
+        Load the project's canonical configuration, create a local worktree using its selected strategy, then run the project's setup script.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``POST /api/worktree``
+        """
+        return cast(
+            "WorktreeInfo",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/worktree",
+                    body={
+                        "projectID": project_id,
+                        "from": from_,
+                        "branch": branch,
+                        "directory": directory,
+                        "name": name,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WorktreeInfo",
+            ),
+        )
+
+    def remove(
+        self,
+        *,
+        project_id: ProjectID,
+        directory: AbsolutePath,
+        force: bool,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove worktree.
+
+        Load the project's canonical configuration and remove a saved worktree using its recorded strategy.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``DELETE /api/worktree``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path="/api/worktree",
+                body={"projectID": project_id, "directory": directory, "force": force},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    def refresh(
+        self,
+        *,
+        project_id: ProjectID,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Refresh worktrees.
+
+        Load the project's canonical configuration, discover worktrees across known checkout roots using all available strategies, and reconcile saved state.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``POST /api/worktree/refresh``
+        """
+        self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/worktree/refresh",
+                body={"projectID": project_id},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncWorktreeResource(AsyncAPIResource):
+    """Operations under ``client.worktree`` (OpenCode ``worktree``)."""
+
+    async def list(
+        self,
+        *,
+        project_id: ProjectID,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WorktreeList:
+        """List worktrees.
+
+        Return the project's saved worktree inventory without loading configuration or running discovery.
+
+        Raises:
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``GET /api/worktree``
+        """
+        return cast(
+            "WorktreeList",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/worktree",
+                    query={"projectID": project_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WorktreeList",
+            ),
+        )
+
+    async def create(
+        self,
+        *,
+        project_id: ProjectID,
+        from_: AbsolutePath | NotGiven = NOT_GIVEN,
+        branch: str | NotGiven = NOT_GIVEN,
+        directory: AbsolutePath | NotGiven = NOT_GIVEN,
+        name: str | NotGiven = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> WorktreeInfo:
+        """Create worktree.
+
+        Load the project's canonical configuration, create a local worktree using its selected strategy, then run the project's setup script.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``POST /api/worktree``
+        """
+        return cast(
+            "WorktreeInfo",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path="/api/worktree",
+                    body={
+                        "projectID": project_id,
+                        "from": from_,
+                        "branch": branch,
+                        "directory": directory,
+                        "name": name,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type="WorktreeInfo",
+            ),
+        )
+
+    async def remove(
+        self,
+        *,
+        project_id: ProjectID,
+        directory: AbsolutePath,
+        force: bool,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove worktree.
+
+        Load the project's canonical configuration and remove a saved worktree using its recorded strategy.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``DELETE /api/worktree``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path="/api/worktree",
+                body={"projectID": project_id, "directory": directory, "force": force},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+    async def refresh(
+        self,
+        *,
+        project_id: ProjectID,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Refresh worktrees.
+
+        Load the project's canonical configuration, discover worktrees across known checkout roots using all available strategies, and reconcile saved state.
+
+        Raises:
+          WorktreeError: The server answered 400.
+          InvalidRequestError: The server answered 400.
+          UnauthorizedError: The server answered 401.
+          ProjectNotFoundError: The server answered 404.
+
+        ``POST /api/worktree/refresh``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="POST",
+                path="/api/worktree/refresh",
+                body={"projectID": project_id},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )