miro_api.models.mindmap_style

  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, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing_extensions import Annotated
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class MindmapStyle(BaseModel):
 28    """
 29    Contains information about the node style, such as the widget's border color or shape type.
 30    """  # noqa: E501
 31
 32    node_color: Optional[StrictStr] = Field(
 33        default=None, description="Hex value representing the color of the widget's border.", alias="nodeColor"
 34    )
 35    shape: Optional[StrictStr] = Field(default=None, description="Shape type of the widget.")
 36    font_size: Optional[Annotated[str, Field(strict=True)]] = Field(
 37        default=None, description="The same font size as in MindmapNodeStyle.", alias="fontSize"
 38    )
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["nodeColor", "shape", "fontSize"]
 41
 42    @field_validator("shape")
 43    def shape_validate_enum(cls, value):
 44        """Validates the enum"""
 45        if value is None:
 46            return value
 47
 48        if value not in set(["pill", "rectangle", "rounded_rectangle", "none"]):
 49            raise ValueError("must be one of enum values ('pill', 'rectangle', 'rounded_rectangle', 'none')")
 50        return value
 51
 52    model_config = {
 53        "populate_by_name": True,
 54        "validate_assignment": True,
 55        "protected_namespaces": (),
 56    }
 57
 58    def to_str(self) -> str:
 59        """Returns the string representation of the model using alias"""
 60        return pprint.pformat(self.model_dump(by_alias=True))
 61
 62    def to_json(self) -> str:
 63        """Returns the JSON representation of the model using alias"""
 64        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 65        return json.dumps(self.to_dict())
 66
 67    @classmethod
 68    def from_json(cls, json_str: str) -> Optional[Self]:
 69        """Create an instance of MindmapStyle from a JSON string"""
 70        return cls.from_dict(json.loads(json_str))
 71
 72    def to_dict(self) -> Dict[str, Any]:
 73        """Return the dictionary representation of the model using alias.
 74
 75        This has the following differences from calling pydantic's
 76        `self.model_dump(by_alias=True)`:
 77
 78        * `None` is only added to the output dict for nullable fields that
 79          were set at model initialization. Other fields with value `None`
 80          are ignored.
 81        * Fields in `self.additional_properties` are added to the output dict.
 82        """
 83        excluded_fields: Set[str] = set(
 84            [
 85                "additional_properties",
 86            ]
 87        )
 88
 89        _dict = self.model_dump(
 90            by_alias=True,
 91            exclude=excluded_fields,
 92            exclude_none=True,
 93        )
 94        # puts key-value pairs in additional_properties in the top level
 95        if self.additional_properties is not None:
 96            for _key, _value in self.additional_properties.items():
 97                _dict[_key] = _value
 98
 99        return _dict
100
101    @classmethod
102    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
103        """Create an instance of MindmapStyle from a dict"""
104        if obj is None:
105            return None
106
107        if not isinstance(obj, dict):
108            return cls.model_validate(obj)
109
110        _obj = cls.model_validate(
111            {"nodeColor": obj.get("nodeColor"), "shape": obj.get("shape"), "fontSize": obj.get("fontSize")}
112        )
113        # store additional fields in additional_properties
114        for _key in obj.keys():
115            if _key not in cls.__properties:
116                _obj.additional_properties[_key] = obj.get(_key)
117
118        return _obj