miro_api.models.embed_update_request

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
 20from typing import Any, ClassVar, Dict, List, Optional
 21from miro_api.models.embed_url_data_changes import EmbedUrlDataChanges
 22from miro_api.models.fixed_ratio_no_rotation_geometry import FixedRatioNoRotationGeometry
 23from miro_api.models.parent import Parent
 24from miro_api.models.position_change import PositionChange
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class EmbedUpdateRequest(BaseModel):
 30    """
 31    EmbedUpdateRequest
 32    """  # noqa: E501
 33
 34    data: Optional[EmbedUrlDataChanges] = None
 35    position: Optional[PositionChange] = None
 36    geometry: Optional[FixedRatioNoRotationGeometry] = None
 37    parent: Optional[Parent] = None
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["data", "position", "geometry", "parent"]
 40
 41    model_config = {
 42        "populate_by_name": True,
 43        "validate_assignment": True,
 44        "protected_namespaces": (),
 45    }
 46
 47    def to_str(self) -> str:
 48        """Returns the string representation of the model using alias"""
 49        return pprint.pformat(self.model_dump(by_alias=True))
 50
 51    def to_json(self) -> str:
 52        """Returns the JSON representation of the model using alias"""
 53        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 54        return json.dumps(self.to_dict())
 55
 56    @classmethod
 57    def from_json(cls, json_str: str) -> Optional[Self]:
 58        """Create an instance of EmbedUpdateRequest from a JSON string"""
 59        return cls.from_dict(json.loads(json_str))
 60
 61    def to_dict(self) -> Dict[str, Any]:
 62        """Return the dictionary representation of the model using alias.
 63
 64        This has the following differences from calling pydantic's
 65        `self.model_dump(by_alias=True)`:
 66
 67        * `None` is only added to the output dict for nullable fields that
 68          were set at model initialization. Other fields with value `None`
 69          are ignored.
 70        * Fields in `self.additional_properties` are added to the output dict.
 71        """
 72        excluded_fields: Set[str] = set(
 73            [
 74                "additional_properties",
 75            ]
 76        )
 77
 78        _dict = self.model_dump(
 79            by_alias=True,
 80            exclude=excluded_fields,
 81            exclude_none=True,
 82        )
 83        # override the default output from pydantic by calling `to_dict()` of data
 84        if self.data:
 85            _dict["data"] = self.data.to_dict()
 86        # override the default output from pydantic by calling `to_dict()` of position
 87        if self.position:
 88            _dict["position"] = self.position.to_dict()
 89        # override the default output from pydantic by calling `to_dict()` of geometry
 90        if self.geometry:
 91            _dict["geometry"] = self.geometry.to_dict()
 92        # override the default output from pydantic by calling `to_dict()` of parent
 93        if self.parent:
 94            _dict["parent"] = self.parent.to_dict()
 95        # puts key-value pairs in additional_properties in the top level
 96        if self.additional_properties is not None:
 97            for _key, _value in self.additional_properties.items():
 98                _dict[_key] = _value
 99
100        return _dict
101
102    @classmethod
103    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
104        """Create an instance of EmbedUpdateRequest from a dict"""
105        if obj is None:
106            return None
107
108        if not isinstance(obj, dict):
109            return cls.model_validate(obj)
110
111        _obj = cls.model_validate(
112            {
113                "data": EmbedUrlDataChanges.from_dict(obj["data"]) if obj.get("data") is not None else None,
114                "position": PositionChange.from_dict(obj["position"]) if obj.get("position") is not None else None,
115                "geometry": (
116                    FixedRatioNoRotationGeometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None
117                ),
118                "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
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

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

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

EmbedUpdateRequest

data: Optional[miro_api.models.embed_url_data_changes.EmbedUrlDataChanges]

position: Optional[miro_api.models.position_change.PositionChange]

geometry: Optional[miro_api.models.fixed_ratio_no_rotation_geometry.FixedRatioNoRotationGeometry]

parent: Optional[miro_api.models.parent.Parent]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

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

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

57    @classmethod
58    def from_json(cls, json_str: str) -> Optional[Self]:
59        """Create an instance of EmbedUpdateRequest from a JSON string"""
60        return cls.from_dict(json.loads(json_str))

Create an instance of EmbedUpdateRequest from a JSON string

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

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

103    @classmethod
104    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
105        """Create an instance of EmbedUpdateRequest from a dict"""
106        if obj is None:
107            return None
108
109        if not isinstance(obj, dict):
110            return cls.model_validate(obj)
111
112        _obj = cls.model_validate(
113            {
114                "data": EmbedUrlDataChanges.from_dict(obj["data"]) if obj.get("data") is not None else None,
115                "position": PositionChange.from_dict(obj["position"]) if obj.get("position") is not None else None,
116                "geometry": (
117                    FixedRatioNoRotationGeometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None
118                ),
119                "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
120            }
121        )
122        # store additional fields in additional_properties
123        for _key in obj.keys():
124            if _key not in cls.__properties:
125                _obj.additional_properties[_key] = obj.get(_key)
126
127        return _obj

Create an instance of EmbedUpdateRequest 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 = {'data': FieldInfo(annotation=Union[EmbedUrlDataChanges, NoneType], required=False), 'position': FieldInfo(annotation=Union[PositionChange, NoneType], required=False), 'geometry': FieldInfo(annotation=Union[FixedRatioNoRotationGeometry, NoneType], required=False), 'parent': FieldInfo(annotation=Union[Parent, NoneType], required=False), '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