miro_api.models.frame_create_request

  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
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.frame_changes import FrameChanges
 23from miro_api.models.frame_style import FrameStyle
 24from miro_api.models.geometry_no_rotation import GeometryNoRotation
 25from miro_api.models.position_change import PositionChange
 26from typing import Optional, Set
 27from typing_extensions import Self
 28
 29
 30class FrameCreateRequest(BaseModel):
 31    """
 32    FrameCreateRequest
 33    """  # noqa: E501
 34
 35    data: FrameChanges
 36    style: Optional[FrameStyle] = None
 37    position: Optional[PositionChange] = None
 38    geometry: Optional[GeometryNoRotation] = None
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["data", "style", "position", "geometry"]
 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 FrameCreateRequest 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 style
 88        if self.style:
 89            _dict["style"] = self.style.to_dict()
 90        # override the default output from pydantic by calling `to_dict()` of position
 91        if self.position:
 92            _dict["position"] = self.position.to_dict()
 93        # override the default output from pydantic by calling `to_dict()` of geometry
 94        if self.geometry:
 95            _dict["geometry"] = self.geometry.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 FrameCreateRequest 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": FrameChanges.from_dict(obj["data"]) if obj.get("data") is not None else None,
115                "style": FrameStyle.from_dict(obj["style"]) if obj.get("style") is not None else None,
116                "position": PositionChange.from_dict(obj["position"]) if obj.get("position") is not None else None,
117                "geometry": GeometryNoRotation.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None,
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