anaplan-sdk 0.2.5__py3-none-any.whl → 0.2.7__py3-none-any.whl

anaplan_sdk/_async_clients/__init__.py

@@ -1,5 +1,6 @@
 from ._alm import _AsyncAlmClient
+from ._audit import _AsyncAuditClient
 from ._bulk import AsyncClient
 from ._transactional import _AsyncTransactionalClient
 
-__all__ = ["_AsyncAlmClient", "AsyncClient", "_AsyncTransactionalClient"]
+__all__ = ["AsyncClient", "_AsyncAlmClient", "_AsyncAuditClient", "_AsyncTransactionalClient"]

anaplan_sdk/_async_clients/_audit.py

@@ -0,0 +1,69 @@
+from asyncio import gather
+from itertools import chain
+from math import ceil
+from typing import Literal
+
+import httpx
+
+from anaplan_sdk._base import _AsyncBaseClient
+
+Event = Literal["all", "byok", "user_activity"]
+
+
+class _AsyncAuditClient(_AsyncBaseClient):
+    def __init__(self, client: httpx.AsyncClient, retry_count: int) -> None:
+        self._client = client
+        self._limit = 10_000
+        self._url = "https://audit.anaplan.com/audit/api/1/events"
+        super().__init__(retry_count, client)
+
+    async def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
+        return (  # noqa
+            await self._get(
+                self._url,
+                params={
+                    "limit": 0,
+                    "type": event_type,
+                    "intervalInHours": days_into_past * 24,
+                },
+            )
+        )["meta"]["paging"]["totalSize"]  # noqa
+
+    async def _get_result_page(
+        self,
+        days_into_past: int = 60,
+        event_type: Event = "all",
+        limit: int = 10_000,
+        offset: int = 0,
+    ) -> list:
+        return (
+            await self._get(
+                self._url,
+                params={
+                    "intervalInHours": days_into_past * 24,
+                    "limit": limit,
+                    "offset": offset,
+                    "type": event_type,
+                },
+            )
+        ).get("response", [])
+
+    async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        total = await self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return await self._get_result_page(total)
+
+        return list(
+            chain.from_iterable(
+                await gather(
+                    *(
+                        self._get_result_page(
+                            days_into_past, event_type, self._limit, n * self._limit
+                        )
+                        for n in range(ceil(total / self._limit))
+                    )
+                )
+            )
+        )

anaplan_sdk/_async_clients/_bulk.py

@@ -17,6 +17,7 @@ from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierExceptio
 from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
 
 from ._alm import _AsyncAlmClient
+from ._audit import _AsyncAuditClient
 from ._transactional import _AsyncTransactionalClient
 
 logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -109,6 +110,7 @@ class AsyncClient(_AsyncBaseClient):
         self._alm_client = (
             _AsyncAlmClient(self._client, model_id, self._retry_count) if model_id else None
         )
+        self.audit = _AsyncAuditClient(self._client, self._retry_count)
         self.status_poll_delay = status_poll_delay
         self.upload_chunk_size = upload_chunk_size
         self.allow_file_creation = allow_file_creation
@@ -379,7 +381,7 @@ class AsyncClient(_AsyncBaseClient):
 
     async def export_and_download(self, action_id: int) -> bytes:
         """
-        Convenience wrapper around `run_action()` a     nd `get_file()` to run an export action and
+        Convenience wrapper around `run_action()` and `get_file()` to run an export action and
         download the exported content in one call.
         :param action_id: The identifier of the action to run.
         :return: The content of the exported file.
@@ -387,6 +389,16 @@ class AsyncClient(_AsyncBaseClient):
         await self.run_action(action_id)
         return await self.get_file(action_id)
 
+    async def list_task_status(self, action_id: int) -> list:
+        """
+        Retrieves the status of all tasks spawned by the specified action.
+        :param action_id: The identifier of the action that was invoked.
+        :return: The list of tasks spawned by the action.
+        """
+        return (await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks")).get(
+            "tasks", []
+        )
+
     async def get_task_status(
         self, action_id: int, task_id: str
     ) -> dict[str, float | int | str | list | dict | bool]:

anaplan_sdk/_base.py

@@ -23,8 +23,8 @@ class _BaseClient:
         self._retry_count = retry_count
         self._client = client
 
-    def _get(self, url: str) -> dict[str, float | int | str | list | dict | bool]:
-        return self._run_with_retry(self._client.get, url).json()
+    def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+        return self._run_with_retry(self._client.get, url, **kwargs).json()
 
     def _get_binary(self, url: str) -> bytes:
         return self._run_with_retry(self._client.get, url).content
@@ -59,14 +59,16 @@ class _BaseClient:
                 url = args[0] or kwargs.get("url")
                 logger.info(f"Retrying for: {url}")
 
+        raise AnaplanException("Exhausted all retries without a successful response or Error.")
+
 
 class _AsyncBaseClient:
     def __init__(self, retry_count: int, client: httpx.AsyncClient):
         self._retry_count = retry_count
         self._client = client
 
-    async def _get(self, url: str) -> dict[str, float | int | str | list | dict | bool]:
-        return (await self._run_with_retry(self._client.get, url)).json()
+    async def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+        return (await self._run_with_retry(self._client.get, url, **kwargs)).json()
 
     async def _get_binary(self, url: str) -> bytes:
         return (await self._run_with_retry(self._client.get, url)).content
@@ -105,6 +107,8 @@ class _AsyncBaseClient:
                 url = args[0] or kwargs.get("url")
                 logger.info(f"Retrying for: {url}")
 
+        raise AnaplanException("Exhausted all retries without a successful response or Error.")
+
 
 def action_url(action_id: int) -> Literal["imports", "exports", "actions", "processes"]:
     """

anaplan_sdk/_clients/__init__.py

@@ -1,5 +1,6 @@
 from ._alm import _AlmClient
+from ._audit import _AuditClient
 from ._bulk import Client
 from ._transactional import _TransactionalClient
 
-__all__ = ["_AlmClient", "Client", "_TransactionalClient"]
+__all__ = ["Client", "_AlmClient", "_AuditClient", "_TransactionalClient"]

anaplan_sdk/_clients/_audit.py

@@ -0,0 +1,68 @@
+from itertools import chain
+from math import ceil
+from typing import Literal
+
+import httpx
+
+from anaplan_sdk._base import _BaseClient
+
+Event = Literal["all", "byok", "user_activity"]
+
+
+class _AuditClient(_BaseClient):
+    def __init__(self, client: httpx.Client, retry_count: int, thread_count: int) -> None:
+        self._client = client
+        self._limit = 10_000
+        self._thread_count = thread_count
+        self._url = "https://audit.anaplan.com/audit/api/1/events"
+        super().__init__(retry_count, client)
+
+    def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
+        return (  # noqa
+            self._get(
+                self._url,
+                params={
+                    "limit": 0,
+                    "type": event_type,
+                    "intervalInHours": days_into_past * 24,
+                },
+            )
+        )["meta"]["paging"]["totalSize"]  # noqa
+
+    def _get_result_page(
+        self,
+        days_into_past: int = 60,
+        event_type: Event = "all",
+        limit: int = 10_000,
+        offset: int = 0,
+    ) -> list:
+        return (
+            self._get(
+                self._url,
+                params={
+                    "intervalInHours": days_into_past * 24,
+                    "limit": limit,
+                    "offset": offset,
+                    "type": event_type,
+                },
+            )
+        ).get("response", [])
+
+    def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        total = self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return self._get_result_page(total)
+
+        from concurrent.futures import ThreadPoolExecutor
+
+        with ThreadPoolExecutor(max_workers=self._thread_count) as executor:
+            futures = [
+                executor.submit(
+                    self._get_result_page, days_into_past, event_type, self._limit, n * self._limit
+                )
+                for n in range(ceil(total / self._limit))
+            ]
+            results = [future.result() for future in futures]
+            return list(chain.from_iterable(results))

anaplan_sdk/_clients/_bulk.py

@@ -18,6 +18,7 @@ from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierExceptio
 from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
 
 from ._alm import _AlmClient
+from ._audit import _AuditClient
 from ._transactional import _TransactionalClient
 
 logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -115,6 +116,7 @@ class Client(_BaseClient):
             _AlmClient(self._client, model_id, self._retry_count) if model_id else None
         )
         self._thread_count = multiprocessing.cpu_count()
+        self.audit = _AuditClient(self._client, self._retry_count, self._thread_count)
         self.status_poll_delay = status_poll_delay
         self.upload_parallel = upload_parallel
         self.upload_chunk_size = upload_chunk_size
@@ -380,6 +382,14 @@ class Client(_BaseClient):
         self.run_action(action_id)
         return self.get_file(action_id)
 
+    def list_task_status(self, action_id: int) -> list:
+        """
+        Retrieves the status of all tasks spawned by the specified action.
+        :param action_id: The identifier of the action that was invoked.
+        :return: The list of tasks spawned by the action.
+        """
+        return self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks").get("tasks", [])
+
     def get_task_status(
         self, action_id: int, task_id: str
     ) -> dict[str, float | int | str | list | dict | bool]:

{anaplan_sdk-0.2.5.dist-info → anaplan_sdk-0.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.5
+Version: 0.2.7
 Summary: Provides pythonic access to the Anaplan API
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk

anaplan_sdk-0.2.7.dist-info/RECORD

@@ -0,0 +1,19 @@
+anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
+anaplan_sdk/_auth.py,sha256=wRcMpdDiHuV-dtiGAKElDiwzfZAEeTOFWfSfaLwNPoU,6597
+anaplan_sdk/_base.py,sha256=2Te7rg_o8_1KD64NfKsDiPLladaoDxMuzk0PaAUNSr8,5299
+anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
+anaplan_sdk/models.py,sha256=ceMaVctpjwQHk7a71Io_-1YcCQshx5i1YYnqxS51nYw,12491
+anaplan_sdk/_async_clients/__init__.py,sha256=wT6qfi4f_4vLFWTJQTsBw8r3DrHtoTIVqi88p5_j-Cg,259
+anaplan_sdk/_async_clients/_alm.py,sha256=-sFk91tRihc5GVPlW41-I5sQ0fxSRCSYTop5S4q2lHc,3673
+anaplan_sdk/_async_clients/_audit.py,sha256=sPu5D_4ENh0iFdlPjuOA1ffFUdAhs2T_M5vHzpwFouA,2194
+anaplan_sdk/_async_clients/_bulk.py,sha256=JmjvZKuekHQceBmItexhkk9YT6njg5_gsYLdtGCyWzE,22202
+anaplan_sdk/_async_clients/_transactional.py,sha256=wX_1U5YS4uwrr8D8MfNkfeA-ylFERMb-6xvewG799xY,4961
+anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
+anaplan_sdk/_clients/_alm.py,sha256=Vcrn3TjHlH365O7F1TKc1WiZWURNqQf_gSc8UUVESM8,3564
+anaplan_sdk/_clients/_audit.py,sha256=vYJxZPM-OS5f4wgzKd2Wcl9kbeypeYrlhT7JSh89KM0,2269
+anaplan_sdk/_clients/_bulk.py,sha256=_rhp7MgcIRq0FYwxEzvU7jBkDm5PQaw9YCU_zqIwauY,22222
+anaplan_sdk/_clients/_transactional.py,sha256=4NYhq2HdxNh4K-HqMyYoyAEqKih2eTtFiXDZi8xOaf8,4695
+anaplan_sdk-0.2.7.dist-info/METADATA,sha256=Kx0L4iI7OVMVSEHTZpv-uCwe8fTGBkOORKNuH-RUSFw,3599
+anaplan_sdk-0.2.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.2.7.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.2.7.dist-info/RECORD,,

anaplan_sdk-0.2.5.dist-info/RECORD

@@ -1,17 +0,0 @@
-anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
-anaplan_sdk/_auth.py,sha256=wRcMpdDiHuV-dtiGAKElDiwzfZAEeTOFWfSfaLwNPoU,6597
-anaplan_sdk/_base.py,sha256=qO5NVmvTYvH7SIEe6SlA-pdMiCEe61EgWXxifvOSG7o,5061
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/models.py,sha256=ceMaVctpjwQHk7a71Io_-1YcCQshx5i1YYnqxS51nYw,12491
-anaplan_sdk/_async_clients/__init__.py,sha256=OOQrL69Xa-F1Mx3N_UaipdbtwNDMbZ6rJB-wHo54Ys4,199
-anaplan_sdk/_async_clients/_alm.py,sha256=-sFk91tRihc5GVPlW41-I5sQ0fxSRCSYTop5S4q2lHc,3673
-anaplan_sdk/_async_clients/_bulk.py,sha256=feCUZKh4PfOoC1VNIlBY5DBCL3MxuOsPrDsUPL56dVw,21662
-anaplan_sdk/_async_clients/_transactional.py,sha256=wX_1U5YS4uwrr8D8MfNkfeA-ylFERMb-6xvewG799xY,4961
-anaplan_sdk/_clients/__init__.py,sha256=vKMLbsWDjlEiJY1q296lnZzYkJk3eKtIwJLoWrO7yxk,169
-anaplan_sdk/_clients/_alm.py,sha256=Vcrn3TjHlH365O7F1TKc1WiZWURNqQf_gSc8UUVESM8,3564
-anaplan_sdk/_clients/_bulk.py,sha256=sdOQeJbxxJTPNKmUN3JMiKBVXTR8HJJcsFaKjduiHq4,21705
-anaplan_sdk/_clients/_transactional.py,sha256=4NYhq2HdxNh4K-HqMyYoyAEqKih2eTtFiXDZi8xOaf8,4695
-anaplan_sdk-0.2.5.dist-info/METADATA,sha256=BdoPh7HxuwpO1F3dFMqsH1mLu_JHSYkz3HqYeNfVfJo,3599
-anaplan_sdk-0.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.2.5.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.2.5.dist-info/RECORD,,