miro_api.models.custom_field_platform

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
 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 import Optional, Set
 22from typing_extensions import Self
 23
 24
 25class CustomFieldPlatform(BaseModel):
 26    """
 27    Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
 28    """  # noqa: E501
 29
 30    fill_color: Optional[StrictStr] = Field(
 31        default=None,
 32        description="Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.",
 33        alias="fillColor",
 34    )
 35    icon_shape: Optional[StrictStr] = Field(
 36        default="round",
 37        description="The shape of the icon on the preview field.",
 38        alias="iconShape",
 39    )
 40    icon_url: Optional[StrictStr] = Field(
 41        default=None,
 42        description="A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.",
 43        alias="iconUrl",
 44    )
 45    text_color: Optional[StrictStr] = Field(
 46        default=None,
 47        description="Hex value representing the color of the text string assigned to `value`.",
 48        alias="textColor",
 49    )
 50    tooltip: Optional[StrictStr] = Field(
 51        default=None,
 52        description="A short text displayed in a tooltip when clicking or hovering over the preview field.",
 53    )
 54    value: Optional[StrictStr] = Field(
 55        default=None,
 56        description="The actual data value of the custom field. It can be any type of information that you want to convey.",
 57    )
 58    additional_properties: Dict[str, Any] = {}
 59    __properties: ClassVar[List[str]] = [
 60        "fillColor",
 61        "iconShape",
 62        "iconUrl",
 63        "textColor",
 64        "tooltip",
 65        "value",
 66    ]
 67
 68    @field_validator("icon_shape")
 69    def icon_shape_validate_enum(cls, value):
 70        """Validates the enum"""
 71        if value is None:
 72            return value
 73
 74        if value not in set(["round", "square"]):
 75            raise ValueError("must be one of enum values ('round', 'square')")
 76        return value
 77
 78    model_config = {
 79        "populate_by_name": True,
 80        "validate_assignment": True,
 81        "protected_namespaces": (),
 82    }
 83
 84    def to_str(self) -> str:
 85        """Returns the string representation of the model using alias"""
 86        return pprint.pformat(self.model_dump(by_alias=True))
 87
 88    def to_json(self) -> str:
 89        """Returns the JSON representation of the model using alias"""
 90        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 91        return json.dumps(self.to_dict())
 92
 93    @classmethod
 94    def from_json(cls, json_str: str) -> Optional[Self]:
 95        """Create an instance of CustomFieldPlatform from a JSON string"""
 96        return cls.from_dict(json.loads(json_str))
 97
 98    def to_dict(self) -> Dict[str, Any]:
 99        """Return the dictionary representation of the model using alias.
100
101        This has the following differences from calling pydantic's
102        `self.model_dump(by_alias=True)`:
103
104        * `None` is only added to the output dict for nullable fields that
105          were set at model initialization. Other fields with value `None`
106          are ignored.
107        * Fields in `self.additional_properties` are added to the output dict.
108        """
109        excluded_fields: Set[str] = set(
110            [
111                "additional_properties",
112            ]
113        )
114
115        _dict = self.model_dump(
116            by_alias=True,
117            exclude=excluded_fields,
118            exclude_none=True,
119        )
120        # puts key-value pairs in additional_properties in the top level
121        if self.additional_properties is not None:
122            for _key, _value in self.additional_properties.items():
123                _dict[_key] = _value
124
125        return _dict
126
127    @classmethod
128    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
129        """Create an instance of CustomFieldPlatform from a dict"""
130        if obj is None:
131            return None
132
133        if not isinstance(obj, dict):
134            return cls.model_validate(obj)
135
136        _obj = cls.model_validate(
137            {
138                "fillColor": obj.get("fillColor"),
139                "iconShape": (obj.get("iconShape") if obj.get("iconShape") is not None else "round"),
140                "iconUrl": obj.get("iconUrl"),
141                "textColor": obj.get("textColor"),
142                "tooltip": obj.get("tooltip"),
143                "value": obj.get("value"),
144            }
145        )
146        # store additional fields in additional_properties
147        for _key in obj.keys():
148            if _key not in cls.__properties:
149                _obj.additional_properties[_key] = obj.get(_key)
150
151        return _obj

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

 26class CustomFieldPlatform(BaseModel):
 27    """
 28    Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.
 29    """  # noqa: E501
 30
 31    fill_color: Optional[StrictStr] = Field(
 32        default=None,
 33        description="Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.",
 34        alias="fillColor",
 35    )
 36    icon_shape: Optional[StrictStr] = Field(
 37        default="round",
 38        description="The shape of the icon on the preview field.",
 39        alias="iconShape",
 40    )
 41    icon_url: Optional[StrictStr] = Field(
 42        default=None,
 43        description="A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.",
 44        alias="iconUrl",
 45    )
 46    text_color: Optional[StrictStr] = Field(
 47        default=None,
 48        description="Hex value representing the color of the text string assigned to `value`.",
 49        alias="textColor",
 50    )
 51    tooltip: Optional[StrictStr] = Field(
 52        default=None,
 53        description="A short text displayed in a tooltip when clicking or hovering over the preview field.",
 54    )
 55    value: Optional[StrictStr] = Field(
 56        default=None,
 57        description="The actual data value of the custom field. It can be any type of information that you want to convey.",
 58    )
 59    additional_properties: Dict[str, Any] = {}
 60    __properties: ClassVar[List[str]] = [
 61        "fillColor",
 62        "iconShape",
 63        "iconUrl",
 64        "textColor",
 65        "tooltip",
 66        "value",
 67    ]
 68
 69    @field_validator("icon_shape")
 70    def icon_shape_validate_enum(cls, value):
 71        """Validates the enum"""
 72        if value is None:
 73            return value
 74
 75        if value not in set(["round", "square"]):
 76            raise ValueError("must be one of enum values ('round', 'square')")
 77        return value
 78
 79    model_config = {
 80        "populate_by_name": True,
 81        "validate_assignment": True,
 82        "protected_namespaces": (),
 83    }
 84
 85    def to_str(self) -> str:
 86        """Returns the string representation of the model using alias"""
 87        return pprint.pformat(self.model_dump(by_alias=True))
 88
 89    def to_json(self) -> str:
 90        """Returns the JSON representation of the model using alias"""
 91        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 92        return json.dumps(self.to_dict())
 93
 94    @classmethod
 95    def from_json(cls, json_str: str) -> Optional[Self]:
 96        """Create an instance of CustomFieldPlatform from a JSON string"""
 97        return cls.from_dict(json.loads(json_str))
 98
 99    def to_dict(self) -> Dict[str, Any]:
100        """Return the dictionary representation of the model using alias.
101
102        This has the following differences from calling pydantic's
103        `self.model_dump(by_alias=True)`:
104
105        * `None` is only added to the output dict for nullable fields that
106          were set at model initialization. Other fields with value `None`
107          are ignored.
108        * Fields in `self.additional_properties` are added to the output dict.
109        """
110        excluded_fields: Set[str] = set(
111            [
112                "additional_properties",
113            ]
114        )
115
116        _dict = self.model_dump(
117            by_alias=True,
118            exclude=excluded_fields,
119            exclude_none=True,
120        )
121        # puts key-value pairs in additional_properties in the top level
122        if self.additional_properties is not None:
123            for _key, _value in self.additional_properties.items():
124                _dict[_key] = _value
125
126        return _dict
127
128    @classmethod
129    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
130        """Create an instance of CustomFieldPlatform from a dict"""
131        if obj is None:
132            return None
133
134        if not isinstance(obj, dict):
135            return cls.model_validate(obj)
136
137        _obj = cls.model_validate(
138            {
139                "fillColor": obj.get("fillColor"),
140                "iconShape": (obj.get("iconShape") if obj.get("iconShape") is not None else "round"),
141                "iconUrl": obj.get("iconUrl"),
142                "textColor": obj.get("textColor"),
143                "tooltip": obj.get("tooltip"),
144                "value": obj.get("value"),
145            }
146        )
147        # store additional fields in additional_properties
148        for _key in obj.keys():
149            if _key not in cls.__properties:
150                _obj.additional_properties[_key] = obj.get(_key)
151
152        return _obj

Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.

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

icon_shape: Optional[Annotated[str, Strict(strict=True)]]

icon_url: Optional[Annotated[str, Strict(strict=True)]]

text_color: Optional[Annotated[str, Strict(strict=True)]]

tooltip: Optional[Annotated[str, Strict(strict=True)]]

value: Optional[Annotated[str, Strict(strict=True)]]

additional_properties: Dict[str, Any]

@field_validator('icon_shape')

def icon_shape_validate_enum(cls, value): View Source

69    @field_validator("icon_shape")
70    def icon_shape_validate_enum(cls, value):
71        """Validates the enum"""
72        if value is None:
73            return value
74
75        if value not in set(["round", "square"]):
76            raise ValueError("must be one of enum values ('round', 'square')")
77        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

94    @classmethod
95    def from_json(cls, json_str: str) -> Optional[Self]:
96        """Create an instance of CustomFieldPlatform from a JSON string"""
97        return cls.from_dict(json.loads(json_str))

Create an instance of CustomFieldPlatform from a JSON string

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

 99    def to_dict(self) -> Dict[str, Any]:
100        """Return the dictionary representation of the model using alias.
101
102        This has the following differences from calling pydantic's
103        `self.model_dump(by_alias=True)`:
104
105        * `None` is only added to the output dict for nullable fields that
106          were set at model initialization. Other fields with value `None`
107          are ignored.
108        * Fields in `self.additional_properties` are added to the output dict.
109        """
110        excluded_fields: Set[str] = set(
111            [
112                "additional_properties",
113            ]
114        )
115
116        _dict = self.model_dump(
117            by_alias=True,
118            exclude=excluded_fields,
119            exclude_none=True,
120        )
121        # puts key-value pairs in additional_properties in the top level
122        if self.additional_properties is not None:
123            for _key, _value in self.additional_properties.items():
124                _dict[_key] = _value
125
126        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

128    @classmethod
129    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
130        """Create an instance of CustomFieldPlatform from a dict"""
131        if obj is None:
132            return None
133
134        if not isinstance(obj, dict):
135            return cls.model_validate(obj)
136
137        _obj = cls.model_validate(
138            {
139                "fillColor": obj.get("fillColor"),
140                "iconShape": (obj.get("iconShape") if obj.get("iconShape") is not None else "round"),
141                "iconUrl": obj.get("iconUrl"),
142                "textColor": obj.get("textColor"),
143                "tooltip": obj.get("tooltip"),
144                "value": obj.get("value"),
145            }
146        )
147        # store additional fields in additional_properties
148        for _key in obj.keys():
149            if _key not in cls.__properties:
150                _obj.additional_properties[_key] = obj.get(_key)
151
152        return _obj

Create an instance of CustomFieldPlatform 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=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='fillColor', alias_priority=2, description="Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card."), 'icon_shape': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='round', alias='iconShape', alias_priority=2, description='The shape of the icon on the preview field.'), 'icon_url': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='iconUrl', alias_priority=2, description='A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.'), 'text_color': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='textColor', alias_priority=2, description='Hex value representing the color of the text string assigned to `value`.'), 'tooltip': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='A short text displayed in a tooltip when clicking or hovering over the preview field.'), 'value': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='The actual data value of the custom field. It can be any type of information that you want to convey.'), '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