anaplan-sdk 0.4.4a4__py3-none-any.whl → 0.5.0a1__py3-none-any.whl

anaplan_sdk/models/_transactional.py

@@ -1,3 +1,5 @@
+from typing import Literal, TypeAlias, Union
+
 from pydantic import Field
 
 from ._base import AnaplanModel
@@ -34,6 +36,120 @@ class Module(AnaplanModel):
     name: str = Field(description="The name of this module.")
 
 
+class Dimension(AnaplanModel):
+    id: int = Field(description="The unique identifier of this dimension.")
+    name: str = Field(description="The name of this dimension.")
+
+
+class DimensionWithCode(Dimension):
+    code: str = Field(description="The code of this dimension.")
+
+
+class View(AnaplanModel):
+    code: str = Field(description="The code of this view.")
+    id: int = Field(description="The unique identifier of this view.")
+    name: str = Field(description="The name of this views.")
+    moduleId: int = Field(description="The unique identifier of the module this view belongs to.")
+
+
+class ViewInfo(AnaplanModel):
+    view_id: int = Field(description="The unique identifier of this view.")
+    view_name: str = Field(description="The name of this view.")
+    rows: list[Dimension] = Field(
+        [], description="The list of dimensions in the rows of this view."
+    )
+    pages: list[Dimension] = Field(
+        [], description="The list of dimensions in the pages of this view."
+    )
+
+
+class PeriodType(AnaplanModel):
+    entity_id: Literal["YEAR", "HALF_YEAR", "MONTH", "QUARTER", "WEEK", "DAY"] = Field(
+        description="The type of period entity."
+    )
+    entity_label: Literal["Year", "Half-Year", "Month", "Quarter", "Week", "Day"] = Field(
+        description="The type of period entity."
+    )
+    entity_index: int = Field(description="The index of the period entity")
+
+
+class EntityFormatFilter(AnaplanModel):
+    source_line_item_or_property: str = Field(
+        description="The unique identifier of the source line item or property."
+    )
+    mapping_hierarchy: str = Field(description="The unique identifier of the mapping hierarchy.")
+    key_property: str = Field(description="The unique identifier of the key property.")
+    value_property: str = Field(description="The unique identifier of the value property.")
+
+
+class TextMetadata(AnaplanModel):
+    data_type: Literal["TEXT"] = Field(
+        description="The data type. Literal for the tagged union discriminator."
+    )
+    text_type: Literal["DRILLTHRU_URI", "EMAIL_ADDRESS", "GENERAL"] = Field(
+        description="The text type."
+    )
+
+
+class ListMetadata(AnaplanModel):
+    data_type: Literal["ENTITY"] = Field(
+        description="The data type. Literal for the tagged union discriminator."
+    )
+    hierarchy_entity_id: int = Field(
+        validation_alias="hierarchyEntityLongId",
+        description="The unique identifier of the hierarchy entity, like Lists or List Subsets.",
+    )
+    selective_access_applied: bool = Field(
+        description="Whether selective access is applied or not."
+    )
+    show_all: bool = Field(description="Whether to show all values or not.")
+    entity_format_filter: EntityFormatFilter | None = Field(
+        None, description="Entity format filter configuration."
+    )
+
+
+class TimePeriodMetadata(AnaplanModel):
+    data_type: Literal["TIME_ENTITY"] = Field(
+        description="The data type. Literal for the tagged union discriminator."
+    )
+    period_type: PeriodType = Field(description="The period type.")
+
+
+class NumberMetadata(AnaplanModel):
+    data_type: Literal["NUMBER"] = Field(
+        description="The data type. Literal for the tagged union discriminator."
+    )
+    comparison_increase: Literal["GOOD", "BAD", "NEUTRAL"] | None = Field(
+        description="The comparison increase setting."
+    )
+    custom_units: str | None = Field(None, description="Custom units for display.")
+    decimal_places: int = Field(description="Number of decimal places.")
+    decimal_separator: Literal["COMMA", "FULL_STOP"] = Field(description="The decimal separator.")
+    units_display_type: Literal[
+        "CUSTOM_SUFFIX",
+        "CUSTOM_PREFIX",
+        "CURRENCY_CODE",
+        "CURRENCY_SYMBOL",
+        "PERCENTAGE_SUFFIX",
+        "NONE",
+    ] = Field(description="Units display type.")
+    units_type: Literal["CUSTOM", "CURRENCY", "PERCENTAGE", "NONE"] = Field(
+        description="Units type."
+    )
+    zero_format: Literal["HYPHEN", "ZERO", "BLANK"] = Field(description="Zero format display.")
+    grouping_separator: Literal["COMMA", "FULL_STOP", "SPACE", "NONE"] = Field(
+        description="The grouping separator."
+    )
+    minimum_significant_digits: int = Field(description="Minimum significant digits.")
+    negative_number_notation: Literal["MINUS_SIGN", "PARENTHESES"] = Field(
+        description="Negative number notation."
+    )
+
+
+class GenericTypeMetadata(AnaplanModel):
+    data_type: Literal["BOOLEAN", "NONE", "DATE"] = Field(description="The data type.")
+
+
 class LineItem(AnaplanModel):
     id: int = Field(description="The unique identifier of this line item.")
     name: str = Field(description="The name of this line item.")
@@ -41,16 +157,33 @@ class LineItem(AnaplanModel):
         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.")
+    format: Literal["NUMBER", "BOOLEAN", "TEXT", "NONE", "DATE", "LIST", "TIME PERIOD"] = Field(
+        description="The format of this line item."
+    )
+    format_metadata: (
+        NumberMetadata | ListMetadata | TimePeriodMetadata | TextMetadata | GenericTypeMetadata
+    ) = Field(
+        description="The format metadata of this line item. Each Type provides different metadata.",
+        discriminator="data_type",
+    )
     summary: str = Field(description="The summary of this line item.")
-    applies_to: list[dict] = Field([], description="The applies to value of this line item.")
+    applies_to: list[Dimension] = Field([], description="The applies to value of this line item.")
+    data_tags: list[Dimension] = Field([], description="The data tags of this line item.")
+    referenced_by: list[Dimension] = Field([], description="List of references to 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.")
+    version: Dimension = Field(description="The version of this line item.")
+    parent: Dimension | None = Field(None, description="The Parent of this line item.")
+    read_access_driver: Dimension | None = Field(
+        None, description="The read access driver of this line item."
+    )
+    write_access_driver: Dimension | None = Field(
+        None, description="The write access driver 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.")
+    code: str | None = Field(None, description="The code 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.")
@@ -92,3 +225,87 @@ class InsertionResult(AnaplanModel):
     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 ListDeletionResult(AnaplanModel):
+    deleted: int = Field(description="The number of items successfully deleted.")
+    failures: list[Failure] = Field([], description="The list of failures.")
+
+
+class PartialCurrentPeriod(AnaplanModel):
+    period_text: str = Field(description="The text representation of the current period.")
+    last_day: str = Field(description="The last day of the current period in YYYY-MM-DD format.")
+
+
+class CurrentPeriod(PartialCurrentPeriod):
+    calendar_type: str = Field(description="The type of calendar used for the current period.")
+
+
+class FiscalYear(AnaplanModel):
+    year: str = Field(description="The fiscal year in the format set in the model, e.g. FY24.")
+    start_date: str = Field(description="The start date of the fiscal year in YYYY-MM-DD format.")
+    end_date: str = Field(description="The end date of the fiscal year in YYYY-MM-DD format.")
+
+
+class TotalsSelection(AnaplanModel):
+    quarter_totals: bool = Field(description="Whether quarter totals are enabled.")
+    half_year_totals: bool = Field(description="Whether half year totals are enabled.")
+    year_to_date_summary: bool = Field(description="Whether year to date summary is enabled.")
+    year_to_go_summary: bool = Field(description="Whether year to go summary is enabled.")
+    total_of_all_periods: bool = Field(description="Whether total of all periods is enabled.")
+
+
+class TotalsSelectionWithQuarter(TotalsSelection):
+    extra_month_quarter: Literal[1, 2, 3, 4] = Field(
+        description="The quarter in which the extra month is included."
+    )
+
+
+class BaseCalendar(AnaplanModel):
+    calendar_type: Literal[
+        "Calendar Months/Quarters/Years",
+        "Weeks: 4-4-5, 4-5-4 or 5-4-4",
+        "Weeks: General",
+        "Weeks: 13 4-week Periods",
+    ] = Field(description="The type of calendar used.")
+    current_period: PartialCurrentPeriod = Field(description="The current period configuration.")
+
+
+class MonthsQuartersYearsCalendar(BaseCalendar):
+    past_years_count: int = Field(description="The number of past years included.")
+    fiscal_year: FiscalYear = Field(description="The fiscal year configuration.")
+    totals_selection: TotalsSelection = Field(
+        description="The totals selection configuration for the calendar."
+    )
+
+
+class WeeksGeneralCalendar(BaseCalendar):
+    start_date: str = Field(description="The start date of the calendar in YYYY-MM-DD format.")
+    weeks_count: int = Field(description="The number of weeks in the calendar.")
+
+
+class WeeksPeriodsCalendar(BaseCalendar):
+    fiscal_year: FiscalYear = Field(description="The fiscal year configuration.")
+    past_years_count: int = Field(description="The number of past years included.")
+    future_years_count: int = Field(description="The number of future years included.")
+    extra_week_month: int = Field(description="The month in which the extra week is included.")
+    week_format: Literal["Numbered", "Week Commencing", "Week Ending"] = Field(
+        description="The format of the week."
+    )
+    totals_selection: TotalsSelectionWithQuarter = Field(
+        description="The totals selection configuration for the calendar."
+    )
+
+
+class WeeksGroupingCalendar(WeeksPeriodsCalendar):
+    week_grouping: str = Field(
+        description="The week grouping configuration, e.g. '4-4-5', '4-5-4', or '5-4-4'."
+    )
+    totals_selection: TotalsSelection = Field(
+        description="The totals selection configuration for the calendar."
+    )
+
+
+ModelCalendar: TypeAlias = Union[
+    MonthsQuartersYearsCalendar, WeeksGeneralCalendar, WeeksGroupingCalendar, WeeksPeriodsCalendar
+]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anaplan-sdk
-Version: 0.4.4a4
+Version: 0.5.0a1
 Summary: Streamlined Python Interface for Anaplan
 Project-URL: Homepage, https://vinzenzklass.github.io/anaplan-sdk/
 Project-URL: Repository, https://github.com/VinzenzKlass/anaplan-sdk
@@ -60,7 +60,8 @@ abstractions over all Anaplan APIs, allowing you to focus on business requiremen
 
 ## Getting Started
 
-Head over to the [Quick Start](quickstart.md) for basic usage instructions and examples.
+Head over to the [Quick Start](https://vinzenzklass.github.io/anaplan-sdk/quickstart/) for basic usage instructions and
+examples.
 
 ## Contributing
 

anaplan_sdk-0.5.0a1.dist-info/RECORD

@@ -0,0 +1,30 @@
+anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
+anaplan_sdk/_auth.py,sha256=l5z2WCcfQ05OkuQ1dcmikp6dB87Rw1qy2zu8bbaAQTs,16620
+anaplan_sdk/_base.py,sha256=i7NznGMnI9tVQB5mXo5DakSRmvWoDOgfkOMWQGNiXOI,16616
+anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
+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=pL-l9EBkbR_M7FbIpKo-YPi265busEhqJn2fB0syVsA,13063
+anaplan_sdk/_async_clients/_audit.py,sha256=tsMydMxepKW9NVAVpqoC48sfmKKC7bJoljUycWfxipA,2396
+anaplan_sdk/_async_clients/_bulk.py,sha256=OcCzvMhbQjJBbeyVw6J5o3Kipa7Tfv0fJcS5MAcIZn4,26708
+anaplan_sdk/_async_clients/_cloud_works.py,sha256=miTgllBKcd5-kKjy5XIdMzndQnyR2DngEN8ldS7t_Rg,17529
+anaplan_sdk/_async_clients/_cw_flow.py,sha256=gb7UhKuYI0Z1ftEeLKtx-oWmaqDJN_RTRdiOm2ZkjFM,3991
+anaplan_sdk/_async_clients/_transactional.py,sha256=9TbFaOYG3cPUPwgQosTtFWXQ6G2PiU3P8r5Mw1p4-dk,17063
+anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
+anaplan_sdk/_clients/_alm.py,sha256=IS9G7B8MI9ACucxBKdA60p8Bz3-FsywleNK6g3_cK50,12788
+anaplan_sdk/_clients/_audit.py,sha256=zjzuU0YS1XViBKZfIVJXAivIsskuJQRyU22DRnpSHZo,2265
+anaplan_sdk/_clients/_bulk.py,sha256=bIzu6wd0JbwwQdK4-tp25gVrx3Q7V2NNrV7fFe6TkPg,26760
+anaplan_sdk/_clients/_cloud_works.py,sha256=bFtIgexOS6oXftrTL-o2E1v5H8CzNxDy-vHAlUxdKJg,17334
+anaplan_sdk/_clients/_cw_flow.py,sha256=F7zoZ4CEpXe7FcGTJO9y2vJC5cd7Jz-ipTnlsk4Q-dA,3867
+anaplan_sdk/_clients/_transactional.py,sha256=rEa9VdgTFYQkzij9nBGdur7KbWDq_RrkiuwE25FZ0ic,16767
+anaplan_sdk/models/__init__.py,sha256=8qS16lOb2cKxbHzqMkTK0bYvzolucppqD1I7Xx1I5rc,1731
+anaplan_sdk/models/_alm.py,sha256=oeENd0YM7-LoIRBq2uATIQTxVgIP9rXx3UZE2UnQAp0,4670
+anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
+anaplan_sdk/models/_bulk.py,sha256=WL0OPNbsYo7lpx-vrk_GLvQXZijxfpE0kleqfQifRyg,8868
+anaplan_sdk/models/_transactional.py,sha256=2bH10zvtMb5Lfh6DC7iQk72aEwq6tyLQ-XnH_0wYSqI,14172
+anaplan_sdk/models/cloud_works.py,sha256=nfn_LHPR-KmW7Tpvz-5qNCzmR8SYgvsVV-lx5iDlyqI,19425
+anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
+anaplan_sdk-0.5.0a1.dist-info/METADATA,sha256=e9ldeBTGI3rqZ9o8VsK_rCl4e2BOqCRIW_Zl5B4UH4U,3669
+anaplan_sdk-0.5.0a1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+anaplan_sdk-0.5.0a1.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+anaplan_sdk-0.5.0a1.dist-info/RECORD,,

anaplan_sdk-0.4.4a4.dist-info/RECORD

@@ -1,30 +0,0 @@
-anaplan_sdk/__init__.py,sha256=WScEKtXlnRLjCb-j3qW9W4kEACTyPsTLFs-L54et2TQ,351
-anaplan_sdk/_auth.py,sha256=H5A_fujTMHf7J33w2jkqMYtlxKFwzqZgxFcBJHi8wvc,16612
-anaplan_sdk/_base.py,sha256=9CdLshORWsLixOyoFa3A0Bka5lhLwlZrQI5sEdBcGFI,12298
-anaplan_sdk/_oauth.py,sha256=AynlJDrGIinQT0jwxI2RSvtU4D7Wasyw3H1uicdlLVI,12672
-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=O1_r-O1tNDq7vXRwE2UEFE5S2bPmPh4IAQPQ8bmZfQE,3297
-anaplan_sdk/_async_clients/_audit.py,sha256=a92RY0B3bWxp2CCAWjzqKfvBjG1LJGlai0Hn5qmwgF8,2312
-anaplan_sdk/_async_clients/_bulk.py,sha256=j0yMoM8NWQH9BsSQ4LRYt8djfd1d11vkjNfU8pUeGLU,23737
-anaplan_sdk/_async_clients/_cloud_works.py,sha256=KPX9W55SF6h8fJd4Rx-HLq6eaRA-Vo3rFu343UiiaGQ,16642
-anaplan_sdk/_async_clients/_cw_flow.py,sha256=ZTNAbKDwb59Wg3u68hbtt1kpd-LNz9K0sftT-gvYzJQ,3651
-anaplan_sdk/_async_clients/_transactional.py,sha256=Mvr7OyBPjQRpBtzkJNfRzV4aNCzUiaYmm0zQubo62Wo,8035
-anaplan_sdk/_clients/__init__.py,sha256=FsbwvZC1FHrxuRXwbPxUzbhz_lO1DpXIxEOjx6-3QuA,219
-anaplan_sdk/_clients/_alm.py,sha256=UAdQxgHfax-VquC0YtbqrRBku2Rn35tVgwJdxYFScps,3202
-anaplan_sdk/_clients/_audit.py,sha256=xQQiwWIb4QQefolPvxNwBFE-pkRzzi8fYPyewjF63lc,2181
-anaplan_sdk/_clients/_bulk.py,sha256=nlsZHK8vjhvyC0auRuqyvJVvTISPqj9EIHBYLoqSpOc,23354
-anaplan_sdk/_clients/_cloud_works.py,sha256=KAMnLoeMJ2iwMXlDSbKynCE57BtkCfOgM5O8wT1kkSs,16291
-anaplan_sdk/_clients/_cw_flow.py,sha256=5IFWFT-qbyGvaSOOtaFOjHnOlyYbj4Rj3xiavfTlm8c,3527
-anaplan_sdk/_clients/_transactional.py,sha256=YUVbA54uhMloQcahwMtmZO3YooO6qQzwZN3ZRSu_z_c,7976
-anaplan_sdk/models/__init__.py,sha256=nSplwPG_74CG9CKbv1PzP9bsA9v5-daS4azpTCvCQTI,925
-anaplan_sdk/models/_alm.py,sha256=IqsTPvkx_ujLpaqZgIrTcr44KHJyKc4dyeRs9rkDjms,2307
-anaplan_sdk/models/_base.py,sha256=6AZc9CfireUKgpZfMxYKu4MbwiyHQOsGLjKrxGXBLic,508
-anaplan_sdk/models/_bulk.py,sha256=_lHARGGjJgi-AmA7u5ZfCmGpLecPnr73LSAsZSX-a_A,8276
-anaplan_sdk/models/_transactional.py,sha256=_0UbVR9D5QABI29yloYrJTSgL-K0EU7PzPeJu5LdhnY,4854
-anaplan_sdk/models/cloud_works.py,sha256=nfn_LHPR-KmW7Tpvz-5qNCzmR8SYgvsVV-lx5iDlyqI,19425
-anaplan_sdk/models/flows.py,sha256=SuLgNj5-2SeE3U1i8iY8cq2IkjuUgd_3M1n2ENructk,3625
-anaplan_sdk-0.4.4a4.dist-info/METADATA,sha256=uf0KLkAvBJr3cY668F9T-wuIG5uya2zHvIRu-roipVo,3628
-anaplan_sdk-0.4.4a4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-anaplan_sdk-0.4.4a4.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-anaplan_sdk-0.4.4a4.dist-info/RECORD,,