miro_api.models.tag_with_links

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

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

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

TagWithLinks

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

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

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

links: Optional[miro_api.models.self_link.SelfLink]

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

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

Validates the enum

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

def to_str(self) -> str: View Source

71    def to_str(self) -> str:
72        """Returns the string representation of the model using alias"""
73        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

75    def to_json(self) -> str:
76        """Returns the JSON representation of the model using alias"""
77        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
78        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

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

Create an instance of TagWithLinks from a JSON string

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

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

117    @classmethod
118    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
119        """Create an instance of TagWithLinks from a dict"""
120        if obj is None:
121            return None
122
123        if not isinstance(obj, dict):
124            return cls.model_validate(obj)
125
126        _obj = cls.model_validate(
127            {
128                "id": obj.get("id"),
129                "title": obj.get("title"),
130                "fillColor": obj.get("fillColor"),
131                "links": SelfLink.from_dict(obj["links"]) if obj.get("links") is not None else None,
132                "type": obj.get("type"),
133            }
134        )
135        # store additional fields in additional_properties
136        for _key in obj.keys():
137            if _key not in cls.__properties:
138                _obj.additional_properties[_key] = obj.get(_key)
139
140        return _obj

Create an instance of TagWithLinks 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 = {'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)]), 'fill_color': FieldInfo(annotation=str, required=True, alias='fillColor', alias_priority=2, description='Background color of the tag.', metadata=[Strict(strict=True)]), 'links': FieldInfo(annotation=Union[SelfLink, NoneType], required=False), '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