miro_api.models.tag

Miro Developer Platform

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): 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 ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

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

class Tag(pydantic.main.BaseModel): View Source

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

Tag

fill_color: typing.Annotated[str, Strict(strict=True)]

id: typing.Annotated[str, Strict(strict=True)]

title: typing.Annotated[str, Strict(strict=True)]

type: typing.Annotated[str, Strict(strict=True)]

additional_properties: Dict[str, Any]

@field_validator('fill_color')

def fill_color_validate_enum(cls, value): View Source

39    @field_validator("fill_color")
40    def fill_color_validate_enum(cls, value):
41        """Validates the enum"""
42        if value not in set(
43            [
44                "red",
45                "light_green",
46                "cyan",
47                "yellow",
48                "magenta",
49                "green",
50                "blue",
51                "gray",
52                "violet",
53                "dark_green",
54                "dark_blue",
55                "black",
56            ]
57        ):
58            raise ValueError(
59                "must be one of enum values ('red', 'light_green', 'cyan', 'yellow', 'magenta', 'green', 'blue', 'gray', 'violet', 'dark_green', 'dark_blue', 'black')"
60            )
61        return value

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

69    def to_str(self) -> str:
70        """Returns the string representation of the model using alias"""
71        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

73    def to_json(self) -> str:
74        """Returns the JSON representation of the model using alias"""
75        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
76        return json.dumps(self.to_dict())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: View Source

78    @classmethod
79    def from_json(cls, json_str: str) -> Optional[Self]:
80        """Create an instance of Tag from a JSON string"""
81        return cls.from_dict(json.loads(json_str))

Create an instance of Tag from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

 83    def to_dict(self) -> Dict[str, Any]:
 84        """Return the dictionary representation of the model using alias.
 85
 86        This has the following differences from calling pydantic's
 87        `self.model_dump(by_alias=True)`:
 88
 89        * `None` is only added to the output dict for nullable fields that
 90          were set at model initialization. Other fields with value `None`
 91          are ignored.
 92        * Fields in `self.additional_properties` are added to the output dict.
 93        """
 94        excluded_fields: Set[str] = set(
 95            [
 96                "additional_properties",
 97            ]
 98        )
 99
100        _dict = self.model_dump(
101            by_alias=True,
102            exclude=excluded_fields,
103            exclude_none=True,
104        )
105        # puts key-value pairs in additional_properties in the top level
106        if self.additional_properties is not None:
107            for _key, _value in self.additional_properties.items():
108                _dict[_key] = _value
109
110        return _dict

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Fields in self.additional_properties are added to the output dict.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[typing_extensions.Self]: View Source

112    @classmethod
113    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
114        """Create an instance of Tag from a dict"""
115        if obj is None:
116            return None
117
118        if not isinstance(obj, dict):
119            return cls.model_validate(obj)
120
121        _obj = cls.model_validate(
122            {"fillColor": obj.get("fillColor"), "id": obj.get("id"), "title": obj.get("title"), "type": obj.get("type")}
123        )
124        # store additional fields in additional_properties
125        for _key in obj.keys():
126            if _key not in cls.__properties:
127                _obj.additional_properties[_key] = obj.get(_key)
128
129        return _obj

Create an instance of Tag from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

265def init_private_attributes(self: BaseModel, __context: Any) -> None:
266    """This function is meant to behave like a BaseModel method to initialise private attributes.
267
268    It takes context as an argument since that's what pydantic-core passes when calling it.
269
270    Args:
271        self: The BaseModel instance.
272        __context: The context.
273    """
274    if getattr(self, '__pydantic_private__', None) is None:
275        pydantic_private = {}
276        for name, private_attr in self.__private_attributes__.items():
277            default = private_attr.get_default()
278            if default is not PydanticUndefined:
279                pydantic_private[name] = default
280        object_setattr(self, '__pydantic_private__', pydantic_private)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Args: self: The BaseModel instance. __context: The context.

model_fields = {'fill_color': FieldInfo(annotation=str, required=True, alias='fillColor', alias_priority=2, description='Background color of the tag.', metadata=[Strict(strict=True)]), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier of the tag.', metadata=[Strict(strict=True)]), 'title': FieldInfo(annotation=str, required=True, description='Text of the tag.', metadata=[Strict(strict=True)]), 'type': FieldInfo(annotation=str, required=True, description='Type of the object that is returned. In this case, type returns `tag`.', metadata=[Strict(strict=True)]), 'additional_properties': FieldInfo(annotation=Dict[str, Any], required=False, default={})}

model_computed_fields = {}

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs