anaplan-sdk 0.4.5__py3-none-any.whl → 0.5.0a1__py3-none-any.whl

anaplan_sdk/_clients/_transactional.py

@@ -1,27 +1,70 @@
+import logging
 from concurrent.futures import ThreadPoolExecutor
 from itertools import chain
-from typing import Any
+from typing import Any, Literal, overload
 
 import httpx
 
-from anaplan_sdk._base import _BaseClient
+from anaplan_sdk._base import (
+    _BaseClient,
+    parse_calendar_response,
+    parse_insertion_response,
+    validate_dimension_id,
+)
+from anaplan_sdk.exceptions import InvalidIdentifierException
 from anaplan_sdk.models import (
+    CurrentPeriod,
+    Dimension,
+    DimensionWithCode,
+    FiscalYear,
     InsertionResult,
     LineItem,
     List,
     ListItem,
     ListMetadata,
+    Model,
+    ModelCalendar,
     ModelStatus,
     Module,
+    View,
+    ViewInfo,
 )
+from anaplan_sdk.models._transactional import ListDeletionResult
+
+logger = logging.getLogger("anaplan_sdk")
 
 
 class _TransactionalClient(_BaseClient):
     def __init__(self, client: httpx.Client, model_id: str, retry_count: int) -> None:
         self._url = f"https://api.anaplan.com/2/0/models/{model_id}"
+        self._model_id = model_id
         super().__init__(retry_count, client)
 
-    def list_modules(self) -> list[Module]:
+    def get_model_details(self) -> Model:
+        """
+        Retrieves the Model details for the current Model.
+        :return: The Model details.
+        """
+        return Model.model_validate(self._get(self._url, params={"modelDetails": "true"})["model"])
+
+    def get_model_status(self) -> ModelStatus:
+        """
+        Gets the current status of the Model.
+        :return: The current status of the Mode.
+        """
+        return ModelStatus.model_validate(self._get(f"{self._url}/status").get("requestStatus"))
+
+    def wake_model(self) -> None:
+        """Wake up the current model."""
+        self._post_empty(f"{self._url}/open", headers={"Content-Type": "application/text"})
+        logger.info(f"Woke up model '{self._model_id}'.")
+
+    def close_model(self) -> None:
+        """Close the current model."""
+        self._post_empty(f"{self._url}/close", headers={"Content-Type": "application/text"})
+        logger.info(f"Closed model '{self._model_id}'.")
+
+    def get_modules(self) -> list[Module]:
         """
         Lists all the Modules in the Model.
         :return: The List of Modules.
@@ -30,18 +73,27 @@ class _TransactionalClient(_BaseClient):
             Module.model_validate(e) for e in self._get_paginated(f"{self._url}/modules", "modules")
         ]
 
-    def get_model_status(self) -> ModelStatus:
+    def get_views(self) -> list[View]:
         """
-        Gets the current status of the Model.
-        :return: The current status of the Mode.
+        Lists all the Views in the Model. This will include all Modules and potentially other saved
+        views.
+        :return: The List of Views.
         """
-        return ModelStatus.model_validate(self._get(f"{self._url}/status").get("requestStatus"))
+        return [View.model_validate(e) for e in self._get_paginated(f"{self._url}/views", "views")]
+
+    def get_view_info(self, view_id: int) -> ViewInfo:
+        """
+        Gets the detailed information about a View.
+        :param view_id: The ID of the View.
+        :return: The information about the View.
+        """
+        return ViewInfo.model_validate(self._get(f"{self._url}/views/{view_id}"))
 
-    def list_line_items(self, only_module_id: int | None = None) -> list[LineItem]:
+    def get_line_items(self, only_module_id: int | None = None) -> list[LineItem]:
         """
         Lists all the Line Items in the Model.
         :param only_module_id: If provided, only Line Items from this Module will be returned.
-        :return: The List of Line Items.
+        :return: All Line Items on this Model or only from the specified Module.
         """
         url = (
             f"{self._url}/modules/{only_module_id}/lineItems?includeAll=true"
@@ -50,7 +102,7 @@ class _TransactionalClient(_BaseClient):
         )
         return [LineItem.model_validate(e) for e in self._get(url).get("items", [])]
 
-    def list_lists(self) -> list[List]:
+    def get_lists(self) -> list[List]:
         """
         Lists all the Lists in the Model.
         :return: All Lists on this model.
@@ -67,18 +119,31 @@ class _TransactionalClient(_BaseClient):
             self._get(f"{self._url}/lists/{list_id}").get("metadata")
         )
 
-    def get_list_items(self, list_id: int) -> list[ListItem]:
+    @overload
+    def get_list_items(
+        self, list_id: int, return_raw: Literal[False] = False
+    ) -> list[ListItem]: ...
+
+    @overload
+    def get_list_items(
+        self, list_id: int, return_raw: Literal[True] = True
+    ) -> list[dict[str, Any]]: ...
+
+    def get_list_items(
+        self, list_id: int, return_raw: bool = False
+    ) -> list[ListItem] | list[dict[str, Any]]:
         """
         Gets all the items in a List.
         :param list_id: The ID of the List.
-        :return: The List of Items.
+        :param return_raw: If True, returns the items as a list of dictionaries instead of ListItem
+               objects. If you use the result of this call in a DataFrame or you simply pass on the
+               data, you will want to set this to avoid unnecessary (de-)serialization.
+        :return: All items in the List.
         """
-        return [
-            ListItem.model_validate(e)
-            for e in self._get(f"{self._url}/lists/{list_id}/items?includeAll=true").get(
-                "listItems", []
-            )
-        ]
+        res = self._get(f"{self._url}/lists/{list_id}/items?includeAll=true")
+        if return_raw:
+            return res.get("listItems", [])
+        return [ListItem.model_validate(e) for e in res.get("listItems", [])]
 
     def insert_list_items(
         self, list_id: int, items: list[dict[str, str | int | dict]]
@@ -100,10 +165,14 @@ class _TransactionalClient(_BaseClient):
         :return: The result of the insertion, indicating how many items were added,
                  ignored or failed.
         """
+        if not items:
+            return InsertionResult(added=0, ignored=0, failures=[], total=0)
         if len(items) <= 100_000:
-            return InsertionResult.model_validate(
+            result = InsertionResult.model_validate(
                 self._post(f"{self._url}/lists/{list_id}/items?action=add", json={"items": items})
             )
+            logger.info(f"Inserted {result.added} items into list '{list_id}'.")
+            return result
 
         with ThreadPoolExecutor() as executor:
             responses = list(
@@ -114,19 +183,13 @@ class _TransactionalClient(_BaseClient):
                     [items[i : i + 100_000] for i in range(0, len(items), 100_000)],
                 )
             )
+        result = parse_insertion_response(responses)
+        logger.info(f"Inserted {result.added} items into list '{list_id}'.")
+        return result
 
-        failures, added, ignored, total = [], 0, 0, 0
-        for res in responses:
-            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 delete_list_items(self, list_id: int, items: list[dict[str, str | int]]) -> int:
+    def delete_list_items(
+        self, list_id: int, items: list[dict[str, str | int]]
+    ) -> ListDeletionResult:
         """
         Deletes items from a List. If you pass a long list, it will be split into chunks of 100,000
         items, the maximum allowed by the API.
@@ -140,12 +203,18 @@ class _TransactionalClient(_BaseClient):
 
         :param list_id: The ID of the List.
         :param items: The items to delete from the List. Must be a dict with either `code` or `id`
-                      as the keys to identify the records to delete.
+                      as the keys to identify the records to delete. Specifying both will error.
+        :return: The result of the deletion, indicating how many items were deleted or failed.
         """
+        if not items:
+            return ListDeletionResult(deleted=0, failures=[])
         if len(items) <= 100_000:
-            return self._post(
+            res = self._post(
                 f"{self._url}/lists/{list_id}/items?action=delete", json={"items": items}
-            ).get("deleted", 0)
+            )
+            info = ListDeletionResult.model_validate(res)
+            logger.info(f"Deleted {info.deleted} items from list '{list_id}'.")
+            return info
 
         with ThreadPoolExecutor() as executor:
             responses = list(
@@ -156,8 +225,12 @@ class _TransactionalClient(_BaseClient):
                     [items[i : i + 100_000] for i in range(0, len(items), 100_000)],
                 )
             )
-
-        return sum(res.get("deleted", 0) for res in responses)
+        info = ListDeletionResult(
+            deleted=sum(res.get("deleted", 0) for res in responses),
+            failures=list(chain.from_iterable(res.get("failures", []) for res in responses)),
+        )
+        logger.info(f"Deleted {info} items from list '{list_id}'.")
+        return info
 
     def reset_list_index(self, list_id: int) -> None:
         """
@@ -165,6 +238,7 @@ class _TransactionalClient(_BaseClient):
         :param list_id: The ID of the List.
         """
         self._post_empty(f"{self._url}/lists/{list_id}/resetIndex")
+        logger.info(f"Reset index for list '{list_id}'.")
 
     def update_module_data(
         self, module_id: int, data: list[dict[str, Any]]
@@ -184,4 +258,117 @@ class _TransactionalClient(_BaseClient):
         :return: The number of cells changed or the response with the according error details.
         """
         res = self._post(f"{self._url}/modules/{module_id}/data", json=data)
+        if "failures" not in res:
+            logger.info(f"Updated {res['numberOfCellsChanged']} cells in module '{module_id}'.")
         return res if "failures" in res else res["numberOfCellsChanged"]
+
+    def get_current_period(self) -> CurrentPeriod:
+        """
+        Gets the current period of the model.
+        :return: The current period of the model.
+        """
+        res = self._get(f"{self._url}/currentPeriod")
+        return CurrentPeriod.model_validate(res["currentPeriod"])
+
+    def set_current_period(self, date: str) -> CurrentPeriod:
+        """
+        Sets the current period of the model to the given date.
+        :param date: The date to set the current period to, in the format 'YYYY-MM-DD'.
+        :return: The updated current period of the model.
+        """
+        res = self._put(f"{self._url}/currentPeriod", {"date": date})
+        logger.info(f"Set current period to '{date}'.")
+        return CurrentPeriod.model_validate(res["currentPeriod"])
+
+    def set_current_fiscal_year(self, year: str) -> FiscalYear:
+        """
+        Sets the current fiscal year of the model.
+        :param year: The fiscal year to set, in the format specified in the model, e.g. FY24.
+        :return: The updated fiscal year of the model.
+        """
+        res = self._put(f"{self._url}/modelCalendar/fiscalYear", {"year": year})
+        logger.info(f"Set current fiscal year to '{year}'.")
+        return FiscalYear.model_validate(res["modelCalendar"]["fiscalYear"])
+
+    def get_model_calendar(self) -> ModelCalendar:
+        """
+        Get the calendar settings of the model.
+        :return: The calendar settings of the model.
+        """
+        return parse_calendar_response(self._get(f"{self._url}/modelCalendar"))
+
+    def get_dimension_items(self, dimension_id: int) -> list[DimensionWithCode]:
+        """
+        Get all items in a dimension. This will fail if the dimensions holds more than 1_000_000
+        items. Valid Dimensions are:
+
+        - Lists (101xxxxxxxxx)
+        - List Subsets (109xxxxxxxxx)
+        - Line Item Subsets (114xxxxxxxxx)
+        - Users (101999999999)
+        For lists and users, you should prefer using the `get_list_items` and `get_users` methods,
+        respectively, instead.
+        :param dimension_id: The ID of the dimension to list items for.
+        :return: A list of Dimension items.
+        """
+        res = self._get(f"{self._url}/dimensions/{validate_dimension_id(dimension_id)}/items")
+        return [DimensionWithCode.model_validate(e) for e in res.get("items", [])]
+
+    def lookup_dimension_items(
+        self, dimension_id: int, codes: list[str] = None, names: list[str] = None
+    ) -> list[DimensionWithCode]:
+        """
+        Looks up items in a dimension by their codes or names. If both are provided, both will be
+        searched for. You must provide at least one of `codes` or `names`. Valid Dimensions to
+        lookup are:
+
+        - Lists (101xxxxxxxxx)
+        - Time (20000000003)
+        - Version (20000000020)
+        - Users (101999999999)
+        :param dimension_id: The ID of the dimension to lookup items for.
+        :param codes: A list of codes to lookup in the dimension.
+        :param names: A list of names to lookup in the dimension.
+        :return: A list of Dimension items that match the provided codes or names.
+        """
+        if not codes and not names:
+            raise ValueError("At least one of 'codes' or 'names' must be provided.")
+        if not (
+            dimension_id == 101999999999
+            or 101000000000 <= dimension_id < 102000000000
+            or dimension_id == 20000000003
+            or dimension_id == 20000000020
+        ):
+            raise InvalidIdentifierException(
+                "Invalid dimension_id. Must be a List (101xxxxxxxxx), Time (20000000003), "
+                "Version (20000000020), or Users (101999999999)."
+            )
+        res = self._post(
+            f"{self._url}/dimensions/{dimension_id}/items", json={"codes": codes, "names": names}
+        )
+        return [DimensionWithCode.model_validate(e) for e in res.get("items", [])]
+
+    def get_view_dimension_items(self, view_id: int, dimension_id: int) -> list[Dimension]:
+        """
+        Get the members of a dimension that are part of the given View. This call returns data as
+        filtered by the page builder when they configure the view. This call respects hidden items,
+        filtering selections, and Selective Access. If the view contains hidden or filtered items,
+        these do not display in the response. This will fail if the dimensions holds more than
+        1_000_000 items. The response returns Items within a flat list (no hierarchy) and order
+        is not guaranteed.
+        :param view_id: The ID of the View.
+        :param dimension_id: The ID of the Dimension to get items for.
+        :return: A list of Dimensions used in the View.
+        """
+        res = self._get(f"{self._url}/views/{view_id}/dimensions/{dimension_id}/items")
+        return [Dimension.model_validate(e) for e in res.get("items", [])]
+
+    def get_line_item_dimensions(self, line_item_id: int) -> list[Dimension]:
+        """
+        Get the dimensions of a Line Item. This will return all dimensions that are used in the
+        Line Item.
+        :param line_item_id: The ID of the Line Item.
+        :return: A list of Dimensions used in the Line Item.
+        """
+        res = self._get(f"{self._url}/lineItems/{line_item_id}/dimensions")
+        return [Dimension.model_validate(e) for e in res.get("dimensions", [])]

anaplan_sdk/models/__init__.py

@@ -1,4 +1,12 @@
-from ._alm import ModelRevision, Revision, SyncTask
+from ._alm import (
+    ModelRevision,
+    ReportTask,
+    ReportTaskResult,
+    Revision,
+    SummaryReport,
+    SyncTask,
+    SyncTaskResult,
+)
 from ._base import AnaplanModel
 from ._bulk import (
     Action,
@@ -10,6 +18,7 @@ from ._bulk import (
     List,
     ListMetadata,
     Model,
+    ModelDeletionResult,
     Process,
     TaskResult,
     TaskResultDetail,
@@ -17,7 +26,26 @@ from ._bulk import (
     TaskSummary,
     Workspace,
 )
-from ._transactional import Failure, InsertionResult, LineItem, ListItem, ModelStatus, Module, User
+from ._transactional import (
+    CurrentPeriod,
+    Dimension,
+    DimensionWithCode,
+    Failure,
+    FiscalYear,
+    InsertionResult,
+    LineItem,
+    ListItem,
+    ModelCalendar,
+    ModelStatus,
+    Module,
+    MonthsQuartersYearsCalendar,
+    User,
+    View,
+    ViewInfo,
+    WeeksGeneralCalendar,
+    WeeksGroupingCalendar,
+    WeeksPeriodsCalendar,
+)
 
 __all__ = [
     "AnaplanModel",
@@ -41,9 +69,26 @@ __all__ = [
     "TaskResult",
     "TaskResultDetail",
     "TaskStatus",
+    "TaskSummary",
+    "SyncTaskResult",
+    "ReportTask",
+    "ReportTaskResult",
+    "SummaryReport",
     "SyncTask",
     "User",
     "Failure",
     "InsertionResult",
     "Revision",
+    "CurrentPeriod",
+    "FiscalYear",
+    "MonthsQuartersYearsCalendar",
+    "WeeksGeneralCalendar",
+    "WeeksGroupingCalendar",
+    "WeeksPeriodsCalendar",
+    "Dimension",
+    "View",
+    "ViewInfo",
+    "ModelCalendar",
+    "ModelDeletionResult",
+    "DimensionWithCode",
 ]

anaplan_sdk/models/_alm.py

@@ -1,6 +1,7 @@
 from pydantic import Field
 
 from ._base import AnaplanModel
+from ._bulk import TaskSummary
 
 
 class Revision(AnaplanModel):
@@ -34,8 +35,8 @@ class ModelRevision(AnaplanModel):
             "workspace."
         ),
     )
-    workspace_id: str = Field(
-        description="The unique identifier of the workspace this revision belongs to."
+    workspace_id: str | None = Field(
+        None, description="The unique identifier of the workspace this revision belongs to."
     )
     applied_by: str = Field(
         description="The unique identifier of the user who applied this revision."
@@ -49,7 +50,64 @@ class ModelRevision(AnaplanModel):
     )
 
 
-class SyncTask(AnaplanModel):
-    id: str = Field(validation_alias="taskId", description="The unique identifier of this task.")
-    task_state: str = Field(description="The state of this task.")
-    creation_time: int = Field(description="The creation time of this task.")
+class SyncTaskResult(AnaplanModel):
+    source_revision_id: str = Field(description="The ID of the source revision.")
+    target_revision_id: str = Field(description="The ID of the target revision.")
+    successful: bool = Field(description="Whether the sync task was successful or not.")
+
+
+class SyncTask(TaskSummary):
+    current_step: str = Field(description="The current step of the sync task.")
+    result: SyncTaskResult | None = Field(None, description="The result of the sync task.")
+
+
+class ReportTaskResult(SyncTaskResult):
+    report_file_url: str = Field(
+        description="The URL of the report file generated by the sync task."
+    )
+
+
+class ReportTaskError(AnaplanModel):
+    title: str = Field(description="The title of the error.")
+    message: str = Field(validation_alias="messageText", description="The message of the error.")
+
+
+class ReportTaskFailureResult(AnaplanModel):
+    successful: bool = Field(description="Whether the sync task was successful or not.")
+    error: ReportTaskError = Field(description="The error that occurred during the sync task.")
+
+
+class ReportTask(SyncTask):
+    result: ReportTaskResult | ReportTaskFailureResult | None = Field(
+        None, description="The result of the comparison report task, including the report file URL."
+    )
+
+
+class SummaryTotals(AnaplanModel):
+    modified: int = Field(0, description="The number of modified items.")
+    deleted: int = Field(0, description="The number of deleted items.")
+    created: int = Field(0, description="The number of created items.")
+
+
+class SummaryDifferences(AnaplanModel):
+    line_items: SummaryTotals = Field(
+        SummaryTotals(modified=0, deleted=0, created=0), description="Changes in line items."
+    )
+    roles_contents: SummaryTotals = Field(
+        SummaryTotals(modified=0, deleted=0, created=0), description="Changes in roles contents."
+    )
+    lists: SummaryTotals = Field(
+        SummaryTotals(modified=0, deleted=0, created=0), description="Changes in lists."
+    )
+    modules: SummaryTotals = Field(
+        SummaryTotals(modified=0, deleted=0, created=0), description="Changes in modules."
+    )
+
+
+class SummaryReport(AnaplanModel):
+    target_revision_id: str = Field(description="The ID of the target revision.")
+    source_revision_id: str = Field(description="The ID of the source revision.")
+    totals: SummaryTotals = Field(description="The total counts of changes.")
+    differences: SummaryDifferences = Field(
+        description="The detailed breakdown of changes by category."
+    )

anaplan_sdk/models/_bulk.py

@@ -174,3 +174,17 @@ class TaskStatus(AnaplanModel):
     progress: float = Field(description="The progress of this task as a float between 0 and 1.")
     current_step: str | None = Field(None, description="The current step of this task.")
     result: TaskResult | None = Field(None)
+
+
+class DeletionFailure(AnaplanModel):
+    model_id: str = Field(description="The unique identifier of the model that failed to delete.")
+    message: str = Field(description="The error message explaining why the deletion failed.")
+
+
+class ModelDeletionResult(AnaplanModel):
+    models_deleted: int = Field(description="The number of models that were successfully deleted.")
+    failures: list[DeletionFailure] = Field(
+        [],
+        validation_alias="bulkDeleteModelsFailures",
+        description="List of models that failed to delete with their error messages.",
+    )