anaplan-sdk 0.3.0__tar.gz → 0.3.1b1__tar.gz

{anaplan_sdk-0.3.0 → anaplan_sdk-0.3.1b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.3.0
+Version: 0.3.1b1
 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.3.1b1/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.3.0 → anaplan_sdk-0.3.1b1}/anaplan_sdk/_async_clients/_bulk.py

@@ -191,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]:
@@ -203,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"}
             )
         ]
 
@@ -214,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]:
@@ -226,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]:
@@ -236,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]:
@@ -246,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]:
@@ -256,7 +258,7 @@ 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) -> TaskStatus:
@@ -406,9 +408,9 @@ class AsyncClient(_AsyncBaseClient):
         """
         return [
             TaskSummary.model_validate(e)
-            for e in (
-                await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks")
-            ).get("tasks", [])
+            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) -> TaskStatus:

{anaplan_sdk-0.3.0 → anaplan_sdk-0.3.1b1}/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:
@@ -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:

{anaplan_sdk-0.3.0 → anaplan_sdk-0.3.1b1}/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.1b1/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.3.0 → anaplan_sdk-0.3.1b1}/anaplan_sdk/_clients/_bulk.py

@@ -199,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"},
             )
         ]
 
@@ -211,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"}
             )
         ]
 
@@ -221,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]:
         """
@@ -231,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]:
@@ -241,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]:
@@ -250,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]:
@@ -400,8 +402,8 @@ class Client(_BaseClient):
         """
         return [
             TaskSummary.model_validate(e)
-            for e in self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks").get(
-                "tasks", []
+            for e in self._get_paginated(
+                f"{self._url}/{action_url(action_id)}/{action_id}/tasks", "tasks"
             )
         ]
 

{anaplan_sdk-0.3.0 → anaplan_sdk-0.3.1b1}/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:
         """
@@ -53,9 +55,9 @@ class _TransactionalClient(_BaseClient):
     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:
         """

{anaplan_sdk-0.3.0 → anaplan_sdk-0.3.1b1}/pyproject.toml

@@ -1,88 +1,88 @@
-[project]
-name = "anaplan-sdk"
-version = "0.3.0"
-description = "Provides pythonic access to the Anaplan API"
-license = "Apache-2.0"
-authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]
-readme = "README.md"
-keywords = ["anaplan", "anaplan api", "anaplan bulk api", "anaplan integration", "anaplan alm api", "anaplan audit api"]
-requires-python = ">=3.10.4"
-dependencies = [
-    "pydantic>=2.7.2,<3.0.0",
-    "httpx>=0.27.0,<1.0.0",
-    "cryptography>=42.0.7,<45.0.0"
-]
-
-[dependency-groups]
-dev = [
-    "ruff>=0.9.2",
-    "pre-commit>=4.0.1",
-    "pytest>=8.3.3",
-    "pytest-asyncio>=0.26.0",
-    "pytest-xdist>=3.6.1",
-    "mkdocs>=1.6.1",
-    "mkdocs-material>=9.5.41",
-    "mkdocstrings[python]>=0.26.2",
-    "polars>=1.25.2",
-    "griffe-fieldz>=0.2.1",
-]
-
-[project.urls]
-Homepage = "https://vinzenzklass.github.io/anaplan-sdk/"
-Repository = "https://github.com/VinzenzKlass/anaplan-sdk"
-Documentation = "https://vinzenzklass.github.io/anaplan-sdk/"
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.ruff]
-exclude = [
-    ".bzr",
-    ".direnv",
-    ".eggs",
-    ".git",
-    ".git-rewrite",
-    ".hg",
-    ".ipynb_checkpoints",
-    ".mypy_cache",
-    ".nox",
-    ".pants.d",
-    ".pyenv",
-    ".pytest_cache",
-    ".pytype",
-    ".ruff_cache",
-    ".svn",
-    ".tox",
-    ".venv",
-    ".vscode",
-    "__pypackages__",
-    "_build",
-    "buck-out",
-    "build",
-    "dist",
-    "node_modules",
-    "site-packages",
-    "venv",
-]
-
-line-length = 100
-fix = true
-target-version = "py312"
-
-[tool.ruff.format]
-skip-magic-trailing-comma = false
-
-[tool.ruff.lint]
-select = ["E", "F", "B", "I"]
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-asyncio_default_fixture_loop_scope = "session"
-asyncio_default_test_loop_scope = "session"
-minversion = "8.0"
-addopts = "-ra -q"
-pythonpath = "anaplan_sdk/"
-testpaths = [
-    "tests",
-]
+[project]
+name = "anaplan-sdk"
+version = "0.3.1b1"
+description = "Provides pythonic access to the Anaplan API"
+license = "Apache-2.0"
+authors = [{ name = "Vinzenz Klass", email = "vinzenz.klass@valantic.com" }]
+readme = "README.md"
+keywords = ["anaplan", "anaplan api", "anaplan bulk api", "anaplan integration", "anaplan alm api", "anaplan audit api"]
+requires-python = ">=3.10.4"
+dependencies = [
+    "pydantic>=2.7.2,<3.0.0",
+    "httpx>=0.27.0,<1.0.0",
+    "cryptography>=42.0.7,<45.0.0"
+]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.9.2",
+    "pre-commit>=4.0.1",
+    "pytest>=8.3.3",
+    "pytest-asyncio>=0.26.0",
+    "pytest-xdist>=3.6.1",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.41",
+    "mkdocstrings[python]>=0.26.2",
+    "polars>=1.25.2",
+    "griffe-fieldz>=0.2.1",
+]
+
+[project.urls]
+Homepage = "https://vinzenzklass.github.io/anaplan-sdk/"
+Repository = "https://github.com/VinzenzKlass/anaplan-sdk"
+Documentation = "https://vinzenzklass.github.io/anaplan-sdk/"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+line-length = 100
+fix = true
+target-version = "py312"
+
+[tool.ruff.format]
+skip-magic-trailing-comma = false
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "I"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+asyncio_default_test_loop_scope = "session"
+minversion = "8.0"
+addopts = "-ra -q"
+pythonpath = "anaplan_sdk/"
+testpaths = [
+    "tests",
+]