anaplan-sdk 0.2.11__py3-none-any.whl → 0.3.0__py3-none-any.whl

anaplan_sdk/_async_clients/_bulk.py

@@ -3,8 +3,7 @@ Asynchronous Client.
 """
 
 import logging
-import time
-from asyncio import gather
+from asyncio import gather, sleep
 from copy import copy
 from typing import AsyncIterator, Iterator
 
@@ -14,7 +13,17 @@ from typing_extensions import Self
 from anaplan_sdk._auth import AnaplanBasicAuth, AnaplanCertAuth, get_certificate, get_private_key
 from anaplan_sdk._base import _AsyncBaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
-from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
+from anaplan_sdk.models import (
+    Action,
+    Export,
+    File,
+    Import,
+    Model,
+    Process,
+    TaskStatus,
+    TaskSummary,
+    Workspace,
+)
 
 from ._alm import _AsyncAlmClient
 from ._audit import _AsyncAuditClient
@@ -250,7 +259,7 @@ class AsyncClient(_AsyncBaseClient):
             for e in (await self._get(f"{self._url}/exports")).get("exports", [])
         ]
 
-    async def run_action(self, action_id: int) -> None:
+    async def run_action(self, action_id: int) -> TaskStatus:
         """
         Runs the specified Anaplan Action and validates the spawned task. If the Action fails or
         completes with errors, will raise an :py:class:`AnaplanActionError`. Failed Tasks are
@@ -268,16 +277,15 @@ class AsyncClient(_AsyncBaseClient):
         task_id = await self.invoke_action(action_id)
         task_status = await self.get_task_status(action_id, task_id)
 
-        while "COMPLETE" not in task_status.get("taskState"):
-            time.sleep(self.status_poll_delay)
+        while task_status.task_state != "COMPLETE":
+            await sleep(self.status_poll_delay)
             task_status = await self.get_task_status(action_id, task_id)
 
-        if task_status.get("taskState") == "COMPLETE" and not task_status.get("result").get(
-            "successful"
-        ):
+        if task_status.task_state == "COMPLETE" and not task_status.result.successful:
             raise AnaplanActionError(f"Task '{task_id}' completed with errors.")
 
         logger.info(f"Task '{task_id}' completed successfully.")
+        return task_status
 
     async def get_file(self, file_id: int) -> bytes:
         """
@@ -390,29 +398,31 @@ class AsyncClient(_AsyncBaseClient):
         await self.run_action(action_id)
         return await self.get_file(action_id)
 
-    async def list_task_status(self, action_id: int) -> list:
+    async def list_task_status(self, action_id: int) -> list[TaskSummary]:
         """
         Retrieves the status of all tasks spawned by the specified action.
         :param action_id: The identifier of the action that was invoked.
         :return: The list of tasks spawned by the action.
         """
-        return (await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks")).get(
-            "tasks", []
-        )
+        return [
+            TaskSummary.model_validate(e)
+            for e in (
+                await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks")
+            ).get("tasks", [])
+        ]
 
-    async def get_task_status(
-        self, action_id: int, task_id: str
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    async def get_task_status(self, action_id: int, task_id: str) -> TaskStatus:
         """
         Retrieves the status of the specified task.
         :param action_id: The identifier of the action that was invoked.
         :param task_id: The identifier of the spawned task.
-        :return: The status of the task as returned by the API. For more information
-                 see: https://anaplan.docs.apiary.io.
+        :return: The status of the task.
         """
-        return (
-            await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}")
-        ).get("task")
+        return TaskStatus.model_validate(
+            (
+                await self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}")
+            ).get("task")
+        )
 
     async def invoke_action(self, action_id: int) -> str:
         """

anaplan_sdk/_async_clients/_transactional.py

@@ -32,7 +32,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         return [
             Module.model_validate(e)
-            for e in (await self._get(f"{self._url}/modules")).get("modules")
+            for e in (await self._get(f"{self._url}/modules")).get("modules", [])
         ]
 
     async def get_model_status(self) -> ModelStatus:
@@ -55,7 +55,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
             if only_module_id
             else f"{self._url}/lineItems?includeAll=true"
         )
-        return [LineItem.model_validate(e) for e in (await self._get(url)).get("items")]
+        return [LineItem.model_validate(e) for e in (await self._get(url)).get("items", [])]
 
     async def list_lists(self) -> list[List]:
         """
@@ -63,7 +63,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         :return: All Lists on this model.
         """
         return [
-            List.model_validate(e) for e in (await self._get(f"{self._url}/lists")).get("lists")
+            List.model_validate(e) for e in (await self._get(f"{self._url}/lists")).get("lists", [])
         ]
 
     async def get_list_metadata(self, list_id: int) -> ListMetadata:
@@ -156,7 +156,7 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         """
         await self._post_empty(f"{self._url}/lists/{list_id}/resetIndex")
 
-    async def write_to_module(
+    async def update_module_data(
         self, module_id: int, data: list[dict[str, Any]]
     ) -> int | dict[str, Any]:
         """
@@ -171,6 +171,17 @@ class _AsyncTransactionalClient(_AsyncBaseClient):
         res = await self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
 
+    async def write_to_module(
+        self, module_id: int, data: list[dict[str, Any]]
+    ) -> int | dict[str, Any]:
+        warnings.warn(
+            "`write_to_module()` is deprecated and will be removed in a future version. "
+            "Use `update_module_data()` instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+        return await self.update_module_data(module_id, data)
+
     async def add_items_to_list(
         self, list_id: int, items: list[dict[str, str | int | dict]]
     ) -> InsertionResult:

anaplan_sdk/_clients/_bulk.py

@@ -15,7 +15,17 @@ from typing_extensions import Self
 from anaplan_sdk._auth import AnaplanBasicAuth, AnaplanCertAuth, get_certificate, get_private_key
 from anaplan_sdk._base import _BaseClient, action_url
 from anaplan_sdk.exceptions import AnaplanActionError, InvalidIdentifierException
-from anaplan_sdk.models import Action, Export, File, Import, Model, Process, Workspace
+from anaplan_sdk.models import (
+    Action,
+    Export,
+    File,
+    Import,
+    Model,
+    Process,
+    TaskStatus,
+    TaskSummary,
+    Workspace,
+)
 
 from ._alm import _AlmClient
 from ._audit import _AuditClient
@@ -252,7 +262,7 @@ class Client(_BaseClient):
             Export.model_validate(e) for e in (self._get(f"{self._url}/exports")).get("exports", [])
         ]
 
-    def run_action(self, action_id: int) -> None:
+    def run_action(self, action_id: int) -> TaskStatus:
         """
         Runs the specified Anaplan Action and validates the spawned task. If the Action fails or
         completes with errors, will raise an :py:class:`AnaplanActionError`. Failed Tasks are
@@ -270,16 +280,15 @@ class Client(_BaseClient):
         task_id = self.invoke_action(action_id)
         task_status = self.get_task_status(action_id, task_id)
 
-        while "COMPLETE" not in task_status.get("taskState"):
+        while task_status.task_state != "COMPLETE":
             time.sleep(self.status_poll_delay)
             task_status = self.get_task_status(action_id, task_id)
 
-        if task_status.get("taskState") == "COMPLETE" and not task_status.get("result").get(
-            "successful"
-        ):
+        if task_status.task_state == "COMPLETE" and not task_status.result.successful:
             raise AnaplanActionError(f"Task '{task_id}' completed with errors.")
 
         logger.info(f"Task '{task_id}' completed successfully.")
+        return task_status
 
     def get_file(self, file_id: int) -> bytes:
         """
@@ -383,26 +392,30 @@ class Client(_BaseClient):
         self.run_action(action_id)
         return self.get_file(action_id)
 
-    def list_task_status(self, action_id: int) -> list:
+    def list_task_status(self, action_id: int) -> list[TaskSummary]:
         """
         Retrieves the status of all tasks spawned by the specified action.
         :param action_id: The identifier of the action that was invoked.
         :return: The list of tasks spawned by the action.
         """
-        return self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks").get("tasks", [])
+        return [
+            TaskSummary.model_validate(e)
+            for e in self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks").get(
+                "tasks", []
+            )
+        ]
 
-    def get_task_status(
-        self, action_id: int, task_id: str
-    ) -> dict[str, float | int | str | list | dict | bool]:
+    def get_task_status(self, action_id: int, task_id: str) -> TaskStatus:
         """
         Retrieves the status of the specified task.
         :param action_id: The identifier of the action that was invoked.
         :param task_id: The identifier of the spawned task.
-        :return: The status of the task as returned by the API. For more information
-                 see: https://anaplan.docs.apiary.io.
+        :return: The status of the task.
         """
-        return self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}").get(
-            "task"
+        return TaskStatus.model_validate(
+            self._get(f"{self._url}/{action_url(action_id)}/{action_id}/tasks/{task_id}").get(
+                "task"
+            )
         )
 
     def invoke_action(self, action_id: int) -> str:

anaplan_sdk/_clients/_transactional.py

@@ -48,14 +48,14 @@ class _TransactionalClient(_BaseClient):
             if only_module_id
             else f"{self._url}/lineItems?includeAll=true"
         )
-        return [LineItem.model_validate(e) for e in self._get(url).get("items")]
+        return [LineItem.model_validate(e) for e in self._get(url).get("items", [])]
 
     def list_lists(self) -> list[List]:
         """
         Lists all the Lists in the Model.
         :return: All Lists on this Model.
         """
-        return [List.model_validate(e) for e in self._get(f"{self._url}/lists").get("lists")]
+        return [List.model_validate(e) for e in self._get(f"{self._url}/lists").get("lists", [])]
 
     def get_list_metadata(self, list_id: int) -> ListMetadata:
         """
@@ -76,7 +76,7 @@ class _TransactionalClient(_BaseClient):
         return [
             ListItem.model_validate(e)
             for e in self._get(f"{self._url}/lists/{list_id}/items?includeAll=true").get(
-                "listItems"
+                "listItems", []
             )
         ]
 
@@ -149,7 +149,9 @@ class _TransactionalClient(_BaseClient):
         """
         self._post_empty(f"{self._url}/lists/{list_id}/resetIndex")
 
-    def write_to_module(self, module_id: int, data: list[dict[str, Any]]) -> int | dict[str, Any]:
+    def update_module_data(
+        self, module_id: int, data: list[dict[str, Any]]
+    ) -> int | dict[str, Any]:
         """
         Write the passed items to the specified module. If successful, the number of cells changed
         is returned, if only partially successful or unsuccessful, the response with the according
@@ -162,6 +164,15 @@ class _TransactionalClient(_BaseClient):
         res = self._post(f"{self._url}/modules/{module_id}/data", json=data)
         return res if "failures" in res else res["numberOfCellsChanged"]
 
+    def write_to_module(self, module_id: int, data: list[dict[str, Any]]) -> int | dict[str, Any]:
+        warnings.warn(
+            "`write_to_module()` is deprecated and will be removed in a future version. "
+            "Use `update_module_data()` instead.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+        return self.update_module_data(module_id, data)
+
     def add_items_to_list(
         self, list_id: int, items: list[dict[str, str | int | dict]]
     ) -> InsertionResult:

anaplan_sdk/models.py

@@ -1,318 +1,329 @@
-from pydantic import BaseModel, Field, field_validator
+from typing import Literal, TypeAlias
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+from pydantic.alias_generators import to_camel
+
+ExportTypes: TypeAlias = Literal[
+    "TABULAR_MULTI_COLUMN",
+    "TABULAR_SINGLE_COLUMN",
+    "GRID_CURRENT_PAGE",
+    "AUDIT_LOG",
+    "TABULAR_ALL_LINE_ITEMS",
+    "TABULAR_CURRENT_LINE_ITEM",
+]
+
+ImportTypes: TypeAlias = Literal[
+    "MODULE_DATA", "HIERARCHY_DATA", "LINE_ITEM_DEFINITION", "USERS", "VERSIONS"
+]
 
 
 class Workspace(BaseModel):
-    id: str
-    """The unique identifier of this workspace."""
-    name: str
-    """The name of this workspace that is also displayed to the users. This can change any time."""
-    active: bool
-    """Whether this workspace is active or not."""
-    size_allowance: int = Field(alias="sizeAllowance", ge=0)
-    """The maximum allowed size of this workspace in bytes."""
-    current_size: int = Field(alias="currentSize", ge=0)
-    """The current size of this workspace in bytes."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(description="The unique identifier of this workspace.")
+    name: str = Field(description="The name of this workspace that is also displayed to the users.")
+    active: bool = Field(description="Whether this workspace is active or not.")
+    size_allowance: int = Field(description="The maximum allowed size of this workspace in bytes.")
+    current_size: int = Field(description="The current size of this workspace in bytes.")
 
 
 class Model(BaseModel):
-    id: str
-    """The unique identifier of this model."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(description="The unique identifier of this model.")
     name: str
-    """The name of this model that is also displayed to the users. This can change any time."""
-    active_state: str = Field(alias="activeState")
-    """The current state of this model. One of "ARCHIVED", "UNLOCKED", "ACTIVE"."""
-    last_saved_serial_number: int = Field(alias="lastSavedSerialNumber")
-    """The serial number of the last save of this model."""
-    last_modified_by_user_guid: str = Field(alias="lastModifiedByUserGuid")
-    """The unique identifier of the user who last modified this model."""
-    memory_usage: int | None = Field(None, alias="memoryUsage")
-    """The memory usage of this model in bytes."""
-    current_workspace_id: str = Field(alias="currentWorkspaceId")
-    """The unique identifier of the workspace that this model is currently in."""
-    current_workspace_name: str = Field(alias="currentWorkspaceName")
-    """The name of the workspace that this model is currently in."""
-    url: str = Field(alias="modelUrl")
-    """The URL of this model."""
-    category_values: list = Field(alias="categoryValues")
-    """The category values of this model."""
-    iso_creation_date: str = Field(alias="isoCreationDate")
-    """The creation date of this model in ISO format."""
-    last_modified: str = Field(alias="lastModified")
-    """The last modified date of this model in ISO format."""
+    active_state: Literal["ARCHIVED", "UNLOCKED", "ACTIVE", "PRODUCTION"] = Field(
+        description="The current state of this model."
+    )
+    last_saved_serial_number: int = Field(
+        description="The serial number of the last save of this model."
+    )
+    last_modified_by_user_guid: str = Field(
+        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."
+    )
+    current_workspace_name: str = Field(
+        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.")
+    iso_creation_date: str = Field(description="The creation date of this model in ISO format.")
+    last_modified: str = Field(description="The last modified date of this model.")
 
 
 class File(BaseModel):
-    id: int
-    """The unique identifier of this file."""
-    name: str
-    """The name of this file."""
-    chunk_count: int = Field(alias="chunkCount")
-    """The number of chunks this file is split into."""
-    delimiter: str | None = Field(None)
-    """The delimiter used in this file."""
-    encoding: str | None = Field(None)
-    """The encoding of this file."""
-    first_data_row: int = Field(alias="firstDataRow")
-    """The row number of the first data row in this file."""
-    format: str | None = Field(None)
-    """The format of this file."""
-    header_row: int = Field(alias="headerRow")
-    """The row number of the header row in this file."""
-    separator: str | None = Field(None)
-    """The separator used in this file."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: int = Field(description="The unique identifier of this file.")
+    name: str = Field(description="The name of this file.")
+    chunk_count: int = Field(description="The number of chunks this file is split into.")
+    delimiter: str | None = Field(None, description="The delimiter used in this file.")
+    encoding: str | None = Field(None, description="The encoding of this file.")
+    first_data_row: int = Field(description="The row number of the first data row in this file.")
+    format: str | None = Field(None, description="The format of this file.")
+    header_row: int = Field(description="The row number of the header row in this file.")
+    separator: str | None = Field(None, description="The separator used in this file.")
 
 
 class List(BaseModel):
-    id: int
-    """The unique identifier of this list."""
-    name: str
-    """The name of this list."""
+    id: int = Field(description="The unique identifier of this list.")
+    name: str = Field(description="The name of this list.")
 
 
 class ListMetadata(BaseModel):
-    id: int
-    """The unique identifier of this list."""
-    name: str
-    """The name of this list."""
-    has_selective_access: bool = Field(alias="hasSelectiveAccess")
-    """Whether this list has selective access or not."""
-    properties: list = Field([])
-    """The properties of this list."""
-    production_data: bool = Field(alias="productionData")
-    """Whether this list is production data or not."""
-    managed_by: str = Field(alias="managedBy")
-    """The user who manages this list."""
-    numbered_list: bool = Field(alias="numberedList")
-    """Whether this list is a numbered list or not."""
-    use_top_level_as_page_default: bool = Field(alias="useTopLevelAsPageDefault")
-    """Whether the top level is used as the page default or not."""
-    item_count: int = Field(alias="itemCount")
-    """The number of items in this list."""
-    next_item_index: int | None = Field(None, alias="nextItemIndex")
-    """The index of the next item in this list."""
-    workflow_enabled: bool = Field(alias="workflowEnabled")
-    """Whether the workflow is enabled for this list or not."""
-    permitted_items: int = Field(alias="permittedItems")
-    """The number of permitted items in this list."""
-    used_in_applies_to: str | None = Field(None, alias="usedInAppliesTo")
-    """The applies to value of this list."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: int = Field(description="The unique identifier of this list.")
+    name: str = Field(description="The name of this list.")
+    has_selective_access: bool = Field(description="Whether this list has selective access or not.")
+    properties: list = Field([], description="The properties of this list.")
+    production_data: bool = Field(description="Whether this list is production data or not.")
+    managed_by: str = Field(description="The user who manages this list.")
+    numbered_list: bool = Field(description="Whether this list is a numbered list or not.")
+    use_top_level_as_page_default: bool = Field(
+        description="Whether the top level is used as the page default or not."
+    )
+    item_count: int = Field(description="The number of items in this list.")
+    next_item_index: int | None = Field(
+        None, description="The index of the next item in this list."
+    )
+    workflow_enabled: bool = Field(
+        description="Whether the workflow is enabled for this list or not."
+    )
+    permitted_items: int = Field(description="The number of permitted items in this list.")
+    used_in_applies_to: str | None = Field(None, description="The applies to value of this list.")
 
 
-class ListItem(BaseModel):
-    id: int
-    """The unique identifier of this list item."""
-    name: str
-    """The name of this list item."""
-    code: str | None = Field(None)
-    """The code of this list item."""
-    properties: dict = Field({})
-    """The properties of this list item."""
-    subsets: dict = Field({})
-    """The subsets of this list item."""
-    parent: str | None = Field(None)
-    """The parent of this list item."""
-    parent_id: str | None = Field(None, alias="parentId")
-    """The unique identifier of the parent of this list item."""
+class Action(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    id: int = Field(description="The unique identifier of this action.")
+    name: str = Field(
+        description="The name of this Action. This is the same as the one displayed in the Web UI."
+    )
+    type: str | None = Field(
+        None, validation_alias="actionType", description="The type of this action."
+    )
 
 
-class Action(BaseModel):
-    id: int
-    """The unique identifier of this action."""
-    name: str
-    """The name of this action."""
-    type: str = Field(alias="actionType")
-    """The type of this action."""
+class ListItem(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: int = Field(description="The unique identifier of this list item.")
+    name: str = Field(description="The name of this list item.")
+    code: str | None = Field(None, description="The code of this list item.")
+    properties: dict = Field({}, description="The properties of this list item.")
+    subsets: dict = Field({}, description="The subsets of this list item.")
+    parent: str | None = Field(None, description="The parent of this list item.")
+    parent_id: str | None = Field(
+        None, description="The unique identifier of the parent of this list item."
+    )
 
 
 class Process(BaseModel):
-    id: int
-    """The unique identifier of this process."""
-    name: str
-    """The name of this process."""
+    id: int = Field(description="The unique identifier of this process.")
+    name: str = Field(description="The name of this process.")
 
 
 class Import(BaseModel):
-    id: int
-    """The unique identifier of this import."""
-    name: str
-    """The name of this import."""
-    type: str = Field(alias="importType")
-    """The type of this import."""
-    source_id: int | None = Field(None, alias="importDataSourceId")
-    """The unique identifier of the data source of this import."""
+    id: int = Field(description="The unique identifier of this import.")
+    name: str = Field(description="The name of this import.")
+    type: ImportTypes = Field(validation_alias="importType", description="The type of this import.")
+    file_id: int | None = Field(
+        None,
+        validation_alias="importDataSourceId",
+        description=(
+            "The unique identifier of the data source of this import. If it is absent, it means "
+            "that the import is not a file import."
+        ),
+    )
 
     # noinspection PyNestedDecorators
-    @field_validator("source_id", mode="before")
+    @field_validator("file_id", mode="before")
     @classmethod
     def _empty_source_is_none(cls, inp: str):
         return inp if inp else None
 
 
 class Export(BaseModel):
-    id: int
-    """The unique identifier of this export."""
-    name: str
-    """The name of this export."""
-    type: str = Field(alias="exportType")
-    """The type of this export."""
-    format: str = Field(alias="exportFormat")
-    """The format of this export."""
-    encoding: str
-    """The encoding of this export."""
-    layout: str
-    """The layout of this export. Will hold values such as `GRID_CURRENT_PAGE` 
-    and `TABULAR_ALL_LINE_ITEMS`, representing the Anaplan Export Structure.
-    """
+    model_config = ConfigDict(populate_by_name=True)
+    id: int = Field(description="The unique identifier of this export.")
+    name: str = Field(description="The name of this export.")
+    type: ExportTypes = Field(validation_alias="exportType", description="The type of this export.")
+    format: str = Field(validation_alias="exportFormat", description="The format of this export.")
+    encoding: str | None = Field(None, description="The encoding of this export.")
+    layout: ExportTypes = Field(
+        description="The layout of this export, representing the Anaplan Export Structure."
+    )
 
 
 class Module(BaseModel):
-    id: int
-    """The unique identifier of this module."""
-    name: str
-    """The name of this module."""
+    id: int = Field(description="The unique identifier of this module.")
+    name: str = Field(description="The name of this module.")
 
 
 class ModelStatus(BaseModel):
-    peak_memory_usage_estimate: int | None = Field(alias="peakMemoryUsageEstimate")
-    """The peak memory usage estimate of this model."""
-    peak_memory_usage_time: int | None = Field(alias="peakMemoryUsageTime")
-    """The peak memory usage time of this model."""
-    progress: float
-    """The progress of this model."""
-    current_step: str = Field(alias="currentStep")
-    """The current step of this model."""
-    tooltip: str | None
-    """The tooltip of this model."""
-    task_id: str | None = Field(alias="taskId")
-    """The unique identifier of the task of this model."""
-    creation_time: int = Field(alias="creationTime")
-    """The creation time of this model."""
-    export_task_type: str | None = Field(alias="exportTaskType")
-    """The export task type of this model."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    peak_memory_usage_estimate: int | None = Field(
+        description="The peak memory usage estimate of this model."
+    )
+    peak_memory_usage_time: int | None = Field(
+        description="The peak memory usage time of this model."
+    )
+    progress: float = Field(description="The progress of this model.")
+    current_step: str = Field(description="The current step of this model.")
+    tooltip: str | None = Field(description="The tooltip of this model.")
+    task_id: str | None = Field(description="The unique identifier of the task of this model.")
+    creation_time: int = Field(description="The creation time of this model.")
+    export_task_type: str | None = Field(description="The export task type of this model.")
 
 
 class LineItem(BaseModel):
-    id: int
-    """The unique identifier of this line item."""
-    name: str
-    """The name of this line item."""
-    module_id: int = Field(alias="moduleId")
-    """The unique identifier of the module this line item belongs to."""
-    module_name: str = Field(alias="moduleName")
-    """The name of the module this line item belongs to."""
-    format: str
-    """The format of this line item."""
-    format_metadata: dict = Field(alias="formatMetadata")
-    """The format metadata of this line item."""
-    summary: str
-    """The summary of this line item."""
-    applies_to: list[dict] = Field([], alias="appliesTo")
-    """The applies to value of this line item."""
-    time_scale: str = Field(alias="timeScale")
-    """The time scale of this line item."""
-    time_range: str = Field(alias="timeRange")
-    """The time range of this line item."""
-    version: dict
-    """The version of this line item."""
-    style: str
-    """The style of this line item."""
-    cell_count: int | None = Field(None, alias="cellCount")
-    """The cell count of this line item."""
-    notes: str
-    """The notes of this line item."""
-    is_summary: bool = Field(alias="isSummary")
-    """Whether this line item is a summary or not."""
-    formula: str | None = Field(None)
-    """The formula of this line item."""
-    formula_scope: str = Field(alias="formulaScope")
-    """The formula scope of this line item."""
-    use_switchover: bool = Field(alias="useSwitchover")
-    """Whether the switchover is used or not."""
-    breakback: bool
-    """Whether the breakback is enabled or not."""
-    brought_forward: bool = Field(alias="broughtForward")
-    """Whether the brought forward is enabled or not."""
-    start_of_section: bool = Field(alias="startOfSection")
-    """Whether this line item is the start of a section or not."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: int = Field(description="The unique identifier of this line item.")
+    name: str = Field(description="The name of this line item.")
+    module_id: int = Field(
+        description="The unique identifier of the module this line item belongs to."
+    )
+    module_name: str = Field(description="The name of the module this line item belongs to.")
+    format: str = Field(description="The format of this line item.")
+    format_metadata: dict = Field(description="The format metadata of this line item.")
+    summary: str = Field(description="The summary of this line item.")
+    applies_to: list[dict] = Field([], description="The applies to value of this line item.")
+    time_scale: str = Field(description="The time scale of this line item.")
+    time_range: str = Field(description="The time range of this line item.")
+    version: dict = Field(description="The version of this line item.")
+    style: str = Field(description="The style of this line item.")
+    cell_count: int | None = Field(None, description="The cell count of this line item.")
+    notes: str = Field(description="The notes of this line item.")
+    is_summary: bool = Field(description="Whether this line item is a summary or not.")
+    formula: str | None = Field(None, description="The formula of this line item.")
+    formula_scope: str = Field(description="The formula scope of this line item.")
+    use_switchover: bool = Field(description="Whether the switchover is used or not.")
+    breakback: bool = Field(description="Whether the breakback is enabled or not.")
+    brought_forward: bool = Field(description="Whether the brought forward is enabled or not.")
+    start_of_section: bool = Field(
+        description="Whether this line item is the start of a section or not."
+    )
 
 
 class Failure(BaseModel):
-    index: int = Field(alias="requestIndex")
-    """The index of the item that failed."""
-    reason: str = Field(alias="failureType")
-    """The reason for the failure."""
-    details: str = Field(alias="failureMessageDetails")
-    """The details of the failure."""
+    model_config = ConfigDict(populate_by_name=True)
+    index: int = Field(
+        validation_alias="requestIndex", description="The index of the item that failed."
+    )
+    reason: str = Field(validation_alias="failureType", description="The reason for the failure.")
+    details: str = Field(
+        validation_alias="failureMessageDetails", description="The details of the failure."
+    )
 
 
 class InsertionResult(BaseModel):
-    added: int
-    """The number of items successfully added."""
-    ignored: int
-    """The number of items ignored, or items that failed."""
-    total: int
-    """The total number of items."""
-    failures: list[Failure] = Field([])
-    """The list of failures."""
+    added: int = Field(description="The number of items successfully added.")
+    ignored: int = Field(description="The number of items ignored, or items that failed.")
+    total: int = Field(description="The total number of items.")
+    failures: list[Failure] = Field([], description="The list of failures.")
 
 
 class Revision(BaseModel):
-    id: str
-    """The unique identifier of this revision."""
-    name: str
-    """The name of this revision."""
-    description: str | None = Field(None)
-    """The description of this revision. Not always present."""
-    created_on: str = Field(alias="createdOn")
-    """The creation date of this revision in ISO format."""
-    created_by: str = Field(alias="createdBy")
-    """The unique identifier of the user who created this revision."""
-    creation_method: str = Field(alias="creationMethod")
-    """The creation method of this revision."""
-    applied_on: str = Field(alias="appliedOn")
-    """The application date of this revision in ISO format."""
-    applied_by: str = Field(alias="appliedBy")
-    """The unique identifier of the user who applied this revision."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(description="The unique identifier of this revision.")
+    name: str = Field(description="The name of this revision.")
+    description: str | None = Field(
+        None, description="The description of this revision. Not always present."
+    )
+    created_on: str = Field(description="The creation date of this revision in ISO format.")
+    created_by: str = Field(
+        description="The unique identifier of the user who created this revision."
+    )
+    creation_method: str = Field(description="The creation method of this revision.")
+    applied_on: str = Field(description="The application date of this revision in ISO format.")
+    applied_by: str = Field(
+        description="The unique identifier of the user who applied this revision."
+    )
 
 
 class ModelRevision(BaseModel):
-    id: str = Field(alias="modelId")
-    """The unique identifier of the model this revision belongs to."""
-    name: str = Field(alias="modelName")
-    """The name of the model this revision belongs to."""
-    workspace_id: str = Field(alias="workspaceId")
-    """The unique identifier of the workspace this revision belongs to."""
-    applied_by: str = Field(alias="appliedBy")
-    """The unique identifier of the user who applied this revision."""
-    applied_on: str = Field(alias="appliedOn")
-    """The application date of this revision in ISO format."""
-    applied_method: str = Field(alias="appliedMethod")
-    """The application method of this revision."""
-    deleted: bool | None = Field(None, alias="modelDeleted")
-    """Whether the model has been deleted or not."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(
+        validation_alias="modelId",
+        description="The unique identifier of the model this revision belongs to.",
+    )
+    name: str = Field(
+        validation_alias="modelName", description="The name of the model this revision belongs to."
+    )
+    workspace_id: str = Field(
+        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."
+    )
+    applied_on: str = Field(description="The application date of this revision in ISO format.")
+    applied_method: str = Field(description="The application method of this revision.")
+    deleted: bool | None = Field(
+        None,
+        validation_alias="modelDeleted",
+        description="Whether the model has been deleted or not.",
+    )
 
 
 class SyncTask(BaseModel):
-    task_id: str = Field(alias="taskId")
-    """The unique identifier of this task."""
-    task_state: str = Field(alias="taskState")
-    """The state of this task."""
-    creation_time: int = Field(alias="creationTime")
-    """The creation time of this task."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    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 User(BaseModel):
-    id: str
-    """The unique identifier of this user."""
-    active: bool
-    """Whether this user is active or not."""
-    email: str
-    """The email address of this user."""
-    email_opt_in: bool = Field(alias="emailOptIn")
-    """Whether this user has opted in to receive emails or not."""
-    first_name: str = Field(alias="firstName")
-    """The first name of this user."""
-    last_name: str = Field(alias="lastName")
-    """The last name of this user."""
-    last_login_date: str | None = Field(None, alias="lastLoginDate")
-    """The last login date of this user in ISO format."""
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(description="The unique identifier of this user.")
+    active: bool = Field(description="Whether this user is active or not.")
+    email: str = Field(description="The email address of this user.")
+    email_opt_in: bool = Field(
+        description="Whether this user has opted in to receive emails or not."
+    )
+    first_name: str = Field(description="The first name of this user.")
+    last_name: str = Field(description="The last name of this user.")
+    last_login_date: str | None = Field(
+        None, description="The last login date of this user in ISO format."
+    )
+
+
+class TaskSummary(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(validation_alias="taskId", description="The unique identifier of this task.")
+    task_state: Literal["NOT_STARTED", "IN_PROGRESS", "COMPLETE"] = Field(
+        description="The state of this task."
+    )
+    creation_time: int = Field(description="Unix timestamp of when this task was created.")
+
+
+class TaskResultDetail(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    local_message_text: str = Field(description="Error message text.")
+    occurrences: int = Field(0, description="The number of occurrences of this error.")
+    type: str = Field(description="The type of this error.")
+    values: list[str] = Field([], description="Further error information if available.")
+
+
+class TaskResult(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    details: list[TaskResultDetail] = Field(
+        [], description="The details of this task result if available."
+    )
+    successful: bool = Field(description="Whether this task completed successfully or not.")
+    failure_dump_available: bool = Field(
+        description="Whether this task completed successfully or not."
+    )
+    nested_results: list["TaskResult"] = Field(
+        [], description="The nested results of this task, if available."
+    )
+
+
+class TaskStatus(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str = Field(validation_alias="taskId", description="The unique identifier of this task.")
+    task_state: Literal["NOT_STARTED", "IN_PROGRESS", "COMPLETE"] = Field(
+        description="The state of this task."
+    )
+    creation_time: int = Field(description="Unix timestamp of when this task was created.")
+    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)

{anaplan_sdk-0.2.11.dist-info → anaplan_sdk-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.2.11
+Version: 0.3.0
 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
@@ -38,7 +38,7 @@ implementation details like authentication, error handling, chunking, compressio
 This Projects supports
 the [Bulk APIs](https://help.anaplan.com/use-the-bulk-apis-93218e5e-00e5-406e-8361-09ab861889a7),
 the [Transactional APIs](https://help.anaplan.com/use-the-transactional-apis-cc1c1e91-39fc-4272-a4b5-16bc91e9c313) and
-the [ALM APsI](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
+the [ALM APIs](https://help.anaplan.com/application-lifecycle-management-api-2565cfa6-e0c2-4e24-884e-d0df957184d6),
 the [Audit APIs](https://auditservice.docs.apiary.io/#),
 providing both synchronous and asynchronous Clients.
 

{anaplan_sdk-0.2.11.dist-info → anaplan_sdk-0.3.0.dist-info}/RECORD

@@ -2,18 +2,18 @@ anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
 anaplan_sdk/_auth.py,sha256=0d495G_iU8vfpk29BJow7Jw2staf18nXqpJlSfaL9h8,5123
 anaplan_sdk/_base.py,sha256=MEE6LpL788QTkrpAVsYI5hu3RfbzSMLGUj-QSW8-OU0,6160
 anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-anaplan_sdk/models.py,sha256=ceMaVctpjwQHk7a71Io_-1YcCQshx5i1YYnqxS51nYw,12491
+anaplan_sdk/models.py,sha256=CpfFVJcW4AVwbAoI6GuPClbywjs2bWXOyH7Vrlnlo4o,16255
 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=yhBt5Fzpt07IGIhvMZWcMoXEIGUlSJwAsxvzaq2vT9c,7056
+anaplan_sdk/_async_clients/_bulk.py,sha256=X5W6-WgUYW9O2f8SIWy7IxjSv4vAz9fYL9jxpEzrpXQ,22354
+anaplan_sdk/_async_clients/_transactional.py,sha256=LlrEVc6c9cUD62PBlOCNjS0ALxqoHy5GZvadacyPbG8,7496
 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=-DuNhhfp2h9fc-ENJQRh9qwXsZiBi3OV1LeH3S7Jzsc,6871
-anaplan_sdk-0.2.11.dist-info/METADATA,sha256=1GMwYl98joRinRzgF3edxbhnY0FeDFE236OnrYNK8CY,3618
-anaplan_sdk-0.2.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.2.11.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.2.11.dist-info/RECORD,,
+anaplan_sdk/_clients/_bulk.py,sha256=3oOaUqjvHF-L-ThFK7joLMQ2iDSSFZ9y5mVUhW45fp8,22398
+anaplan_sdk/_clients/_transactional.py,sha256=2ssYdMY9vynQUwwigOvgSgi2-wbfXDQaAShLqXbVFSQ,7299
+anaplan_sdk-0.3.0.dist-info/METADATA,sha256=b4_PgGjPB-TPX2RV3R5PMLxozPjAnCqq6naA3BXLpNA,3617
+anaplan_sdk-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.3.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.3.0.dist-info/RECORD,,