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