miro_api.models.mindmap_node_style

Miro Developer Platform

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): 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 ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

  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
 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 MindmapNodeStyle(BaseModel):
 28    """
 29    Contains information about the node style, such as the node color or fillOpacity.
 30    """  # noqa: E501
 31
 32    color: Optional[StrictStr] = Field(
 33        default=None, description="Hex value representing the color for the text within the node."
 34    )
 35    fill_opacity: Optional[StrictStr] = Field(
 36        default=None,
 37        description="It sets the opacity level of the background fill color.  Allowed values: any number between 0.0 and 1.0 included.  If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)",
 38        alias="fillOpacity",
 39    )
 40    font_size: Optional[Annotated[str, Field(strict=True)]] = Field(
 41        default=None,
 42        description="Defines the font size, in dp, for the text on the node. Default: `14`.",
 43        alias="fontSize",
 44    )
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = ["color", "fillOpacity", "fontSize"]
 47
 48    model_config = {
 49        "populate_by_name": True,
 50        "validate_assignment": True,
 51        "protected_namespaces": (),
 52    }
 53
 54    def to_str(self) -> str:
 55        """Returns the string representation of the model using alias"""
 56        return pprint.pformat(self.model_dump(by_alias=True))
 57
 58    def to_json(self) -> str:
 59        """Returns the JSON representation of the model using alias"""
 60        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 61        return json.dumps(self.to_dict())
 62
 63    @classmethod
 64    def from_json(cls, json_str: str) -> Optional[Self]:
 65        """Create an instance of MindmapNodeStyle from a JSON string"""
 66        return cls.from_dict(json.loads(json_str))
 67
 68    def to_dict(self) -> Dict[str, Any]:
 69        """Return the dictionary representation of the model using alias.
 70
 71        This has the following differences from calling pydantic's
 72        `self.model_dump(by_alias=True)`:
 73
 74        * `None` is only added to the output dict for nullable fields that
 75          were set at model initialization. Other fields with value `None`
 76          are ignored.
 77        * Fields in `self.additional_properties` are added to the output dict.
 78        """
 79        excluded_fields: Set[str] = set(
 80            [
 81                "additional_properties",
 82            ]
 83        )
 84
 85        _dict = self.model_dump(
 86            by_alias=True,
 87            exclude=excluded_fields,
 88            exclude_none=True,
 89        )
 90        # puts key-value pairs in additional_properties in the top level
 91        if self.additional_properties is not None:
 92            for _key, _value in self.additional_properties.items():
 93                _dict[_key] = _value
 94
 95        return _dict
 96
 97    @classmethod
 98    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 99        """Create an instance of MindmapNodeStyle from a dict"""
100        if obj is None:
101            return None
102
103        if not isinstance(obj, dict):
104            return cls.model_validate(obj)
105
106        _obj = cls.model_validate(
107            {"color": obj.get("color"), "fillOpacity": obj.get("fillOpacity"), "fontSize": obj.get("fontSize")}
108        )
109        # store additional fields in additional_properties
110        for _key in obj.keys():
111            if _key not in cls.__properties:
112                _obj.additional_properties[_key] = obj.get(_key)
113
114        return _obj

class MindmapNodeStyle(pydantic.main.BaseModel): View Source

 28class MindmapNodeStyle(BaseModel):
 29    """
 30    Contains information about the node style, such as the node color or fillOpacity.
 31    """  # noqa: E501
 32
 33    color: Optional[StrictStr] = Field(
 34        default=None, description="Hex value representing the color for the text within the node."
 35    )
 36    fill_opacity: Optional[StrictStr] = Field(
 37        default=None,
 38        description="It sets the opacity level of the background fill color.  Allowed values: any number between 0.0 and 1.0 included.  If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)",
 39        alias="fillOpacity",
 40    )
 41    font_size: Optional[Annotated[str, Field(strict=True)]] = Field(
 42        default=None,
 43        description="Defines the font size, in dp, for the text on the node. Default: `14`.",
 44        alias="fontSize",
 45    )
 46    additional_properties: Dict[str, Any] = {}
 47    __properties: ClassVar[List[str]] = ["color", "fillOpacity", "fontSize"]
 48
 49    model_config = {
 50        "populate_by_name": True,
 51        "validate_assignment": True,
 52        "protected_namespaces": (),
 53    }
 54
 55    def to_str(self) -> str:
 56        """Returns the string representation of the model using alias"""
 57        return pprint.pformat(self.model_dump(by_alias=True))
 58
 59    def to_json(self) -> str:
 60        """Returns the JSON representation of the model using alias"""
 61        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 62        return json.dumps(self.to_dict())
 63
 64    @classmethod
 65    def from_json(cls, json_str: str) -> Optional[Self]:
 66        """Create an instance of MindmapNodeStyle from a JSON string"""
 67        return cls.from_dict(json.loads(json_str))
 68
 69    def to_dict(self) -> Dict[str, Any]:
 70        """Return the dictionary representation of the model using alias.
 71
 72        This has the following differences from calling pydantic's
 73        `self.model_dump(by_alias=True)`:
 74
 75        * `None` is only added to the output dict for nullable fields that
 76          were set at model initialization. Other fields with value `None`
 77          are ignored.
 78        * Fields in `self.additional_properties` are added to the output dict.
 79        """
 80        excluded_fields: Set[str] = set(
 81            [
 82                "additional_properties",
 83            ]
 84        )
 85
 86        _dict = self.model_dump(
 87            by_alias=True,
 88            exclude=excluded_fields,
 89            exclude_none=True,
 90        )
 91        # puts key-value pairs in additional_properties in the top level
 92        if self.additional_properties is not None:
 93            for _key, _value in self.additional_properties.items():
 94                _dict[_key] = _value
 95
 96        return _dict
 97
 98    @classmethod
 99    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
100        """Create an instance of MindmapNodeStyle from a dict"""
101        if obj is None:
102            return None
103
104        if not isinstance(obj, dict):
105            return cls.model_validate(obj)
106
107        _obj = cls.model_validate(
108            {"color": obj.get("color"), "fillOpacity": obj.get("fillOpacity"), "fontSize": obj.get("fontSize")}
109        )
110        # store additional fields in additional_properties
111        for _key in obj.keys():
112            if _key not in cls.__properties:
113                _obj.additional_properties[_key] = obj.get(_key)
114
115        return _obj

Contains information about the node style, such as the node color or fillOpacity.

color: Optional[Annotated[str, Strict(strict=True)]]

fill_opacity: Optional[Annotated[str, Strict(strict=True)]]

font_size: Optional[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])]]

additional_properties: Dict[str, Any]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

55    def to_str(self) -> str:
56        """Returns the string representation of the model using alias"""
57        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

59    def to_json(self) -> str:
60        """Returns the JSON representation of the model using alias"""
61        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
62        return json.dumps(self.to_dict())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: View Source

64    @classmethod
65    def from_json(cls, json_str: str) -> Optional[Self]:
66        """Create an instance of MindmapNodeStyle from a JSON string"""
67        return cls.from_dict(json.loads(json_str))

Create an instance of MindmapNodeStyle from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

69    def to_dict(self) -> Dict[str, Any]:
70        """Return the dictionary representation of the model using alias.
71
72        This has the following differences from calling pydantic's
73        `self.model_dump(by_alias=True)`:
74
75        * `None` is only added to the output dict for nullable fields that
76          were set at model initialization. Other fields with value `None`
77          are ignored.
78        * Fields in `self.additional_properties` are added to the output dict.
79        """
80        excluded_fields: Set[str] = set(
81            [
82                "additional_properties",
83            ]
84        )
85
86        _dict = self.model_dump(
87            by_alias=True,
88            exclude=excluded_fields,
89            exclude_none=True,
90        )
91        # puts key-value pairs in additional_properties in the top level
92        if self.additional_properties is not None:
93            for _key, _value in self.additional_properties.items():
94                _dict[_key] = _value
95
96        return _dict

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.
Fields in self.additional_properties are added to the output dict.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[typing_extensions.Self]: View Source

 98    @classmethod
 99    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
100        """Create an instance of MindmapNodeStyle from a dict"""
101        if obj is None:
102            return None
103
104        if not isinstance(obj, dict):
105            return cls.model_validate(obj)
106
107        _obj = cls.model_validate(
108            {"color": obj.get("color"), "fillOpacity": obj.get("fillOpacity"), "fontSize": obj.get("fontSize")}
109        )
110        # store additional fields in additional_properties
111        for _key in obj.keys():
112            if _key not in cls.__properties:
113                _obj.additional_properties[_key] = obj.get(_key)
114
115        return _obj

Create an instance of MindmapNodeStyle from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

265def init_private_attributes(self: BaseModel, __context: Any) -> None:
266    """This function is meant to behave like a BaseModel method to initialise private attributes.
267
268    It takes context as an argument since that's what pydantic-core passes when calling it.
269
270    Args:
271        self: The BaseModel instance.
272        __context: The context.
273    """
274    if getattr(self, '__pydantic_private__', None) is None:
275        pydantic_private = {}
276        for name, private_attr in self.__private_attributes__.items():
277            default = private_attr.get_default()
278            if default is not PydanticUndefined:
279                pydantic_private[name] = default
280        object_setattr(self, '__pydantic_private__', pydantic_private)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Args: self: The BaseModel instance. __context: The context.

model_fields = {'color': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Hex value representing the color for the text within the node.'), 'fill_opacity': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='fillOpacity', alias_priority=2, description='It sets the opacity level of the background fill color. Allowed values: any number between 0.0 and 1.0 included. If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)'), 'font_size': FieldInfo(annotation=Union[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])], NoneType], required=False, alias='fontSize', alias_priority=2, description='Defines the font size, in dp, for the text on the node. Default: `14`.'), 'additional_properties': FieldInfo(annotation=Dict[str, Any], required=False, default={})}

model_computed_fields = {}

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs