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