miro_api.models.fixed_ratio_geometry_platform_file_upload

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.

  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, StrictFloat, StrictInt
 21from typing import Any, ClassVar, Dict, List, Optional, Union
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class FixedRatioGeometryPlatformFileUpload(BaseModel):
 27    """
 28    Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.
 29    """  # noqa: E501
 30
 31    height: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Height of the item, in pixels.")
 32    width: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Width of the item, in pixels.")
 33    rotation: Optional[Union[StrictFloat, StrictInt]] = Field(
 34        default=None,
 35        description="Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.",
 36    )
 37    additional_properties: Dict[str, Any] = {}
 38    __properties: ClassVar[List[str]] = ["height", "width", "rotation"]
 39
 40    model_config = {
 41        "populate_by_name": True,
 42        "validate_assignment": True,
 43        "protected_namespaces": (),
 44    }
 45
 46    def to_str(self) -> str:
 47        """Returns the string representation of the model using alias"""
 48        return pprint.pformat(self.model_dump(by_alias=True))
 49
 50    def to_json(self) -> str:
 51        """Returns the JSON representation of the model using alias"""
 52        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 53        return json.dumps(self.to_dict())
 54
 55    @classmethod
 56    def from_json(cls, json_str: str) -> Optional[Self]:
 57        """Create an instance of FixedRatioGeometryPlatformFileUpload from a JSON string"""
 58        return cls.from_dict(json.loads(json_str))
 59
 60    def to_dict(self) -> Dict[str, Any]:
 61        """Return the dictionary representation of the model using alias.
 62
 63        This has the following differences from calling pydantic's
 64        `self.model_dump(by_alias=True)`:
 65
 66        * `None` is only added to the output dict for nullable fields that
 67          were set at model initialization. Other fields with value `None`
 68          are ignored.
 69        * Fields in `self.additional_properties` are added to the output dict.
 70        """
 71        excluded_fields: Set[str] = set(
 72            [
 73                "additional_properties",
 74            ]
 75        )
 76
 77        _dict = self.model_dump(
 78            by_alias=True,
 79            exclude=excluded_fields,
 80            exclude_none=True,
 81        )
 82        # puts key-value pairs in additional_properties in the top level
 83        if self.additional_properties is not None:
 84            for _key, _value in self.additional_properties.items():
 85                _dict[_key] = _value
 86
 87        return _dict
 88
 89    @classmethod
 90    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 91        """Create an instance of FixedRatioGeometryPlatformFileUpload from a dict"""
 92        if obj is None:
 93            return None
 94
 95        if not isinstance(obj, dict):
 96            return cls.model_validate(obj)
 97
 98        _obj = cls.model_validate(
 99            {"height": obj.get("height"), "width": obj.get("width"), "rotation": obj.get("rotation")}
100        )
101        # store additional fields in additional_properties
102        for _key in obj.keys():
103            if _key not in cls.__properties:
104                _obj.additional_properties[_key] = obj.get(_key)
105
106        return _obj
class FixedRatioGeometryPlatformFileUpload(pydantic.main.BaseModel):
 27class FixedRatioGeometryPlatformFileUpload(BaseModel):
 28    """
 29    Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.
 30    """  # noqa: E501
 31
 32    height: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Height of the item, in pixels.")
 33    width: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Width of the item, in pixels.")
 34    rotation: Optional[Union[StrictFloat, StrictInt]] = Field(
 35        default=None,
 36        description="Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.",
 37    )
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["height", "width", "rotation"]
 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 FixedRatioGeometryPlatformFileUpload 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        # puts key-value pairs in additional_properties in the top level
 84        if self.additional_properties is not None:
 85            for _key, _value in self.additional_properties.items():
 86                _dict[_key] = _value
 87
 88        return _dict
 89
 90    @classmethod
 91    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 92        """Create an instance of FixedRatioGeometryPlatformFileUpload from a dict"""
 93        if obj is None:
 94            return None
 95
 96        if not isinstance(obj, dict):
 97            return cls.model_validate(obj)
 98
 99        _obj = cls.model_validate(
100            {"height": obj.get("height"), "width": obj.get("width"), "rotation": obj.get("rotation")}
101        )
102        # store additional fields in additional_properties
103        for _key in obj.keys():
104            if _key not in cls.__properties:
105                _obj.additional_properties[_key] = obj.get(_key)
106
107        return _obj

Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.

height: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]
width: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]
rotation: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]
additional_properties: Dict[str, Any]
model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}
def to_str(self) -> str:
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))

Returns the string representation of the model using alias

def to_json(self) -> str:
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())

Returns the JSON representation of the model using alias

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

Create an instance of FixedRatioGeometryPlatformFileUpload from a JSON string

def to_dict(self) -> Dict[str, Any]:
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        # puts key-value pairs in additional_properties in the top level
84        if self.additional_properties is not None:
85            for _key, _value in self.additional_properties.items():
86                _dict[_key] = _value
87
88        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]:
 90    @classmethod
 91    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 92        """Create an instance of FixedRatioGeometryPlatformFileUpload from a dict"""
 93        if obj is None:
 94            return None
 95
 96        if not isinstance(obj, dict):
 97            return cls.model_validate(obj)
 98
 99        _obj = cls.model_validate(
100            {"height": obj.get("height"), "width": obj.get("width"), "rotation": obj.get("rotation")}
101        )
102        # store additional fields in additional_properties
103        for _key in obj.keys():
104            if _key not in cls.__properties:
105                _obj.additional_properties[_key] = obj.get(_key)
106
107        return _obj

Create an instance of FixedRatioGeometryPlatformFileUpload from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None:
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 = {'height': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, description='Height of the item, in pixels.'), 'width': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, description='Width of the item, in pixels.'), 'rotation': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, description='Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.'), '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