miro_api.models.tag_create_request

  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 TagCreateRequest(BaseModel):
 28    """
 29    TagCreateRequest
 30    """  # noqa: E501
 31
 32    fill_color: Optional[StrictStr] = Field(default="red", description="Fill color for the tag.", alias="fillColor")
 33    title: Annotated[str, Field(min_length=0, strict=True, max_length=120)] = Field(
 34        description="Text of the tag. Case-sensitive. Must be unique."
 35    )
 36    additional_properties: Dict[str, Any] = {}
 37    __properties: ClassVar[List[str]] = ["fillColor", "title"]
 38
 39    @field_validator("fill_color")
 40    def fill_color_validate_enum(cls, value):
 41        """Validates the enum"""
 42        if value is None:
 43            return value
 44
 45        if value not in set(
 46            [
 47                "red",
 48                "light_green",
 49                "cyan",
 50                "yellow",
 51                "magenta",
 52                "green",
 53                "blue",
 54                "gray",
 55                "violet",
 56                "dark_green",
 57                "dark_blue",
 58                "black",
 59            ]
 60        ):
 61            raise ValueError(
 62                "must be one of enum values ('red', 'light_green', 'cyan', 'yellow', 'magenta', 'green', 'blue', 'gray', 'violet', 'dark_green', 'dark_blue', 'black')"
 63            )
 64        return value
 65
 66    model_config = {
 67        "populate_by_name": True,
 68        "validate_assignment": True,
 69        "protected_namespaces": (),
 70    }
 71
 72    def to_str(self) -> str:
 73        """Returns the string representation of the model using alias"""
 74        return pprint.pformat(self.model_dump(by_alias=True))
 75
 76    def to_json(self) -> str:
 77        """Returns the JSON representation of the model using alias"""
 78        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 79        return json.dumps(self.to_dict())
 80
 81    @classmethod
 82    def from_json(cls, json_str: str) -> Optional[Self]:
 83        """Create an instance of TagCreateRequest from a JSON string"""
 84        return cls.from_dict(json.loads(json_str))
 85
 86    def to_dict(self) -> Dict[str, Any]:
 87        """Return the dictionary representation of the model using alias.
 88
 89        This has the following differences from calling pydantic's
 90        `self.model_dump(by_alias=True)`:
 91
 92        * `None` is only added to the output dict for nullable fields that
 93          were set at model initialization. Other fields with value `None`
 94          are ignored.
 95        * Fields in `self.additional_properties` are added to the output dict.
 96        """
 97        excluded_fields: Set[str] = set(
 98            [
 99                "additional_properties",
100            ]
101        )
102
103        _dict = self.model_dump(
104            by_alias=True,
105            exclude=excluded_fields,
106            exclude_none=True,
107        )
108        # puts key-value pairs in additional_properties in the top level
109        if self.additional_properties is not None:
110            for _key, _value in self.additional_properties.items():
111                _dict[_key] = _value
112
113        return _dict
114
115    @classmethod
116    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
117        """Create an instance of TagCreateRequest from a dict"""
118        if obj is None:
119            return None
120
121        if not isinstance(obj, dict):
122            return cls.model_validate(obj)
123
124        _obj = cls.model_validate(
125            {
126                "fillColor": obj.get("fillColor") if obj.get("fillColor") is not None else "red",
127                "title": obj.get("title"),
128            }
129        )
130        # store additional fields in additional_properties
131        for _key in obj.keys():
132            if _key not in cls.__properties:
133                _obj.additional_properties[_key] = obj.get(_key)
134
135        return _obj