miro_api.models.frame_data

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, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class FrameData(BaseModel):
 27    """
 28    Contains frame item data, such as the title, frame type, or frame format.
 29    """  # noqa: E501
 30
 31    format: Optional[StrictStr] = Field(default="custom", description="Only custom frames are supported at the moment.")
 32    title: Optional[StrictStr] = Field(
 33        default=None, description="Title of the frame. This title appears at the top of the frame."
 34    )
 35    type: Optional[StrictStr] = Field(
 36        default="freeform", description="Only free form frames are supported at the moment."
 37    )
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["format", "title", "type"]
 40
 41    @field_validator("format")
 42    def format_validate_enum(cls, value):
 43        """Validates the enum"""
 44        if value is None:
 45            return value
 46
 47        if value not in set(
 48            ["custom", "desktop", "phone", "tablet", "a4", "letter", "ratio_1x1", "ratio_4x3", "ratio_16x9"]
 49        ):
 50            raise ValueError(
 51                "must be one of enum values ('custom', 'desktop', 'phone', 'tablet', 'a4', 'letter', 'ratio_1x1', 'ratio_4x3', 'ratio_16x9')"
 52            )
 53        return value
 54
 55    @field_validator("type")
 56    def type_validate_enum(cls, value):
 57        """Validates the enum"""
 58        if value is None:
 59            return value
 60
 61        if value not in set(["freeform", "heap", "grid", "rows", "columns"]):
 62            raise ValueError("must be one of enum values ('freeform', 'heap', 'grid', 'rows', 'columns')")
 63        return value
 64
 65    model_config = {
 66        "populate_by_name": True,
 67        "validate_assignment": True,
 68        "protected_namespaces": (),
 69    }
 70
 71    def to_str(self) -> str:
 72        """Returns the string representation of the model using alias"""
 73        return pprint.pformat(self.model_dump(by_alias=True))
 74
 75    def to_json(self) -> str:
 76        """Returns the JSON representation of the model using alias"""
 77        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 78        return json.dumps(self.to_dict())
 79
 80    @classmethod
 81    def from_json(cls, json_str: str) -> Optional[Self]:
 82        """Create an instance of FrameData from a JSON string"""
 83        return cls.from_dict(json.loads(json_str))
 84
 85    def to_dict(self) -> Dict[str, Any]:
 86        """Return the dictionary representation of the model using alias.
 87
 88        This has the following differences from calling pydantic's
 89        `self.model_dump(by_alias=True)`:
 90
 91        * `None` is only added to the output dict for nullable fields that
 92          were set at model initialization. Other fields with value `None`
 93          are ignored.
 94        * Fields in `self.additional_properties` are added to the output dict.
 95        """
 96        excluded_fields: Set[str] = set(
 97            [
 98                "additional_properties",
 99            ]
100        )
101
102        _dict = self.model_dump(
103            by_alias=True,
104            exclude=excluded_fields,
105            exclude_none=True,
106        )
107        # puts key-value pairs in additional_properties in the top level
108        if self.additional_properties is not None:
109            for _key, _value in self.additional_properties.items():
110                _dict[_key] = _value
111
112        return _dict
113
114    @classmethod
115    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
116        """Create an instance of FrameData from a dict"""
117        if obj is None:
118            return None
119
120        if not isinstance(obj, dict):
121            return cls.model_validate(obj)
122
123        _obj = cls.model_validate(
124            {
125                "format": obj.get("format") if obj.get("format") is not None else "custom",
126                "title": obj.get("title"),
127                "type": obj.get("type") if obj.get("type") is not None else "freeform",
128            }
129        )
130        # store additional fields in additional_properties
131        for _key in obj.keys():
132            if _key not in cls.__properties:
133                _obj.additional_properties[_key] = obj.get(_key)
134
135        return _obj
class FrameData(pydantic.main.BaseModel): 
 27class FrameData(BaseModel):
 28    """
 29    Contains frame item data, such as the title, frame type, or frame format.
 30    """  # noqa: E501
 31
 32    format: Optional[StrictStr] = Field(default="custom", description="Only custom frames are supported at the moment.")
 33    title: Optional[StrictStr] = Field(
 34        default=None, description="Title of the frame. This title appears at the top of the frame."
 35    )
 36    type: Optional[StrictStr] = Field(
 37        default="freeform", description="Only free form frames are supported at the moment."
 38    )
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["format", "title", "type"]
 41
 42    @field_validator("format")
 43    def format_validate_enum(cls, value):
 44        """Validates the enum"""
 45        if value is None:
 46            return value
 47
 48        if value not in set(
 49            ["custom", "desktop", "phone", "tablet", "a4", "letter", "ratio_1x1", "ratio_4x3", "ratio_16x9"]
 50        ):
 51            raise ValueError(
 52                "must be one of enum values ('custom', 'desktop', 'phone', 'tablet', 'a4', 'letter', 'ratio_1x1', 'ratio_4x3', 'ratio_16x9')"
 53            )
 54        return value
 55
 56    @field_validator("type")
 57    def type_validate_enum(cls, value):
 58        """Validates the enum"""
 59        if value is None:
 60            return value
 61
 62        if value not in set(["freeform", "heap", "grid", "rows", "columns"]):
 63            raise ValueError("must be one of enum values ('freeform', 'heap', 'grid', 'rows', 'columns')")
 64        return value
 65
 66    model_config = {
 67        "populate_by_name": True,
 68        "validate_assignment": True,
 69        "protected_namespaces": (),
 70    }
 71
 72    def to_str(self) -> str:
 73        """Returns the string representation of the model using alias"""
 74        return pprint.pformat(self.model_dump(by_alias=True))
 75
 76    def to_json(self) -> str:
 77        """Returns the JSON representation of the model using alias"""
 78        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 79        return json.dumps(self.to_dict())
 80
 81    @classmethod
 82    def from_json(cls, json_str: str) -> Optional[Self]:
 83        """Create an instance of FrameData from a JSON string"""
 84        return cls.from_dict(json.loads(json_str))
 85
 86    def to_dict(self) -> Dict[str, Any]:
 87        """Return the dictionary representation of the model using alias.
 88
 89        This has the following differences from calling pydantic's
 90        `self.model_dump(by_alias=True)`:
 91
 92        * `None` is only added to the output dict for nullable fields that
 93          were set at model initialization. Other fields with value `None`
 94          are ignored.
 95        * Fields in `self.additional_properties` are added to the output dict.
 96        """
 97        excluded_fields: Set[str] = set(
 98            [
 99                "additional_properties",
100            ]
101        )
102
103        _dict = self.model_dump(
104            by_alias=True,
105            exclude=excluded_fields,
106            exclude_none=True,
107        )
108        # puts key-value pairs in additional_properties in the top level
109        if self.additional_properties is not None:
110            for _key, _value in self.additional_properties.items():
111                _dict[_key] = _value
112
113        return _dict
114
115    @classmethod
116    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
117        """Create an instance of FrameData from a dict"""
118        if obj is None:
119            return None
120
121        if not isinstance(obj, dict):
122            return cls.model_validate(obj)
123
124        _obj = cls.model_validate(
125            {
126                "format": obj.get("format") if obj.get("format") is not None else "custom",
127                "title": obj.get("title"),
128                "type": obj.get("type") if obj.get("type") is not None else "freeform",
129            }
130        )
131        # store additional fields in additional_properties
132        for _key in obj.keys():
133            if _key not in cls.__properties:
134                _obj.additional_properties[_key] = obj.get(_key)
135
136        return _obj

Contains frame item data, such as the title, frame type, or frame format.

format: Optional[Annotated[str, Strict(strict=True)]]
title: Optional[Annotated[str, Strict(strict=True)]]
type: Optional[Annotated[str, Strict(strict=True)]]
additional_properties: Dict[str, Any]
@field_validator('format')
def format_validate_enum(cls, value): 
42    @field_validator("format")
43    def format_validate_enum(cls, value):
44        """Validates the enum"""
45        if value is None:
46            return value
47
48        if value not in set(
49            ["custom", "desktop", "phone", "tablet", "a4", "letter", "ratio_1x1", "ratio_4x3", "ratio_16x9"]
50        ):
51            raise ValueError(
52                "must be one of enum values ('custom', 'desktop', 'phone', 'tablet', 'a4', 'letter', 'ratio_1x1', 'ratio_4x3', 'ratio_16x9')"
53            )
54        return value

Validates the enum

@field_validator('type')
def type_validate_enum(cls, value): 
56    @field_validator("type")
57    def type_validate_enum(cls, value):
58        """Validates the enum"""
59        if value is None:
60            return value
61
62        if value not in set(["freeform", "heap", "grid", "rows", "columns"]):
63            raise ValueError("must be one of enum values ('freeform', 'heap', 'grid', 'rows', 'columns')")
64        return value

Validates the enum

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

Returns the string representation of the model using alias

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

Create an instance of FrameData from a JSON string

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

Create an instance of FrameData 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 = {'format': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='custom', description='Only custom frames are supported at the moment.'), 'title': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Title of the frame. This title appears at the top of the frame.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='freeform', description='Only free form frames are supported at the moment.'), '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