miro_api.models.shape_style_for_update

  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 ShapeStyleForUpdate(BaseModel):
 28    """
 29    Contains information about the shape style, such as the border color or opacity. <br> All properties in style object are supported for shape types aren't listed below. <br> <table>   <tr>     <th align=\"left\">Shape type</th>     <th align=\"left\">Unsupported properties</th>   </tr>   <tr>     <td>flow_chart_or</td>     <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td>   </tr>   <tr>     <td>flow_chart_summing_junction</td>     <td>fontSize, fontFamily, color, textAlign, textAlignVertical</td>   </tr>   <tr>     <td>flow_chart_note_curly_left</td>     <td>fillColor, fillOpacity</td>   </tr>   <tr>     <td>flow_chart_note_curly_right</td>     <td>fillColor, fillOpacity</td>   </tr>   <tr>     <td>flow_chart_note_square</td>     <td>fillColor, fillOpacity</td>   </tr> </table>
 30    """  # noqa: E501
 31
 32    border_color: Optional[StrictStr] = Field(
 33        default=None, description="Defines the color of the border of the shape.", alias="borderColor"
 34    )
 35    border_opacity: Optional[Annotated[str, Field(strict=True)]] = Field(
 36        default=None,
 37        description="Defines the opacity level of the shape border. 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",
 38        alias="borderOpacity",
 39    )
 40    border_style: Optional[StrictStr] = Field(
 41        default=None, description="Defines the style used to represent the border of the shape.", alias="borderStyle"
 42    )
 43    border_width: Optional[Annotated[str, Field(strict=True)]] = Field(
 44        default=None, description="Defines the thickness of the shape border, in dp.", alias="borderWidth"
 45    )
 46    color: Optional[StrictStr] = Field(
 47        default=None, description="Hex value representing the color for the text within the shape item."
 48    )
 49    fill_color: Optional[StrictStr] = Field(
 50        default=None,
 51        description="Fill color for the shape. Hex values: `#f5f6f8` `#d5f692` `#d0e17a` `#93d275` `#67c6c0` `#23bfe7` `#a6ccf5` `#7b92ff` `#fff9b1` `#f5d128` `#ff9d48` `#f16c7f` `#ea94bb` `#ffcee0` `#b384bb` `#000000`",
 52        alias="fillColor",
 53    )
 54    fill_opacity: Optional[Annotated[str, Field(strict=True)]] = Field(
 55        default=None,
 56        description="Opacity level of the fill color. Possible values: any number between `0` and `1`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid ",
 57        alias="fillOpacity",
 58    )
 59    font_family: Optional[StrictStr] = Field(
 60        default=None, description="Defines the font type for the text in the shape item.", alias="fontFamily"
 61    )
 62    font_size: Optional[Annotated[str, Field(strict=True)]] = Field(
 63        default=None, description="Defines the font size, in dp, for the text on the shape.", alias="fontSize"
 64    )
 65    text_align: Optional[StrictStr] = Field(
 66        default=None, description="Defines how the sticky note text is horizontally aligned.", alias="textAlign"
 67    )
 68    text_align_vertical: Optional[StrictStr] = Field(
 69        default=None, description="Defines how the sticky note text is vertically aligned.", alias="textAlignVertical"
 70    )
 71    additional_properties: Dict[str, Any] = {}
 72    __properties: ClassVar[List[str]] = [
 73        "borderColor",
 74        "borderOpacity",
 75        "borderStyle",
 76        "borderWidth",
 77        "color",
 78        "fillColor",
 79        "fillOpacity",
 80        "fontFamily",
 81        "fontSize",
 82        "textAlign",
 83        "textAlignVertical",
 84    ]
 85
 86    @field_validator("border_style")
 87    def border_style_validate_enum(cls, value):
 88        """Validates the enum"""
 89        if value is None:
 90            return value
 91
 92        if value not in set(["normal", "dotted", "dashed"]):
 93            raise ValueError("must be one of enum values ('normal', 'dotted', 'dashed')")
 94        return value
 95
 96    @field_validator("font_family")
 97    def font_family_validate_enum(cls, value):
 98        """Validates the enum"""
 99        if value is None:
100            return value
101
102        if value not in set(
103            [
104                "arial",
105                "abril_fatface",
106                "bangers",
107                "eb_garamond",
108                "georgia",
109                "graduate",
110                "gravitas_one",
111                "fredoka_one",
112                "nixie_one",
113                "open_sans",
114                "permanent_marker",
115                "pt_sans",
116                "pt_sans_narrow",
117                "pt_serif",
118                "rammetto_one",
119                "roboto",
120                "roboto_condensed",
121                "roboto_slab",
122                "caveat",
123                "times_new_roman",
124                "titan_one",
125                "lemon_tuesday",
126                "roboto_mono",
127                "noto_sans",
128                "plex_sans",
129                "plex_serif",
130                "plex_mono",
131                "spoof",
132                "tiempos_text",
133                "formular",
134            ]
135        ):
136            raise ValueError(
137                "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')"
138            )
139        return value
140
141    @field_validator("text_align")
142    def text_align_validate_enum(cls, value):
143        """Validates the enum"""
144        if value is None:
145            return value
146
147        if value not in set(["left", "right", "center"]):
148            raise ValueError("must be one of enum values ('left', 'right', 'center')")
149        return value
150
151    @field_validator("text_align_vertical")
152    def text_align_vertical_validate_enum(cls, value):
153        """Validates the enum"""
154        if value is None:
155            return value
156
157        if value not in set(["top", "middle", "bottom"]):
158            raise ValueError("must be one of enum values ('top', 'middle', 'bottom')")
159        return value
160
161    model_config = {
162        "populate_by_name": True,
163        "validate_assignment": True,
164        "protected_namespaces": (),
165    }
166
167    def to_str(self) -> str:
168        """Returns the string representation of the model using alias"""
169        return pprint.pformat(self.model_dump(by_alias=True))
170
171    def to_json(self) -> str:
172        """Returns the JSON representation of the model using alias"""
173        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
174        return json.dumps(self.to_dict())
175
176    @classmethod
177    def from_json(cls, json_str: str) -> Optional[Self]:
178        """Create an instance of ShapeStyleForUpdate from a JSON string"""
179        return cls.from_dict(json.loads(json_str))
180
181    def to_dict(self) -> Dict[str, Any]:
182        """Return the dictionary representation of the model using alias.
183
184        This has the following differences from calling pydantic's
185        `self.model_dump(by_alias=True)`:
186
187        * `None` is only added to the output dict for nullable fields that
188          were set at model initialization. Other fields with value `None`
189          are ignored.
190        * Fields in `self.additional_properties` are added to the output dict.
191        """
192        excluded_fields: Set[str] = set(
193            [
194                "additional_properties",
195            ]
196        )
197
198        _dict = self.model_dump(
199            by_alias=True,
200            exclude=excluded_fields,
201            exclude_none=True,
202        )
203        # puts key-value pairs in additional_properties in the top level
204        if self.additional_properties is not None:
205            for _key, _value in self.additional_properties.items():
206                _dict[_key] = _value
207
208        return _dict
209
210    @classmethod
211    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
212        """Create an instance of ShapeStyleForUpdate from a dict"""
213        if obj is None:
214            return None
215
216        if not isinstance(obj, dict):
217            return cls.model_validate(obj)
218
219        _obj = cls.model_validate(
220            {
221                "borderColor": obj.get("borderColor"),
222                "borderOpacity": obj.get("borderOpacity"),
223                "borderStyle": obj.get("borderStyle"),
224                "borderWidth": obj.get("borderWidth"),
225                "color": obj.get("color"),
226                "fillColor": obj.get("fillColor"),
227                "fillOpacity": obj.get("fillOpacity"),
228                "fontFamily": obj.get("fontFamily"),
229                "fontSize": obj.get("fontSize"),
230                "textAlign": obj.get("textAlign"),
231                "textAlignVertical": obj.get("textAlignVertical"),
232            }
233        )
234        # store additional fields in additional_properties
235        for _key in obj.keys():
236            if _key not in cls.__properties:
237                _obj.additional_properties[_key] = obj.get(_key)
238
239        return _obj