anaplan-sdk 0.2.11__tar.gz → 0.3.1__tar.gz

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/.gitignore

@@ -1,3 +1,4 @@
+.prettierrc
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.11
+Version: 0.3.1
 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
@@ -38,7 +38,7 @@ implementation details like authentication, error handling, chunking, compressio
 This Projects supports
 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 [ALM APIs](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.
 

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/README.md

@@ -21,7 +21,7 @@ implementation details like authentication, error handling, chunking, compressio
 This Projects supports
 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 [ALM APIs](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.
 

anaplan_sdk-0.3.1/anaplan_sdk/_async_clients/_audit.py

@@ -0,0 +1,42 @@
+from typing import Literal
+
+import httpx
+
+from anaplan_sdk._base import _AsyncBaseClient
+from anaplan_sdk.models import User
+
+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 list_users(self) -> list[User]:
+        """
+        Lists all the Users in the authenticated users default tenant.
+        :return: The List of Users.
+        """
+        return [
+            User.model_validate(e)
+            for e in await self._get_paginated("https://api.anaplan.com/2/0/users", "users")
+        ]
+
+    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.
+        """
+        return list(
+            await self._get_paginated(
+                self._url,
+                "response",
+                params={"type": event_type, "intervalInHours": days_into_past * 24},
+            )
+        )

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/anaplan_sdk/_async_clients/_bulk.py

@@ -3,8 +3,7 @@ Asynchronous Client.
 """
 
 import logging
-import time
-from asyncio import gather
+from asyncio import gather, sleep
 from copy import copy
 from typing import AsyncIterator, Iterator
 
@@ -14,7 +13,17 @@ from typing_extensions import Self
 from anaplan_sdk._auth import AnaplanBasicAuth, AnaplanCertAuth, get_certificate, get_private_key
 from anaplan_sdk._base import _AsyncBaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
-from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
+from anaplan_sdk.models import (
+    Action,
+    Export,
+    File,
+    Import,
+    Model,
+    Process,
+    TaskStatus,
+    TaskSummary,
+    Workspace,
+)
 
 from ._alm import _AsyncAlmClient
 from ._audit import _AsyncAuditClient
@@ -182,9 +191,11 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Workspace.model_validate(e)
-            for e in (
-                await self._get("https://api.anaplan.com/2/0/workspaces?tenantDetails=true")
-            ).get("workspaces", [])
+            for e in await self._get_paginated(
+                "https://api.anaplan.com/2/0/workspaces",
+                "workspaces",
+                params={"tenantDetails": "true"},
+            )
         ]
 
     async def list_models(self) -> list[Model]:
@@ -194,8 +205,8 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Model.model_validate(e)
-            for e in (await self._get("https://api.anaplan.com/2/0/models?modelDetails=true")).get(
-                "models", []
+            for e in await self._get_paginated(
+                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
             )
         ]
 
@@ -205,7 +216,7 @@ class AsyncClient(_AsyncBaseClient):
         :return: The List of Files.
         """
         return [
-            File.model_validate(e) for e in (await self._get(f"{self._url}/files")).get("files", [])
+            File.model_validate(e) for e in await self._get_paginated(f"{self._url}/files", "files")
         ]
 
     async def list_actions(self) -> list[Action]:
@@ -217,7 +228,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Action.model_validate(e)
-            for e in (await self._get(f"{self._url}/actions")).get("actions", [])
+            for e in await self._get_paginated(f"{self._url}/actions", "actions")
         ]
 
     async def list_processes(self) -> list[Process]:
@@ -227,7 +238,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Process.model_validate(e)
-            for e in (await self._get(f"{self._url}/processes")).get("processes", [])
+            for e in await self._get_paginated(f"{self._url}/processes", "processes")
         ]
 
     async def list_imports(self) -> list[Import]:
@@ -237,7 +248,7 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Import.model_validate(e)
-            for e in (await self._get(f"{self._url}/imports")).get("imports", [])
+            for e in await self._get_paginated(f"{self._url}/imports", "imports")
         ]
 
     async def list_exports(self) -> list[Export]:
@@ -247,10 +258,10 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             Export.model_validate(e)
-            for e in (await self._get(f"{self._url}/exports")).get("exports", [])
+            for e in await self._get_paginated(f"{self._url}/exports", "exports")
         ]
 
-    async def run_action(self, action_id: int) -> None:
+    async def run_action(self, action_id: int) -> TaskStatus:
         """
         Runs the specified Anaplan Action and validates the spawned task. If the Action fails or
         completes with errors, will raise an :py:class:`AnaplanActionError`. Failed Tasks are
@@ -268,16 +279,15 @@ class AsyncClient(_AsyncBaseClient):
         task_id = await self.invoke_action(action_id)
         task_status = await self.get_task_status(action_id, task_id)
 
-        while "COMPLETE" not in task_status.get("taskState"):
-            time.sleep(self.status_poll_delay)
+        while task_status.task_state != "COMPLETE":
+            await sleep(self.status_poll_delay)
             task_status = await self.get_task_status(action_id, task_id)
 
-        if task_status.get("taskState") == "COMPLETE" and not task_status.get("result").get(
-            "successful"
-        ):
+        if task_status.task_state == "COMPLETE" and not task_status.result.successful:
             raise AnaplanActionError(f"Task '{task_id}' completed with errors.")
 
         logger.info(f"Task '{task_id}' completed successfully.")
+        return task_status
 
     async def get_file(self, file_id: int) -> bytes:
         """
@@ -390,29 +400,31 @@ 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:
+    async def list_task_status(self, action_id: int) -> list[TaskSummary]:
         """
         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", []
-        )
+        return [
+            TaskSummary.model_validate(e)
+            for e in await self._get_paginated(
+                f"{self._url}/{action_url(action_id)}/{action_id}/tasks", "tasks"
+            )
+        ]
 
-    async def get_task_status(
-        self, action_id: int, task_id: str
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    async def get_task_status(self, action_id: int, task_id: str) -> TaskStatus:
         """
         Retrieves the status of the specified task.
         :param action_id: The identifier of the action that was invoked.
         :param task_id: The identifier of the spawned task.
-        :return: The status of the task as returned by the API. For more information
-                 see: https://anaplan.docs.apiary.io.
+        :return: The status of the task.
         """
-        return (
-            await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}")
-        ).get("task")
+        return TaskStatus.model_validate(
+            (
+                await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}")
+            ).get("task")
+        )
 
     async def invoke_action(self, action_id: int) -> str:
         """

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/anaplan_sdk/_async_clients/_transactional.py

@@ -32,7 +32,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         return [
             Module.model_validate(e)
-            for e in (await self._get(f"{self._url}/modules")).get("modules")
+            for e in await self._get_paginated(f"{self._url}/modules", "modules")
         ]
 
     async def get_model_status(self) -> ModelStatus:
@@ -55,7 +55,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
             if only_module_id
             else f"{self._url}/lineItems?includeAll=true"
         )
-        return [LineItem.model_validate(e) for e in (await self._get(url)).get("items")]
+        return [LineItem.model_validate(e) for e in (await self._get(url)).get("items", [])]
 
     async def list_lists(self) -> list[List]:
         """
@@ -63,7 +63,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         :return: All Lists on this model.
         """
         return [
-            List.model_validate(e) for e in (await self._get(f"{self._url}/lists")).get("lists")
+            List.model_validate(e) for e in await self._get_paginated(f"{self._url}/lists", "lists")
         ]
 
     async def get_list_metadata(self, list_id: int) -> ListMetadata:
@@ -156,7 +156,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         await self._post_empty(f"{self._url}/lists/{list_id}/resetIndex")
 
-    async def write_to_module(
+    async def update_module_data(
         self, module_id: int, data: list[dict[str, Any]]
     ) -> int | dict[str, Any]:
         """
@@ -171,6 +171,17 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         res = await self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
 
+    async def write_to_module(
+        self, module_id: int, data: list[dict[str, Any]]
+    ) -> int | dict[str, Any]:
+        warnings.warn(
+            "`write_to_module()` is deprecated and will be removed in a future version. "
+            "Use `update_module_data()` instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+        return await self.update_module_data(module_id, data)
+
     async def add_items_to_list(
         self, list_id: int, items: list[dict[str, str | int | dict]]
     ) -> InsertionResult:

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/anaplan_sdk/_base.py

@@ -6,8 +6,12 @@ import asyncio
 import logging
 import random
 import time
+from asyncio import gather
+from concurrent.futures import ThreadPoolExecutor
 from gzip import compress
-from typing import Any, Callable, Coroutine, Literal
+from itertools import chain
+from math import ceil
+from typing import Any, Callable, Coroutine, Iterator, Literal
 
 import httpx
 from httpx import HTTPError, Response
@@ -26,15 +30,13 @@ class _BaseClient:
         self._retry_count = retry_count
         self._client = client
 
-    def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+    def _get(self, url: str, **kwargs) -> dict[str, Any]:
         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
 
-    def _post(
-        self, url: str, json: dict | list
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    def _post(self, url: str, json: dict | list) -> dict[str, Any]:
         return self._run_with_retry(
             self._client.post, url, headers={"Content-Type": "application/json"}, json=json
         ).json()
@@ -50,6 +52,30 @@ class _BaseClient:
             content=compress(content),
         )
 
+    def __get_page(self, url: str, limit: int, offset: int, result_key: str, **kwargs) -> list:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit, "offset": offset}
+        return self._get(url, **kwargs).get(result_key, [])
+
+    def __get_first_page(self, url: str, limit: int, result_key: str, **kwargs) -> tuple[list, int]:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit}
+        res = self._get(url, **kwargs)
+        return res.get(result_key, []), res["meta"]["paging"]["totalSize"]
+
+    def _get_paginated(
+        self, url: str, result_key: str, page_size: int = 5_000, **kwargs
+    ) -> Iterator[dict[str, Any]]:
+        first_page, total_items = self.__get_first_page(url, page_size, result_key, **kwargs)
+        if total_items <= page_size:
+            return iter(first_page)
+
+        with ThreadPoolExecutor() as executor:
+            pages = executor.map(
+                lambda n: self.__get_page(url, page_size, n * page_size, result_key, **kwargs),
+                range(1, ceil(total_items / page_size)),
+            )
+
+        return chain(first_page, *pages)
+
     def _run_with_retry(self, func: Callable[..., Response], *args, **kwargs) -> Response:
         for i in range(max(self._retry_count, 1)):
             try:
@@ -77,15 +103,13 @@ class _AsyncBaseClient:
         self._retry_count = retry_count
         self._client = client
 
-    async def _get(self, url: str, **kwargs) -> dict[str, float | int | str | list | dict | bool]:
+    async def _get(self, url: str, **kwargs) -> dict[str, Any]:
         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
 
-    async def _post(
-        self, url: str, json: dict | list
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    async def _post(self, url: str, json: dict | list) -> dict[str, Any]:
         return (
             await self._run_with_retry(
                 self._client.post, url, headers={"Content-Type": "application/json"}, json=json
@@ -103,6 +127,33 @@ class _AsyncBaseClient:
             content=compress(content),
         )
 
+    async def __get_page(
+        self, url: str, limit: int, offset: int, result_key: str, **kwargs
+    ) -> list:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit, "offset": offset}
+        return (await self._get(url, **kwargs)).get(result_key, [])
+
+    async def __get_first_page(
+        self, url: str, limit: int, result_key: str, **kwargs
+    ) -> tuple[list, int]:
+        kwargs["params"] = kwargs.get("params", {}) | {"limit": limit}
+        res = await self._get(url, **kwargs)
+        return res.get(result_key, []), res["meta"]["paging"]["totalSize"]
+
+    async def _get_paginated(
+        self, url: str, result_key: str, page_size: int = 5_000, **kwargs
+    ) -> Iterator[dict[str, Any]]:
+        first_page, total_items = await self.__get_first_page(url, page_size, result_key, **kwargs)
+        if total_items <= page_size:
+            return iter(first_page)
+        pages = await gather(
+            *(
+                self.__get_page(url, page_size, n * page_size, result_key, **kwargs)
+                for n in range(1, ceil(total_items / page_size))
+            )
+        )
+        return chain(first_page, *pages)
+
     async def _run_with_retry(
         self, func: Callable[..., Coroutine[Any, Any, Response]], *args, **kwargs
     ) -> Response:

anaplan_sdk-0.3.1/anaplan_sdk/_clients/_audit.py

@@ -0,0 +1,43 @@
+from typing import Literal
+
+import httpx
+
+from anaplan_sdk._base import _BaseClient
+from anaplan_sdk.models import User
+
+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 list_users(self) -> list[User]:
+        """
+        Lists all the Users in the authenticated users default tenant.
+        :return: The List of Users.
+        """
+        return [
+            User.model_validate(e)
+            for e in self._get_paginated("https://api.anaplan.com/2/0/users", "users")
+        ]
+
+    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.
+        """
+        return list(
+            self._get_paginated(
+                self._url,
+                "response",
+                params={"type": event_type, "intervalInHours": days_into_past * 24},
+            )
+        )

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/anaplan_sdk/_clients/_bulk.py

@@ -15,7 +15,17 @@ from typing_extensions import Self
 from anaplan_sdk._auth import AnaplanBasicAuth, AnaplanCertAuth, get_certificate, get_private_key
 from anaplan_sdk._base import _BaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
-from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
+from anaplan_sdk.models import (
+    Action,
+    Export,
+    File,
+    Import,
+    Model,
+    Process,
+    TaskStatus,
+    TaskSummary,
+    Workspace,
+)
 
 from ._alm import _AlmClient
 from ._audit import _AuditClient
@@ -189,8 +199,10 @@ class Client(_BaseClient):
         """
         return [
             Workspace.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/workspaces?tenantDetails=true").get(
-                "workspaces", []
+            for e in self._get_paginated(
+                "https://api.anaplan.com/2/0/workspaces",
+                "workspaces",
+                params={"tenantDetails": "true"},
             )
         ]
 
@@ -201,8 +213,8 @@ class Client(_BaseClient):
         """
         return [
             Model.model_validate(e)
-            for e in self._get("https://api.anaplan.com/2/0/models?modelDetails=true").get(
-                "models", []
+            for e in self._get_paginated(
+                "https://api.anaplan.com/2/0/models", "models", params={"modelDetails": "true"}
             )
         ]
 
@@ -211,7 +223,7 @@ class Client(_BaseClient):
         Lists all the Files in the Model.
         :return: The List of Files.
         """
-        return [File.model_validate(e) for e in self._get(f"{self._url}/files").get("files", [])]
+        return [File.model_validate(e) for e in self._get_paginated(f"{self._url}/files", "files")]
 
     def list_actions(self) -> list[Action]:
         """
@@ -221,7 +233,7 @@ class Client(_BaseClient):
         :return: The List of Actions.
         """
         return [
-            Action.model_validate(e) for e in (self._get(f"{self._url}/actions")).get("actions", [])
+            Action.model_validate(e) for e in self._get_paginated(f"{self._url}/actions", "actions")
         ]
 
     def list_processes(self) -> list[Process]:
@@ -231,7 +243,7 @@ class Client(_BaseClient):
         """
         return [
             Process.model_validate(e)
-            for e in (self._get(f"{self._url}/processes")).get("processes", [])
+            for e in self._get_paginated(f"{self._url}/processes", "processes")
         ]
 
     def list_imports(self) -> list[Import]:
@@ -240,7 +252,7 @@ class Client(_BaseClient):
         :return: The List of Imports.
         """
         return [
-            Import.model_validate(e) for e in (self._get(f"{self._url}/imports")).get("imports", [])
+            Import.model_validate(e) for e in self._get_paginated(f"{self._url}/imports", "imports")
         ]
 
     def list_exports(self) -> list[Export]:
@@ -252,7 +264,7 @@ class Client(_BaseClient):
             Export.model_validate(e) for e in (self._get(f"{self._url}/exports")).get("exports", [])
         ]
 
-    def run_action(self, action_id: int) -> None:
+    def run_action(self, action_id: int) -> TaskStatus:
         """
         Runs the specified Anaplan Action and validates the spawned task. If the Action fails or
         completes with errors, will raise an :py:class:`AnaplanActionError`. Failed Tasks are
@@ -270,16 +282,15 @@ class Client(_BaseClient):
         task_id = self.invoke_action(action_id)
         task_status = self.get_task_status(action_id, task_id)
 
-        while "COMPLETE" not in task_status.get("taskState"):
+        while task_status.task_state != "COMPLETE":
             time.sleep(self.status_poll_delay)
             task_status = self.get_task_status(action_id, task_id)
 
-        if task_status.get("taskState") == "COMPLETE" and not task_status.get("result").get(
-            "successful"
-        ):
+        if task_status.task_state == "COMPLETE" and not task_status.result.successful:
             raise AnaplanActionError(f"Task '{task_id}' completed with errors.")
 
         logger.info(f"Task '{task_id}' completed successfully.")
+        return task_status
 
     def get_file(self, file_id: int) -> bytes:
         """
@@ -383,26 +394,30 @@ class Client(_BaseClient):
         self.run_action(action_id)
         return self.get_file(action_id)
 
-    def list_task_status(self, action_id: int) -> list:
+    def list_task_status(self, action_id: int) -> list[TaskSummary]:
         """
         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", [])
+        return [
+            TaskSummary.model_validate(e)
+            for e in self._get_paginated(
+                f"{self._url}/{action_url(action_id)}/{action_id}/tasks", "tasks"
+            )
+        ]
 
-    def get_task_status(
-        self, action_id: int, task_id: str
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    def get_task_status(self, action_id: int, task_id: str) -> TaskStatus:
         """
         Retrieves the status of the specified task.
         :param action_id: The identifier of the action that was invoked.
         :param task_id: The identifier of the spawned task.
-        :return: The status of the task as returned by the API. For more information
-                 see: https://anaplan.docs.apiary.io.
+        :return: The status of the task.
         """
-        return self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}").get(
-            "task"
+        return TaskStatus.model_validate(
+            self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}").get(
+                "task"
+            )
         )
 
     def invoke_action(self, action_id: int) -> str:

{anaplan_sdk-0.2.11 → anaplan_sdk-0.3.1}/anaplan_sdk/_clients/_transactional.py

@@ -28,7 +28,9 @@ class _TransactionalClient(_BaseClient):
         Lists all the Modules in the Model.
         :return: The List of Modules.
         """
-        return [Module.model_validate(e) for e in self._get(f"{self._url}/modules").get("modules")]
+        return [
+            Module.model_validate(e) for e in self._get_paginated(f"{self._url}/modules", "modules")
+        ]
 
     def get_model_status(self) -> ModelStatus:
         """
@@ -48,14 +50,14 @@ class _TransactionalClient(_BaseClient):
             if only_module_id
             else f"{self._url}/lineItems?includeAll=true"
         )
-        return [LineItem.model_validate(e) for e in self._get(url).get("items")]
+        return [LineItem.model_validate(e) for e in self._get(url).get("items", [])]
 
     def list_lists(self) -> list[List]:
         """
         Lists all the Lists in the Model.
-        :return: All Lists on this Model.
+        :return: All Lists on this model.
         """
-        return [List.model_validate(e) for e in self._get(f"{self._url}/lists").get("lists")]
+        return [List.model_validate(e) for e in self._get_paginated(f"{self._url}/lists", "lists")]
 
     def get_list_metadata(self, list_id: int) -> ListMetadata:
         """
@@ -76,7 +78,7 @@ class _TransactionalClient(_BaseClient):
         return [
             ListItem.model_validate(e)
             for e in self._get(f"{self._url}/lists/{list_id}/items?includeAll=true").get(
-                "listItems"
+                "listItems", []
             )
         ]
 
@@ -149,7 +151,9 @@ class _TransactionalClient(_BaseClient):
         """
         self._post_empty(f"{self._url}/lists/{list_id}/resetIndex")
 
-    def write_to_module(self, module_id: int, data: list[dict[str, Any]]) -> int | dict[str, Any]:
+    def update_module_data(
+        self, module_id: int, data: list[dict[str, Any]]
+    ) -> int | dict[str, Any]:
         """
         Write the passed items to the specified module. If successful, the number of cells changed
         is returned, if only partially successful or unsuccessful, the response with the according
@@ -162,6 +166,15 @@ class _TransactionalClient(_BaseClient):
         res = self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
 
+    def write_to_module(self, module_id: int, data: list[dict[str, Any]]) -> int | dict[str, Any]:
+        warnings.warn(
+            "`write_to_module()` is deprecated and will be removed in a future version. "
+            "Use `update_module_data()` instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+        return self.update_module_data(module_id, data)
+
     def add_items_to_list(
         self, list_id: int, items: list[dict[str, str | int | dict]]
     ) -> InsertionResult: