miro_api.models.custom_field_platformbulkcreateoperation

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

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

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

60    @field_validator("icon_shape")
61    def icon_shape_validate_enum(cls, value):
62        """Validates the enum"""
63        if value is None:
64            return value
65
66        if value not in set(["round", "square"]):
67            raise ValueError("must be one of enum values ('round', 'square')")
68        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

85    @classmethod
86    def from_json(cls, json_str: str) -> Optional[Self]:
87        """Create an instance of CustomFieldPlatformbulkcreateoperation from a JSON string"""
88        return cls.from_dict(json.loads(json_str))

Create an instance of CustomFieldPlatformbulkcreateoperation from a JSON string

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

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

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

Create an instance of CustomFieldPlatformbulkcreateoperation 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