miro_api.models.fixed_ratio_geometry_platform_file_upload

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