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

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

@@ -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.0a3 → anaplan_sdk-0.5.0a5}/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.0a5}/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-0.5.0a3 → anaplan_sdk-0.5.0a5}/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-0.5.0a3 → anaplan_sdk-0.5.0a5}/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.0a5}/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.0a5}/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.0a5}/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:
         """