miro_api.models.embed_data

  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, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List, Optional
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25
 26class EmbedData(BaseModel):
 27    """
 28    EmbedData
 29    """  # noqa: E501
 30
 31    content_type: Optional[StrictStr] = Field(
 32        default=None, description="Type of the embedded item's content.", alias="contentType"
 33    )
 34    description: Optional[StrictStr] = Field(default=None, description="Short description of the embedded item.")
 35    html: Optional[StrictStr] = Field(default=None, description="Html code of the embedded item.")
 36    mode: Optional[StrictStr] = Field(
 37        default=None,
 38        description="Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.",
 39    )
 40    preview_url: Optional[StrictStr] = Field(
 41        default=None,
 42        description="The URL to download the resource. You must use your access token to access the URL. The URL contains the `redirect` parameter and the `format` parameter to control the request execution as described in the following parameters: `format` parameter: By default, the image format is set to the preview image. If you want to download the original image, set the `format` parameter in the URL to `original`. `redirect`: By default, the `redirect` parameter is set to `false` and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the `redirect` parameter is set to `true`, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be `image/png`, 'image/svg', or 'image/jpg', depending on the original image type.",
 43        alias="previewUrl",
 44    )
 45    provider_name: Optional[StrictStr] = Field(
 46        default=None, description="Name of the content's provider.", alias="providerName"
 47    )
 48    provider_url: Optional[StrictStr] = Field(
 49        default=None, description="Url of the content's provider.", alias="providerUrl"
 50    )
 51    title: Optional[StrictStr] = Field(default=None, description="Title of the embedded item.")
 52    url: Optional[StrictStr] = Field(
 53        default=None,
 54        description="A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS.",
 55    )
 56    additional_properties: Dict[str, Any] = {}
 57    __properties: ClassVar[List[str]] = [
 58        "contentType",
 59        "description",
 60        "html",
 61        "mode",
 62        "previewUrl",
 63        "providerName",
 64        "providerUrl",
 65        "title",
 66        "url",
 67    ]
 68
 69    @field_validator("mode")
 70    def mode_validate_enum(cls, value):
 71        """Validates the enum"""
 72        if value is None:
 73            return value
 74
 75        if value not in set(["inline", "modal"]):
 76            raise ValueError("must be one of enum values ('inline', 'modal')")
 77        return value
 78
 79    model_config = {
 80        "populate_by_name": True,
 81        "validate_assignment": True,
 82        "protected_namespaces": (),
 83    }
 84
 85    def to_str(self) -> str:
 86        """Returns the string representation of the model using alias"""
 87        return pprint.pformat(self.model_dump(by_alias=True))
 88
 89    def to_json(self) -> str:
 90        """Returns the JSON representation of the model using alias"""
 91        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 92        return json.dumps(self.to_dict())
 93
 94    @classmethod
 95    def from_json(cls, json_str: str) -> Optional[Self]:
 96        """Create an instance of EmbedData from a JSON string"""
 97        return cls.from_dict(json.loads(json_str))
 98
 99    def to_dict(self) -> Dict[str, Any]:
100        """Return the dictionary representation of the model using alias.
101
102        This has the following differences from calling pydantic's
103        `self.model_dump(by_alias=True)`:
104
105        * `None` is only added to the output dict for nullable fields that
106          were set at model initialization. Other fields with value `None`
107          are ignored.
108        * Fields in `self.additional_properties` are added to the output dict.
109        """
110        excluded_fields: Set[str] = set(
111            [
112                "additional_properties",
113            ]
114        )
115
116        _dict = self.model_dump(
117            by_alias=True,
118            exclude=excluded_fields,
119            exclude_none=True,
120        )
121        # puts key-value pairs in additional_properties in the top level
122        if self.additional_properties is not None:
123            for _key, _value in self.additional_properties.items():
124                _dict[_key] = _value
125
126        return _dict
127
128    @classmethod
129    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
130        """Create an instance of EmbedData from a dict"""
131        if obj is None:
132            return None
133
134        if not isinstance(obj, dict):
135            return cls.model_validate(obj)
136
137        _obj = cls.model_validate(
138            {
139                "contentType": obj.get("contentType"),
140                "description": obj.get("description"),
141                "html": obj.get("html"),
142                "mode": obj.get("mode"),
143                "previewUrl": obj.get("previewUrl"),
144                "providerName": obj.get("providerName"),
145                "providerUrl": obj.get("providerUrl"),
146                "title": obj.get("title"),
147                "url": obj.get("url"),
148            }
149        )
150        # store additional fields in additional_properties
151        for _key in obj.keys():
152            if _key not in cls.__properties:
153                _obj.additional_properties[_key] = obj.get(_key)
154
155        return _obj