anaplan-sdk 0.5.0a4__py3-none-any.whl → 0.5.0a6__py3-none-any.whl

anaplan_sdk/_async_clients/_alm.py

@@ -1,7 +1,8 @@
 import logging
 from typing import Literal, overload
 
-from anaplan_sdk._services import _AsyncHttpService, sort_params
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import sort_params
 from anaplan_sdk.exceptions import AnaplanActionError
 from anaplan_sdk.models import (
     ModelRevision,

anaplan_sdk/_async_clients/_audit.py

@@ -1,6 +1,7 @@
 from typing import Any, Literal
 
-from anaplan_sdk._services import _AsyncHttpService, sort_params
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import sort_params
 from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
@@ -21,7 +22,9 @@ class _AsyncAuditClient:
     ) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
-        :param search_pattern: Optionally filter for specific users. When provided,
+        :param search_pattern: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific users. When provided,
                case-insensitive matches users with emails or names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all users.

anaplan_sdk/_async_clients/_bulk.py

@@ -7,7 +7,8 @@ import httpx
 from typing_extensions import Self
 
 from anaplan_sdk._auth import _create_auth
-from anaplan_sdk._services import _AsyncHttpService, action_url, sort_params
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import action_url, models_url, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
     Action,
@@ -142,34 +143,24 @@ class AsyncClient:
             f"Initialized AsyncClient with workspace_id={workspace_id}, model_id={model_id}"
         )
 
-    @classmethod
-    def from_existing(
-        cls, existing: Self, *, workspace_id: str | None = None, model_id: str | None = None
-    ) -> Self:
+    def with_model(self, model_id: str | None = None, workspace_id: str | None = None) -> Self:
         """
-        Create a new instance of the Client from an existing instance. This is useful if you want
-        to interact with multiple models or workspaces in the same script but share the same
-        authentication and configuration. This creates a shallow copy of the existing client and
-        optionally updates the relevant attributes to the new workspace and model. You can provide
-        either a new workspace Id or a new model Id, or both. If you do not provide one of them,
-        the existing value will be used. If you omit both, the new instance will be an identical
-        copy of the existing instance.
-
-        :param existing: The existing instance to copy.
+        Create a new instance of the Client with the given model and workspace Ids. **This creates
+        a copy of the current client. The current instance remains unchanged.**
         :param workspace_id: The workspace Id to use or None to use the existing workspace Id.
         :param model_id: The model Id to use or None to use the existing model Id.
         :return: A new instance of the Client.
         """
-        client = copy(existing)
-        new_ws_id = workspace_id or existing._workspace_id
-        new_model_id = model_id or existing._model_id
+        client = copy(self)
+        new_ws_id = workspace_id or self._workspace_id
+        new_model_id = model_id or self._model_id
         logger.debug(
             f"Creating a new AsyncClient from existing instance "
             f"with workspace_id={new_ws_id}, model_id={new_model_id}."
         )
         client._url = f"https://api.anaplan.com/2/0/workspaces/{new_ws_id}/models/{new_model_id}"
-        client._transactional_client = _AsyncTransactionalClient(existing._http, new_model_id)
-        client._alm_client = _AsyncAlmClient(existing._http, new_model_id)
+        client._transactional_client = _AsyncTransactionalClient(self._http, new_model_id)
+        client._alm_client = _AsyncAlmClient(self._http, new_model_id)
         return client
 
     @property
@@ -235,7 +226,9 @@ class AsyncClient:
     ) -> list[Workspace]:
         """
         Lists all the Workspaces the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific workspaces. When provided,
+        :param search_pattern: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific workspaces. When provided,
                case-insensitive matches workspaces with names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all users.
@@ -253,13 +246,19 @@ class AsyncClient:
 
     async def get_models(
         self,
+        only_in_workspace: bool | str = False,
         search_pattern: str | None = None,
         sort_by: Literal["active_state", "name"] | None = None,
         descending: bool = False,
     ) -> list[Model]:
         """
         Lists all the Models the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific models. When provided,
+        :param only_in_workspace: If True, only lists models in the workspace provided when
+               instantiating the client. If a string is provided, only lists models in the workspace
+               with the given Id. If False (default), lists models in all workspaces the user
+        :param search_pattern:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific models. When provided,
                case-insensitive matches model names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all models.
@@ -271,7 +270,7 @@ class AsyncClient:
         if search_pattern:
             params["s"] = search_pattern
         res = await self._http.get_paginated(
-            "https://api.anaplan.com/2/0/models", "models", params=params
+            models_url(only_in_workspace, self._workspace_id), "models", params=params
         )
         return [Model.model_validate(e) for e in res]
 

anaplan_sdk/_async_clients/_cloud_works.py

@@ -1,8 +1,8 @@
 import logging
 from typing import Any, Literal
 
-from anaplan_sdk._services import (
-    _AsyncHttpService,
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import (
     connection_body_payload,
     construct_payload,
     integration_payload,

anaplan_sdk/_async_clients/_cw_flow.py

@@ -1,7 +1,8 @@
 import logging
 from typing import Any
 
-from anaplan_sdk._services import _AsyncHttpService, construct_payload
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import construct_payload
 from anaplan_sdk.models.flows import Flow, FlowInput, FlowSummary
 
 logger = logging.getLogger("anaplan_sdk")

anaplan_sdk/_async_clients/_transactional.py

@@ -3,8 +3,8 @@ from asyncio import gather
 from itertools import chain
 from typing import Any, Literal, overload
 
-from anaplan_sdk._services import (
-    _AsyncHttpService,
+from anaplan_sdk._services import _AsyncHttpService
+from anaplan_sdk._utils import (
     parse_calendar_response,
     parse_insertion_response,
     sort_params,

anaplan_sdk/_clients/_alm.py

@@ -1,7 +1,8 @@
 import logging
 from typing import Literal, overload
 
-from anaplan_sdk._services import _HttpService, sort_params
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import sort_params
 from anaplan_sdk.exceptions import AnaplanActionError
 from anaplan_sdk.models import (
     ModelRevision,

anaplan_sdk/_clients/_audit.py

@@ -1,6 +1,7 @@
 from typing import Any, Literal
 
-from anaplan_sdk._services import _HttpService, sort_params
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import sort_params
 from anaplan_sdk.models import User
 
 Event = Literal["all", "byok", "user_activity"]
@@ -21,7 +22,9 @@ class _AuditClient:
     ) -> list[User]:
         """
         Lists all the Users in the authenticated users default tenant.
-        :param search_pattern: Optionally filter for specific users. When provided,
+        :param search_pattern: **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific users. When provided,
                case-insensitive matches users with emails or names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all users.

anaplan_sdk/_clients/_bulk.py

@@ -8,7 +8,8 @@ import httpx
 from typing_extensions import Self
 
 from anaplan_sdk._auth import _create_auth
-from anaplan_sdk._services import _HttpService, action_url, sort_params
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import action_url, models_url, sort_params
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
 from anaplan_sdk.models import (
     Action,
@@ -147,34 +148,24 @@ class Client:
         self.allow_file_creation = allow_file_creation
         logger.debug(f"Initialized Client with workspace_id={workspace_id}, model_id={model_id}")
 
-    @classmethod
-    def from_existing(
-        cls, existing: Self, *, workspace_id: str | None = None, model_id: str | None = None
-    ) -> Self:
+    def with_model(self, model_id: str | None = None, workspace_id: str | None = None) -> Self:
         """
-        Create a new instance of the Client from an existing instance. This is useful if you want
-        to interact with multiple models or workspaces in the same script but share the same
-        authentication and configuration. This creates a shallow copy of the existing client and
-        optionally updates the relevant attributes to the new workspace and model. You can provide
-        either a new workspace Id or a new model Id, or both. If you do not provide one of them,
-        the existing value will be used. If you omit both, the new instance will be an identical
-        copy of the existing instance.
-
-        :param existing: The existing instance to copy.
+        Create a new instance of the Client with the given model and workspace Ids. **This creates
+        a copy of the current client. The current instance remains unchanged.**
         :param workspace_id: The workspace Id to use or None to use the existing workspace Id.
         :param model_id: The model Id to use or None to use the existing model Id.
         :return: A new instance of the Client.
         """
-        client = copy(existing)
-        new_ws_id = workspace_id or existing._workspace_id
-        new_model_id = model_id or existing._model_id
+        client = copy(self)
+        new_ws_id = workspace_id or self._workspace_id
+        new_model_id = model_id or self._model_id
         logger.debug(
             f"Creating a new AsyncClient from existing instance "
             f"with workspace_id={new_ws_id}, model_id={new_model_id}."
         )
         client._url = f"https://api.anaplan.com/2/0/workspaces/{new_ws_id}/models/{new_model_id}"
-        client._transactional_client = _TransactionalClient(existing._http, new_model_id)
-        client._alm_client = _AlmClient(existing._http, new_model_id)
+        client._transactional_client = _TransactionalClient(self._http, new_model_id)
+        client._alm_client = _AlmClient(self._http, new_model_id)
         return client
 
     @property
@@ -240,7 +231,9 @@ class Client:
     ) -> list[Workspace]:
         """
         Lists all the Workspaces the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific workspaces. When provided,
+        :param search_pattern:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific workspaces. When provided,
                case-insensitive matches workspaces with names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all users.
@@ -258,13 +251,19 @@ class Client:
 
     def get_models(
         self,
+        only_in_workspace: bool | str = False,
         search_pattern: str | None = None,
         sort_by: Literal["active_state", "name"] | None = None,
         descending: bool = False,
     ) -> list[Model]:
         """
         Lists all the Models the authenticated user has access to.
-        :param search_pattern: Optionally filter for specific models. When provided,
+        :param only_in_workspace: If True, only lists models in the workspace provided when
+               instantiating the client. If a string is provided, only lists models in the workspace
+               with the given Id. If False (default), lists models in all workspaces the user
+        :param search_pattern:  **Caution: This is an undocumented Feature and may behave
+               unpredictably. It requires the Tenant Admin role. For non-admin users, it is
+               ignored.** Optionally filter for specific models. When provided,
                case-insensitive matches model names containing this string.
                You can use the wildcards `%` for 0-n characters, and `_` for exactly 1 character.
                When None (default), returns all models.
@@ -276,7 +275,7 @@ class Client:
         if search_pattern:
             params["s"] = search_pattern
         res = self._http.get_paginated(
-            "https://api.anaplan.com/2/0/models", "models", params=params
+            models_url(only_in_workspace, self._workspace_id), "models", params=params
         )
         return [Model.model_validate(e) for e in res]
 

anaplan_sdk/_clients/_cloud_works.py

@@ -1,8 +1,8 @@
 import logging
 from typing import Any, Literal
 
-from anaplan_sdk._services import (
-    _HttpService,
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import (
     connection_body_payload,
     construct_payload,
     integration_payload,

anaplan_sdk/_clients/_cw_flow.py

@@ -1,7 +1,8 @@
 import logging
 from typing import Any
 
-from anaplan_sdk._services import _HttpService, construct_payload
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import construct_payload
 from anaplan_sdk.models.flows import Flow, FlowInput, FlowSummary
 
 logger = logging.getLogger("anaplan_sdk")

anaplan_sdk/_clients/_transactional.py

@@ -3,8 +3,8 @@ from concurrent.futures import ThreadPoolExecutor
 from itertools import chain
 from typing import Any, Literal, overload
 
-from anaplan_sdk._services import (
-    _HttpService,
+from anaplan_sdk._services import _HttpService
+from anaplan_sdk._utils import (
     parse_calendar_response,
     parse_insertion_response,
     sort_params,

anaplan_sdk/_services.py

@@ -6,32 +6,13 @@ from concurrent.futures import ThreadPoolExecutor
 from gzip import compress
 from itertools import chain
 from math import ceil
-from typing import Any, Awaitable, Callable, Coroutine, Iterator, Literal, Type, TypeVar
+from typing import Any, Awaitable, Callable, Coroutine, Iterator, TypeVar
 
 import httpx
 from httpx import HTTPError, Response
-from pydantic.alias_generators import to_camel
 
 from .exceptions import AnaplanException, AnaplanTimeoutException, InvalidIdentifierException
-from .models import (
-    AnaplanModel,
-    InsertionResult,
-    ModelCalendar,
-    MonthsQuartersYearsCalendar,
-    TaskSummary,
-    WeeksGeneralCalendar,
-    WeeksGroupingCalendar,
-    WeeksPeriodsCalendar,
-)
-from .models.cloud_works import (
-    AmazonS3ConnectionInput,
-    AzureBlobConnectionInput,
-    ConnectionBody,
-    GoogleBigQueryConnectionInput,
-    IntegrationInput,
-    IntegrationProcessInput,
-    ScheduleInput,
-)
+from .models import TaskSummary
 
 SORT_WARNING = (
     "If you are sorting by a field that is potentially ambiguous (e.g., name), the order of "
@@ -47,7 +28,6 @@ logger = logging.getLogger("anaplan_sdk")
 _json_header = {"Content-Type": "application/json"}
 _gzip_header = {"Content-Type": "application/x-gzip"}
 
-T = TypeVar("T", bound=AnaplanModel)
 Task = TypeVar("Task", bound=TaskSummary)
 
 
@@ -134,15 +114,7 @@ class _HttpService:
         logger.debug(f"Fetching first page with limit={self._page_size} from {url}.")
         kwargs["params"] = (kwargs.get("params") or {}) | {"limit": self._page_size}
         res = self.get(url, **kwargs)
-        total_items, first_page = res["meta"]["paging"]["totalSize"], res.get(result_key, [])
-        actual_page_size = res["meta"]["paging"]["currentPageSize"]
-        if actual_page_size < self._page_size and not actual_page_size == total_items:
-            logger.warning(
-                f"Page size {self._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.")
-        return first_page, total_items, actual_page_size
+        return _extract_first_page(res, result_key, self._page_size)
 
     def __run_with_retry(self, func: Callable[..., Response], *args, **kwargs) -> Response:
         for i in range(max(self._retry_count, 1)):
@@ -159,7 +131,7 @@ class _HttpService:
                 return response
             except HTTPError as error:
                 if i >= self._retry_count - 1:
-                    raise_error(error)
+                    _raise_error(error)
                 url = args[0] or kwargs.get("url")
                 logger.info(f"Retrying for: {url}")
 
@@ -252,15 +224,7 @@ class _AsyncHttpService:
         logger.debug(f"Fetching first page with limit={self._page_size} from {url}.")
         kwargs["params"] = (kwargs.get("params") or {}) | {"limit": self._page_size}
         res = await self.get(url, **kwargs)
-        total_items, first_page = res["meta"]["paging"]["totalSize"], res.get(result_key, [])
-        actual_page_size = res["meta"]["paging"]["currentPageSize"]
-        if actual_page_size < self._page_size and not actual_page_size == total_items:
-            logger.warning(
-                f"Page size {self._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.")
-        return first_page, total_items, actual_page_size
+        return _extract_first_page(res, result_key, self._page_size)
 
     async def _run_with_retry(
         self, func: Callable[..., Coroutine[Any, Any, Response]], *args, **kwargs
@@ -279,109 +243,28 @@ class _AsyncHttpService:
                 return response
             except HTTPError as error:
                 if i >= self._retry_count - 1:
-                    raise_error(error)
+                    _raise_error(error)
                 url = args[0] or kwargs.get("url")
                 logger.info(f"Retrying for: {url}")
 
         raise AnaplanException("Exhausted all retries without a successful response or Error.")
 
 
-def sort_params(sort_by: str | None, descending: bool) -> dict[str, str | bool]:
-    """
-    Construct search parameters for sorting. This also converts snake_case to camelCase.
-    :param sort_by: The field to sort by, optionally in snake_case.
-    :param descending: Whether to sort in descending order.
-    :return: A dictionary of search parameters in Anaplan's expected format.
-    """
-    if not sort_by:
-        return {}
-    return {"sort": f"{'-' if descending else '+'}{to_camel(sort_by)}"}
-
-
-def construct_payload(model: Type[T], body: T | dict[str, Any]) -> dict[str, Any]:
-    """
-    Construct a payload for the given model and body.
-    :param model: The model class to use for validation.
-    :param body: The body to validate and optionally convert to a dictionary.
-    :return: A dictionary representation of the validated body.
-    """
-    if isinstance(body, dict):
-        body = model.model_validate(body)
-    return body.model_dump(exclude_none=True, by_alias=True)
-
-
-def connection_body_payload(body: ConnectionBody | dict[str, Any]) -> dict[str, Any]:
-    """
-    Construct a payload for the given integration body.
-    :param body: The body to validate and optionally convert to a dictionary.
-    :return: A dictionary representation of the validated body.
-    """
-    if isinstance(body, dict):
-        if "sasToken" in body:
-            body = AzureBlobConnectionInput.model_validate(body)
-        elif "secretAccessKey" in body:
-            body = AmazonS3ConnectionInput.model_validate(body)
-        else:
-            body = GoogleBigQueryConnectionInput.model_validate(body)
-    return body.model_dump(exclude_none=True, by_alias=True)
-
-
-def integration_payload(
-    body: IntegrationInput | IntegrationProcessInput | dict[str, Any],
-) -> dict[str, Any]:
-    """
-    Construct a payload for the given integration body.
-    :param body: The body to validate and optionally convert to a dictionary.
-    :return: A dictionary representation of the validated body.
-    """
-    if isinstance(body, dict):
-        body = (
-            IntegrationInput.model_validate(body)
-            if "jobs" in body
-            else IntegrationProcessInput.model_validate(body)
+def _extract_first_page(
+    res: dict[str, Any], result_key: str, page_size: int
+) -> tuple[list[dict[str, Any]], int, int]:
+    total_items, first_page = res["meta"]["paging"]["totalSize"], res.get(result_key, [])
+    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"Using the server-side enforced page size {actual_page_size} for further requests."
         )
-    return body.model_dump(exclude_none=True, by_alias=True)
-
-
-def schedule_payload(
-    integration_id: str, schedule: ScheduleInput | dict[str, Any]
-) -> dict[str, Any]:
-    """
-    Construct a payload for the given integration ID and schedule.
-    :param integration_id: The ID of the integration.
-    :param schedule: The schedule to validate and optionally convert to a dictionary.
-    :return: A dictionary representation of the validated schedule.
-    """
-    if isinstance(schedule, dict):
-        schedule = ScheduleInput.model_validate(schedule)
-    return {
-        "integrationId": integration_id,
-        "schedule": schedule.model_dump(exclude_none=True, by_alias=True),
-    }
-
-
-def action_url(action_id: int) -> Literal["imports", "exports", "actions", "processes"]:
-    """
-    Determine the type of action based on its identifier.
-    :param action_id: The identifier of the action.
-    :return: The type of action.
-    """
-    if 12000000000 <= action_id < 113000000000:
-        return "imports"
-    if 116000000000 <= action_id < 117000000000:
-        return "exports"
-    if 117000000000 <= action_id < 118000000000:
-        return "actions"
-    if 118000000000 <= action_id < 119000000000:
-        return "processes"
-    raise InvalidIdentifierException(f"Action '{action_id}' is not a valid identifier.")
-
-
-def raise_error(error: HTTPError) -> None:
-    """
-    Raise an appropriate exception based on the error.
-    :param error: The error to raise an exception for.
-    """
+    logger.debug(f"Found {total_items} total items, retrieved {len(first_page)} in first page.")
+    return first_page, total_items, actual_page_size
+
+
+def _raise_error(error: HTTPError) -> None:
     if isinstance(error, httpx.TimeoutException):
         raise AnaplanTimeoutException from error
     if isinstance(error, httpx.HTTPStatusError):
@@ -392,59 +275,3 @@ def raise_error(error: HTTPError) -> None:
 
     logger.error(f"Error: {error}")
     raise AnaplanException from error
-
-
-def parse_calendar_response(data: dict) -> ModelCalendar:
-    """
-    Parse calendar response and return appropriate calendar model.
-    :param data: The calendar data from the API response.
-    :return: The calendar settings of the model based on calendar type.
-    """
-    calendar_data = data["modelCalendar"]
-    cal_type = calendar_data["calendarType"]
-    if cal_type == "Calendar Months/Quarters/Years":
-        return MonthsQuartersYearsCalendar.model_validate(calendar_data)
-    if cal_type == "Weeks: 4-4-5, 4-5-4 or 5-4-4":
-        return WeeksGroupingCalendar.model_validate(calendar_data)
-    if cal_type == "Weeks: General":
-        return WeeksGeneralCalendar.model_validate(calendar_data)
-    if cal_type == "Weeks: 13 4-week Periods":
-        return WeeksPeriodsCalendar.model_validate(calendar_data)
-    raise AnaplanException(
-        "Unknown calendar type encountered. Please report this issue: "
-        "https://github.com/VinzenzKlass/anaplan-sdk/issues/new"
-    )
-
-
-def parse_insertion_response(data: list[dict]) -> InsertionResult:
-    failures, added, ignored, total = [], 0, 0, 0
-    for res in data:
-        failures.append(res.get("failures", []))
-        added += res.get("added", 0)
-        total += res.get("total", 0)
-        ignored += res.get("ignored", 0)
-    return InsertionResult(
-        added=added, ignored=ignored, total=total, failures=list(chain.from_iterable(failures))
-    )
-
-
-def validate_dimension_id(dimension_id: int) -> int:
-    if not (
-        dimension_id == 101999999999
-        or 101_000_000_000 <= dimension_id < 102_000_000_000
-        or 109_000_000_000 <= dimension_id < 110_000_000_000
-        or 114_000_000_000 <= dimension_id < 115_000_000_000
-    ):
-        raise InvalidIdentifierException(
-            "Invalid dimension_id. Must be a List (101xxxxxxxxx), List Subset (109xxxxxxxxx), "
-            "Line Item Subset (114xxxxxxxxx), or Users (101999999999)."
-        )
-    msg = (
-        "Using `get_dimension_items` for {} is discouraged. "
-        "Prefer `{}` for better performance and more details on the members."
-    )
-    if dimension_id == 101999999999:
-        logger.warning(msg.format("Users", "get_users"))
-    if 101000000000 <= dimension_id < 102000000000:
-        logger.warning(msg.format("Lists", "get_list_items"))
-    return dimension_id

anaplan_sdk/_utils.py

@@ -0,0 +1,188 @@
+from itertools import chain
+from typing import Any, Literal, Type, TypeVar
+
+from pydantic.alias_generators import to_camel
+
+from anaplan_sdk._services import logger
+from anaplan_sdk.exceptions import AnaplanException, InvalidIdentifierException
+from anaplan_sdk.models import (
+    AnaplanModel,
+    InsertionResult,
+    ModelCalendar,
+    MonthsQuartersYearsCalendar,
+    WeeksGeneralCalendar,
+    WeeksGroupingCalendar,
+    WeeksPeriodsCalendar,
+)
+from anaplan_sdk.models.cloud_works import (
+    AmazonS3ConnectionInput,
+    AzureBlobConnectionInput,
+    ConnectionBody,
+    GoogleBigQueryConnectionInput,
+    IntegrationInput,
+    IntegrationProcessInput,
+    ScheduleInput,
+)
+
+T = TypeVar("T", bound=AnaplanModel)
+
+
+def models_url(only_in_workspace: bool | str, workspace_id: str | None) -> str:
+    if isinstance(only_in_workspace, bool) and only_in_workspace:
+        if not workspace_id:
+            raise ValueError(
+                "Cannot list models in the current workspace, since no workspace Id was "
+                "provided when instantiating the client. Either provide a workspace Id when "
+                "instantiating the client, or pass a specific workspace Id to this method."
+            )
+        return f"https://api.anaplan.com/2/0/workspaces/{workspace_id}/models"
+    if isinstance(only_in_workspace, str):
+        return f"https://api.anaplan.com/2/0/workspaces/{only_in_workspace}/models"
+    return "https://api.anaplan.com/2/0/models"
+
+
+def sort_params(sort_by: str | None, descending: bool) -> dict[str, str | bool]:
+    """
+    Construct search parameters for sorting. This also converts snake_case to camelCase.
+    :param sort_by: The field to sort by, optionally in snake_case.
+    :param descending: Whether to sort in descending order.
+    :return: A dictionary of search parameters in Anaplan's expected format.
+    """
+    if not sort_by:
+        return {}
+    return {"sort": f"{'-' if descending else '+'}{to_camel(sort_by)}"}
+
+
+def construct_payload(model: Type[T], body: T | dict[str, Any]) -> dict[str, Any]:
+    """
+    Construct a payload for the given model and body.
+    :param model: The model class to use for validation.
+    :param body: The body to validate and optionally convert to a dictionary.
+    :return: A dictionary representation of the validated body.
+    """
+    if isinstance(body, dict):
+        body = model.model_validate(body)
+    return body.model_dump(exclude_none=True, by_alias=True)
+
+
+def connection_body_payload(body: ConnectionBody | dict[str, Any]) -> dict[str, Any]:
+    """
+    Construct a payload for the given integration body.
+    :param body: The body to validate and optionally convert to a dictionary.
+    :return: A dictionary representation of the validated body.
+    """
+    if isinstance(body, dict):
+        if "sasToken" in body:
+            body = AzureBlobConnectionInput.model_validate(body)
+        elif "secretAccessKey" in body:
+            body = AmazonS3ConnectionInput.model_validate(body)
+        else:
+            body = GoogleBigQueryConnectionInput.model_validate(body)
+    return body.model_dump(exclude_none=True, by_alias=True)
+
+
+def integration_payload(
+    body: IntegrationInput | IntegrationProcessInput | dict[str, Any],
+) -> dict[str, Any]:
+    """
+    Construct a payload for the given integration body.
+    :param body: The body to validate and optionally convert to a dictionary.
+    :return: A dictionary representation of the validated body.
+    """
+    if isinstance(body, dict):
+        body = (
+            IntegrationInput.model_validate(body)
+            if "jobs" in body
+            else IntegrationProcessInput.model_validate(body)
+        )
+    return body.model_dump(exclude_none=True, by_alias=True)
+
+
+def schedule_payload(
+    integration_id: str, schedule: ScheduleInput | dict[str, Any]
+) -> dict[str, Any]:
+    """
+    Construct a payload for the given integration ID and schedule.
+    :param integration_id: The ID of the integration.
+    :param schedule: The schedule to validate and optionally convert to a dictionary.
+    :return: A dictionary representation of the validated schedule.
+    """
+    if isinstance(schedule, dict):
+        schedule = ScheduleInput.model_validate(schedule)
+    return {
+        "integrationId": integration_id,
+        "schedule": schedule.model_dump(exclude_none=True, by_alias=True),
+    }
+
+
+def action_url(action_id: int) -> Literal["imports", "exports", "actions", "processes"]:
+    """
+    Determine the type of action based on its identifier.
+    :param action_id: The identifier of the action.
+    :return: The type of action.
+    """
+    if 12000000000 <= action_id < 113000000000:
+        return "imports"
+    if 116000000000 <= action_id < 117000000000:
+        return "exports"
+    if 117000000000 <= action_id < 118000000000:
+        return "actions"
+    if 118000000000 <= action_id < 119000000000:
+        return "processes"
+    raise InvalidIdentifierException(f"Action '{action_id}' is not a valid identifier.")
+
+
+def parse_calendar_response(data: dict) -> ModelCalendar:
+    """
+    Parse calendar response and return appropriate calendar model.
+    :param data: The calendar data from the API response.
+    :return: The calendar settings of the model based on calendar type.
+    """
+    calendar_data = data["modelCalendar"]
+    cal_type = calendar_data["calendarType"]
+    if cal_type == "Calendar Months/Quarters/Years":
+        return MonthsQuartersYearsCalendar.model_validate(calendar_data)
+    if cal_type == "Weeks: 4-4-5, 4-5-4 or 5-4-4":
+        return WeeksGroupingCalendar.model_validate(calendar_data)
+    if cal_type == "Weeks: General":
+        return WeeksGeneralCalendar.model_validate(calendar_data)
+    if cal_type == "Weeks: 13 4-week Periods":
+        return WeeksPeriodsCalendar.model_validate(calendar_data)
+    raise AnaplanException(
+        "Unknown calendar type encountered. Please report this issue: "
+        "https://github.com/VinzenzKlass/anaplan-sdk/issues/new"
+    )
+
+
+def parse_insertion_response(data: list[dict]) -> InsertionResult:
+    failures, added, ignored, total = [], 0, 0, 0
+    for res in data:
+        failures.append(res.get("failures", []))
+        added += res.get("added", 0)
+        total += res.get("total", 0)
+        ignored += res.get("ignored", 0)
+    return InsertionResult(
+        added=added, ignored=ignored, total=total, failures=list(chain.from_iterable(failures))
+    )
+
+
+def validate_dimension_id(dimension_id: int) -> int:
+    if not (
+        dimension_id == 101999999999
+        or 101_000_000_000 <= dimension_id < 102_000_000_000
+        or 109_000_000_000 <= dimension_id < 110_000_000_000
+        or 114_000_000_000 <= dimension_id < 115_000_000_000
+    ):
+        raise InvalidIdentifierException(
+            "Invalid dimension_id. Must be a List (101xxxxxxxxx), List Subset (109xxxxxxxxx), "
+            "Line Item Subset (114xxxxxxxxx), or Users (101999999999)."
+        )
+    msg = (
+        "Using `get_dimension_items` for {} is discouraged. "
+        "Prefer `{}` for better performance and more details on the members."
+    )
+    if dimension_id == 101999999999:
+        logger.warning(msg.format("Users", "get_users"))
+    if 101000000000 <= dimension_id < 102000000000:
+        logger.warning(msg.format("Lists", "get_list_items"))
+    return dimension_id

anaplan_sdk/models/_bulk.py

@@ -39,11 +39,13 @@ class Model(AnaplanModel):
         description="The unique identifier of the user who last modified this model."
     )
     memory_usage: int = Field(0, description="The memory usage of this model in bytes.")
-    current_workspace_id: str = Field(
-        description="The unique identifier of the workspace that this model is currently in."
+    workspace_id: str = Field(
+        validation_alias="currentWorkspaceId",
+        description="The unique identifier of the workspace that this model is currently in.",
     )
-    current_workspace_name: str = Field(
-        description="The name of the workspace that this model is currently in."
+    workspace_name: str = Field(
+        validation_alias="currentWorkspaceName",
+        description="The name of the workspace that this model is currently in.",
     )
     url: str = Field(validation_alias="modelUrl", description="The current URL of this model.")
     category_values: list = Field(description="The category values of this model.")

{anaplan_sdk-0.5.0a4.dist-info → anaplan_sdk-0.5.0a6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.5.0a4
+Version: 0.5.0a6
 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

anaplan_sdk-0.5.0a6.dist-info/RECORD

@@ -0,0 +1,31 @@
+anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
+anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
+anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
+anaplan_sdk/_services.py,sha256=n14DvTC2I5ub7yzjWBaAAX9YMF7LwI_BU7zuofAj0l4,13026
+anaplan_sdk/_utils.py,sha256=jsrhdfLpriMoANukVvXpjpEJ5hWDNx7ZJKAguLvKgJA,7517
+anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
+anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
+anaplan_sdk/_async_clients/_alm.py,sha256=_PTD9Eght879HAadjcsfdvS0KCN93jgwpPOF8r3_E14,13178
+anaplan_sdk/_async_clients/_audit.py,sha256=MkCTt7s6039GfDoyyINmDA1vAkZn2xPL4hFK8D4CYsE,2927
+anaplan_sdk/_async_clients/_bulk.py,sha256=TsUUIGK_RPo1yKUyEbaGoFXFMBd0H4YHXI-ABYieZog,30100
+anaplan_sdk/_async_clients/_cloud_works.py,sha256=aSgmJQvE7dSJawwK0A7GEBWs7wokWk7eCwRiQuiVg6I,17701
+anaplan_sdk/_async_clients/_cw_flow.py,sha256=qJJFfnwLR7zIdZ_ay4fVI9zr3eP5B-qMcs4GlC9vqQY,3966
+anaplan_sdk/_async_clients/_transactional.py,sha256=f-NlIjvRJ0NIKRcI6ZaO2YatLERwIaC0TY0fKvgUJ5Q,18050
+anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
+anaplan_sdk/_clients/_alm.py,sha256=oRHTjnCuwQYZDE2CBWA1u410jSImIroCsDOSeP9U9w8,12905
+anaplan_sdk/_clients/_audit.py,sha256=Am6VviRw88_VC5i0N7TQTXEm6pJAHZb7xNaJTljD0fc,2850
+anaplan_sdk/_clients/_bulk.py,sha256=9kN8LU3c0iDF-Ov47utBl-dj_hxX3twf7TOcolzogyI,30257
+anaplan_sdk/_clients/_cloud_works.py,sha256=1bbMYM_g8MSorxTI9Au_dFzbJZgKGJVBE6DYlbWBR0U,17492
+anaplan_sdk/_clients/_cw_flow.py,sha256=x64Ua2FwCpt8vab6gaLV8tDwW_ugJrDfU5dv-TnmM2M,3855
+anaplan_sdk/_clients/_transactional.py,sha256=IgkvBaq1Ep5mB-uxu6QoE17cUCfsodvV8dppASQrIT4,17875
+anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
+anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
+anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
+anaplan_sdk/models/_bulk.py,sha256=C0s6XdvHxuJHrPXU-pnZ1JXK1PJOl9FScHArpaox_mQ,8489
+anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
+anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
+anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
+anaplan_sdk-0.5.0a6.dist-info/METADATA,sha256=VZfvzZQlLtBEOFFXMexsiEaetmGPe8fLilZBewT7iOg,3678
+anaplan_sdk-0.5.0a6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.5.0a6.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.5.0a6.dist-info/RECORD,,

anaplan_sdk-0.5.0a4.dist-info/RECORD

@@ -1,30 +0,0 @@
-anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
-anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
-anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
-anaplan_sdk/_services.py,sha256=isBMmeoxgQi2Xoc5wdD7qtraIHBqYJNAp-CEKWyhqj4,20104
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/_async_clients/__init__.py,sha256=pZXgMMg4S9Aj_pxQCaSiPuNG-sePVGBtNJ0133VjqW4,364
-anaplan_sdk/_async_clients/_alm.py,sha256=zvKEvXlxNkcQim_XvyZLCbDafFldljg8APHqhAAIfvw,13147
-anaplan_sdk/_async_clients/_audit.py,sha256=j9CeWzIuGsZrVBbjS_T8w6le2cjieW7NW6fDiCY34TA,2718
-anaplan_sdk/_async_clients/_bulk.py,sha256=TTdTMXu1-3iNlD9oxGAbh58JXSRHiFAxnMt70zLz8kk,29929
-anaplan_sdk/_async_clients/_cloud_works.py,sha256=VB4l93426A0Xes5dZ6DsDu0go-BVNhs2RZn2zX5DSOc,17675
-anaplan_sdk/_async_clients/_cw_flow.py,sha256=_allKIOP-qb33wrOj6GV5VAOvrCXOVJ1QXvck-jsocQ,3935
-anaplan_sdk/_async_clients/_transactional.py,sha256=U6X5pW7By387JOgvHx-GmgVRi7MRJKALpx0lWI6xRMo,18024
-anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=3U7Cy5U5TsePF1YPogXvsOzNeQlQm_ezO5TlmD-Xbbs,12874
-anaplan_sdk/_clients/_audit.py,sha256=b7l9xNbUGLceeNlS2No53RKJmksUeIICDTCuYPXgyV0,2641
-anaplan_sdk/_clients/_bulk.py,sha256=lZhsbw-Zqtrwofgzds7Lct1HnUfN5M4QDxWP-PocotE,30085
-anaplan_sdk/_clients/_cloud_works.py,sha256=FsCp2wPxIoArAN1vcIfOI6ANNkK2ZebQ4MWJZB-nFJU,17466
-anaplan_sdk/_clients/_cw_flow.py,sha256=O6t4utbDZdSVXGC0PXUcPpQ4oXrPohU9_8SUBCpxTXw,3824
-anaplan_sdk/_clients/_transactional.py,sha256=SaHAnaGLZrhXmM8d6JnWWkwf-sVCEDW0nL2a4_wvjfk,17849
-anaplan_sdk/models/__init__.py,sha256=zfwDQJQrXuLEXSpbJcm08a_YK1P7a7u-kMhwtJiJFmA,1783
-anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
-anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
-anaplan_sdk/models/_bulk.py,sha256=S72qujNr5STdiyKaCEvrQjKYHik_aemiJFNKE7docpI,8405
-anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
-anaplan_sdk/models/cloud_works.py,sha256=APUGDt_e-JshtXkba5cQh5rZkXOZBz0Aix0qVNdEWgw,19501
-anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
-anaplan_sdk-0.5.0a4.dist-info/METADATA,sha256=GQk0AT6_rIKYU7o79QBL1ur0DKfYGZ4fqxKv_hqajsg,3678
-anaplan_sdk-0.5.0a4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.5.0a4.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.5.0a4.dist-info/RECORD,,