Made the requested changes

Author: vaibhavatlan

pyatlan/client/aio/oauth_client.py

@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: Apache-2.0
-# Copyright 2025 Atlan Pte. Ltd.
+# Copyright 2026 Atlan Pte. Ltd.
 
 from __future__ import annotations
 
@@ -18,9 +18,9 @@
     RoleGet,
 )
 from pyatlan.errors import ErrorCode
-from pyatlan.model.oauth_clients import (
-    OAuthClient,
+from pyatlan.model.oauth_client import (
     OAuthClientCreateResponse,
+    OAuthClientListResponse,
     OAuthClientResponse,
 )
 
@@ -37,11 +37,11 @@ def __init__(self, client: AsyncApiCaller):
             )
         self._client = client
 
-    async def get_all(self) -> OAuthClientResponse:
+    async def get_all(self) -> OAuthClientListResponse:
         """
         Retrieves all OAuth clients defined in Atlan.
 
-        :returns: an OAuthClientResponse containing all OAuth clients
+        :returns: an OAuthClientListResponse containing all OAuth clients
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGetAll.prepare_request()
@@ -54,27 +54,27 @@ async def get(
         limit: Optional[int] = None,
         offset: int = 0,
         sort: Optional[str] = None,
-    ) -> OAuthClientResponse:
+    ) -> OAuthClientListResponse:
         """
         Retrieves OAuth clients defined in Atlan with pagination support.
 
         :param limit: maximum number of results to be returned
         :param offset: starting point for results to return, for paging
         :param sort: property by which to sort the results (e.g., 'createdAt' for descending)
-        :returns: an OAuthClientResponse containing records and pagination info
+        :returns: an OAuthClientListResponse containing records and pagination info
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGet.prepare_request(limit, offset, sort)
         raw_json = await self._client._call_api(endpoint, query_params)
         return OAuthClientGet.process_response(raw_json)
 
     @validate_arguments
-    async def get_by_id(self, client_id: str) -> OAuthClient:
+    async def get_by_id(self, client_id: str) -> OAuthClientResponse:
         """
         Retrieves the OAuth client with the specified client ID.
 
         :param client_id: unique client identifier (e.g., 'oauth-client-xxx')
-        :returns: the OAuthClient with the specified client ID
+        :returns: the OAuthClientResponse with the specified client ID
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGetById.prepare_request(client_id)
@@ -87,14 +87,14 @@ async def update(
         client_id: str,
         display_name: Optional[str] = None,
         description: Optional[str] = None,
-    ) -> OAuthClient:
+    ) -> OAuthClientResponse:
         """
         Update an existing OAuth client with the provided settings.
 
         :param client_id: unique client identifier (e.g., 'oauth-client-xxx')
         :param display_name: human-readable name for the OAuth client
         :param description: optional explanation of the OAuth client
-        :returns: the updated OAuthClient
+        :returns: the updated OAuthClientResponse
         :raises AtlanError: on any API communication issue
         """
         endpoint, request_obj = OAuthClientUpdate.prepare_request(
@@ -135,17 +135,15 @@ async def create(
         name: str,
         role: str,
         description: Optional[str] = None,
-        persona_qns: Optional[List[str]] = None,
+        persona_qualified_names: Optional[List[str]] = None,
     ) -> OAuthClientCreateResponse:
         """
         Create a new OAuth client with the provided settings.
 
         :param name: human-readable name for the OAuth client (displayed in UI)
-        :param role: role description to assign to the OAuth client (e.g., 'Admin', 'Member',
-                     'Guest', 'Admins (Connections)'). This is matched against available role
-                     descriptions and the corresponding role name is used in the API payload.
+        :param role: role description to assign to the OAuth client (e.g., 'Admin', 'Member').
         :param description: optional explanation of the OAuth client
-        :param persona_qns: qualified names of personas to associate with the OAuth client
+        :param persona_qualified_names: qualified names of personas to associate with the OAuth client
         :returns: the created OAuthClientCreateResponse (includes client_id and client_secret)
         :raises AtlanError: on any API communication issue
         :raises NotFoundError: if the specified role description is not found
@@ -159,7 +157,7 @@ async def create(
             display_name=name,
             role=resolved_role,
             description=description,
-            persona_qns=persona_qns,
+            persona_qualified_names=persona_qualified_names,
         )
         raw_json = await self._client._call_api(endpoint, request_obj=request_obj)
         return OAuthClientCreate.process_response(raw_json)

pyatlan/client/common/oauth_client.py

@@ -1,8 +1,9 @@
 # SPDX-License-Identifier: Apache-2.0
-# Copyright 2025 Atlan Pte. Ltd.
+# Copyright 2026 Atlan Pte. Ltd.
 
 from __future__ import annotations
 
+import json
 from typing import Dict, List, Optional
 
 from pyatlan.client.constants import (
@@ -13,9 +14,9 @@
     UPDATE_OAUTH_CLIENT,
 )
 from pyatlan.errors import ErrorCode
-from pyatlan.model.oauth_clients import (
-    OAuthClient,
+from pyatlan.model.oauth_client import (
     OAuthClientCreateResponse,
+    OAuthClientListResponse,
     OAuthClientRequest,
     OAuthClientResponse,
 )
@@ -35,14 +36,14 @@ def prepare_request() -> tuple:
         return GET_OAUTH_CLIENTS.format_path_with_params(), None
 
     @staticmethod
-    def process_response(raw_json: Dict) -> OAuthClientResponse:
+    def process_response(raw_json: Dict) -> OAuthClientListResponse:
         """
-        Process the API response into an OAuthClientResponse object.
+        Process the API response into an OAuthClientListResponse object.
 
         :param raw_json: raw response from the API
-        :returns: OAuthClientResponse with pagination info and records
+        :returns: OAuthClientListResponse with pagination info and records
         """
-        return OAuthClientResponse(**raw_json)
+        return OAuthClientListResponse(**raw_json)
 
 
 class OAuthClientGet:
@@ -74,14 +75,14 @@ def prepare_request(
         return GET_OAUTH_CLIENTS.format_path_with_params(), query_params
 
     @staticmethod
-    def process_response(raw_json: Dict) -> OAuthClientResponse:
+    def process_response(raw_json: Dict) -> OAuthClientListResponse:
         """
-        Process the API response into an OAuthClientResponse object.
+        Process the API response into an OAuthClientListResponse object.
 
         :param raw_json: raw response from the API
-        :returns: OAuthClientResponse with pagination info and records
+        :returns: OAuthClientListResponse with pagination info and records
         """
-        return OAuthClientResponse(**raw_json)
+        return OAuthClientListResponse(**raw_json)
 
 
 class OAuthClientGetById:
@@ -101,14 +102,14 @@ def prepare_request(client_id: str) -> tuple:
         return endpoint, None
 
     @staticmethod
-    def process_response(raw_json: Dict) -> OAuthClient:
+    def process_response(raw_json: Dict) -> OAuthClientResponse:
         """
-        Process the API response into an OAuthClient object.
+        Process the API response into an OAuthClientResponse object.
 
         :param raw_json: raw response from the API
-        :returns: OAuthClient object
+        :returns: OAuthClientResponse object
         """
-        return OAuthClient(**raw_json)
+        return OAuthClientResponse(**raw_json)
 
 
 class OAuthClientUpdate:
@@ -141,14 +142,14 @@ def prepare_request(
         return endpoint, request_dict
 
     @staticmethod
-    def process_response(raw_json: Dict) -> OAuthClient:
+    def process_response(raw_json: Dict) -> OAuthClientResponse:
         """
-        Process the API response into an OAuthClient.
+        Process the API response into an OAuthClientResponse.
 
         :param raw_json: raw response from the API
-        :returns: the updated OAuthClient
+        :returns: the updated OAuthClientResponse
         """
-        return OAuthClient(**raw_json)
+        return OAuthClientResponse(**raw_json)
 
 
 class OAuthClientPurge:
@@ -212,7 +213,6 @@ def build_roles_filter() -> str:
 
         :returns: JSON filter string
         """
-        import json
 
         return json.dumps({"$or": [{"level": "workspace"}, {"level": "admin-subrole"}]})
 
@@ -221,7 +221,7 @@ def prepare_request(
         display_name: str,
         role: str,
         description: Optional[str] = None,
-        persona_qns: Optional[List[str]] = None,
+        persona_qualified_names: Optional[List[str]] = None,
     ) -> tuple:
         """
         Prepare the request for creating an OAuth client.
@@ -232,15 +232,15 @@ def prepare_request(
         :param display_name: human-readable name for the OAuth client
         :param role: role assigned to the OAuth client (must be the actual API value like '$admin')
         :param description: optional explanation of the OAuth client
-        :param persona_qns: qualified names of personas to associate with the OAuth client
+        :param persona_qualified_names: qualified names of personas to associate with the OAuth client
         :returns: tuple of (endpoint, request_dict)
         """
         request = OAuthClientRequest(
             display_name=display_name,
             description=description,
             role=role,
-            persona_qns=persona_qns,
-        )
+            persona_qualified_names=persona_qualified_names,
+        )  # type: ignore[call-arg]
         return CREATE_OAUTH_CLIENT.format_path_with_params(), request
 
     @staticmethod

pyatlan/client/oauth_client.py

@@ -17,9 +17,9 @@
     RoleGet,
 )
 from pyatlan.errors import ErrorCode
-from pyatlan.model.oauth_clients import (
-    OAuthClient,
+from pyatlan.model.oauth_client import (
     OAuthClientCreateResponse,
+    OAuthClientListResponse,
     OAuthClientResponse,
 )
 
@@ -38,11 +38,11 @@ def __init__(self, client: ApiCaller):
             )
         self._client = client
 
-    def get_all(self) -> OAuthClientResponse:
+    def get_all(self) -> OAuthClientListResponse:
         """
         Retrieves all OAuth clients defined in Atlan.
 
-        :returns: an OAuthClientResponse containing all OAuth clients
+        :returns: an OAuthClientListResponse containing all OAuth clients
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGetAll.prepare_request()
@@ -55,27 +55,27 @@ def get(
         limit: Optional[int] = None,
         offset: int = 0,
         sort: Optional[str] = None,
-    ) -> OAuthClientResponse:
+    ) -> OAuthClientListResponse:
         """
         Retrieves OAuth clients defined in Atlan with pagination support.
 
         :param limit: maximum number of results to be returned
         :param offset: starting point for results to return, for paging
         :param sort: property by which to sort the results (e.g., 'createdAt' for descending)
-        :returns: an OAuthClientResponse containing records and pagination info
+        :returns: an OAuthClientListResponse containing records and pagination info
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGet.prepare_request(limit, offset, sort)
         raw_json = self._client._call_api(endpoint, query_params)
         return OAuthClientGet.process_response(raw_json)
 
     @validate_arguments
-    def get_by_id(self, client_id: str) -> OAuthClient:
+    def get_by_id(self, client_id: str) -> OAuthClientResponse:
         """
         Retrieves the OAuth client with the specified client ID.
 
         :param client_id: unique client identifier (e.g., 'oauth-client-xxx')
-        :returns: the OAuthClient with the specified client ID
+        :returns: the OAuthClientResponse with the specified client ID
         :raises AtlanError: on any API communication issue
         """
         endpoint, query_params = OAuthClientGetById.prepare_request(client_id)
@@ -88,14 +88,14 @@ def update(
         client_id: str,
         display_name: Optional[str] = None,
         description: Optional[str] = None,
-    ) -> OAuthClient:
+    ) -> OAuthClientResponse:
         """
         Update an existing OAuth client with the provided settings.
 
         :param client_id: unique client identifier (e.g., 'oauth-client-xxx')
         :param display_name: human-readable name for the OAuth client
         :param description: optional explanation of the OAuth client
-        :returns: the updated OAuthClient
+        :returns: the updated OAuthClientResponse
         :raises AtlanError: on any API communication issue
         """
         endpoint, request_obj = OAuthClientUpdate.prepare_request(
@@ -136,15 +136,15 @@ def create(
         name: str,
         role: str,
         description: Optional[str] = None,
-        persona_qns: Optional[List[str]] = None,
+        persona_qualified_names: Optional[List[str]] = None,
     ) -> OAuthClientCreateResponse:
         """
         Create a new OAuth client with the provided settings.
 
         :param name: human-readable name for the OAuth client (displayed in UI)
         :param role: role description to assign to the OAuth client (e.g., 'Admin', 'Member').
         :param description: optional explanation of the OAuth client
-        :param persona_qns: qualified names of personas to associate with the OAuth client
+        :param persona_qualified_names: qualified names of personas to associate with the OAuth client
         :returns: the created OAuthClientCreateResponse (includes client_id and client_secret)
         :raises AtlanError: on any API communication issue
         :raises NotFoundError: if the specified role description is not found
@@ -158,7 +158,7 @@ def create(
             display_name=name,
             role=resolved_role,
             description=description,
-            persona_qns=persona_qns,
+            persona_qualified_names=persona_qualified_names,
         )
         raw_json = self._client._call_api(endpoint, request_obj=request_obj)
         return OAuthClientCreate.process_response(raw_json)