anaplan-sdk 0.5.0a6__tar.gz → 0.5.1__tar.gz

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/.github/workflows/tests.yml

@@ -34,4 +34,4 @@ jobs:
           pip install uv
           uv sync
       - name: "Run tests"
-        run: "uv run python -m pytest -n 12 --dist loadfile tests/"
+        run: "uv run python -m pytest -n 15 --dist loadfile tests/"

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a6
+Version: 0.5.1
 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
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 </h3>
 
 <p align="center" style="font-size: 1.2rem; font-weight: 300; margin: 15px 0">
-    Streamlined Python Interface for Anaplan
+    Streamlined Python Interface for the Anaplan API.
 </p>
 
 <div align="center">
@@ -45,9 +45,11 @@ Description-Content-Type: text/markdown
 </div>
 
 ---
+Streamlined Python Interface for the Anaplan API. Get up and running with the Anaplan API in minutes.
 
 Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. It delivers high-level
-abstractions over all Anaplan APIs, allowing you to focus on business requirements rather than implementation details.
+abstractions over all parts of the Anaplan API, allowing you to focus on business requirements rather than
+implementation details.
 
 ## Key Features
 

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/README.md

@@ -7,7 +7,7 @@
 </h3>
 
 <p align="center" style="font-size: 1.2rem; font-weight: 300; margin: 15px 0">
-    Streamlined Python Interface for Anaplan
+    Streamlined Python Interface for the Anaplan API.
 </p>
 
 <div align="center">
@@ -23,9 +23,11 @@
 </div>
 
 ---
+Streamlined Python Interface for the Anaplan API. Get up and running with the Anaplan API in minutes.
 
 Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. It delivers high-level
-abstractions over all Anaplan APIs, allowing you to focus on business requirements rather than implementation details.
+abstractions over all parts of the Anaplan API, allowing you to focus on business requirements rather than
+implementation details.
 
 ## Key Features
 

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/__init__.py

@@ -2,6 +2,7 @@ from ._async_clients import AsyncClient
 from ._auth import AnaplanLocalOAuth, AnaplanRefreshTokenAuth
 from ._clients import Client
 from ._oauth import AsyncOauth, Oauth
+from .models.scim import field
 
 __all__ = [
     "AsyncClient",
@@ -12,4 +13,5 @@ __all__ = [
     "Oauth",
     "models",
     "exceptions",
+    "field",
 ]

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/_async_clients/__init__.py

@@ -2,6 +2,8 @@ from ._alm import _AsyncAlmClient
 from ._audit import _AsyncAuditClient
 from ._bulk import AsyncClient
 from ._cloud_works import _AsyncCloudWorksClient
+from ._cw_flow import _AsyncFlowClient
+from ._scim import _AsyncScimClient
 from ._transactional import _AsyncTransactionalClient
 
 __all__ = [
@@ -9,5 +11,7 @@ __all__ = [
     "_AsyncAlmClient",
     "_AsyncAuditClient",
     "_AsyncCloudWorksClient",
+    "_AsyncFlowClient",
     "_AsyncTransactionalClient",
+    "_AsyncScimClient",
 ]

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/_async_clients/_audit.py

@@ -11,7 +11,6 @@ UserSortBy = Literal["first_name", "last_name", "email", "active", "last_login_d
 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"
 
     async def get_users(

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/_async_clients/_bulk.py

@@ -26,6 +26,7 @@ from anaplan_sdk.models import (
 from ._alm import _AsyncAlmClient
 from ._audit import _AsyncAuditClient
 from ._cloud_works import _AsyncCloudWorksClient
+from ._scim import _AsyncScimClient
 from ._transactional import _AsyncTransactionalClient
 
 SortBy = Literal["id", "name"] | None
@@ -135,7 +136,8 @@ class AsyncClient:
             _AsyncTransactionalClient(self._http, model_id) if model_id else None
         )
         self._alm_client = _AsyncAlmClient(self._http, model_id) if model_id else None
-        self._audit = _AsyncAuditClient(self._http)
+        self._audit_client = _AsyncAuditClient(self._http)
+        self._scim_client = _AsyncScimClient(self._http)
         self._cloud_works = _AsyncCloudWorksClient(self._http)
         self.upload_chunk_size = upload_chunk_size
         self.allow_file_creation = allow_file_creation
@@ -169,7 +171,7 @@ class AsyncClient:
         The Audit Client provides access to the Anaplan Audit API.
         For details, see https://vinzenzklass.github.io/anaplan-sdk/guides/audit/.
         """
-        return self._audit
+        return self._audit_client
 
     @property
     def cw(self) -> _AsyncCloudWorksClient:
@@ -218,6 +220,15 @@ class AsyncClient:
             )
         return self._alm_client
 
+    @property
+    def scim(self) -> _AsyncScimClient:
+        """
+        To use the SCIM API, you must be User Admin. The SCIM API allows managing internal users.
+        Visiting users are excluded from the SCIM API.
+        :return: The SCIM Client.
+        """
+        return self._scim_client
+
     async def get_workspaces(
         self,
         search_pattern: str | None = None,

anaplan_sdk-0.5.1/anaplan_sdk/_async_clients/_scim.py

@@ -0,0 +1,148 @@
+import logging
+from asyncio import gather
+from itertools import chain
+from typing import Any
+
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import construct_payload
+from anaplan_sdk.models.scim import (
+    Operation,
+    ReplaceUserInput,
+    Resource,
+    Schema,
+    ServiceProviderConfig,
+    User,
+    UserInput,
+    field,
+)
+
+logger = logging.getLogger("anaplan_sdk")
+
+
+class _AsyncScimClient:
+    def __init__(self, http: _AsyncHttpService) -> None:
+        self._http = http
+        self._url = "https://api.anaplan.com/scim/1/0/v2"
+
+    async def get_service_provider_config(self) -> ServiceProviderConfig:
+        """
+        Get the SCIM Service Provider Configuration.
+        :return: The ServiceProviderConfig object describing the available SCIM features.
+        """
+        res = await self._http.get(f"{self._url}/ServiceProviderConfig")
+        return ServiceProviderConfig.model_validate(res)
+
+    async def get_resource_types(self) -> list[Resource]:
+        """
+        Get the SCIM Resource Types.
+        :return: A list of Resource objects describing the SCIM resource types.
+        """
+        res = await self._http.get(f"{self._url}/ResourceTypes")
+        return [Resource.model_validate(e) for e in res.get("Resources", [])]
+
+    async def get_resource_schemas(self) -> list[Schema]:
+        """
+        Get the SCIM Resource Schemas.
+        :return: A list of Schema objects describing the SCIM resource schemas.
+        """
+        res = await self._http.get(f"{self._url}/Schemas")
+        return [Schema.model_validate(e) for e in res.get("Resources", [])]
+
+    async def get_users(self, predicate: str | field = None, page_size: int = 100) -> list[User]:
+        """
+        Get a list of users, optionally filtered by a predicate. Keep in mind that this will only
+        return internal users. To get a list of all users in the tenant, use the `get_users()`
+        in the `audit` namespace instead.
+        :param predicate: A filter predicate to filter the users. This can either be a string,
+               in which case it will be passed as-is, or an expression. Anaplan supports filtering
+               on the following fields: "id", "externalId", "userName", "name.familyName",
+               "name.givenName" and "active". It supports the operators "eq", "ne", "gt", "ge",
+               "lt", "le" and "pr". It supports logical operators "and" and "or", "not" is not
+               supported. It supports grouping with parentheses.
+        :param page_size: The number of users to fetch per page. Values above 100 will error.
+        :return: The internal users optionally matching the filter.
+        """
+        params: dict[str, int | str] = {"startIndex": 1, "count": page_size}
+        if predicate is not None:
+            _predicate = predicate if isinstance(predicate, str) else str(predicate)
+            logger.debug(f"Searching for users with predicate: {_predicate}")
+            params["filter"] = _predicate
+        res = await self._http.get(f"{self._url}/Users", params=params)
+        users = [User.model_validate(e) for e in res.get("Resources", [])]
+        if (total := res["totalResults"]) <= page_size:
+            return users
+        pages = await gather(
+            *(
+                self._http.get(
+                    f"{self._url}/Users", params=(params | {"startIndex": i, "count": page_size})
+                )
+                for i in range(page_size + 1, total + 1, page_size)
+            )
+        )
+        for user in chain(*(p.get("Resources", []) for p in pages)):
+            users.append(User.model_validate(user))
+        return users
+
+    async def get_user(self, user_id: str) -> User:
+        """
+        Get a user by their ID.
+        :param user_id: The ID of the user to fetch.
+        :return: The User object.
+        """
+        res = await self._http.get(f"{self._url}/Users/{user_id}")
+        return User.model_validate(res)
+
+    async def add_user(self, user: UserInput | dict[str, Any]) -> User:
+        """
+        Add a new user to your Anaplan tenant.
+        :param user: The user info to add. Can either be a UserInput object or a dict. If you pass
+               a dict, it will be validated against the UserInput model before sending. If the info
+               you provided is invalid or incomplete, this will raise a pydantic.ValidationError.
+        :return: The created User object.
+        """
+        res = await self._http.post(f"{self._url}/Users", json=construct_payload(UserInput, user))
+        user = User.model_validate(res)
+        logger.info(f"Added user '{user.user_name}' with ID '{user.id}'.")
+        return user
+
+    async def replace_user(self, user_id: str, user: ReplaceUserInput | dict[str, Any]):
+        """
+        Replace an existing user with new information. Note that this will replace all fields of the
+        :param user_id: ID of the user to replace.
+        :param user: The new user info. Can either be a ReplaceUserInput object or a dict. If you
+               pass a dict, it will be validated against the ReplaceUserInput model before sending.
+               If the info you provided is invalid or incomplete, this will raise a
+               pydantic.ValidationError.
+        :return: The updated User object.
+        """
+        res = await self._http.put(
+            f"{self._url}/Users/{user_id}", json=construct_payload(ReplaceUserInput, user)
+        )
+        user = User.model_validate(res)
+        logger.info(f"Replaced user with ID '{user_id}' with '{user.user_name}'.")
+        return user
+
+    async def update_user(
+        self, user_id: str, operations: list[Operation] | list[dict[str, Any]]
+    ) -> User:
+        """
+        Update an existing user with a list of operations. This allows you to update only specific
+        fields of the user without replacing the entire user.
+        :param user_id: The ID of the user to update.
+        :param operations: A list of operations to perform on the user. Each operation can either be
+               an Operation object or a dict. If you pass a dict, it will be validated against
+               the Operation model before sending. If the operation is invalid, this will raise a
+               pydantic.ValidationError. You can also use the models Replace, Add and Remove which
+               are subclasses of Operation and provide a more convenient way to create operations.
+        :return: The updated User object.
+        """
+        res = await self._http.patch(
+            f"{self._url}/Users/{user_id}",
+            json={
+                "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+                "Operations": [construct_payload(Operation, e) for e in operations],
+            },
+        )
+        user = User.model_validate(res)
+        logger.info(f"Updated user with ID '{user_id}'.")
+        return user

anaplan_sdk-0.5.1/anaplan_sdk/_clients/__init__.py

@@ -0,0 +1,17 @@
+from ._alm import _AlmClient
+from ._audit import _AuditClient
+from ._bulk import Client
+from ._cloud_works import _CloudWorksClient
+from ._cw_flow import _FlowClient
+from ._scim import _ScimClient
+from ._transactional import _TransactionalClient
+
+__all__ = [
+    "Client",
+    "_AlmClient",
+    "_AuditClient",
+    "_CloudWorksClient",
+    "_FlowClient",
+    "_ScimClient",
+    "_TransactionalClient",
+]

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/_clients/_bulk.py

@@ -27,6 +27,7 @@ from anaplan_sdk.models import (
 from ._alm import _AlmClient
 from ._audit import _AuditClient
 from ._cloud_works import _CloudWorksClient
+from ._scim import _ScimClient
 from ._transactional import _TransactionalClient
 
 SortBy = Literal["id", "name"] | None
@@ -139,9 +140,10 @@ class Client:
             _TransactionalClient(self._http, model_id) if model_id else None
         )
         self._alm_client = _AlmClient(self._http, model_id) if model_id else None
+        self._audit_client = _AuditClient(self._http)
+        self._scim_client = _ScimClient(self._http)
         self._cloud_works = _CloudWorksClient(self._http)
         self._thread_count = multiprocessing.cpu_count()
-        self._audit = _AuditClient(self._http)
         self.status_poll_delay = status_poll_delay
         self.upload_parallel = upload_parallel
         self.upload_chunk_size = upload_chunk_size
@@ -174,7 +176,7 @@ class Client:
         The Audit Client provides access to the Anaplan Audit API.
         For details, see https://vinzenzklass.github.io/anaplan-sdk/guides/audit/.
         """
-        return self._audit
+        return self._audit_client
 
     @property
     def cw(self) -> _CloudWorksClient:
@@ -223,6 +225,15 @@ class Client:
             )
         return self._alm_client
 
+    @property
+    def scim(self) -> _ScimClient:
+        """
+        To use the SCIM API, you must be User Admin. The SCIM API allows managing internal users.
+        Visiting users are excluded from the SCIM API.
+        :return: The SCIM Client.
+        """
+        return self._scim_client
+
     def get_workspaces(
         self,
         search_pattern: str | None = None,

anaplan_sdk-0.5.1/anaplan_sdk/_clients/_scim.py

@@ -0,0 +1,145 @@
+import logging
+from concurrent.futures import ThreadPoolExecutor
+from itertools import chain
+from typing import Any
+
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import construct_payload
+from anaplan_sdk.models.scim import (
+    Operation,
+    ReplaceUserInput,
+    Resource,
+    Schema,
+    ServiceProviderConfig,
+    User,
+    UserInput,
+    field,
+)
+
+logger = logging.getLogger("anaplan_sdk")
+
+
+class _ScimClient:
+    def __init__(self, http: _HttpService) -> None:
+        self._http = http
+        self._url = "https://api.anaplan.com/scim/1/0/v2"
+
+    def get_service_provider_config(self) -> ServiceProviderConfig:
+        """
+        Get the SCIM Service Provider Configuration.
+        :return: The ServiceProviderConfig object describing the available SCIM features.
+        """
+        res = self._http.get(f"{self._url}/ServiceProviderConfig")
+        return ServiceProviderConfig.model_validate(res)
+
+    def get_resource_types(self) -> list[Resource]:
+        """
+        Get the SCIM Resource Types.
+        :return: A list of Resource objects describing the SCIM resource types.
+        """
+        res = self._http.get(f"{self._url}/ResourceTypes")
+        return [Resource.model_validate(e) for e in res.get("Resources", [])]
+
+    def get_resource_schemas(self) -> list[Schema]:
+        """
+        Get the SCIM Resource Schemas.
+        :return: A list of Schema objects describing the SCIM resource schemas.
+        """
+        res = self._http.get(f"{self._url}/Schemas")
+        return [Schema.model_validate(e) for e in res.get("Resources", [])]
+
+    def get_users(self, predicate: str | field = None, page_size: int = 100) -> list[User]:
+        """
+        Get a list of users, optionally filtered by a predicate. Keep in mind that this will only
+        return internal users. To get a list of all users in the tenant, use the `get_users()`
+        in the `audit` namespace instead.
+        :param predicate: A filter predicate to filter the users. This can either be a string,
+               in which case it will be passed as-is, or an expression. Anaplan supports filtering
+               on the following fields: "id", "externalId", "userName", "name.familyName",
+               "name.givenName" and "active". It supports the operators "eq", "ne", "gt", "ge",
+               "lt", "le" and "pr". It supports logical operators "and" and "or", "not" is not
+               supported. It supports grouping with parentheses.
+        :param page_size: The number of users to fetch per page. Values above 100 will error.
+        :return: The internal users optionally matching the filter.
+        """
+        params: dict[str, int | str] = {"startIndex": 1, "count": page_size}
+        if predicate is not None:
+            _predicate = predicate if isinstance(predicate, str) else str(predicate)
+            logger.debug(f"Searching for users with predicate: {_predicate}")
+            params["filter"] = _predicate
+        res = self._http.get(f"{self._url}/Users", params=params)
+        users = [User.model_validate(e) for e in res.get("Resources", [])]
+        if (total := res["totalResults"]) <= page_size:
+            return users
+        with ThreadPoolExecutor() as executor:
+            pages = executor.map(
+                lambda i: self._http.get(
+                    f"{self._url}/Users", params=(params | {"startIndex": i, "count": page_size})
+                ),
+                range(page_size + 1, total + 1, page_size),
+            )
+        for user in chain(*(p.get("Resources", []) for p in pages)):
+            users.append(User.model_validate(user))
+        return users
+
+    def get_user(self, user_id: str) -> User:
+        """
+        Get a user by their ID.
+        :param user_id: The ID of the user to fetch.
+        :return: The User object.
+        """
+        res = self._http.get(f"{self._url}/Users/{user_id}")
+        return User.model_validate(res)
+
+    def add_user(self, user: UserInput | dict[str, Any]) -> User:
+        """
+        Add a new user to your Anaplan tenant.
+        :param user: The user info to add. Can either be a UserInput object or a dict. If you pass
+               a dict, it will be validated against the UserInput model before sending. If the info
+               you provided is invalid or incomplete, this will raise a pydantic.ValidationError.
+        :return: The created User object.
+        """
+        res = self._http.post(f"{self._url}/Users", json=construct_payload(UserInput, user))
+        user = User.model_validate(res)
+        logger.info(f"Added user '{user.user_name}' with ID '{user.id}'.")
+        return user
+
+    def replace_user(self, user_id: str, user: ReplaceUserInput | dict[str, Any]):
+        """
+        Replace an existing user with new information. Note that this will replace all fields of the
+        :param user_id: ID of the user to replace.
+        :param user: The new user info. Can either be a ReplaceUserInput object or a dict. If you
+               pass a dict, it will be validated against the ReplaceUserInput model before sending.
+               If the info you provided is invalid or incomplete, this will raise a
+               pydantic.ValidationError.
+        :return: The updated User object.
+        """
+        res = self._http.put(
+            f"{self._url}/Users/{user_id}", json=construct_payload(ReplaceUserInput, user)
+        )
+        user = User.model_validate(res)
+        logger.info(f"Replaced user with ID '{user_id}' with '{user.user_name}'.")
+        return user
+
+    def update_user(self, user_id: str, operations: list[Operation] | list[dict[str, Any]]) -> User:
+        """
+        Update an existing user with a list of operations. This allows you to update only specific
+        fields of the user without replacing the entire user.
+        :param user_id: The ID of the user to update.
+        :param operations: A list of operations to perform on the user. Each operation can either be
+               an Operation object or a dict. If you pass a dict, it will be validated against
+               the Operation model before sending. If the operation is invalid, this will raise a
+               pydantic.ValidationError. You can also use the models Replace, Add and Remove which
+               are subclasses of Operation and provide a more convenient way to create operations.
+        :return: The updated User object.
+        """
+        res = self._http.patch(
+            f"{self._url}/Users/{user_id}",
+            json={
+                "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+                "Operations": [construct_payload(Operation, e) for e in operations],
+            },
+        )
+        user = User.model_validate(res)
+        logger.info(f"Updated user with ID '{user_id}'.")
+        return user

{anaplan_sdk-0.5.0a6 → anaplan_sdk-0.5.1}/anaplan_sdk/_services.py

@@ -257,7 +257,7 @@ def _extract_first_page(
     actual_page_size = res["meta"]["paging"]["currentPageSize"]
     if actual_page_size < page_size and not actual_page_size == total_items:
         logger.warning(
-            f"Page size {page_size} was silently truncated to {actual_page_size}."
+            f"Page size {page_size} was silently truncated to {actual_page_size}. "
             f"Using the server-side enforced page size {actual_page_size} for further requests."
         )
     logger.debug(f"Found {total_items} total items, retrieved {len(first_page)} in first page.")