miro_api.models.generic_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
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from datetime import datetime
 21from pydantic import BaseModel, Field, StrictStr
 22from typing import Any, ClassVar, Dict, List, Optional
 23from miro_api.models.created_by import CreatedBy
 24from miro_api.models.geometry import Geometry
 25from miro_api.models.modified_by import ModifiedBy
 26from miro_api.models.parent import Parent
 27from miro_api.models.position import Position
 28from miro_api.models.widget_data_output import WidgetDataOutput
 29from typing import Optional, Set
 30from typing_extensions import Self
 31
 32
 33class GenericItem(BaseModel):
 34    """
 35    Contains the result data.
 36    """  # noqa: E501
 37
 38    created_at: Optional[datetime] = Field(
 39        default=None,
 40        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)).",
 41        alias="createdAt",
 42    )
 43    created_by: Optional[CreatedBy] = Field(default=None, alias="createdBy")
 44    data: Optional[WidgetDataOutput] = None
 45    geometry: Optional[Geometry] = None
 46    id: StrictStr = Field(description="Unique identifier (ID) of an item.")
 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[Parent] = None
 54    position: Optional[Position] = None
 55    type: StrictStr = Field(description="Type of item that is returned.")
 56    additional_properties: Dict[str, Any] = {}
 57    __properties: ClassVar[List[str]] = [
 58        "createdAt",
 59        "createdBy",
 60        "data",
 61        "geometry",
 62        "id",
 63        "modifiedAt",
 64        "modifiedBy",
 65        "parent",
 66        "position",
 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 GenericItem 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 created_by
113        if self.created_by:
114            _dict["createdBy"] = self.created_by.to_dict()
115        # override the default output from pydantic by calling `to_dict()` of data
116        if self.data:
117            _dict["data"] = self.data.to_dict()
118        # override the default output from pydantic by calling `to_dict()` of geometry
119        if self.geometry:
120            _dict["geometry"] = self.geometry.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 position
128        if self.position:
129            _dict["position"] = self.position.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 GenericItem 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                "createdAt": obj.get("createdAt"),
149                "createdBy": CreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
150                "data": WidgetDataOutput.from_dict(obj["data"]) if obj.get("data") is not None else None,
151                "geometry": Geometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None,
152                "id": obj.get("id"),
153                "modifiedAt": obj.get("modifiedAt"),
154                "modifiedBy": ModifiedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
155                "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
156                "position": Position.from_dict(obj["position"]) if obj.get("position") 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

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

 34class GenericItem(BaseModel):
 35    """
 36    Contains the result data.
 37    """  # noqa: E501
 38
 39    created_at: Optional[datetime] = Field(
 40        default=None,
 41        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)).",
 42        alias="createdAt",
 43    )
 44    created_by: Optional[CreatedBy] = Field(default=None, alias="createdBy")
 45    data: Optional[WidgetDataOutput] = None
 46    geometry: Optional[Geometry] = None
 47    id: StrictStr = Field(description="Unique identifier (ID) of an item.")
 48    modified_at: Optional[datetime] = Field(
 49        default=None,
 50        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)).",
 51        alias="modifiedAt",
 52    )
 53    modified_by: Optional[ModifiedBy] = Field(default=None, alias="modifiedBy")
 54    parent: Optional[Parent] = None
 55    position: Optional[Position] = None
 56    type: StrictStr = Field(description="Type of item that is returned.")
 57    additional_properties: Dict[str, Any] = {}
 58    __properties: ClassVar[List[str]] = [
 59        "createdAt",
 60        "createdBy",
 61        "data",
 62        "geometry",
 63        "id",
 64        "modifiedAt",
 65        "modifiedBy",
 66        "parent",
 67        "position",
 68        "type",
 69    ]
 70
 71    model_config = {
 72        "populate_by_name": True,
 73        "validate_assignment": True,
 74        "protected_namespaces": (),
 75    }
 76
 77    def to_str(self) -> str:
 78        """Returns the string representation of the model using alias"""
 79        return pprint.pformat(self.model_dump(by_alias=True))
 80
 81    def to_json(self) -> str:
 82        """Returns the JSON representation of the model using alias"""
 83        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 84        return json.dumps(self.to_dict())
 85
 86    @classmethod
 87    def from_json(cls, json_str: str) -> Optional[Self]:
 88        """Create an instance of GenericItem from a JSON string"""
 89        return cls.from_dict(json.loads(json_str))
 90
 91    def to_dict(self) -> Dict[str, Any]:
 92        """Return the dictionary representation of the model using alias.
 93
 94        This has the following differences from calling pydantic's
 95        `self.model_dump(by_alias=True)`:
 96
 97        * `None` is only added to the output dict for nullable fields that
 98          were set at model initialization. Other fields with value `None`
 99          are ignored.
100        * Fields in `self.additional_properties` are added to the output dict.
101        """
102        excluded_fields: Set[str] = set(
103            [
104                "additional_properties",
105            ]
106        )
107
108        _dict = self.model_dump(
109            by_alias=True,
110            exclude=excluded_fields,
111            exclude_none=True,
112        )
113        # override the default output from pydantic by calling `to_dict()` of created_by
114        if self.created_by:
115            _dict["createdBy"] = self.created_by.to_dict()
116        # override the default output from pydantic by calling `to_dict()` of data
117        if self.data:
118            _dict["data"] = self.data.to_dict()
119        # override the default output from pydantic by calling `to_dict()` of geometry
120        if self.geometry:
121            _dict["geometry"] = self.geometry.to_dict()
122        # override the default output from pydantic by calling `to_dict()` of modified_by
123        if self.modified_by:
124            _dict["modifiedBy"] = self.modified_by.to_dict()
125        # override the default output from pydantic by calling `to_dict()` of parent
126        if self.parent:
127            _dict["parent"] = self.parent.to_dict()
128        # override the default output from pydantic by calling `to_dict()` of position
129        if self.position:
130            _dict["position"] = self.position.to_dict()
131        # puts key-value pairs in additional_properties in the top level
132        if self.additional_properties is not None:
133            for _key, _value in self.additional_properties.items():
134                _dict[_key] = _value
135
136        return _dict
137
138    @classmethod
139    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
140        """Create an instance of GenericItem from a dict"""
141        if obj is None:
142            return None
143
144        if not isinstance(obj, dict):
145            return cls.model_validate(obj)
146
147        _obj = cls.model_validate(
148            {
149                "createdAt": obj.get("createdAt"),
150                "createdBy": CreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
151                "data": WidgetDataOutput.from_dict(obj["data"]) if obj.get("data") is not None else None,
152                "geometry": Geometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None,
153                "id": obj.get("id"),
154                "modifiedAt": obj.get("modifiedAt"),
155                "modifiedBy": ModifiedBy.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
156                "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None,
157                "position": Position.from_dict(obj["position"]) if obj.get("position") is not None else None,
158                "type": obj.get("type"),
159            }
160        )
161        # store additional fields in additional_properties
162        for _key in obj.keys():
163            if _key not in cls.__properties:
164                _obj.additional_properties[_key] = obj.get(_key)
165
166        return _obj

Contains the result data.

created_at: Optional[datetime.datetime]

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

data: Optional[miro_api.models.widget_data_output.WidgetDataOutput]

geometry: Optional[miro_api.models.geometry.Geometry]

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

modified_at: Optional[datetime.datetime]

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

parent: Optional[miro_api.models.parent.Parent]

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

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

77    def to_str(self) -> str:
78        """Returns the string representation of the model using alias"""
79        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

81    def to_json(self) -> str:
82        """Returns the JSON representation of the model using alias"""
83        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
84        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

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

Create an instance of GenericItem from a JSON string

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

 91    def to_dict(self) -> Dict[str, Any]:
 92        """Return the dictionary representation of the model using alias.
 93
 94        This has the following differences from calling pydantic's
 95        `self.model_dump(by_alias=True)`:
 96
 97        * `None` is only added to the output dict for nullable fields that
 98          were set at model initialization. Other fields with value `None`
 99          are ignored.
100        * Fields in `self.additional_properties` are added to the output dict.
101        """
102        excluded_fields: Set[str] = set(
103            [
104                "additional_properties",
105            ]
106        )
107
108        _dict = self.model_dump(
109            by_alias=True,
110            exclude=excluded_fields,
111            exclude_none=True,
112        )
113        # override the default output from pydantic by calling `to_dict()` of created_by
114        if self.created_by:
115            _dict["createdBy"] = self.created_by.to_dict()
116        # override the default output from pydantic by calling `to_dict()` of data
117        if self.data:
118            _dict["data"] = self.data.to_dict()
119        # override the default output from pydantic by calling `to_dict()` of geometry
120        if self.geometry:
121            _dict["geometry"] = self.geometry.to_dict()
122        # override the default output from pydantic by calling `to_dict()` of modified_by
123        if self.modified_by:
124            _dict["modifiedBy"] = self.modified_by.to_dict()
125        # override the default output from pydantic by calling `to_dict()` of parent
126        if self.parent:
127            _dict["parent"] = self.parent.to_dict()
128        # override the default output from pydantic by calling `to_dict()` of position
129        if self.position:
130            _dict["position"] = self.position.to_dict()
131        # puts key-value pairs in additional_properties in the top level
132        if self.additional_properties is not None:
133            for _key, _value in self.additional_properties.items():
134                _dict[_key] = _value
135
136        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

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

Create an instance of GenericItem 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 = {'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), 'data': FieldInfo(annotation=Union[WidgetDataOutput, NoneType], required=False), 'geometry': FieldInfo(annotation=Union[Geometry, NoneType], required=False), 'id': FieldInfo(annotation=str, required=True, description='Unique identifier (ID) of an item.', metadata=[Strict(strict=True)]), '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[Parent, NoneType], required=False), 'position': FieldInfo(annotation=Union[Position, 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