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

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

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

ShapeCreateRequest

data: Optional[miro_api.models.shape_data_for_create.ShapeDataForCreate]

style: Optional[miro_api.models.shape_style_for_create.ShapeStyleForCreate]

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

geometry: Optional[miro_api.models.geometry.Geometry]

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

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

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

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

Create an instance of ShapeCreateRequest from a JSON string

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

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

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

Create an instance of ShapeCreateRequest 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[ShapeDataForCreate, NoneType], required=False), 'style': FieldInfo(annotation=Union[ShapeStyleForCreate, NoneType], required=False), 'position': FieldInfo(annotation=Union[PositionChange, NoneType], required=False), 'geometry': FieldInfo(annotation=Union[Geometry, 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