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

opencode/resources/permission.py

@@ -0,0 +1,698 @@
+# This file is generated by `python -m codegen` from spec/contract.json. Do not edit it by hand.
+# OpenCode 2.1.2
+
+"""The ``permission`` resource."""
+
+from __future__ import annotations
+
+import builtins
+from collections.abc import Mapping, Sequence
+from functools import cached_property
+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 (
+    AgentID,
+    Location,
+    PermissionCreateResponse,
+    PermissionID,
+    PermissionReply,
+    PermissionRequest,
+    PermissionRequestListResponse,
+    PermissionSavedID,
+    PermissionSavedInfo,
+    PermissionSource,
+    ProjectID,
+    SessionID,
+)
+
+__all__ = ["PermissionResource", "AsyncPermissionResource"]
+
+
+class PermissionRequestResource(SyncAPIResource):
+    """Operations under ``client.permission.request`` (OpenCode ``permission.request``)."""
+
+    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,
+    ) -> PermissionRequestListResponse:
+        """List pending permission requests.
+
+        Retrieve pending permission requests for a location.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/permission/request``
+        """
+        return cast(
+            "PermissionRequestListResponse",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/permission/request",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionRequestListResponse,
+            ),
+        )
+
+
+class PermissionSavedResource(SyncAPIResource):
+    """Operations under ``client.permission.saved`` (OpenCode ``permission.saved``)."""
+
+    def list(
+        self,
+        *,
+        project_id: ProjectID | 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[PermissionSavedInfo]:
+        """List saved permissions.
+
+        Retrieve saved permissions, optionally filtered by project.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/permission/saved``
+        """
+        return cast(
+            "builtins.list[PermissionSavedInfo]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/permission/saved",
+                    query={"projectID": project_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PermissionSavedInfo],
+                unwrap=True,
+            ),
+        )
+
+    def update(
+        self,
+        id: PermissionSavedID,
+        *,
+        action: str | NotGiven | None = NOT_GIVEN,
+        resource: 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,
+    ) -> PermissionSavedInfo:
+        """Update saved permission.
+
+        Change the action or resource of a saved permission. Fails with a conflict when the project already has a saved permission with the same action and resource.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PermissionSavedNotFoundError
+          LocationNotFoundError
+          ConflictError
+
+        ``PATCH /api/permission/saved/:id``
+        """
+        return cast(
+            "PermissionSavedInfo",
+            self._client.request(
+                RequestOptions(
+                    method="PATCH",
+                    path=f"/api/permission/saved/{encode_path_segment(id)}",
+                    body={"action": action, "resource": resource},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionSavedInfo,
+                unwrap=True,
+            ),
+        )
+
+    def remove(
+        self,
+        id: PermissionSavedID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove saved permission.
+
+        Remove a saved permission by ID.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``DELETE /api/permission/saved/:id``
+        """
+        self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/permission/saved/{encode_path_segment(id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class PermissionResource(SyncAPIResource):
+    """Operations under ``client.permission`` (OpenCode ``permission``)."""
+
+    @cached_property
+    def request_(self) -> PermissionRequestResource:
+        return PermissionRequestResource(self._client)
+
+    @cached_property
+    def saved(self) -> PermissionSavedResource:
+        return PermissionSavedResource(self._client)
+
+    def create(
+        self,
+        session_id: SessionID,
+        *,
+        action: str,
+        resources: Sequence[str],
+        id: PermissionID | NotGiven | None = NOT_GIVEN,
+        save: Sequence[str] | NotGiven = NOT_GIVEN,
+        metadata: Mapping[str, Any] | NotGiven = NOT_GIVEN,
+        source: PermissionSource | NotGiven = NOT_GIVEN,
+        agent: AgentID | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PermissionCreateResponse:
+        """Create permission request.
+
+        Evaluate and, when approval is required, create a permission request for a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          LocationNotFoundError
+
+        ``POST /api/session/:sessionID/permission``
+        """
+        return cast(
+            "PermissionCreateResponse",
+            self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission",
+                    body={
+                        "id": id,
+                        "action": action,
+                        "resources": resources,
+                        "save": save,
+                        "metadata": metadata,
+                        "source": source,
+                        "agent": agent,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionCreateResponse,
+                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[PermissionRequest]:
+        """List session permission requests.
+
+        Retrieve pending permission requests owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/session/:sessionID/permission``
+        """
+        return cast(
+            "builtins.list[PermissionRequest]",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PermissionRequest],
+                unwrap=True,
+            ),
+        )
+
+    def get(
+        self,
+        session_id: SessionID,
+        request_id: PermissionID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PermissionRequest:
+        """Get permission request.
+
+        Retrieve a pending permission request owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          PermissionNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/session/:sessionID/permission/:requestID``
+        """
+        return cast(
+            "PermissionRequest",
+            self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission/{encode_path_segment(request_id)}",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionRequest,
+                unwrap=True,
+            ),
+        )
+
+    def reply(
+        self,
+        session_id: SessionID,
+        request_id: PermissionID,
+        *,
+        decision: PermissionReply,
+        message: 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,
+    ) -> None:
+        """Reply to pending permission request.
+
+        Respond to a pending permission request owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          PermissionNotFoundError
+          LocationNotFoundError
+
+        ``POST /api/session/:sessionID/permission/:requestID/reply``
+        """
+        self._client.request(
+            RequestOptions(
+                method="POST",
+                path=f"/api/session/{encode_path_segment(session_id)}/permission/{encode_path_segment(request_id)}/reply",
+                body={"decision": decision, "message": message},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncPermissionRequestResource(AsyncAPIResource):
+    """Operations under ``client.permission.request`` (OpenCode ``permission.request``)."""
+
+    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,
+    ) -> PermissionRequestListResponse:
+        """List pending permission requests.
+
+        Retrieve pending permission requests for a location.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/permission/request``
+        """
+        return cast(
+            "PermissionRequestListResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/permission/request",
+                    query={"location": self._location(location)},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionRequestListResponse,
+            ),
+        )
+
+
+class AsyncPermissionSavedResource(AsyncAPIResource):
+    """Operations under ``client.permission.saved`` (OpenCode ``permission.saved``)."""
+
+    async def list(
+        self,
+        *,
+        project_id: ProjectID | 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[PermissionSavedInfo]:
+        """List saved permissions.
+
+        Retrieve saved permissions, optionally filtered by project.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``GET /api/permission/saved``
+        """
+        return cast(
+            "builtins.list[PermissionSavedInfo]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path="/api/permission/saved",
+                    query={"projectID": project_id},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PermissionSavedInfo],
+                unwrap=True,
+            ),
+        )
+
+    async def update(
+        self,
+        id: PermissionSavedID,
+        *,
+        action: str | NotGiven | None = NOT_GIVEN,
+        resource: 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,
+    ) -> PermissionSavedInfo:
+        """Update saved permission.
+
+        Change the action or resource of a saved permission. Fails with a conflict when the project already has a saved permission with the same action and resource.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          PermissionSavedNotFoundError
+          LocationNotFoundError
+          ConflictError
+
+        ``PATCH /api/permission/saved/:id``
+        """
+        return cast(
+            "PermissionSavedInfo",
+            await self._client.request(
+                RequestOptions(
+                    method="PATCH",
+                    path=f"/api/permission/saved/{encode_path_segment(id)}",
+                    body={"action": action, "resource": resource},
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionSavedInfo,
+                unwrap=True,
+            ),
+        )
+
+    async def remove(
+        self,
+        id: PermissionSavedID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> None:
+        """Remove saved permission.
+
+        Remove a saved permission by ID.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          LocationNotFoundError
+
+        ``DELETE /api/permission/saved/:id``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="DELETE",
+                path=f"/api/permission/saved/{encode_path_segment(id)}",
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )
+
+
+class AsyncPermissionResource(AsyncAPIResource):
+    """Operations under ``client.permission`` (OpenCode ``permission``)."""
+
+    @cached_property
+    def request_(self) -> AsyncPermissionRequestResource:
+        return AsyncPermissionRequestResource(self._client)
+
+    @cached_property
+    def saved(self) -> AsyncPermissionSavedResource:
+        return AsyncPermissionSavedResource(self._client)
+
+    async def create(
+        self,
+        session_id: SessionID,
+        *,
+        action: str,
+        resources: Sequence[str],
+        id: PermissionID | NotGiven | None = NOT_GIVEN,
+        save: Sequence[str] | NotGiven = NOT_GIVEN,
+        metadata: Mapping[str, Any] | NotGiven = NOT_GIVEN,
+        source: PermissionSource | NotGiven = NOT_GIVEN,
+        agent: AgentID | NotGiven | None = NOT_GIVEN,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PermissionCreateResponse:
+        """Create permission request.
+
+        Evaluate and, when approval is required, create a permission request for a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          LocationNotFoundError
+
+        ``POST /api/session/:sessionID/permission``
+        """
+        return cast(
+            "PermissionCreateResponse",
+            await self._client.request(
+                RequestOptions(
+                    method="POST",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission",
+                    body={
+                        "id": id,
+                        "action": action,
+                        "resources": resources,
+                        "save": save,
+                        "metadata": metadata,
+                        "source": source,
+                        "agent": agent,
+                    },
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionCreateResponse,
+                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[PermissionRequest]:
+        """List session permission requests.
+
+        Retrieve pending permission requests owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/session/:sessionID/permission``
+        """
+        return cast(
+            "builtins.list[PermissionRequest]",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=builtins.list[PermissionRequest],
+                unwrap=True,
+            ),
+        )
+
+    async def get(
+        self,
+        session_id: SessionID,
+        request_id: PermissionID,
+        *,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: Timeout | NotGiven = NOT_GIVEN,
+    ) -> PermissionRequest:
+        """Get permission request.
+
+        Retrieve a pending permission request owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          PermissionNotFoundError
+          LocationNotFoundError
+
+        ``GET /api/session/:sessionID/permission/:requestID``
+        """
+        return cast(
+            "PermissionRequest",
+            await self._client.request(
+                RequestOptions(
+                    method="GET",
+                    path=f"/api/session/{encode_path_segment(session_id)}/permission/{encode_path_segment(request_id)}",
+                    extra_headers=extra_headers,
+                    extra_query=extra_query,
+                    extra_body=extra_body,
+                    timeout=timeout,
+                ),
+                response_type=PermissionRequest,
+                unwrap=True,
+            ),
+        )
+
+    async def reply(
+        self,
+        session_id: SessionID,
+        request_id: PermissionID,
+        *,
+        decision: PermissionReply,
+        message: 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,
+    ) -> None:
+        """Reply to pending permission request.
+
+        Respond to a pending permission request owned by a session.
+
+        Raises:
+          InvalidRequestError
+          UnauthorizedError
+          SessionNotFoundError
+          PermissionNotFoundError
+          LocationNotFoundError
+
+        ``POST /api/session/:sessionID/permission/:requestID/reply``
+        """
+        await self._client.request(
+            RequestOptions(
+                method="POST",
+                path=f"/api/session/{encode_path_segment(session_id)}/permission/{encode_path_segment(request_id)}/reply",
+                body={"decision": decision, "message": message},
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+            ),
+            kind="void",
+        )