miro_api.models.position

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, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional, Union
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class Position(BaseModel):
 27    """
 28    Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.
 29    """  # noqa: E501
 30
 31    origin: Optional[StrictStr] = Field(
 32        default="center",
 33        description="Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates. Currently, only one option is supported.",
 34    )
 35    relative_to: Optional[StrictStr] = Field(default=None, alias="relativeTo")
 36    x: Optional[Union[StrictFloat, StrictInt]] = Field(
 37        default=None,
 38        description="X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.",
 39    )
 40    y: Optional[Union[StrictFloat, StrictInt]] = Field(
 41        default=None,
 42        description="Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.",
 43    )
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["origin", "relativeTo", "x", "y"]
 46
 47    @field_validator("origin")
 48    def origin_validate_enum(cls, value):
 49        """Validates the enum"""
 50        if value is None:
 51            return value
 52
 53        if value not in set(["center"]):
 54            raise ValueError("must be one of enum values ('center')")
 55        return value
 56
 57    @field_validator("relative_to")
 58    def relative_to_validate_enum(cls, value):
 59        """Validates the enum"""
 60        if value is None:
 61            return value
 62
 63        if value not in set(["canvas_center", "parent_top_left"]):
 64            raise ValueError("must be one of enum values ('canvas_center', 'parent_top_left')")
 65        return value
 66
 67    model_config = {
 68        "populate_by_name": True,
 69        "validate_assignment": True,
 70        "protected_namespaces": (),
 71    }
 72
 73    def to_str(self) -> str:
 74        """Returns the string representation of the model using alias"""
 75        return pprint.pformat(self.model_dump(by_alias=True))
 76
 77    def to_json(self) -> str:
 78        """Returns the JSON representation of the model using alias"""
 79        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 80        return json.dumps(self.to_dict())
 81
 82    @classmethod
 83    def from_json(cls, json_str: str) -> Optional[Self]:
 84        """Create an instance of Position from a JSON string"""
 85        return cls.from_dict(json.loads(json_str))
 86
 87    def to_dict(self) -> Dict[str, Any]:
 88        """Return the dictionary representation of the model using alias.
 89
 90        This has the following differences from calling pydantic's
 91        `self.model_dump(by_alias=True)`:
 92
 93        * `None` is only added to the output dict for nullable fields that
 94          were set at model initialization. Other fields with value `None`
 95          are ignored.
 96        * Fields in `self.additional_properties` are added to the output dict.
 97        """
 98        excluded_fields: Set[str] = set(
 99            [
100                "additional_properties",
101            ]
102        )
103
104        _dict = self.model_dump(
105            by_alias=True,
106            exclude=excluded_fields,
107            exclude_none=True,
108        )
109        # puts key-value pairs in additional_properties in the top level
110        if self.additional_properties is not None:
111            for _key, _value in self.additional_properties.items():
112                _dict[_key] = _value
113
114        return _dict
115
116    @classmethod
117    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
118        """Create an instance of Position from a dict"""
119        if obj is None:
120            return None
121
122        if not isinstance(obj, dict):
123            return cls.model_validate(obj)
124
125        _obj = cls.model_validate(
126            {
127                "origin": obj.get("origin") if obj.get("origin") is not None else "center",
128                "relativeTo": obj.get("relativeTo"),
129                "x": obj.get("x"),
130                "y": obj.get("y"),
131            }
132        )
133        # store additional fields in additional_properties
134        for _key in obj.keys():
135            if _key not in cls.__properties:
136                _obj.additional_properties[_key] = obj.get(_key)
137
138        return _obj
class Position(pydantic.main.BaseModel): 
 27class Position(BaseModel):
 28    """
 29    Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.
 30    """  # noqa: E501
 31
 32    origin: Optional[StrictStr] = Field(
 33        default="center",
 34        description="Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates. Currently, only one option is supported.",
 35    )
 36    relative_to: Optional[StrictStr] = Field(default=None, alias="relativeTo")
 37    x: Optional[Union[StrictFloat, StrictInt]] = Field(
 38        default=None,
 39        description="X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.",
 40    )
 41    y: Optional[Union[StrictFloat, StrictInt]] = Field(
 42        default=None,
 43        description="Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.",
 44    )
 45    additional_properties: Dict[str, Any] = {}
 46    __properties: ClassVar[List[str]] = ["origin", "relativeTo", "x", "y"]
 47
 48    @field_validator("origin")
 49    def origin_validate_enum(cls, value):
 50        """Validates the enum"""
 51        if value is None:
 52            return value
 53
 54        if value not in set(["center"]):
 55            raise ValueError("must be one of enum values ('center')")
 56        return value
 57
 58    @field_validator("relative_to")
 59    def relative_to_validate_enum(cls, value):
 60        """Validates the enum"""
 61        if value is None:
 62            return value
 63
 64        if value not in set(["canvas_center", "parent_top_left"]):
 65            raise ValueError("must be one of enum values ('canvas_center', 'parent_top_left')")
 66        return value
 67
 68    model_config = {
 69        "populate_by_name": True,
 70        "validate_assignment": True,
 71        "protected_namespaces": (),
 72    }
 73
 74    def to_str(self) -> str:
 75        """Returns the string representation of the model using alias"""
 76        return pprint.pformat(self.model_dump(by_alias=True))
 77
 78    def to_json(self) -> str:
 79        """Returns the JSON representation of the model using alias"""
 80        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 81        return json.dumps(self.to_dict())
 82
 83    @classmethod
 84    def from_json(cls, json_str: str) -> Optional[Self]:
 85        """Create an instance of Position from a JSON string"""
 86        return cls.from_dict(json.loads(json_str))
 87
 88    def to_dict(self) -> Dict[str, Any]:
 89        """Return the dictionary representation of the model using alias.
 90
 91        This has the following differences from calling pydantic's
 92        `self.model_dump(by_alias=True)`:
 93
 94        * `None` is only added to the output dict for nullable fields that
 95          were set at model initialization. Other fields with value `None`
 96          are ignored.
 97        * Fields in `self.additional_properties` are added to the output dict.
 98        """
 99        excluded_fields: Set[str] = set(
100            [
101                "additional_properties",
102            ]
103        )
104
105        _dict = self.model_dump(
106            by_alias=True,
107            exclude=excluded_fields,
108            exclude_none=True,
109        )
110        # puts key-value pairs in additional_properties in the top level
111        if self.additional_properties is not None:
112            for _key, _value in self.additional_properties.items():
113                _dict[_key] = _value
114
115        return _dict
116
117    @classmethod
118    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
119        """Create an instance of Position from a dict"""
120        if obj is None:
121            return None
122
123        if not isinstance(obj, dict):
124            return cls.model_validate(obj)
125
126        _obj = cls.model_validate(
127            {
128                "origin": obj.get("origin") if obj.get("origin") is not None else "center",
129                "relativeTo": obj.get("relativeTo"),
130                "x": obj.get("x"),
131                "y": obj.get("y"),
132            }
133        )
134        # store additional fields in additional_properties
135        for _key in obj.keys():
136            if _key not in cls.__properties:
137                _obj.additional_properties[_key] = obj.get(_key)
138
139        return _obj

Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

origin: Optional[Annotated[str, Strict(strict=True)]]
relative_to: Optional[Annotated[str, Strict(strict=True)]]
x: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]
y: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType]
additional_properties: Dict[str, Any]
@field_validator('origin')
def origin_validate_enum(cls, value): 
48    @field_validator("origin")
49    def origin_validate_enum(cls, value):
50        """Validates the enum"""
51        if value is None:
52            return value
53
54        if value not in set(["center"]):
55            raise ValueError("must be one of enum values ('center')")
56        return value

Validates the enum

@field_validator('relative_to')
def relative_to_validate_enum(cls, value): 
58    @field_validator("relative_to")
59    def relative_to_validate_enum(cls, value):
60        """Validates the enum"""
61        if value is None:
62            return value
63
64        if value not in set(["canvas_center", "parent_top_left"]):
65            raise ValueError("must be one of enum values ('canvas_center', 'parent_top_left')")
66        return value

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}
def to_str(self) -> str: 
74    def to_str(self) -> str:
75        """Returns the string representation of the model using alias"""
76        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: 
78    def to_json(self) -> str:
79        """Returns the JSON representation of the model using alias"""
80        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
81        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]: 
83    @classmethod
84    def from_json(cls, json_str: str) -> Optional[Self]:
85        """Create an instance of Position from a JSON string"""
86        return cls.from_dict(json.loads(json_str))

Create an instance of Position from a JSON string

def to_dict(self) -> Dict[str, Any]: 
 88    def to_dict(self) -> Dict[str, Any]:
 89        """Return the dictionary representation of the model using alias.
 90
 91        This has the following differences from calling pydantic's
 92        `self.model_dump(by_alias=True)`:
 93
 94        * `None` is only added to the output dict for nullable fields that
 95          were set at model initialization. Other fields with value `None`
 96          are ignored.
 97        * Fields in `self.additional_properties` are added to the output dict.
 98        """
 99        excluded_fields: Set[str] = set(
100            [
101                "additional_properties",
102            ]
103        )
104
105        _dict = self.model_dump(
106            by_alias=True,
107            exclude=excluded_fields,
108            exclude_none=True,
109        )
110        # puts key-value pairs in additional_properties in the top level
111        if self.additional_properties is not None:
112            for _key, _value in self.additional_properties.items():
113                _dict[_key] = _value
114
115        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]: 
117    @classmethod
118    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
119        """Create an instance of Position from a dict"""
120        if obj is None:
121            return None
122
123        if not isinstance(obj, dict):
124            return cls.model_validate(obj)
125
126        _obj = cls.model_validate(
127            {
128                "origin": obj.get("origin") if obj.get("origin") is not None else "center",
129                "relativeTo": obj.get("relativeTo"),
130                "x": obj.get("x"),
131                "y": obj.get("y"),
132            }
133        )
134        # store additional fields in additional_properties
135        for _key in obj.keys():
136            if _key not in cls.__properties:
137                _obj.additional_properties[_key] = obj.get(_key)
138
139        return _obj

Create an instance of Position 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 = {'origin': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='center', description='Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates. Currently, only one option is supported.'), 'relative_to': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='relativeTo', alias_priority=2), 'x': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, description='X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.'), 'y': FieldInfo(annotation=Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)], NoneType], required=False, description='Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has `x: 0` and `y: 0` coordinates.'), '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