miro_api.models.embed_url_data_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 EmbedUrlDataPlatformbulkcreateoperation(BaseModel):
 26    """
 27    Contains information about the embed URL.
 28    """  # noqa: E501
 29
 30    mode: Optional[StrictStr] = Field(
 31        default=None,
 32        description="Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.",
 33    )
 34    preview_url: Optional[StrictStr] = Field(
 35        default=None,
 36        description="URL of the image to be used as the preview image for the embedded item.",
 37        alias="previewUrl",
 38    )
 39    url: StrictStr = Field(
 40        description="A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS."
 41    )
 42    additional_properties: Dict[str, Any] = {}
 43    __properties: ClassVar[List[str]] = ["mode", "previewUrl", "url"]
 44
 45    @field_validator("mode")
 46    def mode_validate_enum(cls, value):
 47        """Validates the enum"""
 48        if value is None:
 49            return value
 50
 51        if value not in set(["inline", "modal"]):
 52            raise ValueError("must be one of enum values ('inline', 'modal')")
 53        return value
 54
 55    model_config = {
 56        "populate_by_name": True,
 57        "validate_assignment": True,
 58        "protected_namespaces": (),
 59    }
 60
 61    def to_str(self) -> str:
 62        """Returns the string representation of the model using alias"""
 63        return pprint.pformat(self.model_dump(by_alias=True))
 64
 65    def to_json(self) -> str:
 66        """Returns the JSON representation of the model using alias"""
 67        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 68        return json.dumps(self.to_dict())
 69
 70    @classmethod
 71    def from_json(cls, json_str: str) -> Optional[Self]:
 72        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a JSON string"""
 73        return cls.from_dict(json.loads(json_str))
 74
 75    def to_dict(self) -> Dict[str, Any]:
 76        """Return the dictionary representation of the model using alias.
 77
 78        This has the following differences from calling pydantic's
 79        `self.model_dump(by_alias=True)`:
 80
 81        * `None` is only added to the output dict for nullable fields that
 82          were set at model initialization. Other fields with value `None`
 83          are ignored.
 84        * Fields in `self.additional_properties` are added to the output dict.
 85        """
 86        excluded_fields: Set[str] = set(
 87            [
 88                "additional_properties",
 89            ]
 90        )
 91
 92        _dict = self.model_dump(
 93            by_alias=True,
 94            exclude=excluded_fields,
 95            exclude_none=True,
 96        )
 97        # puts key-value pairs in additional_properties in the top level
 98        if self.additional_properties is not None:
 99            for _key, _value in self.additional_properties.items():
100                _dict[_key] = _value
101
102        return _dict
103
104    @classmethod
105    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
106        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a dict"""
107        if obj is None:
108            return None
109
110        if not isinstance(obj, dict):
111            return cls.model_validate(obj)
112
113        _obj = cls.model_validate(
114            {
115                "mode": obj.get("mode"),
116                "previewUrl": obj.get("previewUrl"),
117                "url": obj.get("url") if obj.get("url") is not None else "https://www.youtube.com/watch?v=HlVSNEiFCBk",
118            }
119        )
120        # store additional fields in additional_properties
121        for _key in obj.keys():
122            if _key not in cls.__properties:
123                _obj.additional_properties[_key] = obj.get(_key)
124
125        return _obj

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

 26class EmbedUrlDataPlatformbulkcreateoperation(BaseModel):
 27    """
 28    Contains information about the embed URL.
 29    """  # noqa: E501
 30
 31    mode: Optional[StrictStr] = Field(
 32        default=None,
 33        description="Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.",
 34    )
 35    preview_url: Optional[StrictStr] = Field(
 36        default=None,
 37        description="URL of the image to be used as the preview image for the embedded item.",
 38        alias="previewUrl",
 39    )
 40    url: StrictStr = Field(
 41        description="A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS."
 42    )
 43    additional_properties: Dict[str, Any] = {}
 44    __properties: ClassVar[List[str]] = ["mode", "previewUrl", "url"]
 45
 46    @field_validator("mode")
 47    def mode_validate_enum(cls, value):
 48        """Validates the enum"""
 49        if value is None:
 50            return value
 51
 52        if value not in set(["inline", "modal"]):
 53            raise ValueError("must be one of enum values ('inline', 'modal')")
 54        return value
 55
 56    model_config = {
 57        "populate_by_name": True,
 58        "validate_assignment": True,
 59        "protected_namespaces": (),
 60    }
 61
 62    def to_str(self) -> str:
 63        """Returns the string representation of the model using alias"""
 64        return pprint.pformat(self.model_dump(by_alias=True))
 65
 66    def to_json(self) -> str:
 67        """Returns the JSON representation of the model using alias"""
 68        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 69        return json.dumps(self.to_dict())
 70
 71    @classmethod
 72    def from_json(cls, json_str: str) -> Optional[Self]:
 73        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a JSON string"""
 74        return cls.from_dict(json.loads(json_str))
 75
 76    def to_dict(self) -> Dict[str, Any]:
 77        """Return the dictionary representation of the model using alias.
 78
 79        This has the following differences from calling pydantic's
 80        `self.model_dump(by_alias=True)`:
 81
 82        * `None` is only added to the output dict for nullable fields that
 83          were set at model initialization. Other fields with value `None`
 84          are ignored.
 85        * Fields in `self.additional_properties` are added to the output dict.
 86        """
 87        excluded_fields: Set[str] = set(
 88            [
 89                "additional_properties",
 90            ]
 91        )
 92
 93        _dict = self.model_dump(
 94            by_alias=True,
 95            exclude=excluded_fields,
 96            exclude_none=True,
 97        )
 98        # puts key-value pairs in additional_properties in the top level
 99        if self.additional_properties is not None:
100            for _key, _value in self.additional_properties.items():
101                _dict[_key] = _value
102
103        return _dict
104
105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "mode": obj.get("mode"),
117                "previewUrl": obj.get("previewUrl"),
118                "url": obj.get("url") if obj.get("url") is not None else "https://www.youtube.com/watch?v=HlVSNEiFCBk",
119            }
120        )
121        # store additional fields in additional_properties
122        for _key in obj.keys():
123            if _key not in cls.__properties:
124                _obj.additional_properties[_key] = obj.get(_key)
125
126        return _obj

Contains information about the embed URL.

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

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

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

additional_properties: Dict[str, Any]

@field_validator('mode')

def mode_validate_enum(cls, value): View Source

46    @field_validator("mode")
47    def mode_validate_enum(cls, value):
48        """Validates the enum"""
49        if value is None:
50            return value
51
52        if value not in set(["inline", "modal"]):
53            raise ValueError("must be one of enum values ('inline', 'modal')")
54        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

71    @classmethod
72    def from_json(cls, json_str: str) -> Optional[Self]:
73        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a JSON string"""
74        return cls.from_dict(json.loads(json_str))

Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a JSON string

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

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

105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of EmbedUrlDataPlatformbulkcreateoperation from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "mode": obj.get("mode"),
117                "previewUrl": obj.get("previewUrl"),
118                "url": obj.get("url") if obj.get("url") is not None else "https://www.youtube.com/watch?v=HlVSNEiFCBk",
119            }
120        )
121        # store additional fields in additional_properties
122        for _key in obj.keys():
123            if _key not in cls.__properties:
124                _obj.additional_properties[_key] = obj.get(_key)
125
126        return _obj

Create an instance of EmbedUrlDataPlatformbulkcreateoperation 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 = {'mode': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.'), 'preview_url': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='previewUrl', alias_priority=2, description='URL of the image to be used as the preview image for the embedded item.'), 'url': FieldInfo(annotation=str, required=True, description='A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS.', 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