anaplan-sdk 0.3.1b1__py3-none-any.whl → 0.4.0a2__py3-none-any.whl

anaplan_sdk/models.py

@@ -1,329 +0,0 @@
-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):
-    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):
-    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
-    id: str = Field(description="The unique identifier of this model.")
-    name: str
-    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):
-    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 = Field(description="The unique identifier of this list.")
-    name: str = Field(description="The name of this list.")
-
-
-class ListMetadata(BaseModel):
-    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 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 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 = Field(description="The unique identifier of this process.")
-    name: str = Field(description="The name of this process.")
-
-
-class Import(BaseModel):
-    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("file_id", mode="before")
-    @classmethod
-    def _empty_source_is_none(cls, inp: str):
-        return inp if inp else None
-
-
-class Export(BaseModel):
-    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 = Field(description="The unique identifier of this module.")
-    name: str = Field(description="The name of this module.")
-
-
-class ModelStatus(BaseModel):
-    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):
-    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):
-    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 = 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):
-    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):
-    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):
-    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):
-    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.3.1b1.dist-info/METADATA

@@ -1,109 +0,0 @@
-Metadata-Version: 2.4
-Name: anaplan-sdk
-Version: 0.3.1b1
-Summary: Provides pythonic access to the Anaplan API
-Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
-Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk
-Project-URL: Documentation, https://vinzenzklass.github.io/anaplan-sdk/
-Author-email: Vinzenz Klass <vinzenz.klass@valantic.com>
-License-Expression: Apache-2.0
-License-File: LICENSE
-Keywords: anaplan,anaplan alm api,anaplan api,anaplan audit api,anaplan bulk api,anaplan integration
-Requires-Python: >=3.10.4
-Requires-Dist: cryptography<45.0.0,>=42.0.7
-Requires-Dist: httpx<1.0.0,>=0.27.0
-Requires-Dist: pydantic<3.0.0,>=2.7.2
-Description-Content-Type: text/markdown
-
-<p align="center" style="margin: 0 0 10px">
-  <img width="200" height="200" src="https://vinzenzklass.github.io/anaplan-sdk/img/anaplan-sdk.webp" alt='Python' style="border-radius: 15px">
-</p>
-
-<h1 align="center" style="font-size: 3rem; font-weight: 400; margin: -15px 0">
-Anaplan SDK
-</h1>
-
-<p align="center" style="margin-top: 15px">
-<a href="https://pepy.tech/project/anaplan-sdk">
-<img align="center" src="https://static.pepy.tech/badge/anaplan-sdk/month" alt="Downloads Badge"/>
-</a>
-</p>
-
----
-
-Anaplan SDK is an independent, unofficial project providing pythonic access to Anaplan. Anaplan SDK provides high-level
-abstractions over the various Anaplan APIs, so you can focus on you requirements rather than spend time on
-implementation details like authentication, error handling, chunking, compression and data formatting.
-
-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 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.
-
-Visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/) for documentation.
-
----
-
-### Install Anaplan SDK using pip
-
-```shell
-pip install anaplan-sdk
-```
-
-### Instantiate a client
-
-```python
-import anaplan_sdk
-
-anaplan = anaplan_sdk.Client(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-```
-
-### Find workspaces and models
-
-If you don't know the workspace and model Ids, instantiate client with authentication information only and
-call `.list_workspaces()` and list `.list_models()`
-
-```python
-anaplan = anaplan_sdk.Client(
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-
-for workspace in anaplan.list_workspaces():
-    print(f"{workspace.name}: {workspace.id}")
-
-for model in anaplan.list_models():
-    print(f"{model.name}: {model.id}")
-```
-
-### Async Support
-
-This SDK also provides an `AsyncClient` with full async support
-
-```python
-import asyncio
-
-anaplan = anaplan_sdk.AsyncClient(
-    workspace_id="AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
-    model_id="11111111111111111111111111111111",
-    user_email="admin@company.com",
-    password="my_super_secret_password",
-)
-workspaces, models = await asyncio.gather(
-    anaplan.list_workspaces(), anaplan.list_models()
-)
-for workspace in workspaces:
-    print(f"{workspace.name}: {workspace.id}")
-for model in models:
-    print(f"{model.name}: {model.id}")
-```
-
-For more information, API reference and detailed guides,
-visit [Anaplan SDK](https://vinzenzklass.github.io/anaplan-sdk/).

anaplan_sdk-0.3.1b1.dist-info/RECORD

@@ -1,19 +0,0 @@
-anaplan_sdk/__init__.py,sha256=5fr-SZSsH6f3vkRUTDoK6xdAN31cCpe9Mwz2VNu47Uw,134
-anaplan_sdk/_auth.py,sha256=0d495G_iU8vfpk29BJow7Jw2staf18nXqpJlSfaL9h8,5123
-anaplan_sdk/_base.py,sha256=sRsM1z2QadTZ3HhX5NDH6NNRgGCJTy32sJB3cQzDT7E,8465
-anaplan_sdk/exceptions.py,sha256=ALkA9fBF0NQ7dufFxV6AivjmHyuJk9DOQ9jtJV2n7f0,1809
-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=t8tsQQ6v5kJXERAeAWEI1P9-vO5GsJCyWRTwh7EK1uw,1467
-anaplan_sdk/_async_clients/_bulk.py,sha256=O2EiDRdGliYMovGESUvjy2HM0SwsQh9UTmayKmtnASc,22419
-anaplan_sdk/_async_clients/_transactional.py,sha256=eKLT2s5cfnLmK7eqzhfAn8kwoYxEBYgSqwhDgZFA03k,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=ae6szT0_OhaNWZUA9b3s2xnkYhSOKbrtnn0SKxmDeqI,1485
-anaplan_sdk/_clients/_bulk.py,sha256=NUW26y0-9PO_4yatabZ3n47ld66nHbBVP7Fx3GbG8l8,22471
-anaplan_sdk/_clients/_transactional.py,sha256=_ZrR40sNREZbaSkIzxpM9iMc85Wq9LDnytR8IlU9lqY,7331
-anaplan_sdk-0.3.1b1.dist-info/METADATA,sha256=6nZiUHD4AIAQxzF3SzgmZ-JfXaYrGsl7xyqdFjxft0k,3619
-anaplan_sdk-0.3.1b1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.3.1b1.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.3.1b1.dist-info/RECORD,,