miro_api.models.document_item_platform_file_upload

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