anaplan-sdk 0.2.6__py3-none-any.whl → 0.2.8__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

@@ -10,7 +10,7 @@ from anaplan_sdk._base import _AsyncBaseClient
 Event = Literal["all", "byok", "user_activity"]
 
 
-class _AuditClient(_AsyncBaseClient):
+class _AsyncAuditClient(_AsyncBaseClient):
     def __init__(self, client: httpx.AsyncClient, retry_count: int) -> None:
         self._client = client
         self._limit = 10_000
@@ -49,11 +49,18 @@ class _AuditClient(_AsyncBaseClient):
         ).get("response", [])
 
     async def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        """
+        Get audit events from Anaplan Audit API.
+        :param days_into_past: The nuber of days into the past to get events for. The API provides
+        data for up to 30 days.
+        :param event_type: The type of events to get.
+        :return: A list of audit events.
+        """
         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 await self._get_result_page(days_into_past, event_type)
 
         return list(
             chain.from_iterable(

anaplan_sdk/_async_clients/_bulk.py

@@ -17,7 +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 _AuditClient
+from ._audit import _AsyncAuditClient
 from ._transactional import _AsyncTransactionalClient
 
 logging.getLogger("httpx").setLevel(logging.CRITICAL)
@@ -110,7 +110,7 @@ class AsyncClient(_AsyncBaseClient):
         self._alm_client = (
             _AsyncAlmClient(self._client, model_id, self._retry_count) if model_id else None
         )
-        self.audit = _AuditClient(self._client, self._retry_count)
+        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
@@ -381,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.
@@ -389,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/_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

@@ -49,11 +49,18 @@ class _AuditClient(_BaseClient):
         ).get("response", [])
 
     def get_events(self, days_into_past: int = 30, event_type: Event = "all") -> list:
+        """
+        Get audit events from Anaplan Audit API.
+        :param days_into_past: The nuber of days into the past to get events for. The API provides
+        data for up to 30 days.
+        :param event_type: The type of events to get.
+        :return: A list of audit events.
+        """
         total = self._get_total(days_into_past, event_type)
         if total == 0:
             return []
         if total <= 10_000:
-            return self._get_result_page(total)
+            return self._get_result_page(days_into_past, event_type)
 
         from concurrent.futures import ThreadPoolExecutor
 

anaplan_sdk/_clients/_bulk.py

@@ -382,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.6.dist-info → anaplan_sdk-0.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.6
+Version: 0.2.8
 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
@@ -22,6 +22,7 @@ Description-Content-Type: text/markdown
 <h1 align="center" style="font-size: 3rem; font-weight: 400; margin: -15px 0">
 Anaplan SDK
 </h1>
+
 <p align="center" style="margin-top: 15px">
 <a href="https://pepy.tech/project/anaplan-sdk">
 <img align="center" src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="Downloads Badge"/>
@@ -30,15 +31,15 @@ Anaplan SDK
 
 ---
 
-Anaplan SDK is an independent, unofficial project providing pythonic access to
-the [Anaplan Integration API v2](https://anaplan.docs.apiary.io/). This Project aims to provide high-level abstractions
-over the API, so you can deal with python objects and simple functions rather than implementation details like HTTP
-Requests, Authentication, JSON Parsing, Compression, Chunking and so on.
+Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. Anaplan SDK provides high-level
+abstractions over the various Anaplan APIs, so you can focus on you requirements rather than spend time on
+implementation details like authentication, error handling, chunking, compression and data formatting.
 
 This Projects supports
-the [Bulk API](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
-the [Transactional API](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
-the [ALM API](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
+the [Bulk APIs](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
+the [Transactional APIs](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
+the [ALM APsI](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
+the [Audit APIs](https://auditservice.docs.apiary.io/#),
 providing both synchronous and asynchronous Clients.
 
 Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.

{anaplan_sdk-0.2.6.dist-info → anaplan_sdk-0.2.8.dist-info}/RECORD

@@ -3,17 +3,17 @@ 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=OOQrL69Xa-F1Mx3N_UaipdbtwNDMbZ6rJB-wHo54Ys4,199
+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=Kw8S9QAEPJF6UBYkBr4LTlfOTwBON5hpK5TZgUtnE-U,2189
-anaplan_sdk/_async_clients/_bulk.py,sha256=hozafosOEPIoKjKRZC-cYHZBIA6JPNFLStYW3YWTuEU,21764
+anaplan_sdk/_async_clients/_audit.py,sha256=seCaB3wm_RXeO1CPUhzJwR0OxkS_iAwgrAWnLXAAb9M,2521
+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=vKMLbsWDjlEiJY1q296lnZzYkJk3eKtIwJLoWrO7yxk,169
+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=tImRczEMcjF7GqmmL6jKbZTYjH9aCYrY1pl-4-GQGT8,21827
+anaplan_sdk/_clients/_audit.py,sha256=08CIBaxL8g6s6s0kpuA9_pxJpwRxxJrAjI9lQE3YgqE,2596
+anaplan_sdk/_clients/_bulk.py,sha256=_rhp7MgcIRq0FYwxEzvU7jBkDm5PQaw9YCU_zqIwauY,22222
 anaplan_sdk/_clients/_transactional.py,sha256=4NYhq2HdxNh4K-HqMyYoyAEqKih2eTtFiXDZi8xOaf8,4695
-anaplan_sdk-0.2.6.dist-info/METADATA,sha256=mlKuUSgvCerypmrulSZ20hSLzJcFBbsuqv-IlwWfNqI,3599
-anaplan_sdk-0.2.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.2.6.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.2.6.dist-info/RECORD,,
+anaplan_sdk-0.2.8.dist-info/METADATA,sha256=ay8eF31erA7KFU96IPNLfhgw_BUNvU8Ua5wGQyqL0yU,3602
+anaplan_sdk-0.2.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.2.8.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.2.8.dist-info/RECORD,,