miro_api.models.frame_changes

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, StrictBool, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class FrameChanges(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="Sample frame title", 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(["custom"]):
 53            raise ValueError("must be one of enum values ('custom')")
 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"]):
 63            raise ValueError("must be one of enum values ('freeform')")
 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 FrameChanges 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 FrameChanges 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") if obj.get("title") is not None else "Sample frame title",
128                "type": obj.get("type") if obj.get("type") is not None else "freeform",
129                "showContent": obj.get("showContent") if obj.get("showContent") is not None else True,
130            }
131        )
132        # store additional fields in additional_properties
133        for _key in obj.keys():
134            if _key not in cls.__properties:
135                _obj.additional_properties[_key] = obj.get(_key)
136
137        return _obj
class FrameChanges(pydantic.main.BaseModel): 
 27class FrameChanges(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="Sample frame title", 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    show_content: Optional[StrictBool] = Field(
 40        default=True,
 41        description="Hide or reveal the content inside a frame (Enterprise plan only).",
 42        alias="showContent",
 43    )
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["format", "title", "type", "showContent"]
 46
 47    @field_validator("format")
 48    def format_validate_enum(cls, value):
 49        """Validates the enum"""
 50        if value is None:
 51            return value
 52
 53        if value not in set(["custom"]):
 54            raise ValueError("must be one of enum values ('custom')")
 55        return value
 56
 57    @field_validator("type")
 58    def type_validate_enum(cls, value):
 59        """Validates the enum"""
 60        if value is None:
 61            return value
 62
 63        if value not in set(["freeform"]):
 64            raise ValueError("must be one of enum values ('freeform')")
 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 FrameChanges 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 FrameChanges 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                "format": obj.get("format") if obj.get("format") is not None else "custom",
128                "title": obj.get("title") if obj.get("title") is not None else "Sample frame title",
129                "type": obj.get("type") if obj.get("type") is not None else "freeform",
130                "showContent": obj.get("showContent") if obj.get("showContent") is not None else True,
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

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): 
47    @field_validator("format")
48    def format_validate_enum(cls, value):
49        """Validates the enum"""
50        if value is None:
51            return value
52
53        if value not in set(["custom"]):
54            raise ValueError("must be one of enum values ('custom')")
55        return value

Validates the enum

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

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}
def to_str(self) -> str: 
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))

Returns the string representation of the model using alias

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

Returns the JSON representation of the model using alias

@classmethod
def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: 
82    @classmethod
83    def from_json(cls, json_str: str) -> Optional[Self]:
84        """Create an instance of FrameChanges from a JSON string"""
85        return cls.from_dict(json.loads(json_str))

Create an instance of FrameChanges from a JSON string

def to_dict(self) -> Dict[str, Any]: 
 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

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]: 
116    @classmethod
117    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
118        """Create an instance of FrameChanges 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                "format": obj.get("format") if obj.get("format") is not None else "custom",
128                "title": obj.get("title") if obj.get("title") is not None else "Sample frame title",
129                "type": obj.get("type") if obj.get("type") is not None else "freeform",
130                "showContent": obj.get("showContent") if obj.get("showContent") is not None else True,
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

Create an instance of FrameChanges 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, default='Sample frame title', 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