miro_api.models.app_card_item

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