miro_api.models.doc_format_item

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.

View Source

  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 datetime import datetime
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.created_by import CreatedBy
 23from miro_api.models.doc_format_data import DocFormatData
 24from miro_api.models.modified_by import ModifiedBy
 25from miro_api.models.parent_links_envelope import ParentLinksEnvelope
 26from miro_api.models.position import Position
 27from miro_api.models.widget_links import WidgetLinks
 28from typing import Optional, Set
 29from typing_extensions import Self
 30
 31
 32class DocFormatItem(BaseModel):
 33    """
 34    DocFormatItem
 35    """  # noqa: E501
 36
 37    id: StrictStr = Field(description="Unique identifier (ID) of an item.")
 38    data: Optional[DocFormatData] = None
 39    position: Optional[Position] = None
 40    created_at: Optional[datetime] = Field(
 41        default=None,
 42        description="Date and time when the item was created. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 43        alias="createdAt",
 44    )
 45    created_by: Optional[CreatedBy] = Field(default=None, alias="createdBy")
 46    modified_at: Optional[datetime] = Field(
 47        default=None,
 48        description="Date and time when the item was last modified. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 49        alias="modifiedAt",
 50    )
 51    modified_by: Optional[ModifiedBy] = Field(default=None, alias="modifiedBy")
 52    parent: Optional[ParentLinksEnvelope] = None
 53    links: Optional[WidgetLinks] = None
 54    type: StrictStr = Field(description="Type of item that is returned.")
 55    additional_properties: Dict[str, Any] = {}
 56    __properties: ClassVar[List[str]] = [
 57        "id",
 58        "data",
 59        "position",
 60        "createdAt",
 61        "createdBy",
 62        "modifiedAt",
 63        "modifiedBy",
 64        "parent",
 65        "links",
 66        "type",
 67    ]
 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 DocFormatItem 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        # override the default output from pydantic by calling `to_dict()` of data
112        if self.data:
113            _dict["data"] = self.data.to_dict()
114        # override the default output from pydantic by calling `to_dict()` of position
115        if self.position:
116            _dict["position"] = self.position.to_dict()
117        # override the default output from pydantic by calling `to_dict()` of created_by
118        if self.created_by:
119            _dict["createdBy"] = self.created_by.to_dict()
120        # override the default output from pydantic by calling `to_dict()` of modified_by
121        if self.modified_by:
122            _dict["modifiedBy"] = self.modified_by.to_dict()
123        # override the default output from pydantic by calling `to_dict()` of parent
124        if self.parent:
125            _dict["parent"] = self.parent.to_dict()
126        # override the default output from pydantic by calling `to_dict()` of links
127        if self.links:
128            _dict["links"] = self.links.to_dict()
129        # puts key-value pairs in additional_properties in the top level
130        if self.additional_properties is not None:
131            for _key, _value in self.additional_properties.items():
132                _dict[_key] = _value
133
134        return _dict
135
136    @classmethod
137    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
138        """Create an instance of DocFormatItem from a dict"""
139        if obj is None:
140            return None
141
142        if not isinstance(obj, dict):
143            return cls.model_validate(obj)
144
145        _obj = cls.model_validate(
146            {
147                "id": obj.get("id"),
148                "data": DocFormatData.from_dict(obj["data"]) if obj.get("data") is not None else None,
149                "position": Position.from_dict(obj["position"]) if obj.get("position") is not None else None,
150                "createdAt": obj.get("createdAt"),
151                "createdBy": CreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
152                "modifiedAt": obj.get("modifiedAt"),
153                "modifiedBy": ModifiedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
154                "parent": ParentLinksEnvelope.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
155                "links": WidgetLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
156                "type": obj.get("type"),
157            }
158        )
159        # store additional fields in additional_properties
160        for _key in obj.keys():
161            if _key not in cls.__properties:
162                _obj.additional_properties[_key] = obj.get(_key)
163
164        return _obj

class DocFormatItem(pydantic.main.BaseModel): View Source

 33class DocFormatItem(BaseModel):
 34    """
 35    DocFormatItem
 36    """  # noqa: E501
 37
 38    id: StrictStr = Field(description="Unique identifier (ID) of an item.")
 39    data: Optional[DocFormatData] = None
 40    position: Optional[Position] = None
 41    created_at: Optional[datetime] = Field(
 42        default=None,
 43        description="Date and time when the item was created. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 44        alias="createdAt",
 45    )
 46    created_by: Optional[CreatedBy] = Field(default=None, alias="createdBy")
 47    modified_at: Optional[datetime] = Field(
 48        default=None,
 49        description="Date and time when the item was last modified. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 50        alias="modifiedAt",
 51    )
 52    modified_by: Optional[ModifiedBy] = Field(default=None, alias="modifiedBy")
 53    parent: Optional[ParentLinksEnvelope] = None
 54    links: Optional[WidgetLinks] = None
 55    type: StrictStr = Field(description="Type of item that is returned.")
 56    additional_properties: Dict[str, Any] = {}
 57    __properties: ClassVar[List[str]] = [
 58        "id",
 59        "data",
 60        "position",
 61        "createdAt",
 62        "createdBy",
 63        "modifiedAt",
 64        "modifiedBy",
 65        "parent",
 66        "links",
 67        "type",
 68    ]
 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 DocFormatItem 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        # override the default output from pydantic by calling `to_dict()` of data
113        if self.data:
114            _dict["data"] = self.data.to_dict()
115        # override the default output from pydantic by calling `to_dict()` of position
116        if self.position:
117            _dict["position"] = self.position.to_dict()
118        # override the default output from pydantic by calling `to_dict()` of created_by
119        if self.created_by:
120            _dict["createdBy"] = self.created_by.to_dict()
121        # override the default output from pydantic by calling `to_dict()` of modified_by
122        if self.modified_by:
123            _dict["modifiedBy"] = self.modified_by.to_dict()
124        # override the default output from pydantic by calling `to_dict()` of parent
125        if self.parent:
126            _dict["parent"] = self.parent.to_dict()
127        # override the default output from pydantic by calling `to_dict()` of links
128        if self.links:
129            _dict["links"] = self.links.to_dict()
130        # puts key-value pairs in additional_properties in the top level
131        if self.additional_properties is not None:
132            for _key, _value in self.additional_properties.items():
133                _dict[_key] = _value
134
135        return _dict
136
137    @classmethod
138    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
139        """Create an instance of DocFormatItem from a dict"""
140        if obj is None:
141            return None
142
143        if not isinstance(obj, dict):
144            return cls.model_validate(obj)
145
146        _obj = cls.model_validate(
147            {
148                "id": obj.get("id"),
149                "data": DocFormatData.from_dict(obj["data"]) if obj.get("data") is not None else None,
150                "position": Position.from_dict(obj["position"]) if obj.get("position") is not None else None,
151                "createdAt": obj.get("createdAt"),
152                "createdBy": CreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
153                "modifiedAt": obj.get("modifiedAt"),
154                "modifiedBy": ModifiedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
155                "parent": ParentLinksEnvelope.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
156                "links": WidgetLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
157                "type": obj.get("type"),
158            }
159        )
160        # store additional fields in additional_properties
161        for _key in obj.keys():
162            if _key not in cls.__properties:
163                _obj.additional_properties[_key] = obj.get(_key)
164
165        return _obj

DocFormatItem

id: typing.Annotated[str, Strict(strict=True)]

data: Optional[miro_api.models.doc_format_data.DocFormatData]

position: Optional[miro_api.models.position.Position]

created_at: Optional[datetime.datetime]

created_by: Optional[miro_api.models.created_by.CreatedBy]

modified_at: Optional[datetime.datetime]

modified_by: Optional[miro_api.models.modified_by.ModifiedBy]

parent: Optional[miro_api.models.parent_links_envelope.ParentLinksEnvelope]

links: Optional[miro_api.models.widget_links.WidgetLinks]

type: typing.Annotated[str, Strict(strict=True)]

additional_properties: Dict[str, Any]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

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: View Source

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]: View Source

85    @classmethod
86    def from_json(cls, json_str: str) -> Optional[Self]:
87        """Create an instance of DocFormatItem from a JSON string"""
88        return cls.from_dict(json.loads(json_str))

Create an instance of DocFormatItem from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

 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        # override the default output from pydantic by calling `to_dict()` of data
113        if self.data:
114            _dict["data"] = self.data.to_dict()
115        # override the default output from pydantic by calling `to_dict()` of position
116        if self.position:
117            _dict["position"] = self.position.to_dict()
118        # override the default output from pydantic by calling `to_dict()` of created_by
119        if self.created_by:
120            _dict["createdBy"] = self.created_by.to_dict()
121        # override the default output from pydantic by calling `to_dict()` of modified_by
122        if self.modified_by:
123            _dict["modifiedBy"] = self.modified_by.to_dict()
124        # override the default output from pydantic by calling `to_dict()` of parent
125        if self.parent:
126            _dict["parent"] = self.parent.to_dict()
127        # override the default output from pydantic by calling `to_dict()` of links
128        if self.links:
129            _dict["links"] = self.links.to_dict()
130        # puts key-value pairs in additional_properties in the top level
131        if self.additional_properties is not None:
132            for _key, _value in self.additional_properties.items():
133                _dict[_key] = _value
134
135        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]: View Source

137    @classmethod
138    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
139        """Create an instance of DocFormatItem from a dict"""
140        if obj is None:
141            return None
142
143        if not isinstance(obj, dict):
144            return cls.model_validate(obj)
145
146        _obj = cls.model_validate(
147            {
148                "id": obj.get("id"),
149                "data": DocFormatData.from_dict(obj["data"]) if obj.get("data") is not None else None,
150                "position": Position.from_dict(obj["position"]) if obj.get("position") is not None else None,
151                "createdAt": obj.get("createdAt"),
152                "createdBy": CreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
153                "modifiedAt": obj.get("modifiedAt"),
154                "modifiedBy": ModifiedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
155                "parent": ParentLinksEnvelope.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
156                "links": WidgetLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
157                "type": obj.get("type"),
158            }
159        )
160        # store additional fields in additional_properties
161        for _key in obj.keys():
162            if _key not in cls.__properties:
163                _obj.additional_properties[_key] = obj.get(_key)
164
165        return _obj

Create an instance of DocFormatItem from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

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 = {'id': FieldInfo(annotation=str, required=True, description='Unique identifier (ID) of an item.', metadata=[Strict(strict=True)]), 'data': FieldInfo(annotation=Union[DocFormatData, NoneType], required=False), 'position': FieldInfo(annotation=Union[Position, NoneType], required=False), 'created_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='createdAt', alias_priority=2, description='Date and time when the item was created. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).'), 'created_by': FieldInfo(annotation=Union[CreatedBy, NoneType], required=False, alias='createdBy', alias_priority=2), 'modified_at': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='modifiedAt', alias_priority=2, description='Date and time when the item was last modified. <br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).'), 'modified_by': FieldInfo(annotation=Union[ModifiedBy, NoneType], required=False, alias='modifiedBy', alias_priority=2), 'parent': FieldInfo(annotation=Union[ParentLinksEnvelope, NoneType], required=False), 'links': FieldInfo(annotation=Union[WidgetLinks, NoneType], required=False), 'type': FieldInfo(annotation=str, required=True, description='Type of item that is returned.', metadata=[Strict(strict=True)]), '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