anaplan-sdk 0.2.8__py3-none-any.whl → 0.2.10__py3-none-any.whl

anaplan_sdk/_async_clients/_alm.py

@@ -1,8 +1,12 @@
+import warnings
+
 import httpx
 
 from anaplan_sdk._base import _AsyncBaseClient
 from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
 
+warnings.filterwarnings("always", category=DeprecationWarning)
+
 
 class _AsyncAlmClient(_AsyncBaseClient):
     def __init__(self, client: httpx.AsyncClient, model_id: str, retry_count: int) -> None:
@@ -15,6 +19,12 @@ class _AsyncAlmClient(_AsyncBaseClient):
         Lists all the Users in the authenticated users default tenant.
         :return: The List of Users.
         """
+        warnings.warn(
+            "`list_users()` on the ALM client is deprecated and will be removed in a "
+            "future version. Use `list_users()` on the Audit client instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
         return [
             User.model_validate(e)
             for e in (await self._get("https://api.anaplan.com/2/0/users")).get("users")

anaplan_sdk/_async_clients/_audit.py

@@ -6,6 +6,7 @@ from typing import Literal
 import httpx
 
 from anaplan_sdk._base import _AsyncBaseClient
+from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
 
@@ -17,6 +18,43 @@ class _AsyncAuditClient(_AsyncBaseClient):
         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("https://api.anaplan.com/2/0/users")).get("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.
+        """
+        total = await self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return await self._get_result_page(days_into_past, event_type)
+
+        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))
+                    )
+                )
+            )
+        )
+
     async def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
         return (  # noqa
             await self._get(
@@ -47,30 +85,3 @@ class _AsyncAuditClient(_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(days_into_past, event_type)
-
-        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

@@ -133,6 +133,7 @@ class AsyncClient(_AsyncBaseClient):
         client._transactional_client = _AsyncTransactionalClient(
             existing._client, model_id, existing._retry_count
         )
+        client._alm_client = _AsyncAlmClient(existing._client, model_id, existing._retry_count)
         return client
 
     @property

anaplan_sdk/_clients/_alm.py

@@ -1,8 +1,12 @@
+import warnings
+
 import httpx
 
 from anaplan_sdk._base import _BaseClient
 from anaplan_sdk.models import ModelRevision, Revision, SyncTask, User
 
+warnings.filterwarnings("always", category=DeprecationWarning)
+
 
 class _AlmClient(_BaseClient):
     def __init__(self, client: httpx.Client, model_id: str, retry_count: int) -> None:
@@ -15,6 +19,12 @@ class _AlmClient(_BaseClient):
         Lists all the Users in the authenticated users default tenant.
         :return: The List of Users.
         """
+        warnings.warn(
+            "`list_users()` on the ALM client is deprecated and will be removed in a "
+            "future version. Use `list_users()` on the Audit client instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
         return [
             User.model_validate(e)
             for e in self._get("https://api.anaplan.com/2/0/users").get("users")

anaplan_sdk/_clients/_audit.py

@@ -5,6 +5,7 @@ from typing import Literal
 import httpx
 
 from anaplan_sdk._base import _BaseClient
+from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
 
@@ -17,6 +18,42 @@ class _AuditClient(_BaseClient):
         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("https://api.anaplan.com/2/0/users").get("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.
+        """
+        total = self._get_total(days_into_past, event_type)
+        if total == 0:
+            return []
+        if total <= 10_000:
+            return self._get_result_page(days_into_past, event_type)
+
+        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))
+
     def _get_total(self, days_into_past: int = 60, event_type: Event = "all") -> int:
         return (  # noqa
             self._get(
@@ -47,29 +84,3 @@ 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(days_into_past, event_type)
-
-        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

@@ -140,6 +140,7 @@ class Client(_BaseClient):
         client._transactional_client = _TransactionalClient(
             existing._client, model_id, existing._retry_count
         )
+        client._alm_client = _AlmClient(existing._client, model_id, existing._retry_count)
         return client
 
     @property

{anaplan_sdk-0.2.8.dist-info → anaplan_sdk-0.2.10.dist-info}/METADATA

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.8
+Version: 0.2.10
 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
 Project-URL: Documentation, https://vinzenzklass.github.io/anaplan-sdk/
-Author-email: Vinzenz Klass <vinzenz.klass@ba.valantic.com>
+Author-email: Vinzenz Klass <vinzenz.klass@valantic.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
-Keywords: anaplan,anaplan alm api,anaplan api,anaplan bulk api,anaplan integration
+Keywords: anaplan,anaplan alm api,anaplan api,anaplan audit api,anaplan bulk api,anaplan integration
 Requires-Python: >=3.10.4
 Requires-Dist: cryptography<45.0.0,>=42.0.7
 Requires-Dist: httpx<1.0.0,>=0.27.0

anaplan_sdk-0.2.10.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=HtpwKNCc5eb6DUgS8nqNocxzaoaHOAMQPo0SaTMaD-A,4021
+anaplan_sdk/_async_clients/_audit.py,sha256=wgJx58aDksWJLu4MU-tOz76KjG41AVzBW0v3jAEv9GE,2897
+anaplan_sdk/_async_clients/_bulk.py,sha256=kviZxMbTolz9ZmbtE_hhOxbnmZghToRo3mxIhVADzho,22299
+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=wzhibRuNzsK3PZM2EOI3OnSGHfv8CG2fuY5zLbnSqog,3912
+anaplan_sdk/_clients/_audit.py,sha256=jqj_sTGNUaM2jAu91Us747pVULntPUkL_qkA4nKc8so,2981
+anaplan_sdk/_clients/_bulk.py,sha256=hTepWQZ-IxAs2WPqsuTfWF3ExuWWrNiMD9I4viQpUAQ,22314
+anaplan_sdk/_clients/_transactional.py,sha256=4NYhq2HdxNh4K-HqMyYoyAEqKih2eTtFiXDZi8xOaf8,4695
+anaplan_sdk-0.2.10.dist-info/METADATA,sha256=MmE2KsCg0OfKUgnE_hc4TOCRQROmIY35hKAZ3fCRQD0,3618
+anaplan_sdk-0.2.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.2.10.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.2.10.dist-info/RECORD,,

anaplan_sdk-0.2.8.dist-info/RECORD

@@ -1,19 +0,0 @@
-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=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=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=Vcrn3TjHlH365O7F1TKc1WiZWURNqQf_gSc8UUVESM8,3564
-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.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,,