miro_api.models.update_text_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 UpdateTextStyle(BaseModel):
 28    """
 29    Contains information about the style of a text item, such as the fill color or font family.
 30    """  # noqa: E501
 31
 32    color: Optional[StrictStr] = Field(
 33        default=None, description="Hex value representing the color for the text within the text item."
 34    )
 35    fill_color: Optional[StrictStr] = Field(
 36        default=None, description="Background color of the text item.", alias="fillColor"
 37    )
 38    fill_opacity: Optional[Annotated[str, Field(strict=True)]] = Field(
 39        default=None,
 40        description="Opacity level of the background color. Possible values: any number between `0.0` and `1.0`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid",
 41        alias="fillOpacity",
 42    )
 43    font_family: Optional[StrictStr] = Field(
 44        default=None, description="Font type for the text in the text item.", alias="fontFamily"
 45    )
 46    font_size: Optional[Annotated[str, Field(strict=True)]] = Field(
 47        default=None, description="Font size, in dp.", alias="fontSize"
 48    )
 49    text_align: Optional[StrictStr] = Field(
 50        default=None, description="Horizontal alignment for the item's content.", alias="textAlign"
 51    )
 52    additional_properties: Dict[str, Any] = {}
 53    __properties: ClassVar[List[str]] = ["color", "fillColor", "fillOpacity", "fontFamily", "fontSize", "textAlign"]
 54
 55    @field_validator("font_family")
 56    def font_family_validate_enum(cls, value):
 57        """Validates the enum"""
 58        if value is None:
 59            return value
 60
 61        if value not in set(
 62            [
 63                "arial",
 64                "abril_fatface",
 65                "bangers",
 66                "eb_garamond",
 67                "georgia",
 68                "graduate",
 69                "gravitas_one",
 70                "fredoka_one",
 71                "nixie_one",
 72                "open_sans",
 73                "permanent_marker",
 74                "pt_sans",
 75                "pt_sans_narrow",
 76                "pt_serif",
 77                "rammetto_one",
 78                "roboto",
 79                "roboto_condensed",
 80                "roboto_slab",
 81                "caveat",
 82                "times_new_roman",
 83                "titan_one",
 84                "lemon_tuesday",
 85                "roboto_mono",
 86                "noto_sans",
 87                "plex_sans",
 88                "plex_serif",
 89                "plex_mono",
 90                "spoof",
 91                "tiempos_text",
 92                "formular",
 93            ]
 94        ):
 95            raise ValueError(
 96                "must be one of enum values ('arial', 'abril_fatface', 'bangers', 'eb_garamond', 'georgia', 'graduate', 'gravitas_one', 'fredoka_one', 'nixie_one', 'open_sans', 'permanent_marker', 'pt_sans', 'pt_sans_narrow', 'pt_serif', 'rammetto_one', 'roboto', 'roboto_condensed', 'roboto_slab', 'caveat', 'times_new_roman', 'titan_one', 'lemon_tuesday', 'roboto_mono', 'noto_sans', 'plex_sans', 'plex_serif', 'plex_mono', 'spoof', 'tiempos_text', 'formular')"
 97            )
 98        return value
 99
100    @field_validator("text_align")
101    def text_align_validate_enum(cls, value):
102        """Validates the enum"""
103        if value is None:
104            return value
105
106        if value not in set(["left", "right", "center"]):
107            raise ValueError("must be one of enum values ('left', 'right', 'center')")
108        return value
109
110    model_config = {
111        "populate_by_name": True,
112        "validate_assignment": True,
113        "protected_namespaces": (),
114    }
115
116    def to_str(self) -> str:
117        """Returns the string representation of the model using alias"""
118        return pprint.pformat(self.model_dump(by_alias=True))
119
120    def to_json(self) -> str:
121        """Returns the JSON representation of the model using alias"""
122        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
123        return json.dumps(self.to_dict())
124
125    @classmethod
126    def from_json(cls, json_str: str) -> Optional[Self]:
127        """Create an instance of UpdateTextStyle from a JSON string"""
128        return cls.from_dict(json.loads(json_str))
129
130    def to_dict(self) -> Dict[str, Any]:
131        """Return the dictionary representation of the model using alias.
132
133        This has the following differences from calling pydantic's
134        `self.model_dump(by_alias=True)`:
135
136        * `None` is only added to the output dict for nullable fields that
137          were set at model initialization. Other fields with value `None`
138          are ignored.
139        * Fields in `self.additional_properties` are added to the output dict.
140        """
141        excluded_fields: Set[str] = set(
142            [
143                "additional_properties",
144            ]
145        )
146
147        _dict = self.model_dump(
148            by_alias=True,
149            exclude=excluded_fields,
150            exclude_none=True,
151        )
152        # puts key-value pairs in additional_properties in the top level
153        if self.additional_properties is not None:
154            for _key, _value in self.additional_properties.items():
155                _dict[_key] = _value
156
157        return _dict
158
159    @classmethod
160    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
161        """Create an instance of UpdateTextStyle from a dict"""
162        if obj is None:
163            return None
164
165        if not isinstance(obj, dict):
166            return cls.model_validate(obj)
167
168        _obj = cls.model_validate(
169            {
170                "color": obj.get("color"),
171                "fillColor": obj.get("fillColor"),
172                "fillOpacity": obj.get("fillOpacity"),
173                "fontFamily": obj.get("fontFamily"),
174                "fontSize": obj.get("fontSize"),
175                "textAlign": obj.get("textAlign"),
176            }
177        )
178        # store additional fields in additional_properties
179        for _key in obj.keys():
180            if _key not in cls.__properties:
181                _obj.additional_properties[_key] = obj.get(_key)
182
183        return _obj