visier-platform-sdk 22222222.99201.1914__py3-none-any.whl → 22222222.99201.1914b6__py3-none-any.whl

visier_platform_sdk/models/plan_data_upload_response_dto.py

@@ -21,7 +21,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
 from visier_platform_sdk.models.plan_data_load_change_list_dto import PlanDataLoadChangeListDTO
-from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO
+from visier_platform_sdk.models.plan_data_load_error_dto import PlanDataLoadErrorDTO
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -31,7 +31,7 @@ class PlanDataUploadResponseDTO(BaseModel):
     """ # noqa: E501
     updated_cells_count: Optional[StrictInt] = Field(default=None, description="The number of cells that were updated from the data load process.", alias="updatedCellsCount")
     potential_updated_cells_count: Optional[StrictInt] = Field(default=None, description="The number of cells that would have been updated if all changes were saved.", alias="potentialUpdatedCellsCount")
-    errors: Optional[List[PlanningPlanDataLoadErrorDTO]] = Field(default=None, description="The collection of errors encountered during the data load process.")
+    errors: Optional[List[PlanDataLoadErrorDTO]] = Field(default=None, description="The collection of errors encountered during the data load process.")
     changelists: Optional[List[PlanDataLoadChangeListDTO]] = Field(default=None, description="The collection of changes grouped by plan item made during the data load process. This list only contains the changes specified by the load. If you indicated in the request that the changes are to be rolled up or distributed, the values modified as a result of the calculations are not listed here.")
     __properties: ClassVar[List[str]] = ["updatedCellsCount", "potentialUpdatedCellsCount", "errors", "changelists"]
 
@@ -102,7 +102,7 @@ class PlanDataUploadResponseDTO(BaseModel):
         _obj = cls.model_validate({
             "updatedCellsCount": obj.get("updatedCellsCount"),
             "potentialUpdatedCellsCount": obj.get("potentialUpdatedCellsCount"),
-            "errors": [PlanningPlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "errors": [PlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
             "changelists": [PlanDataLoadChangeListDTO.from_dict(_item) for _item in obj["changelists"]] if obj.get("changelists") is not None else None
         })
         return _obj

visier_platform_sdk/models/plan_info_dto.py

@@ -0,0 +1,106 @@
+# 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.99201.1914
+    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.scenario_info_dto import ScenarioInfoDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanInfoDTO(BaseModel):
+    """
+    Information about a plan and its scenarios.
+    """ # noqa: E501
+    uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the plan.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the plan.", alias="displayName")
+    model_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the planning model that the plan is using.", alias="modelId")
+    scenarios: Optional[List[ScenarioInfoDTO]] = Field(default=None, description="Information about the plan's scenarios.")
+    parent_plan_uuid: Optional[StrictStr] = Field(default=None, description="If the plan is a subplan, the response returns its parent plan's UUID. Not returned for main plans.", alias="parentPlanUuid")
+    currency_code: Optional[StrictStr] = Field(default=None, description="The 3-digit ISO 4217 currency code of the plan's data.", alias="currencyCode")
+    __properties: ClassVar[List[str]] = ["uuid", "displayName", "modelId", "scenarios", "parentPlanUuid", "currencyCode"]
+
+    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 PlanInfoDTO 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 scenarios (list)
+        _items = []
+        if self.scenarios:
+            for _item_scenarios in self.scenarios:
+                if _item_scenarios:
+                    _items.append(_item_scenarios.to_dict())
+            _dict['scenarios'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanInfoDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uuid": obj.get("uuid"),
+            "displayName": obj.get("displayName"),
+            "modelId": obj.get("modelId"),
+            "scenarios": [ScenarioInfoDTO.from_dict(_item) for _item in obj["scenarios"]] if obj.get("scenarios") is not None else None,
+            "parentPlanUuid": obj.get("parentPlanUuid"),
+            "currencyCode": obj.get("currencyCode")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_item_dto.py

@@ -0,0 +1,102 @@
+# 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.99201.1914
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanItemDTO(BaseModel):
+    """
+    A plan item is a metric in your plan. The available plan items depend on the planning model.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the plan item.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the plan item.", alias="displayName")
+    data_type: Optional[StrictStr] = Field(default=None, description="The data type of the plan item. The data types are:  - **rate**: Converts values into a percentage in the planning grid. The provided value is multiplied by 100 to get the display value. For example, a provided value of 0.5 is displayed as 50% in the grid.  - **number**: Displays values as whole numbers. Decimal values are rounded to a whole number when displayed in the planning grid.  - **currency**: Displays values as a currency. Values must not contain thousand separators, currency codes, or currency symbols.  - **decimal**: Displays values with decimals.", alias="dataType")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "dataType"]
+
+    @field_validator('data_type')
+    def data_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['unknown', 'number', 'currency', 'decimal', 'rate']):
+            raise ValueError("must be one of enum values ('unknown', 'number', 'currency', 'decimal', 'rate')")
+        return value
+
+    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 PlanItemDTO 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 PlanItemDTO 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"),
+            "dataType": obj.get("dataType")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_parameter_definition_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.99201.1914
+    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 PlanParameterDefinitionDTO(BaseModel):
+    """
+    The definition of a plan parameter. These parameters resolve planning model metrics to a specific plan and scenario  or snapshot values at query runtime.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique ID of the parameter.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the parameter.", alias="displayName")
+    description: Optional[StrictStr] = Field(default=None, description="The localized description of the parameter.")
+    model_name: Optional[StrictStr] = Field(default=None, description="The name of the planning model to which the parameter applies.", alias="modelName")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "description", "modelName"]
+
+    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 PlanParameterDefinitionDTO 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 PlanParameterDefinitionDTO 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"),
+            "description": obj.get("description"),
+            "modelName": obj.get("modelName")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_parameter_value_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.99201.1914
+    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 PlanParameterValueDTO(BaseModel):
+    """
+    The value for a parameter on a planning metric, including the parameter ID and the plan the parameter is based on.
+    """ # noqa: E501
+    parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan parameter qualified by the object.", alias="parameterId")
+    plan_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan the parameter is based on.", alias="planId")
+    scenario_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the scenario the parameter is based on.", alias="scenarioId")
+    snapshot_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the snapshot the parameter is based on.", alias="snapshotId")
+    __properties: ClassVar[List[str]] = ["parameterId", "planId", "scenarioId", "snapshotId"]
+
+    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 PlanParameterValueDTO 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 PlanParameterValueDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameterId": obj.get("parameterId"),
+            "planId": obj.get("planId"),
+            "scenarioId": obj.get("scenarioId"),
+            "snapshotId": obj.get("snapshotId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/plan_row_data_load_response_dto.py

@@ -20,8 +20,8 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from visier_platform_sdk.models.planning_plan_data_load_error_dto import PlanningPlanDataLoadErrorDTO
-from visier_platform_sdk.models.planning_plan_segment_level_member_dto import PlanningPlanSegmentLevelMemberDTO
+from visier_platform_sdk.models.plan_data_load_error_dto import PlanDataLoadErrorDTO
+from visier_platform_sdk.models.plan_segment_level_member_dto import PlanSegmentLevelMemberDTO
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,8 +33,8 @@ class PlanRowDataLoadResponseDTO(BaseModel):
     removed_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows removed from the plan.", alias="removedRowsCount")
     potential_added_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows that could have been added to the plan.", alias="potentialAddedRowsCount")
     potential_removed_rows_count: Optional[StrictInt] = Field(default=None, description="The number of rows that could have been removed from the plan.", alias="potentialRemovedRowsCount")
-    errors: Optional[List[PlanningPlanDataLoadErrorDTO]] = Field(default=None, description="The errors that occurred while loading the data.")
-    custom_members: Optional[List[PlanningPlanSegmentLevelMemberDTO]] = Field(default=None, description="The custom members and their corresponding IDs in the plan.", alias="customMembers")
+    errors: Optional[List[PlanDataLoadErrorDTO]] = Field(default=None, description="The errors that occurred while loading the data.")
+    custom_members: Optional[List[PlanSegmentLevelMemberDTO]] = Field(default=None, description="The custom members and their corresponding IDs in the plan.", alias="customMembers")
     __properties: ClassVar[List[str]] = ["addedRowsCount", "removedRowsCount", "potentialAddedRowsCount", "potentialRemovedRowsCount", "errors", "customMembers"]
 
     model_config = ConfigDict(
@@ -106,8 +106,8 @@ class PlanRowDataLoadResponseDTO(BaseModel):
             "removedRowsCount": obj.get("removedRowsCount"),
             "potentialAddedRowsCount": obj.get("potentialAddedRowsCount"),
             "potentialRemovedRowsCount": obj.get("potentialRemovedRowsCount"),
-            "errors": [PlanningPlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
-            "customMembers": [PlanningPlanSegmentLevelMemberDTO.from_dict(_item) for _item in obj["customMembers"]] if obj.get("customMembers") is not None else None
+            "errors": [PlanDataLoadErrorDTO.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "customMembers": [PlanSegmentLevelMemberDTO.from_dict(_item) for _item in obj["customMembers"]] if obj.get("customMembers") is not None else None
         })
         return _obj
 

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.99201.1914
+    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
+
+