miro_api.models.frame_data_platform_containers

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

Validates the enum

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

Validates the enum

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

Returns the string representation of the model using alias

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

Create an instance of FrameDataPlatformContainers from a JSON string

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

Create an instance of FrameDataPlatformContainers 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.'), 'show_content': FieldInfo(annotation=Union[Annotated[bool, Strict(strict=True)], NoneType], required=False, default=True, alias='showContent', alias_priority=2, description='Hide or reveal the content inside a frame (Enterprise plan only).'), '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