visier-platform-sdk 22222222.99200.21494__py3-none-any.whl

visier_platform_sdk/models/plan_schema_dto.py

@@ -0,0 +1,126 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.plan_item_dto import PlanItemDTO
+from visier_platform_sdk.models.plan_segment_level_dto import PlanSegmentLevelDTO
+from visier_platform_sdk.models.plan_segment_level_member_list_dto import PlanSegmentLevelMemberListDTO
+from visier_platform_sdk.models.plan_time_period_dto import PlanTimePeriodDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanSchemaDTO(BaseModel):
+    """
+    Information about a plan's schema.
+    """ # noqa: E501
+    plan_items: Optional[List[PlanItemDTO]] = Field(default=None, description="A collection of editable plan items in a plan.", alias="planItems")
+    time_periods: Optional[List[PlanTimePeriodDTO]] = Field(default=None, description="The editable time periods in a plan. These time periods are the columns in the planning grid.", alias="timePeriods")
+    plan_segment_levels: Optional[List[PlanSegmentLevelDTO]] = Field(default=None, description="The dimensions that the plan is segmented by.", alias="planSegmentLevels")
+    plan_segment_level_members: Optional[List[PlanSegmentLevelMemberListDTO]] = Field(default=None, description="A collection of members grouped by their dimension and level.  The combination of these member IDs points to a specific row in the plan.", alias="planSegmentLevelMembers")
+    __properties: ClassVar[List[str]] = ["planItems", "timePeriods", "planSegmentLevels", "planSegmentLevelMembers"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanSchemaDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in plan_items (list)
+        _items = []
+        if self.plan_items:
+            for _item_plan_items in self.plan_items:
+                if _item_plan_items:
+                    _items.append(_item_plan_items.to_dict())
+            _dict['planItems'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in time_periods (list)
+        _items = []
+        if self.time_periods:
+            for _item_time_periods in self.time_periods:
+                if _item_time_periods:
+                    _items.append(_item_time_periods.to_dict())
+            _dict['timePeriods'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in plan_segment_levels (list)
+        _items = []
+        if self.plan_segment_levels:
+            for _item_plan_segment_levels in self.plan_segment_levels:
+                if _item_plan_segment_levels:
+                    _items.append(_item_plan_segment_levels.to_dict())
+            _dict['planSegmentLevels'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in plan_segment_level_members (list)
+        _items = []
+        if self.plan_segment_level_members:
+            for _item_plan_segment_level_members in self.plan_segment_level_members:
+                if _item_plan_segment_level_members:
+                    _items.append(_item_plan_segment_level_members.to_dict())
+            _dict['planSegmentLevelMembers'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanSchemaDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "planItems": [PlanItemDTO.from_dict(_item) for _item in obj["planItems"]] if obj.get("planItems") is not None else None,
+            "timePeriods": [PlanTimePeriodDTO.from_dict(_item) for _item in obj["timePeriods"]] if obj.get("timePeriods") is not None else None,
+            "planSegmentLevels": [PlanSegmentLevelDTO.from_dict(_item) for _item in obj["planSegmentLevels"]] if obj.get("planSegmentLevels") is not None else None,
+            "planSegmentLevelMembers": [PlanSegmentLevelMemberListDTO.from_dict(_item) for _item in obj["planSegmentLevelMembers"]] if obj.get("planSegmentLevelMembers") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_segment_level_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanSegmentLevelDTO(BaseModel):
+    """
+    A dimension and dimension level that segments the plan.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension appended with its level ID.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension level.", alias="displayName")
+    order: Optional[StrictInt] = Field(default=None, description="The number that describes the segment's position in the plan's overall structure.")
+    segment_id: Optional[StrictStr] = Field(default=None, description="The symbol name of the dimension.", alias="segmentId")
+    segment_display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension.", alias="segmentDisplayName")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "order", "segmentId", "segmentDisplayName"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "displayName": obj.get("displayName"),
+            "order": obj.get("order"),
+            "segmentId": obj.get("segmentId"),
+            "segmentDisplayName": obj.get("segmentDisplayName")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_segment_level_member_dto.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanSegmentLevelMemberDTO(BaseModel):
+    """
+    A member in the dimension.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension member.", alias="displayName")
+    is_custom: Optional[StrictBool] = Field(default=None, description="If `true`, this is a custom member created for use in the plan and all its subplans.", alias="isCustom")
+    parent_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension member's parent.", alias="parentId")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "isCustom", "parentId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelMemberDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelMemberDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "displayName": obj.get("displayName"),
+            "isCustom": obj.get("isCustom"),
+            "parentId": obj.get("parentId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_segment_level_member_list_dto.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.plan_segment_level_member_dto import PlanSegmentLevelMemberDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanSegmentLevelMemberListDTO(BaseModel):
+    """
+    A collection of dimension members.
+    """ # noqa: E501
+    segment_level_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension and dimension level.", alias="segmentLevelId")
+    members: Optional[List[PlanSegmentLevelMemberDTO]] = Field(default=None, description="The dimension members.")
+    segment_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the dimension.", alias="segmentId")
+    __properties: ClassVar[List[str]] = ["segmentLevelId", "members", "segmentId"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelMemberListDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in members (list)
+        _items = []
+        if self.members:
+            for _item_members in self.members:
+                if _item_members:
+                    _items.append(_item_members.to_dict())
+            _dict['members'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanSegmentLevelMemberListDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "segmentLevelId": obj.get("segmentLevelId"),
+            "members": [PlanSegmentLevelMemberDTO.from_dict(_item) for _item in obj["members"]] if obj.get("members") is not None else None,
+            "segmentId": obj.get("segmentId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_time_period_dto.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanTimePeriodDTO(BaseModel):
+    """
+    A time period in the plan.
+    """ # noqa: E501
+    var_date: Optional[StrictStr] = Field(default=None, description="The date of the time period. The format is YYYY-MM-DD.", alias="date")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the time period; for example, March 2024.", alias="displayName")
+    __properties: ClassVar[List[str]] = ["date", "displayName"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanTimePeriodDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanTimePeriodDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "date": obj.get("date"),
+            "displayName": obj.get("displayName")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_with_schema_dto.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.plan_data_load_error_dto import PlanDataLoadErrorDTO
+from visier_platform_sdk.models.plan_info_dto import PlanInfoDTO
+from visier_platform_sdk.models.plan_schema_dto import PlanSchemaDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanWithSchemaDTO(BaseModel):
+    """
+    Details about the plan, including its schema.
+    """ # noqa: E501
+    plan: Optional[PlanInfoDTO] = None
+    var_schema: Optional[PlanSchemaDTO] = Field(default=None, alias="schema")
+    errors: Optional[List[PlanDataLoadErrorDTO]] = Field(default=None, description="The errors that occurred while loading the data.")
+    __properties: ClassVar[List[str]] = ["plan", "schema", "errors"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of PlanWithSchemaDTO from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of plan
+        if self.plan:
+            _dict['plan'] = self.plan.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of var_schema
+        if self.var_schema:
+            _dict['schema'] = self.var_schema.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in errors (list)
+        _items = []
+        if self.errors:
+            for _item_errors in self.errors:
+                if _item_errors:
+                    _items.append(_item_errors.to_dict())
+            _dict['errors'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanWithSchemaDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "plan": PlanInfoDTO.from_dict(obj["plan"]) if obj.get("plan") is not None else None,
+            "schema": PlanSchemaDTO.from_dict(obj["schema"]) if obj.get("schema") is not None else None,
+            "errors": [PlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None
+        })
+        return _obj
+
+