anaplan-sdk 0.5.0a3__tar.gz → 0.5.0a4__tar.gz

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a3
+Version: 0.5.0a4
 Summary: Streamlined Python Interface for the Anaplan API.
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_async_clients/_alm.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Literal, overload
 
-from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._services import _AsyncHttpService, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError
 from anaplan_sdk.models import (
     ModelRevision,
@@ -29,13 +29,21 @@ class _AsyncAlmClient:
         logger.info(f"Changed model status to '{status}' for model {self._model_id}.")
         await self._http.put(f"{self._url}/onlineStatus", json={"status": status})
 
-    async def get_revisions(self) -> list[Revision]:
+    async def get_revisions(
+        self,
+        sort_by: Literal["id", "name", "applied_on", "created_on"] | None = None,
+        descending: bool = False,
+    ) -> list[Revision]:
         """
         Use this call to return a list of revisions for a specific model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: A list of revisions for a specific model.
         """
-        res = await self._http.get(f"{self._url}/alm/revisions")
-        return [Revision.model_validate(e) for e in res.get("revisions", [])]
+        res = await self._http.get_paginated(
+            f"{self._url}/alm/revisions", "revisions", params=sort_params(sort_by, descending)
+        )
+        return [Revision.model_validate(e) for e in res]
 
     async def get_latest_revision(self) -> Revision | None:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_async_clients/_audit.py

@@ -1,9 +1,10 @@
 from typing import Any, Literal
 
-from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._services import _AsyncHttpService, sort_params
 from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
+UserSortBy = Literal["first_name", "last_name", "email", "active", "last_login_date"] | None
 
 
 class _AsyncAuditClient:
@@ -12,22 +13,29 @@ class _AsyncAuditClient:
         self._limit = 10_000
         self._url = "https://audit.anaplan.com/audit/api/1/events"
 
-    async def get_users(self, search_pattern: str | None = None) -> list[User]:
+    async def get_users(
+        self,
+        search_pattern: str | None = None,
+        sort_by: UserSortBy = None,
+        descending: bool = False,
+    ) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
         :param search_pattern: Optionally filter for specific users. When provided,
                case-insensitive matches users with emails or names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all users.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Users.
         """
-        params = {"s": search_pattern} if search_pattern else None
-        return [
-            User.model_validate(e)
-            for e in await self._http.get_paginated(
-                "https://api.anaplan.com/2/0/users", "users", params=params
-            )
-        ]
+        params = sort_params(sort_by, descending)
+        if search_pattern:
+            params["s"] = search_pattern
+        res = await self._http.get_paginated(
+            "https://api.anaplan.com/2/0/users", "users", params=params
+        )
+        return [User.model_validate(e) for e in res]
 
     async def get_user(self, user_id: str = "me") -> User:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_async_clients/_bulk.py

@@ -27,6 +27,8 @@ from ._audit import _AsyncAuditClient
 from ._cloud_works import _AsyncCloudWorksClient
 from ._transactional import _AsyncTransactionalClient
 
+SortBy = Literal["id", "name"] | None
+
 logger = logging.getLogger("anaplan_sdk")
 
 
@@ -228,7 +230,7 @@ class AsyncClient:
     async def get_workspaces(
         self,
         search_pattern: str | None = None,
-        sort_by: Literal["size_allowance", "name"] = "name",
+        sort_by: Literal["size_allowance", "name"] | None = None,
         descending: bool = False,
     ) -> list[Workspace]:
         """
@@ -244,17 +246,15 @@ class AsyncClient:
         params = {"tenantDetails": "true"} | sort_params(sort_by, descending)
         if search_pattern:
             params["s"] = search_pattern
-        return [
-            Workspace.model_validate(e)
-            for e in await self._http.get_paginated(
-                "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
-            )
-        ]
+        res = await self._http.get_paginated(
+            "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
+        )
+        return [Workspace.model_validate(e) for e in res]
 
     async def get_models(
         self,
         search_pattern: str | None = None,
-        sort_by: Literal["active_state", "name"] = "name",
+        sort_by: Literal["active_state", "name"] | None = None,
         descending: bool = False,
     ) -> list[Model]:
         """
@@ -270,12 +270,10 @@ class AsyncClient:
         params = {"modelDetails": "true"} | sort_params(sort_by, descending)
         if search_pattern:
             params["s"] = search_pattern
-        return [
-            Model.model_validate(e)
-            for e in await self._http.get_paginated(
-                "https://api.anaplan.com/2/0/models", "models", params=params
-            )
-        ]
+        res = await self._http.get_paginated(
+            "https://api.anaplan.com/2/0/models", "models", params=params
+        )
+        return [Model.model_validate(e) for e in res]
 
     async def delete_models(self, model_ids: list[str]) -> ModelDeletionResult:
         """
@@ -291,9 +289,7 @@ class AsyncClient:
         )
         return ModelDeletionResult.model_validate(res)
 
-    async def get_files(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[File]:
+    async def get_files(self, sort_by: SortBy = None, descending: bool = False) -> list[File]:
         """
         Lists all the Files in the Model.
         :param sort_by: The field to sort the results by.
@@ -305,9 +301,7 @@ class AsyncClient:
         )
         return [File.model_validate(e) for e in res]
 
-    async def get_actions(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[Action]:
+    async def get_actions(self, sort_by: SortBy = None, descending: bool = False) -> list[Action]:
         """
         Lists all the Actions in the Model. This will only return the Actions listed under
         `Other Actions` in Anaplan. For Imports, exports, and processes, see their respective
@@ -322,7 +316,7 @@ class AsyncClient:
         return [Action.model_validate(e) for e in res]
 
     async def get_processes(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
+        self, sort_by: SortBy = None, descending: bool = False
     ) -> list[Process]:
         """
         Lists all the Processes in the Model.
@@ -335,9 +329,7 @@ class AsyncClient:
         )
         return [Process.model_validate(e) for e in res]
 
-    async def get_imports(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[Import]:
+    async def get_imports(self, sort_by: SortBy = None, descending: bool = False) -> list[Import]:
         """
         Lists all the Imports in the Model.
         :param sort_by: The field to sort the results by.
@@ -349,9 +341,7 @@ class AsyncClient:
         )
         return [Import.model_validate(e) for e in res]
 
-    async def get_exports(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[Export]:
+    async def get_exports(self, sort_by: SortBy = None, descending: bool = False) -> list[Export]:
         """
         Lists all the Exports in the Model.
         :param sort_by: The field to sort the results by.

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_async_clients/_cloud_works.py

@@ -99,14 +99,15 @@ class _AsyncCloudWorksClient:
         logger.info(f"Deleted connection '{con_id}'.")
 
     async def get_integrations(
-        self, sort_by_name: Literal["ascending", "descending"] = "ascending"
+        self, sort_by: Literal["name"] | None = None, descending: bool = False
     ) -> list[Integration]:
         """
         List all integrations in CloudWorks.
-        :param sort_by_name: Sort the integrations by name in ascending or descending order.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: A list of integrations.
         """
-        params = {"sortBy": "name" if sort_by_name == "ascending" else "-name"}
+        params = {"sortBy": f"{'-' if descending else ''}{sort_by}"} if sort_by else None
         return [
             Integration.model_validate(e)
             for e in await self._http.get_paginated(f"{self._url}", "integrations", params=params)

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_async_clients/_transactional.py

@@ -30,6 +30,8 @@ from anaplan_sdk.models import (
     ViewInfo,
 )
 
+SortBy = Literal["id", "name"] | None
+
 logger = logging.getLogger("anaplan_sdk")
 
 
@@ -69,9 +71,7 @@ class _AsyncTransactionalClient:
         )
         logger.info(f"Closed model '{self._model_id}'.")
 
-    async def get_modules(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[Module]:
+    async def get_modules(self, sort_by: SortBy = None, descending: bool = False) -> list[Module]:
         """
         Lists all the Modules in the Model.
         :param sort_by: The field to sort the results by.
@@ -84,7 +84,7 @@ class _AsyncTransactionalClient:
         return [Module.model_validate(e) for e in res]
 
     async def get_views(
-        self, sort_by: Literal["id", "module_id", "name"] = "id", descending: bool = False
+        self, sort_by: Literal["id", "module_id", "name"] | None = None, descending: bool = False
     ) -> list[View]:
         """
         Lists all the Views in the Model. This will include all Modules and potentially other saved
@@ -120,9 +120,7 @@ class _AsyncTransactionalClient:
         )
         return [LineItem.model_validate(e) for e in res.get("items", [])]
 
-    async def get_lists(
-        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
-    ) -> list[List]:
+    async def get_lists(self, sort_by: SortBy = None, descending: bool = False) -> list[List]:
         """
         Lists all the Lists in the Model.
         :param sort_by: The field to sort the results by.

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_clients/_alm.py

@@ -1,7 +1,7 @@
 import logging
 from typing import Literal, overload
 
-from anaplan_sdk._services import _HttpService
+from anaplan_sdk._services import _HttpService, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError
 from anaplan_sdk.models import (
     ModelRevision,
@@ -29,13 +29,21 @@ class _AlmClient:
         logger.info(f"Changed model status to '{status}' for model {self._model_id}.")
         self._http.put(f"{self._url}/onlineStatus", json={"status": status})
 
-    def get_revisions(self) -> list[Revision]:
+    def get_revisions(
+        self,
+        sort_by: Literal["id", "name", "applied_on", "created_on"] | None = None,
+        descending: bool = False,
+    ) -> list[Revision]:
         """
         Use this call to return a list of revisions for a specific model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: A list of revisions for a specific model.
         """
-        res = self._http.get(f"{self._url}/alm/revisions")
-        return [Revision.model_validate(e) for e in res.get("revisions", [])]
+        res = self._http.get_paginated(
+            f"{self._url}/alm/revisions", "revisions", params=sort_params(sort_by, descending)
+        )
+        return [Revision.model_validate(e) for e in res]
 
     def get_latest_revision(self) -> Revision | None:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_clients/_audit.py

@@ -1,9 +1,10 @@
 from typing import Any, Literal
 
-from anaplan_sdk._services import _HttpService
+from anaplan_sdk._services import _HttpService, sort_params
 from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
+UserSortBy = Literal["first_name", "last_name", "email", "active", "last_login_date"] | None
 
 
 class _AuditClient:
@@ -12,20 +13,27 @@ class _AuditClient:
         self._limit = 10_000
         self._url = "https://audit.anaplan.com/audit/api/1/events"
 
-    def get_users(self, search_pattern: str | None = None) -> list[User]:
+    def get_users(
+        self,
+        search_pattern: str | None = None,
+        sort_by: UserSortBy = None,
+        descending: bool = False,
+    ) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
-        :param search_pattern: Optional filter for users. When provided, case-insensitive matches
-               users with emails containing this string. When None (default), returns all users.
+        :param search_pattern: Optionally filter for specific users. When provided,
+               case-insensitive matches users with emails or names containing this string.
+               You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
+               When None (default), returns all users.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Users.
         """
-        params = {"s": search_pattern} if search_pattern else None
-        return [
-            User.model_validate(e)
-            for e in self._http.get_paginated(
-                "https://api.anaplan.com/2/0/users", "users", params=params
-            )
-        ]
+        params = sort_params(sort_by, descending)
+        if search_pattern:
+            params["s"] = search_pattern
+        res = self._http.get_paginated("https://api.anaplan.com/2/0/users", "users", params=params)
+        return [User.model_validate(e) for e in res]
 
     def get_user(self, user_id: str = "me") -> User:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_clients/_bulk.py

@@ -2,13 +2,13 @@ import logging
 import multiprocessing
 from concurrent.futures import ThreadPoolExecutor
 from copy import copy
-from typing import Iterator
+from typing import Iterator, Literal
 
 import httpx
 from typing_extensions import Self
 
 from anaplan_sdk._auth import _create_auth
-from anaplan_sdk._services import _HttpService, action_url
+from anaplan_sdk._services import _HttpService, action_url, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
     Action,
@@ -28,6 +28,8 @@ from ._audit import _AuditClient
 from ._cloud_works import _CloudWorksClient
 from ._transactional import _TransactionalClient
 
+SortBy = Literal["id", "name"] | None
+
 logger = logging.getLogger("anaplan_sdk")
 
 
@@ -230,42 +232,53 @@ class Client:
             )
         return self._alm_client
 
-    def get_workspaces(self, search_pattern: str | None = None) -> list[Workspace]:
+    def get_workspaces(
+        self,
+        search_pattern: str | None = None,
+        sort_by: Literal["size_allowance", "name"] | None = None,
+        descending: bool = False,
+    ) -> list[Workspace]:
         """
         Lists all the Workspaces the authenticated user has access to.
-        :param search_pattern: Optional filter for workspaces. When provided, case-insensitive
-               matches workspaces with names containing this string. When None (default),
-               returns all workspaces.
+        :param search_pattern: Optionally filter for specific workspaces. When provided,
+               case-insensitive matches workspaces with names containing this string.
+               You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
+               When None (default), returns all users.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Workspaces.
         """
-        params = {"tenantDetails": "true"}
+        params = {"tenantDetails": "true"} | sort_params(sort_by, descending)
         if search_pattern:
             params["s"] = search_pattern
-        return [
-            Workspace.model_validate(e)
-            for e in self._http.get_paginated(
-                "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
-            )
-        ]
+        res = self._http.get_paginated(
+            "https://api.anaplan.com/2/0/workspaces", "workspaces", params=params
+        )
+        return [Workspace.model_validate(e) for e in res]
 
-    def get_models(self, search_pattern: str | None = None) -> list[Model]:
+    def get_models(
+        self,
+        search_pattern: str | None = None,
+        sort_by: Literal["active_state", "name"] | None = None,
+        descending: bool = False,
+    ) -> list[Model]:
         """
         Lists all the Models the authenticated user has access to.
         :param search_pattern: Optionally filter for specific models. When provided,
                case-insensitive matches model names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all models.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Models.
         """
-        params = {"modelDetails": "true"}
+        params = {"modelDetails": "true"} | sort_params(sort_by, descending)
         if search_pattern:
             params["s"] = search_pattern
-        return [
-            Model.model_validate(e)
-            for e in self._http.get_paginated(
-                "https://api.anaplan.com/2/0/models", "models", params=params
-            )
-        ]
+        res = self._http.get_paginated(
+            "https://api.anaplan.com/2/0/models", "models", params=params
+        )
+        return [Model.model_validate(e) for e in res]
 
     def delete_models(self, model_ids: list[str]) -> ModelDeletionResult:
         """
@@ -281,56 +294,69 @@ class Client:
         )
         return ModelDeletionResult.model_validate(res)
 
-    def get_files(self) -> list[File]:
+    def get_files(
+        self, sort_by: Literal["id", "name"] = "id", descending: bool = False
+    ) -> list[File]:
         """
         Lists all the Files in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Files.
         """
-        return [
-            File.model_validate(e) for e in self._http.get_paginated(f"{self._url}/files", "files")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/files", "files", params=sort_params(sort_by, descending)
+        )
+        return [File.model_validate(e) for e in res]
 
-    def get_actions(self) -> list[Action]:
+    def get_actions(self, sort_by: SortBy = None, descending: bool = False) -> list[Action]:
         """
         Lists all the Actions in the Model. This will only return the Actions listed under
         `Other Actions` in Anaplan. For Imports, exports, and processes, see their respective
         methods instead.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Actions.
         """
-        return [
-            Action.model_validate(e)
-            for e in self._http.get_paginated(f"{self._url}/actions", "actions")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/actions", "actions", params=sort_params(sort_by, descending)
+        )
+        return [Action.model_validate(e) for e in res]
 
-    def get_processes(self) -> list[Process]:
+    def get_processes(self, sort_by: SortBy = None, descending: bool = False) -> list[Process]:
         """
         Lists all the Processes in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Processes.
         """
-        return [
-            Process.model_validate(e)
-            for e in self._http.get_paginated(f"{self._url}/processes", "processes")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/processes", "processes", params=sort_params(sort_by, descending)
+        )
+        return [Process.model_validate(e) for e in res]
 
-    def get_imports(self) -> list[Import]:
+    def get_imports(self, sort_by: SortBy = None, descending: bool = False) -> list[Import]:
         """
         Lists all the Imports in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Imports.
         """
-        return [
-            Import.model_validate(e)
-            for e in self._http.get_paginated(f"{self._url}/imports", "imports")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/imports", "imports", params=sort_params(sort_by, descending)
+        )
+        return [Import.model_validate(e) for e in res]
 
-    def get_exports(self) -> list[Export]:
+    def get_exports(self, sort_by: SortBy = None, descending: bool = False) -> list[Export]:
         """
         Lists all the Exports in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Exports.
         """
-        return [
-            Export.model_validate(e)
-            for e in (self._http.get(f"{self._url}/exports")).get("exports", [])
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/exports", "exports", params=sort_params(sort_by, descending)
+        )
+        return [Export.model_validate(e) for e in res]
 
     def run_action(self, action_id: int, wait_for_completion: bool = True) -> TaskStatus:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_clients/_cloud_works.py

@@ -95,14 +95,15 @@ class _CloudWorksClient:
         logger.info(f"Deleted connection '{con_id}'.")
 
     def get_integrations(
-        self, sort_by_name: Literal["ascending", "descending"] = "ascending"
+        self, sort_by: Literal["name"] | None = None, descending: bool = False
     ) -> list[Integration]:
         """
         List all integrations in CloudWorks.
-        :param sort_by_name: Sort the integrations by name in ascending or descending order.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: A list of integrations.
         """
-        params = {"sortBy": "name" if sort_by_name == "ascending" else "-name"}
+        params = {"sortBy": f"{'-' if descending else ''}{sort_by}"} if sort_by else None
         return [
             Integration.model_validate(e)
             for e in self._http.get_paginated(f"{self._url}", "integrations", params=params)

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_clients/_transactional.py

@@ -7,6 +7,7 @@ from anaplan_sdk._services import (
     _HttpService,
     parse_calendar_response,
     parse_insertion_response,
+    sort_params,
     validate_dimension_id,
 )
 from anaplan_sdk.exceptions import InvalidIdentifierException
@@ -29,6 +30,8 @@ from anaplan_sdk.models import (
     ViewInfo,
 )
 
+SortBy = Literal["id", "name"] | None
+
 logger = logging.getLogger("anaplan_sdk")
 
 
@@ -66,24 +69,32 @@ class _TransactionalClient:
         self._http.post_empty(f"{self._url}/close", headers={"Content-Type": "application/text"})
         logger.info(f"Closed model '{self._model_id}'.")
 
-    def get_modules(self) -> list[Module]:
+    def get_modules(self, sort_by: SortBy = None, descending: bool = False) -> list[Module]:
         """
         Lists all the Modules in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Modules.
         """
-        return [
-            Module.model_validate(e)
-            for e in self._http.get_paginated(f"{self._url}/modules", "modules")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/modules", "modules", params=sort_params(sort_by, descending)
+        )
+        return [Module.model_validate(e) for e in res]
 
-    def get_views(self) -> list[View]:
+    def get_views(
+        self, sort_by: Literal["id", "module_id", "name"] | None = None, descending: bool = False
+    ) -> list[View]:
         """
         Lists all the Views in the Model. This will include all Modules and potentially other saved
         views.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: The List of Views.
         """
+        params = {"includesubsidiaryviews": True} | sort_params(sort_by, descending)
         return [
-            View.model_validate(e) for e in self._http.get_paginated(f"{self._url}/views", "views")
+            View.model_validate(e)
+            for e in self._http.get_paginated(f"{self._url}/views", "views", params=params)
         ]
 
     def get_view_info(self, view_id: int) -> ViewInfo:
@@ -107,14 +118,17 @@ class _TransactionalClient:
         )
         return [LineItem.model_validate(e) for e in self._http.get(url).get("items", [])]
 
-    def get_lists(self) -> list[List]:
+    def get_lists(self, sort_by: SortBy = None, descending: bool = False) -> list[List]:
         """
         Lists all the Lists in the Model.
+        :param sort_by: The field to sort the results by.
+        :param descending: If True, the results will be sorted in descending order.
         :return: All Lists on this model.
         """
-        return [
-            List.model_validate(e) for e in self._http.get_paginated(f"{self._url}/lists", "lists")
-        ]
+        res = self._http.get_paginated(
+            f"{self._url}/lists", "lists", params=sort_params(sort_by, descending)
+        )
+        return [List.model_validate(e) for e in res]
 
     def get_list_metadata(self, list_id: int) -> ListMetadata:
         """

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/anaplan_sdk/_services.py

@@ -33,6 +33,15 @@ from .models.cloud_works import (
     ScheduleInput,
 )
 
+SORT_WARNING = (
+    "If you are sorting by a field that is potentially ambiguous (e.g., name), the order of "
+    "results is not guaranteed to be internally consistent across multiple requests. This will "
+    "lead to wrong results when paginating through result sets where the ambiguous order can cause "
+    "records to slip between pages or be duplicated on multiple pages. The only way to ensure "
+    "correct results when sorting is to make sure the entire result set fits in one page, or to "
+    "sort by a field that is guaranteed to be unique (e.g., id)."
+)
+
 logger = logging.getLogger("anaplan_sdk")
 
 _json_header = {"Content-Type": "application/json"}
@@ -104,7 +113,8 @@ class _HttpService:
         if total_items <= self._page_size:
             logger.debug("All items fit in first page, no additional requests needed.")
             return iter(first_page)
-
+        if kwargs and (kwargs.get("params") or {}).get("sort", None):
+            logger.warning(SORT_WARNING)
         pages_needed = ceil(total_items / actual_size)
         logger.debug(f"Fetching {pages_needed - 1} additional pages with {actual_size} items each.")
         with ThreadPoolExecutor() as executor:
@@ -222,6 +232,8 @@ class _AsyncHttpService:
         if total_items <= self._page_size:
             logger.debug("All items fit in first page, no additional requests needed.")
             return iter(first_page)
+        if kwargs and (kwargs.get("params") or {}).get("sort", None):
+            logger.warning(SORT_WARNING)
         pages = await gather(
             *(
                 self._get_page(url, actual_size, n * actual_size, result_key, **kwargs)
@@ -274,13 +286,15 @@ class _AsyncHttpService:
         raise AnaplanException("Exhausted all retries without a successful response or Error.")
 
 
-def sort_params(sort_by: str, descending: bool) -> dict[str, str | bool]:
+def sort_params(sort_by: str | None, descending: bool) -> dict[str, str | bool]:
     """
     Construct search parameters for sorting. This also converts snake_case to camelCase.
     :param sort_by: The field to sort by, optionally in snake_case.
     :param descending: Whether to sort in descending order.
     :return: A dictionary of search parameters in Anaplan's expected format.
     """
+    if not sort_by:
+        return {}
     return {"sort": f"{'-' if descending else '+'}{to_camel(sort_by)}"}
 
 

anaplan_sdk-0.5.0a4/docs/guides/sorting.md

@@ -0,0 +1,41 @@
+!!! danger "Anaplan Sorting is not consistent"
+    If you are sorting by a field that is potentially ambiguous (e.g., `name`), the order of results is not guaranteed
+    to be internally consistent across multiple requests. This will lead to wrong results when paginating through
+    result sets where the ambiguous order can cause records to slip between pages or be duplicated on multiple pages.
+    The only way to ensure correct results when sorting is to make sure the entire result set fits in one page,
+    or to sort by a field that is guaranteed to be unique (e.g., `id`).
+
+Some endpoints support sorting results by a specified field in either ascending or descending order. The methods for
+these endpoints include a `sort_by` parameter to specify the field to sort on, and a `descending` boolean parameter
+to specify the sort order (default is ascending).  
+
+## Syntax
+
+These Methods support sorting. The Type Literals for the `sort_by` will tell you which fields are supported for sorting.
+
+```python
+# Audit
+anaplan.audit.get_users(sort_by="email")
+
+# Workspaces & Models
+anaplan.get_workspaces(sort_by="size_allowance", descending=True)
+anaplan.get_models(sort_by="active_state")
+
+# Model Objects
+anaplan.get_files(sort_by="name")
+anaplan.get_actions(sort_by="id")
+anaplan.get_processes(sort_by="name")
+anaplan.get_imports(sort_by="id")
+anaplan.get_exports(sort_by="name")
+
+# Transactional
+anaplan.tr.get_modules(sort_by="name")
+anaplan.tr.get_views(sort_by="module_id")
+anaplan.tr.get_lists(sort_by="id")
+
+# ALM
+anaplan.alm.get_revisions(sort_by="created_on")
+
+# CloudWorks
+anaplan.cw.get_integrations(sort_by_name="descending")
+```

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/mkdocs.yml

@@ -46,6 +46,7 @@ nav:
       - CloudWorks API: 'guides/cloud_works.md'
       - ALM API: 'guides/alm.md'
       - Audit API: 'guides/audit.md'
+      - Sorting: 'guides/sorting.md'
       - Multiple Models: 'guides/multiple_models.md'
       - Logging: 'guides/logging.md'
   - Concepts:

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/pyproject.toml

@@ -1,11 +1,9 @@
 [project]
 name = "anaplan-sdk"
-version = "0.5.0a3"
+version = "0.5.0a4"
 description = "Streamlined Python Interface for the Anaplan API."
 license = "Apache-2.0"
-authors = [
-    { name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }
-]
+authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]
 readme = "README.md"
 keywords = [
     "anaplan",

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/tests/async/test_async_cloud_works_client.py

@@ -51,7 +51,7 @@ async def test_list_integrations(client):
 
 
 async def test_list_integrations_desc(client):
-    integrations_desc = await client.cw.get_integrations(sort_by_name="descending")
+    integrations_desc = await client.cw.get_integrations(sort_by="name", descending=True)
     assert isinstance(integrations_desc, list)
     assert all(isinstance(i, Integration) for i in integrations_desc)
 

{anaplan_sdk-0.5.0a3 → anaplan_sdk-0.5.0a4}/tests/sync/test_cloud_works_client.py

@@ -49,7 +49,7 @@ def test_list_integrations(client):
 
 
 def test_list_integrations_desc(client):
-    integrations_desc = client.cw.get_integrations(sort_by_name="descending")
+    integrations_desc = client.cw.get_integrations(sort_by="name", descending=True)
     assert isinstance(integrations_desc, list)
     assert all(isinstance(i, Integration) for i in integrations_desc)