miro_api.models.embed_url_data_changes

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 EmbedUrlDataChanges(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: Optional[StrictStr] = Field(
 41        default=None,
 42        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.",
 43    )
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["mode", "previewUrl", "url"]
 46
 47    @field_validator("mode")
 48    def mode_validate_enum(cls, value):
 49        """Validates the enum"""
 50        if value is None:
 51            return value
 52
 53        if value not in set(["inline", "modal"]):
 54            raise ValueError("must be one of enum values ('inline', 'modal')")
 55        return value
 56
 57    model_config = {
 58        "populate_by_name": True,
 59        "validate_assignment": True,
 60        "protected_namespaces": (),
 61    }
 62
 63    def to_str(self) -> str:
 64        """Returns the string representation of the model using alias"""
 65        return pprint.pformat(self.model_dump(by_alias=True))
 66
 67    def to_json(self) -> str:
 68        """Returns the JSON representation of the model using alias"""
 69        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 70        return json.dumps(self.to_dict())
 71
 72    @classmethod
 73    def from_json(cls, json_str: str) -> Optional[Self]:
 74        """Create an instance of EmbedUrlDataChanges from a JSON string"""
 75        return cls.from_dict(json.loads(json_str))
 76
 77    def to_dict(self) -> Dict[str, Any]:
 78        """Return the dictionary representation of the model using alias.
 79
 80        This has the following differences from calling pydantic's
 81        `self.model_dump(by_alias=True)`:
 82
 83        * `None` is only added to the output dict for nullable fields that
 84          were set at model initialization. Other fields with value `None`
 85          are ignored.
 86        * Fields in `self.additional_properties` are added to the output dict.
 87        """
 88        excluded_fields: Set[str] = set(
 89            [
 90                "additional_properties",
 91            ]
 92        )
 93
 94        _dict = self.model_dump(
 95            by_alias=True,
 96            exclude=excluded_fields,
 97            exclude_none=True,
 98        )
 99        # puts key-value pairs in additional_properties in the top level
100        if self.additional_properties is not None:
101            for _key, _value in self.additional_properties.items():
102                _dict[_key] = _value
103
104        return _dict
105
106    @classmethod
107    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108        """Create an instance of EmbedUrlDataChanges from a dict"""
109        if obj is None:
110            return None
111
112        if not isinstance(obj, dict):
113            return cls.model_validate(obj)
114
115        _obj = cls.model_validate({"mode": obj.get("mode"), "previewUrl": obj.get("previewUrl"), "url": obj.get("url")})
116        # store additional fields in additional_properties
117        for _key in obj.keys():
118            if _key not in cls.__properties:
119                _obj.additional_properties[_key] = obj.get(_key)
120
121        return _obj

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

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

Contains information about the embed URL.

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

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

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

additional_properties: Dict[str, Any]

@field_validator('mode')

def mode_validate_enum(cls, value): View Source

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

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of EmbedUrlDataChanges from a JSON string

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

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

107    @classmethod
108    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
109        """Create an instance of EmbedUrlDataChanges from a dict"""
110        if obj is None:
111            return None
112
113        if not isinstance(obj, dict):
114            return cls.model_validate(obj)
115
116        _obj = cls.model_validate({"mode": obj.get("mode"), "previewUrl": obj.get("previewUrl"), "url": obj.get("url")})
117        # store additional fields in additional_properties
118        for _key in obj.keys():
119            if _key not in cls.__properties:
120                _obj.additional_properties[_key] = obj.get(_key)
121
122        return _obj

Create an instance of EmbedUrlDataChanges 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=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, 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.'), '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