agenta 0.36.5__py3-none-any.whl → 0.37.1__py3-none-any.whl

agenta/client/backend/organization/client.py

@@ -0,0 +1,839 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.organization import Organization
+from ..core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..types.organization_details import OrganizationDetails
+from ..core.jsonable_encoder import jsonable_encoder
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.http_validation_error import HttpValidationError
+from ..types.invite_request import InviteRequest
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class OrganizationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list_organizations(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[Organization]:
+        """
+        Returns a list of organizations associated with the user's session.
+
+        Returns:
+            list[Organization]: A list of organizations associated with the user's session.
+
+        Raises:
+            HTTPException: If there is an error retrieving the organizations from the database.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Organization]
+            Successful Response
+
+        Examples
+        --------
+        from agenta import AgentaApi
+
+        client = AgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.organization.list_organizations()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "organizations",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[Organization],
+                    parse_obj_as(
+                        type_=typing.List[Organization],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def fetch_organization_details(
+        self, org_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrganizationDetails:
+        """
+        Return the details of the organization.
+
+        Parameters
+        ----------
+        org_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrganizationDetails
+            Successful Response
+
+        Examples
+        --------
+        from agenta import AgentaApi
+
+        client = AgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.organization.fetch_organization_details(
+            org_id="org_id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    OrganizationDetails,
+                    parse_obj_as(
+                        type_=OrganizationDetails,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def invite_user_to_workspace(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        request: typing.Sequence[InviteRequest],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Assigns a role to a user in an organization.
+
+        Args:
+            org_id (str): The ID of the organization.
+            payload (InviteRequest): The payload containing the organization id, user email, and role to assign.
+            workspace_id (str): The ID of the workspace.
+
+        Returns:
+            bool: True if the role was successfully assigned, False otherwise.
+
+        Raises:
+            HTTPException: If the user does not have permission to perform this action.
+            HTTPException: If there is an error assigning the role to the user.
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        request : typing.Sequence[InviteRequest]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        from agenta import AgentaApi, InviteRequest
+
+        client = AgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.organization.invite_user_to_workspace(
+            org_id="org_id",
+            workspace_id="workspace_id",
+            request=[
+                InviteRequest(
+                    email="email",
+                    roles=["roles"],
+                )
+            ],
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
+            method="POST",
+            json=convert_and_respect_annotation_metadata(
+                object_=request,
+                annotation=typing.Sequence[InviteRequest],
+                direction="write",
+            ),
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def resend_invitation(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        email: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Resend an invitation to a user to an Organization.
+
+        Raises:
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
+
+        Returns:
+            JSONResponse: Resent invitation to user; status_code: 200
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        email : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        from agenta import AgentaApi
+
+        client = AgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.organization.resend_invitation(
+            org_id="org_id",
+            workspace_id="workspace_id",
+            email="email",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/resend",
+            method="POST",
+            json={
+                "email": email,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def accept_invitation(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        project_id: str,
+        token: str,
+        email: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Accept an invitation to an organization.
+
+        Raises:
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
+
+        Returns:
+            JSONResponse: Accepted invitation to workspace; status_code: 200
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        project_id : str
+
+        token : str
+
+        email : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        from agenta import AgentaApi
+
+        client = AgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.organization.accept_invitation(
+            org_id="org_id",
+            workspace_id="workspace_id",
+            project_id="project_id",
+            token="token",
+            email="email",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
+            method="POST",
+            params={
+                "project_id": project_id,
+            },
+            json={
+                "token": token,
+                "email": email,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncOrganizationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list_organizations(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[Organization]:
+        """
+        Returns a list of organizations associated with the user's session.
+
+        Returns:
+            list[Organization]: A list of organizations associated with the user's session.
+
+        Raises:
+            HTTPException: If there is an error retrieving the organizations from the database.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[Organization]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from agenta import AsyncAgentaApi
+
+        client = AsyncAgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.organization.list_organizations()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "organizations",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[Organization],
+                    parse_obj_as(
+                        type_=typing.List[Organization],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def fetch_organization_details(
+        self, org_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> OrganizationDetails:
+        """
+        Return the details of the organization.
+
+        Parameters
+        ----------
+        org_id : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrganizationDetails
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from agenta import AsyncAgentaApi
+
+        client = AsyncAgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.organization.fetch_organization_details(
+                org_id="org_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    OrganizationDetails,
+                    parse_obj_as(
+                        type_=OrganizationDetails,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def invite_user_to_workspace(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        request: typing.Sequence[InviteRequest],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Assigns a role to a user in an organization.
+
+        Args:
+            org_id (str): The ID of the organization.
+            payload (InviteRequest): The payload containing the organization id, user email, and role to assign.
+            workspace_id (str): The ID of the workspace.
+
+        Returns:
+            bool: True if the role was successfully assigned, False otherwise.
+
+        Raises:
+            HTTPException: If the user does not have permission to perform this action.
+            HTTPException: If there is an error assigning the role to the user.
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        request : typing.Sequence[InviteRequest]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from agenta import AsyncAgentaApi, InviteRequest
+
+        client = AsyncAgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.organization.invite_user_to_workspace(
+                org_id="org_id",
+                workspace_id="workspace_id",
+                request=[
+                    InviteRequest(
+                        email="email",
+                        roles=["roles"],
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
+            method="POST",
+            json=convert_and_respect_annotation_metadata(
+                object_=request,
+                annotation=typing.Sequence[InviteRequest],
+                direction="write",
+            ),
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def resend_invitation(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        email: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Resend an invitation to a user to an Organization.
+
+        Raises:
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
+
+        Returns:
+            JSONResponse: Resent invitation to user; status_code: 200
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        email : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from agenta import AsyncAgentaApi
+
+        client = AsyncAgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.organization.resend_invitation(
+                org_id="org_id",
+                workspace_id="workspace_id",
+                email="email",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/resend",
+            method="POST",
+            json={
+                "email": email,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def accept_invitation(
+        self,
+        org_id: str,
+        workspace_id: str,
+        *,
+        project_id: str,
+        token: str,
+        email: str,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Optional[typing.Any]:
+        """
+        Accept an invitation to an organization.
+
+        Raises:
+            HTTPException: _description_; status_code: 500
+            HTTPException: Invitation not found or has expired; status_code: 400
+            HTTPException: You already belong to this organization; status_code: 400
+
+        Returns:
+            JSONResponse: Accepted invitation to workspace; status_code: 200
+
+        Parameters
+        ----------
+        org_id : str
+
+        workspace_id : str
+
+        project_id : str
+
+        token : str
+
+        email : str
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Optional[typing.Any]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from agenta import AsyncAgentaApi
+
+        client = AsyncAgentaApi(
+            api_key="YOUR_API_KEY",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.organization.accept_invitation(
+                org_id="org_id",
+                workspace_id="workspace_id",
+                project_id="project_id",
+                token="token",
+                email="email",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
+            method="POST",
+            params={
+                "project_id": project_id,
+            },
+            json={
+                "token": token,
+                "email": email,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.Optional[typing.Any],
+                    parse_obj_as(
+                        type_=typing.Optional[typing.Any],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    typing.cast(
+                        HttpValidationError,
+                        parse_obj_as(
+                            type_=HttpValidationError,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)