agenta 0.52.6__py3-none-any.whl → 0.63.2__py3-none-any.whl

agenta/client/client.py

@@ -99,13 +99,17 @@ class AgentaApi:
         self._client_wrapper = SyncClientWrapper(
             base_url=base_url,
             api_key=api_key,
-            httpx_client=httpx_client
-            if httpx_client is not None
-            else httpx.Client(
-                timeout=_defaulted_timeout, follow_redirects=follow_redirects
-            )
-            if follow_redirects is not None
-            else httpx.Client(timeout=_defaulted_timeout),
+            httpx_client=(
+                httpx_client
+                if httpx_client is not None
+                else (
+                    httpx.Client(
+                        timeout=_defaulted_timeout, follow_redirects=follow_redirects
+                    )
+                    if follow_redirects is not None
+                    else httpx.Client(timeout=_defaulted_timeout)
+                )
+            ),
             timeout=_defaulted_timeout,
         )
         self.admin = AdminClient(client_wrapper=self._client_wrapper)
@@ -542,7 +546,10 @@ class AgentaApi:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def fetch_organization_details(
-        self, org_id: str, *, request_options: typing.Optional[RequestOptions] = None
+        self,
+        organization_id: str,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
         Get an organization's details.
@@ -556,7 +563,7 @@ class AgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -575,11 +582,11 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.fetch_organization_details(
-            org_id="org_id",
+            organization_id="organization_id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}",
             method="GET",
             request_options=request_options,
         )
@@ -609,7 +616,7 @@ class AgentaApi:
 
     def update_organization(
         self,
-        org_id: str,
+        organization_id: str,
         *,
         name: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
@@ -619,7 +626,7 @@ class AgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         name : typing.Optional[str]
 
@@ -644,11 +651,11 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.update_organization(
-            org_id="org_id",
+            organization_id="organization_id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}",
             method="PUT",
             json={
                 "name": name,
@@ -687,7 +694,7 @@ class AgentaApi:
 
     def invite_user_to_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         request: typing.Sequence[InviteRequest],
@@ -696,7 +703,7 @@ class AgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -719,7 +726,7 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.invite_user_to_workspace(
-            org_id="org_id",
+            organization_id="organization_id",
             workspace_id="workspace_id",
             request=[
                 InviteRequest(
@@ -730,7 +737,7 @@ class AgentaApi:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
             method="POST",
             json=convert_and_respect_annotation_metadata(
                 object_=request,
@@ -766,7 +773,7 @@ class AgentaApi:
 
     def resend_invitation(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         email: str,
@@ -785,7 +792,7 @@ class AgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -808,13 +815,13 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.resend_invitation(
-            org_id="org_id",
+            organization_id="organization_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",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/resend",
             method="POST",
             json={
                 "email": email,
@@ -851,7 +858,7 @@ class AgentaApi:
 
     def accept_invitation(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         project_id: str,
@@ -871,7 +878,7 @@ class AgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -896,14 +903,14 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.accept_invitation(
-            org_id="org_id",
+            organization_id="organization_id",
             workspace_id="workspace_id",
             project_id="project_id",
             token="token",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
             method="POST",
             params={
                 "project_id": project_id,
@@ -943,7 +950,7 @@ class AgentaApi:
 
     def create_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         *,
         name: str,
         description: typing.Optional[str] = OMIT,
@@ -953,7 +960,7 @@ class AgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         name : str
 
@@ -978,12 +985,12 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.create_workspace(
-            org_id="org_id",
+            organization_id="organization_id",
             name="name",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces",
             method="POST",
             json={
                 "name": name,
@@ -1022,7 +1029,7 @@ class AgentaApi:
 
     def update_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         name: typing.Optional[str] = OMIT,
@@ -1033,7 +1040,7 @@ class AgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -1060,12 +1067,12 @@ class AgentaApi:
             base_url="https://yourhost.com/path/to/api",
         )
         client.update_workspace(
-            org_id="org_id",
+            organization_id="organization_id",
             workspace_id="workspace_id",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}",
             method="PUT",
             json={
                 "name": name,
@@ -1307,7 +1314,7 @@ class AgentaApi:
         workspace_id: str,
         *,
         email: str,
-        org_id: str,
+        organization_id: str,
         role: str,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
@@ -1317,7 +1324,7 @@ class AgentaApi:
         Args:
             workspace_id (str): The ID of the workspace.
             email (str): The email of the user to remove the role from.
-            org_id (str): The ID of the organization.
+            organization_id (str): The ID of the organization.
             role (str): The role to remove from the user.
             request (Request): The FastAPI request object.
 
@@ -1334,7 +1341,7 @@ class AgentaApi:
 
         email : str
 
-        org_id : str
+        organization_id : str
 
         role : str
 
@@ -1357,7 +1364,7 @@ class AgentaApi:
         client.unassign_role_from_user(
             workspace_id="workspace_id",
             email="email",
-            org_id="org_id",
+            organization_id="organization_id",
             role="role",
         )
         """
@@ -1366,7 +1373,7 @@ class AgentaApi:
             method="DELETE",
             params={
                 "email": email,
-                "org_id": org_id,
+                "organization_id": organization_id,
                 "role": role,
             },
             request_options=request_options,
@@ -1399,7 +1406,7 @@ class AgentaApi:
         self,
         workspace_id: str,
         *,
-        org_id: str,
+        organization_id: str,
         email: str,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkspaceResponse:
@@ -1422,7 +1429,7 @@ class AgentaApi:
         ----------
         workspace_id : str
 
-        org_id : str
+        organization_id : str
 
         email : str
 
@@ -1444,7 +1451,7 @@ class AgentaApi:
         )
         client.remove_user_from_workspace(
             workspace_id="workspace_id",
-            org_id="org_id",
+            organization_id="organization_id",
             email="email",
         )
         """
@@ -1452,7 +1459,7 @@ class AgentaApi:
             f"workspaces/{jsonable_encoder(workspace_id)}/users",
             method="DELETE",
             params={
-                "org_id": org_id,
+                "organization_id": organization_id,
                 "email": email,
             },
             request_options=request_options,
@@ -1630,13 +1637,17 @@ class AsyncAgentaApi:
         self._client_wrapper = AsyncClientWrapper(
             base_url=base_url,
             api_key=api_key,
-            httpx_client=httpx_client
-            if httpx_client is not None
-            else httpx.AsyncClient(
-                timeout=_defaulted_timeout, follow_redirects=follow_redirects
-            )
-            if follow_redirects is not None
-            else httpx.AsyncClient(timeout=_defaulted_timeout),
+            httpx_client=(
+                httpx_client
+                if httpx_client is not None
+                else (
+                    httpx.AsyncClient(
+                        timeout=_defaulted_timeout, follow_redirects=follow_redirects
+                    )
+                    if follow_redirects is not None
+                    else httpx.AsyncClient(timeout=_defaulted_timeout)
+                )
+            ),
             timeout=_defaulted_timeout,
         )
         self.admin = AsyncAdminClient(client_wrapper=self._client_wrapper)
@@ -2133,7 +2144,10 @@ class AsyncAgentaApi:
         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
+        self,
+        organization_id: str,
+        *,
+        request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
         """
         Get an organization's details.
@@ -2147,7 +2161,7 @@ class AsyncAgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -2171,14 +2185,14 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.fetch_organization_details(
-                org_id="org_id",
+                organization_id="organization_id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}",
             method="GET",
             request_options=request_options,
         )
@@ -2208,7 +2222,7 @@ class AsyncAgentaApi:
 
     async def update_organization(
         self,
-        org_id: str,
+        organization_id: str,
         *,
         name: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
@@ -2218,7 +2232,7 @@ class AsyncAgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         name : typing.Optional[str]
 
@@ -2248,14 +2262,14 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.update_organization(
-                org_id="org_id",
+                organization_id="organization_id",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}",
             method="PUT",
             json={
                 "name": name,
@@ -2294,7 +2308,7 @@ class AsyncAgentaApi:
 
     async def invite_user_to_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         request: typing.Sequence[InviteRequest],
@@ -2303,7 +2317,7 @@ class AsyncAgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -2331,7 +2345,7 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.invite_user_to_workspace(
-                org_id="org_id",
+                organization_id="organization_id",
                 workspace_id="workspace_id",
                 request=[
                     InviteRequest(
@@ -2345,7 +2359,7 @@ class AsyncAgentaApi:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite",
             method="POST",
             json=convert_and_respect_annotation_metadata(
                 object_=request,
@@ -2381,7 +2395,7 @@ class AsyncAgentaApi:
 
     async def resend_invitation(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         email: str,
@@ -2400,7 +2414,7 @@ class AsyncAgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -2428,7 +2442,7 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.resend_invitation(
-                org_id="org_id",
+                organization_id="organization_id",
                 workspace_id="workspace_id",
                 email="email",
             )
@@ -2437,7 +2451,7 @@ class AsyncAgentaApi:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/resend",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/resend",
             method="POST",
             json={
                 "email": email,
@@ -2474,7 +2488,7 @@ class AsyncAgentaApi:
 
     async def accept_invitation(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         project_id: str,
@@ -2494,7 +2508,7 @@ class AsyncAgentaApi:
 
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -2524,7 +2538,7 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.accept_invitation(
-                org_id="org_id",
+                organization_id="organization_id",
                 workspace_id="workspace_id",
                 project_id="project_id",
                 token="token",
@@ -2534,7 +2548,7 @@ class AsyncAgentaApi:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}/invite/accept",
             method="POST",
             params={
                 "project_id": project_id,
@@ -2574,7 +2588,7 @@ class AsyncAgentaApi:
 
     async def create_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         *,
         name: str,
         description: typing.Optional[str] = OMIT,
@@ -2584,7 +2598,7 @@ class AsyncAgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         name : str
 
@@ -2614,7 +2628,7 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.create_workspace(
-                org_id="org_id",
+                organization_id="organization_id",
                 name="name",
             )
 
@@ -2622,7 +2636,7 @@ class AsyncAgentaApi:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces",
             method="POST",
             json={
                 "name": name,
@@ -2661,7 +2675,7 @@ class AsyncAgentaApi:
 
     async def update_workspace(
         self,
-        org_id: str,
+        organization_id: str,
         workspace_id: str,
         *,
         name: typing.Optional[str] = OMIT,
@@ -2672,7 +2686,7 @@ class AsyncAgentaApi:
         """
         Parameters
         ----------
-        org_id : str
+        organization_id : str
 
         workspace_id : str
 
@@ -2704,7 +2718,7 @@ class AsyncAgentaApi:
 
         async def main() -> None:
             await client.update_workspace(
-                org_id="org_id",
+                organization_id="organization_id",
                 workspace_id="workspace_id",
             )
 
@@ -2712,7 +2726,7 @@ class AsyncAgentaApi:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"organizations/{jsonable_encoder(org_id)}/workspaces/{jsonable_encoder(workspace_id)}",
+            f"organizations/{jsonable_encoder(organization_id)}/workspaces/{jsonable_encoder(workspace_id)}",
             method="PUT",
             json={
                 "name": name,
@@ -2978,7 +2992,7 @@ class AsyncAgentaApi:
         workspace_id: str,
         *,
         email: str,
-        org_id: str,
+        organization_id: str,
         role: str,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Optional[typing.Any]:
@@ -2988,7 +3002,7 @@ class AsyncAgentaApi:
         Args:
             workspace_id (str): The ID of the workspace.
             email (str): The email of the user to remove the role from.
-            org_id (str): The ID of the organization.
+            organization_id (str): The ID of the organization.
             role (str): The role to remove from the user.
             request (Request): The FastAPI request object.
 
@@ -3005,7 +3019,7 @@ class AsyncAgentaApi:
 
         email : str
 
-        org_id : str
+        organization_id : str
 
         role : str
 
@@ -3033,7 +3047,7 @@ class AsyncAgentaApi:
             await client.unassign_role_from_user(
                 workspace_id="workspace_id",
                 email="email",
-                org_id="org_id",
+                organization_id="organization_id",
                 role="role",
             )
 
@@ -3045,7 +3059,7 @@ class AsyncAgentaApi:
             method="DELETE",
             params={
                 "email": email,
-                "org_id": org_id,
+                "organization_id": organization_id,
                 "role": role,
             },
             request_options=request_options,
@@ -3078,7 +3092,7 @@ class AsyncAgentaApi:
         self,
         workspace_id: str,
         *,
-        org_id: str,
+        organization_id: str,
         email: str,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> WorkspaceResponse:
@@ -3101,7 +3115,7 @@ class AsyncAgentaApi:
         ----------
         workspace_id : str
 
-        org_id : str
+        organization_id : str
 
         email : str
 
@@ -3128,7 +3142,7 @@ class AsyncAgentaApi:
         async def main() -> None:
             await client.remove_user_from_workspace(
                 workspace_id="workspace_id",
-                org_id="org_id",
+                organization_id="organization_id",
                 email="email",
             )
 
@@ -3139,7 +3153,7 @@ class AsyncAgentaApi:
             f"workspaces/{jsonable_encoder(workspace_id)}/users",
             method="DELETE",
             params={
-                "org_id": org_id,
+                "organization_id": organization_id,
                 "email": email,
             },
             request_options=request_options,