anaplan-sdk 0.5.0a3__py3-none-any.whl → 0.5.0a5__py3-none-any.whl

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/_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,31 @@ 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,
+        :param search_pattern: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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/_async_clients/_bulk.py

@@ -7,7 +7,7 @@ import httpx
 from typing_extensions import Self
 
 from anaplan_sdk._auth import _create_auth
-from anaplan_sdk._services import _AsyncHttpService, action_url, sort_params
+from anaplan_sdk._services import _AsyncHttpService, action_url, models_url, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
     Action,
@@ -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")
 
 
@@ -140,34 +142,24 @@ class AsyncClient:
             f"Initialized AsyncClient with workspace_id={workspace_id}, model_id={model_id}"
         )
 
-    @classmethod
-    def from_existing(
-        cls, existing: Self, *, workspace_id: str | None = None, model_id: str | None = None
-    ) -> Self:
+    def with_model(self, model_id: str | None = None, workspace_id: str | None = None) -> Self:
         """
-        Create a new instance of the Client from an existing instance. This is useful if you want
-        to interact with multiple models or workspaces in the same script but share the same
-        authentication and configuration. This creates a shallow copy of the existing client and
-        optionally updates the relevant attributes to the new workspace and model. You can provide
-        either a new workspace Id or a new model Id, or both. If you do not provide one of them,
-        the existing value will be used. If you omit both, the new instance will be an identical
-        copy of the existing instance.
-
-        :param existing: The existing instance to copy.
+        Create a new instance of the Client with the given model and workspace Ids. **This creates
+        a copy of the current client. The current instance remains unchanged.**
         :param workspace_id: The workspace Id to use or None to use the existing workspace Id.
         :param model_id: The model Id to use or None to use the existing model Id.
         :return: A new instance of the Client.
         """
-        client = copy(existing)
-        new_ws_id = workspace_id or existing._workspace_id
-        new_model_id = model_id or existing._model_id
+        client = copy(self)
+        new_ws_id = workspace_id or self._workspace_id
+        new_model_id = model_id or self._model_id
         logger.debug(
             f"Creating a new AsyncClient from existing instance "
             f"with workspace_id={new_ws_id}, model_id={new_model_id}."
         )
         client._url = f"https://api.anaplan.com/2/0/workspaces/{new_ws_id}/models/{new_model_id}"
-        client._transactional_client = _AsyncTransactionalClient(existing._http, new_model_id)
-        client._alm_client = _AsyncAlmClient(existing._http, new_model_id)
+        client._transactional_client = _AsyncTransactionalClient(self._http, new_model_id)
+        client._alm_client = _AsyncAlmClient(self._http, new_model_id)
         return client
 
     @property
@@ -228,12 +220,14 @@ 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]:
         """
         Lists all the Workspaces the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific workspaces. When provided,
+        :param search_pattern: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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.
@@ -244,22 +238,26 @@ 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,
+        only_in_workspace: bool | str = False,
         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]:
         """
         Lists all the Models the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific models. When provided,
+        :param only_in_workspace: If True, only lists models in the workspace provided when
+               instantiating the client. If a string is provided, only lists models in the workspace
+               with the given Id. If False (default), lists models in all workspaces the user
+        :param search_pattern:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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.
@@ -270,12 +268,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(
+            models_url(only_in_workspace, self._workspace_id), "models", params=params
+        )
+        return [Model.model_validate(e) for e in res]
 
     async def delete_models(self, model_ids: list[str]) -> ModelDeletionResult:
         """
@@ -291,9 +287,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 +299,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 +314,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 +327,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 +339,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/_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/_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/_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/_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,29 @@ 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: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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/_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, models_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")
 
 
@@ -145,34 +147,24 @@ class Client:
         self.allow_file_creation = allow_file_creation
         logger.debug(f"Initialized Client with workspace_id={workspace_id}, model_id={model_id}")
 
-    @classmethod
-    def from_existing(
-        cls, existing: Self, *, workspace_id: str | None = None, model_id: str | None = None
-    ) -> Self:
+    def with_model(self, model_id: str | None = None, workspace_id: str | None = None) -> Self:
         """
-        Create a new instance of the Client from an existing instance. This is useful if you want
-        to interact with multiple models or workspaces in the same script but share the same
-        authentication and configuration. This creates a shallow copy of the existing client and
-        optionally updates the relevant attributes to the new workspace and model. You can provide
-        either a new workspace Id or a new model Id, or both. If you do not provide one of them,
-        the existing value will be used. If you omit both, the new instance will be an identical
-        copy of the existing instance.
-
-        :param existing: The existing instance to copy.
+        Create a new instance of the Client with the given model and workspace Ids. **This creates
+        a copy of the current client. The current instance remains unchanged.**
         :param workspace_id: The workspace Id to use or None to use the existing workspace Id.
         :param model_id: The model Id to use or None to use the existing model Id.
         :return: A new instance of the Client.
         """
-        client = copy(existing)
-        new_ws_id = workspace_id or existing._workspace_id
-        new_model_id = model_id or existing._model_id
+        client = copy(self)
+        new_ws_id = workspace_id or self._workspace_id
+        new_model_id = model_id or self._model_id
         logger.debug(
             f"Creating a new AsyncClient from existing instance "
             f"with workspace_id={new_ws_id}, model_id={new_model_id}."
         )
         client._url = f"https://api.anaplan.com/2/0/workspaces/{new_ws_id}/models/{new_model_id}"
-        client._transactional_client = _TransactionalClient(existing._http, new_model_id)
-        client._alm_client = _AlmClient(existing._http, new_model_id)
+        client._transactional_client = _TransactionalClient(self._http, new_model_id)
+        client._alm_client = _AlmClient(self._http, new_model_id)
         return client
 
     @property
@@ -230,42 +222,61 @@ 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:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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,
+        only_in_workspace: bool | str = False,
+        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,
+        :param only_in_workspace: If True, only lists models in the workspace provided when
+               instantiating the client. If a string is provided, only lists models in the workspace
+               with the given Id. If False (default), lists models in all workspaces the user
+        :param search_pattern:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** 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(
+            models_url(only_in_workspace, self._workspace_id), "models", params=params
+        )
+        return [Model.model_validate(e) for e in res]
 
     def delete_models(self, model_ids: list[str]) -> ModelDeletionResult:
         """
@@ -281,56 +292,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/_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/_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/_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,29 @@ 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 models_url(only_in_workspace: bool | str, workspace_id: str | None) -> str:
+    if isinstance(only_in_workspace, bool) and only_in_workspace:
+        if not workspace_id:
+            raise ValueError(
+                "Cannot list models in the current workspace, since no workspace Id was "
+                "provided when instantiating the client. Either provide a workspace Id when "
+                "instantiating the client, or pass a specific workspace Id to this method."
+            )
+        return f"https://api.anaplan.com/2/0/workspaces/{workspace_id}/models"
+    if isinstance(only_in_workspace, str):
+        return f"https://api.anaplan.com/2/0/workspaces/{only_in_workspace}/models"
+    return "https://api.anaplan.com/2/0/models"
+
+
+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/models/_bulk.py

@@ -39,11 +39,13 @@ class Model(AnaplanModel):
         description="The unique identifier of the user who last modified this model."
     )
     memory_usage: int = Field(0, description="The memory usage of this model in bytes.")
-    current_workspace_id: str = Field(
-        description="The unique identifier of the workspace that this model is currently in."
+    workspace_id: str = Field(
+        validation_alias="currentWorkspaceId",
+        description="The unique identifier of the workspace that this model is currently in.",
     )
-    current_workspace_name: str = Field(
-        description="The name of the workspace that this model is currently in."
+    workspace_name: str = Field(
+        validation_alias="currentWorkspaceName",
+        description="The name of the workspace that this model is currently in.",
     )
     url: str = Field(validation_alias="modelUrl", description="The current URL of this model.")
     category_values: list = Field(description="The category values of this model.")

{anaplan_sdk-0.5.0a3.dist-info → anaplan_sdk-0.5.0a5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a3
+Version: 0.5.0a5
 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.0a5.dist-info/RECORD

@@ -0,0 +1,30 @@
+anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
+anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
+anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
+anaplan_sdk/_services.py,sha256=D54hGrzj1MSj7_6-WDZUZsoLcThI_neW4aIoDOqALjE,20869
+anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
+anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
+anaplan_sdk/_async_clients/_alm.py,sha256=zvKEvXlxNkcQim_XvyZLCbDafFldljg8APHqhAAIfvw,13147
+anaplan_sdk/_async_clients/_audit.py,sha256=r3pJ4iHmXHyfDu19L80UTZzMReg6FKE7DlzyhXLhI8A,2896
+anaplan_sdk/_async_clients/_bulk.py,sha256=JkXZ6mtK04bATyVZA6yA8akjVerurRjgINCViXAwoWM,30069
+anaplan_sdk/_async_clients/_cloud_works.py,sha256=VB4l93426A0Xes5dZ6DsDu0go-BVNhs2RZn2zX5DSOc,17675
+anaplan_sdk/_async_clients/_cw_flow.py,sha256=_allKIOP-qb33wrOj6GV5VAOvrCXOVJ1QXvck-jsocQ,3935
+anaplan_sdk/_async_clients/_transactional.py,sha256=U6X5pW7By387JOgvHx-GmgVRi7MRJKALpx0lWI6xRMo,18024
+anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
+anaplan_sdk/_clients/_alm.py,sha256=3U7Cy5U5TsePF1YPogXvsOzNeQlQm_ezO5TlmD-Xbbs,12874
+anaplan_sdk/_clients/_audit.py,sha256=oF1-7rGfYWG6LfM-i0vJzgpx4NAsLczo4welJR14N-U,2819
+anaplan_sdk/_clients/_bulk.py,sha256=-I0e5yBHhQPIuS9pF_dRRi7OmY7H88P5mGPusGupKi4,30226
+anaplan_sdk/_clients/_cloud_works.py,sha256=FsCp2wPxIoArAN1vcIfOI6ANNkK2ZebQ4MWJZB-nFJU,17466
+anaplan_sdk/_clients/_cw_flow.py,sha256=O6t4utbDZdSVXGC0PXUcPpQ4oXrPohU9_8SUBCpxTXw,3824
+anaplan_sdk/_clients/_transactional.py,sha256=SaHAnaGLZrhXmM8d6JnWWkwf-sVCEDW0nL2a4_wvjfk,17849
+anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
+anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
+anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
+anaplan_sdk/models/_bulk.py,sha256=C0s6XdvHxuJHrPXU-pnZ1JXK1PJOl9FScHArpaox_mQ,8489
+anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
+anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
+anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
+anaplan_sdk-0.5.0a5.dist-info/METADATA,sha256=cPMNYurLnr08YAdhsgOUFlrcw-xehz2gd5MQF_TrFg8,3678
+anaplan_sdk-0.5.0a5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.5.0a5.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.5.0a5.dist-info/RECORD,,

anaplan_sdk-0.5.0a3.dist-info/RECORD

@@ -1,30 +0,0 @@
-anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
-anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
-anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
-anaplan_sdk/_services.py,sha256=gEeGUBAtmkp55-pZXPU1ehd57pGJkkVJJ6OB1oJ5awU,19252
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
-anaplan_sdk/_async_clients/_alm.py,sha256=rhVhykUo6wIvA1SBQkpEAviSsVLURumi_3XQlxTf7z8,12788
-anaplan_sdk/_async_clients/_audit.py,sha256=dipSzp4jMvRCHJAVMQfO854_wpmIcYEDinEPSGdoms4,2342
-anaplan_sdk/_async_clients/_bulk.py,sha256=hjxJ4kY0IfyWYYLPu9QuFkxsPFGbcmY0XPru5LatTcs,30069
-anaplan_sdk/_async_clients/_cloud_works.py,sha256=ecm7DqT39J56xQwYxJMKd_ZVqxzXZdpmagwJUvqKBj4,17613
-anaplan_sdk/_async_clients/_cw_flow.py,sha256=_allKIOP-qb33wrOj6GV5VAOvrCXOVJ1QXvck-jsocQ,3935
-anaplan_sdk/_async_clients/_transactional.py,sha256=gO4v22O0RIHLYwfaVURie1-uLlXo0ypUlOloOZEgmtw,18038
-anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=_LlZIRCE3HxZ4OzU13LOGnX4MQ26j2puSPTy9WGJa3o,12515
-anaplan_sdk/_clients/_audit.py,sha256=9mq7VGYsl6wOdIU7G3GvzP3O7r1ZDCFg5eAu7k4RgxM,2154
-anaplan_sdk/_clients/_bulk.py,sha256=aY2uwAzXSMorEZr7FfP18QA_z0NV6ONQrqOOsyg8CsU,28108
-anaplan_sdk/_clients/_cloud_works.py,sha256=C4F_zJ70vIlZ1lPTCsHkbB41oO6vip9iXaQqRHo4FuY,17404
-anaplan_sdk/_clients/_cw_flow.py,sha256=O6t4utbDZdSVXGC0PXUcPpQ4oXrPohU9_8SUBCpxTXw,3824
-anaplan_sdk/_clients/_transactional.py,sha256=avqww59ccM3FqYMeK1oE-8UH4jyk_pKSCETzhSGKyxA,16936
-anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
-anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
-anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
-anaplan_sdk/models/_bulk.py,sha256=S72qujNr5STdiyKaCEvrQjKYHik_aemiJFNKE7docpI,8405
-anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
-anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
-anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
-anaplan_sdk-0.5.0a3.dist-info/METADATA,sha256=zd3-QsRJ_Fa9PTqn2wt0lMnLrJAkHuLi1YfmYnboeoE,3678
-anaplan_sdk-0.5.0a3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.5.0a3.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.5.0a3.dist-info/RECORD,,