miro_api.models.mindmap_data

  1# coding: utf-8
  2
  3"""
  4Miro Developer Platform
  5
  6<img src=\"https://content.pstmn.io/47449ea6-0ef7-4af2-bac1-e58a70e61c58/aW1hZ2UucG5n\" width=\"1685\" height=\"593\">  ### Miro Developer Platform concepts  - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes.   ### Getting started with the Miro REST API  - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes.   ### Miro REST API tutorials  Check out our how-to articles with step-by-step instructions and code examples so you can:  - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth)   ### Miro App Examples  Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.
  7
  8The version of the OpenAPI document: v2.0
  9Generated by OpenAPI Generator (https://openapi-generator.tech)
 10
 11Do not edit the class manually.
 12"""  # noqa: E501
 13
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, Field, StrictBool, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.mindmap_node_view import MindmapNodeView
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class MindmapData(BaseModel):
 28    """
 29    Contains mind map node data, such as `nodeView` or `isRoot`.
 30    """  # noqa: E501
 31
 32    node_view: Optional[MindmapNodeView] = Field(default=None, alias="nodeView")
 33    is_root: Optional[StrictBool] = Field(
 34        default=None, description="Indicates whether this node is the root of the mind map.", alias="isRoot"
 35    )
 36    direction: Optional[StrictStr] = Field(
 37        default=None,
 38        description="Indicates where this node is positioned relative to the root node. `start` indicates that this node must be positioned at the start of the root node, which is either the left or top of the root node. `end` indicates that this node must be positioned at the emd of the root node, which is either the right or bottom of the root node.",
 39    )
 40    additional_properties: Dict[str, Any] = {}
 41    __properties: ClassVar[List[str]] = ["nodeView", "isRoot", "direction"]
 42
 43    @field_validator("direction")
 44    def direction_validate_enum(cls, value):
 45        """Validates the enum"""
 46        if value is None:
 47            return value
 48
 49        if value not in set(["start", "end"]):
 50            raise ValueError("must be one of enum values ('start', 'end')")
 51        return value
 52
 53    model_config = {
 54        "populate_by_name": True,
 55        "validate_assignment": True,
 56        "protected_namespaces": (),
 57    }
 58
 59    def to_str(self) -> str:
 60        """Returns the string representation of the model using alias"""
 61        return pprint.pformat(self.model_dump(by_alias=True))
 62
 63    def to_json(self) -> str:
 64        """Returns the JSON representation of the model using alias"""
 65        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 66        return json.dumps(self.to_dict())
 67
 68    @classmethod
 69    def from_json(cls, json_str: str) -> Optional[Self]:
 70        """Create an instance of MindmapData from a JSON string"""
 71        return cls.from_dict(json.loads(json_str))
 72
 73    def to_dict(self) -> Dict[str, Any]:
 74        """Return the dictionary representation of the model using alias.
 75
 76        This has the following differences from calling pydantic's
 77        `self.model_dump(by_alias=True)`:
 78
 79        * `None` is only added to the output dict for nullable fields that
 80          were set at model initialization. Other fields with value `None`
 81          are ignored.
 82        * Fields in `self.additional_properties` are added to the output dict.
 83        """
 84        excluded_fields: Set[str] = set(
 85            [
 86                "additional_properties",
 87            ]
 88        )
 89
 90        _dict = self.model_dump(
 91            by_alias=True,
 92            exclude=excluded_fields,
 93            exclude_none=True,
 94        )
 95        # override the default output from pydantic by calling `to_dict()` of node_view
 96        if self.node_view:
 97            _dict["nodeView"] = self.node_view.to_dict()
 98        # puts key-value pairs in additional_properties in the top level
 99        if self.additional_properties is not None:
100            for _key, _value in self.additional_properties.items():
101                _dict[_key] = _value
102
103        return _dict
104
105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of MindmapData from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "nodeView": MindmapNodeView.from_dict(obj["nodeView"]) if obj.get("nodeView") is not None else None,
117                "isRoot": obj.get("isRoot"),
118                "direction": obj.get("direction"),
119            }
120        )
121        # store additional fields in additional_properties
122        for _key in obj.keys():
123            if _key not in cls.__properties:
124                _obj.additional_properties[_key] = obj.get(_key)
125
126        return _obj