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
 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 import Optional, Set
 23from typing_extensions import Self
 24
 25
 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

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

 27class CustomFieldPlatformbulkcreateoperation(BaseModel):
 28    """
 29    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.
 30    """  # noqa: E501
 31
 32    fill_color: Optional[StrictStr] = Field(
 33        default=None,
 34        description="Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.",
 35        alias="fillColor",
 36    )
 37    icon_shape: Optional[StrictStr] = Field(
 38        default="round", description="The shape of the icon on the preview field.", 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]] = ["fillColor", "iconShape", "iconUrl", "textColor", "tooltip", "value"]
 60
 61    @field_validator("icon_shape")
 62    def icon_shape_validate_enum(cls, value):
 63        """Validates the enum"""
 64        if value is None:
 65            return value
 66
 67        if value not in set(["round", "square"]):
 68            raise ValueError("must be one of enum values ('round', 'square')")
 69        return value
 70
 71    model_config = {
 72        "populate_by_name": True,
 73        "validate_assignment": True,
 74        "protected_namespaces": (),
 75    }
 76
 77    def to_str(self) -> str:
 78        """Returns the string representation of the model using alias"""
 79        return pprint.pformat(self.model_dump(by_alias=True))
 80
 81    def to_json(self) -> str:
 82        """Returns the JSON representation of the model using alias"""
 83        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 84        return json.dumps(self.to_dict())
 85
 86    @classmethod
 87    def from_json(cls, json_str: str) -> Optional[Self]:
 88        """Create an instance of CustomFieldPlatformbulkcreateoperation from a JSON string"""
 89        return cls.from_dict(json.loads(json_str))
 90
 91    def to_dict(self) -> Dict[str, Any]:
 92        """Return the dictionary representation of the model using alias.
 93
 94        This has the following differences from calling pydantic's
 95        `self.model_dump(by_alias=True)`:
 96
 97        * `None` is only added to the output dict for nullable fields that
 98          were set at model initialization. Other fields with value `None`
 99          are ignored.
100        * Fields in `self.additional_properties` are added to the output dict.
101        """
102        excluded_fields: Set[str] = set(
103            [
104                "additional_properties",
105            ]
106        )
107
108        _dict = self.model_dump(
109            by_alias=True,
110            exclude=excluded_fields,
111            exclude_none=True,
112        )
113        # puts key-value pairs in additional_properties in the top level
114        if self.additional_properties is not None:
115            for _key, _value in self.additional_properties.items():
116                _dict[_key] = _value
117
118        return _dict
119
120    @classmethod
121    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
122        """Create an instance of CustomFieldPlatformbulkcreateoperation from a dict"""
123        if obj is None:
124            return None
125
126        if not isinstance(obj, dict):
127            return cls.model_validate(obj)
128
129        _obj = cls.model_validate(
130            {
131                "fillColor": obj.get("fillColor"),
132                "iconShape": obj.get("iconShape") if obj.get("iconShape") is not None else "round",
133                "iconUrl": obj.get("iconUrl"),
134                "textColor": obj.get("textColor"),
135                "tooltip": obj.get("tooltip"),
136                "value": obj.get("value"),
137            }
138        )
139        # store additional fields in additional_properties
140        for _key in obj.keys():
141            if _key not in cls.__properties:
142                _obj.additional_properties[_key] = obj.get(_key)
143
144        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

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

Validates the enum

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

def to_str(self) -> str: View Source

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

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

86    @classmethod
87    def from_json(cls, json_str: str) -> Optional[Self]:
88        """Create an instance of CustomFieldPlatformbulkcreateoperation from a JSON string"""
89        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

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

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