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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a1
-Summary: Streamlined Python Interface for Anaplan
+Version: 0.5.0a3
+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
 Project-URL: Documentation, https://vinzenzklass.github.io/anaplan-sdk/

{anaplan_sdk-0.5.0a1 → anaplan_sdk-0.5.0a3}/anaplan_sdk/_async_clients/_alm.py

@@ -1,10 +1,7 @@
 import logging
-from asyncio import sleep
 from typing import Literal, overload
 
-import httpx
-
-from anaplan_sdk._base import _AsyncBaseClient
+from anaplan_sdk._services import _AsyncHttpService
 from anaplan_sdk.exceptions import AnaplanActionError
 from anaplan_sdk.models import (
     ModelRevision,
@@ -18,14 +15,11 @@ from anaplan_sdk.models import (
 logger = logging.getLogger("anaplan_sdk")
 
 
-class _AsyncAlmClient(_AsyncBaseClient):
-    def __init__(
-        self, client: httpx.AsyncClient, model_id: str, retry_count: int, status_poll_delay: int
-    ) -> None:
-        self.status_poll_delay = status_poll_delay
+class _AsyncAlmClient:
+    def __init__(self, http: _AsyncHttpService, model_id: str) -> None:
+        self._http = http
         self._model_id = model_id
         self._url = f"https://api.anaplan.com/2/0/models/{model_id}"
-        super().__init__(retry_count, client)
 
     async def change_model_status(self, status: Literal["online", "offline"]) -> None:
         """
@@ -33,14 +27,14 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param status: The status of the model. Can be either "online" or "offline".
         """
         logger.info(f"Changed model status to '{status}' for model {self._model_id}.")
-        await self._put(f"{self._url}/onlineStatus", json={"status": status})
+        await self._http.put(f"{self._url}/onlineStatus", json={"status": status})
 
     async def get_revisions(self) -> list[Revision]:
         """
         Use this call to return a list of revisions for a specific model.
         :return: A list of revisions for a specific model.
         """
-        res = await self._get(f"{self._url}/alm/revisions")
+        res = await self._http.get(f"{self._url}/alm/revisions")
         return [Revision.model_validate(e) for e in res.get("revisions", [])]
 
     async def get_latest_revision(self) -> Revision | None:
@@ -52,7 +46,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         latest revision.
         :return: The latest revision for a specific model, or None if no revisions exist.
         """
-        res = (await self._get(f"{self._url}/alm/latestRevision")).get("revisions")
+        res = (await self._http.get(f"{self._url}/alm/latestRevision")).get("revisions")
         return Revision.model_validate(res[0]) if res else None
 
     async def get_syncable_revisions(self, source_model_id: str) -> list[Revision]:
@@ -65,7 +59,9 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param source_model_id: The ID of the source model.
         :return: A list of revisions that can be synchronized to the target model.
         """
-        res = await self._get(f"{self._url}/alm/syncableRevisions?sourceModelId={source_model_id}")
+        res = await self._http.get(
+            f"{self._url}/alm/syncableRevisions?sourceModelId={source_model_id}"
+        )
         return [Revision.model_validate(e) for e in res.get("revisions", [])]
 
     async def create_revision(self, name: str, description: str) -> Revision:
@@ -75,7 +71,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param description: The description of the revision.
         :return: The created Revision Info.
         """
-        res = await self._post(
+        res = await self._http.post(
             f"{self._url}/alm/revisions", json={"name": name, "description": description}
         )
         rev = Revision.model_validate(res["revision"])
@@ -88,7 +84,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         they completed within the last 48 hours.
         :return: A list of sync tasks in descending order of creation time.
         """
-        res = await self._get(f"{self._url}/alm/syncTasks")
+        res = await self._http.get(f"{self._url}/alm/syncTasks")
         return [TaskSummary.model_validate(e) for e in res.get("tasks", [])]
 
     async def get_sync_task(self, task_id: str) -> SyncTask:
@@ -97,7 +93,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param task_id: The ID of the sync task.
         :return: The sync task information.
         """
-        res = await self._get(f"{self._url}/alm/syncTasks/{task_id}")
+        res = await self._http.get(f"{self._url}/alm/syncTasks/{task_id}")
         return SyncTask.model_validate(res["task"])
 
     async def sync_models(
@@ -123,7 +119,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
             "sourceModelId": source_model_id,
             "targetRevisionId": target_revision_id,
         }
-        res = await self._post(f"{self._url}/alm/syncTasks", json=payload)
+        res = await self._http.post(f"{self._url}/alm/syncTasks", json=payload)
         task = await self.get_sync_task(res["task"]["taskId"])
         logger.info(
             f"Started sync task '{task.id}' from Model '{source_model_id}' "
@@ -131,8 +127,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         )
         if not wait_for_completion:
             return task
-        while (task := await self.get_sync_task(task.id)).task_state != "COMPLETE":
-            await sleep(self.status_poll_delay)
+        task = await self._http.poll_task(self.get_sync_task, task.id)
         if not task.result.successful:
             msg = f"Sync task {task.id} completed with errors: {task.result.error}."
             logger.error(msg)
@@ -147,7 +142,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param revision_id: The ID of the revision.
         :return: A list of models that had a specific revision applied to them.
         """
-        res = await self._get(f"{self._url}/alm/revisions/{revision_id}/appliedToModels")
+        res = await self._http.get(f"{self._url}/alm/revisions/{revision_id}/appliedToModels")
         return [ModelRevision.model_validate(e) for e in res.get("appliedToModels", [])]
 
     async def create_comparison_report(
@@ -172,7 +167,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
             "sourceModelId": source_model_id,
             "targetRevisionId": target_revision_id,
         }
-        res = await self._post(f"{self._url}/alm/comparisonReportTasks", json=payload)
+        res = await self._http.post(f"{self._url}/alm/comparisonReportTasks", json=payload)
         task = await self.get_comparison_report_task(res["task"]["taskId"])
         logger.info(
             f"Started Comparison Report task '{task.id}' between Model '{source_model_id}' "
@@ -180,8 +175,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         )
         if not wait_for_completion:
             return task
-        while (task := await self.get_comparison_report_task(task.id)).task_state != "COMPLETE":
-            await sleep(self.status_poll_delay)
+        task = await self._http.poll_task(self.get_comparison_report_task, task.id)
         if not task.result.successful:
             msg = f"Comparison Report task {task.id} completed with errors: {task.result.error}."
             logger.error(msg)
@@ -195,7 +189,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param task_id: The ID of the comparison report task.
         :return: The report task information.
         """
-        res = await self._get(f"{self._url}/alm/comparisonReportTasks/{task_id}")
+        res = await self._http.get(f"{self._url}/alm/comparisonReportTasks/{task_id}")
         return ReportTask.model_validate(res["task"])
 
     async def get_comparison_report(self, task: ReportTask) -> bytes:
@@ -204,7 +198,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param task: The report task object containing the task ID.
         :return: The binary content of the comparison report.
         """
-        return await self._get_binary(
+        return await self._http.get_binary(
             f"{self._url}/alm/comparisonReports/"
             f"{task.result.target_revision_id}/{task.result.source_revision_id}"
         )
@@ -248,7 +242,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
             "sourceModelId": source_model_id,
             "targetRevisionId": target_revision_id,
         }
-        res = await self._post(f"{self._url}/alm/summaryReportTasks", json=payload)
+        res = await self._http.post(f"{self._url}/alm/summaryReportTasks", json=payload)
         task = await self.get_comparison_summary_task(res["task"]["taskId"])
         logger.info(
             f"Started Comparison Summary task '{task.id}' between Model '{source_model_id}' "
@@ -256,8 +250,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         )
         if not wait_for_completion:
             return task
-        while (task := await self.get_comparison_summary_task(task.id)).task_state != "COMPLETE":
-            await sleep(self.status_poll_delay)
+        task = await self._http.poll_task(self.get_comparison_summary_task, task.id)
         if not task.result.successful:
             msg = f"Comparison Summary task {task.id} completed with errors: {task.result.error}."
             logger.error(msg)
@@ -271,7 +264,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param task_id: The ID of the comparison summary task.
         :return: The report task information.
         """
-        res = await self._get(f"{self._url}/alm/summaryReportTasks/{task_id}")
+        res = await self._http.get(f"{self._url}/alm/summaryReportTasks/{task_id}")
         return ReportTask.model_validate(res["task"])
 
     async def get_comparison_summary(self, task: ReportTask) -> SummaryReport:
@@ -280,7 +273,7 @@ class _AsyncAlmClient(_AsyncBaseClient):
         :param task: The summary task object containing the task ID.
         :return: The binary content of the comparison summary.
         """
-        res = await self._get(
+        res = await self._http.get(
             f"{self._url}/alm/summaryReports/"
             f"{task.result.target_revision_id}/{task.result.source_revision_id}"
         )

{anaplan_sdk-0.5.0a1 → anaplan_sdk-0.5.0a3}/anaplan_sdk/_async_clients/_audit.py

@@ -1,18 +1,16 @@
 from typing import Any, Literal
 
-import httpx
-
-from anaplan_sdk._base import _AsyncBaseClient
+from anaplan_sdk._services import _AsyncHttpService
 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:
+class _AsyncAuditClient:
+    def __init__(self, http: _AsyncHttpService) -> None:
+        self._http = http
         self._limit = 10_000
         self._url = "https://audit.anaplan.com/audit/api/1/events"
-        super().__init__(retry_count, client)
 
     async def get_users(self, search_pattern: str | None = None) -> list[User]:
         """
@@ -26,7 +24,7 @@ class _AsyncAuditClient(_AsyncBaseClient):
         params = {"s": search_pattern} if search_pattern else None
         return [
             User.model_validate(e)
-            for e in await self._get_paginated(
+            for e in await self._http.get_paginated(
                 "https://api.anaplan.com/2/0/users", "users", params=params
             )
         ]
@@ -37,7 +35,7 @@ class _AsyncAuditClient(_AsyncBaseClient):
         :return: The requested or currently authenticated User.
         """
         return User.model_validate(
-            (await self._get(f"https://api.anaplan.com/2/0/users/{user_id}")).get("user")
+            (await self._http.get(f"https://api.anaplan.com/2/0/users/{user_id}")).get("user")
         )
 
     async def get_events(
@@ -51,7 +49,7 @@ class _AsyncAuditClient(_AsyncBaseClient):
         :return: A list of log entries, each containing a dictionary with event details.
         """
         return list(
-            await self._get_paginated(
+            await self._http.get_paginated(
                 self._url,
                 "response",
                 params={"type": event_type, "intervalInHours": days_into_past * 24},