miro_api.models.caption

  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_extensions import Annotated
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class Caption(BaseModel):
 28    """
 29    Contains the connector's caption data, such as content and its position.
 30    """  # noqa: E501
 31
 32    content: Annotated[str, Field(min_length=0, strict=True, max_length=200)] = Field(
 33        description="The text you want to display on the connector. Supports inline HTML tags."
 34    )
 35    position: Optional[StrictStr] = Field(
 36        default=None,
 37        description="The relative position of the text on the connector, in percentage, minimum 0%, maximum 100%. With 50% value, the text will be placed in the middle of the connector line. Default: 50%",
 38    )
 39    text_align_vertical: Optional[StrictStr] = Field(
 40        default=None,
 41        description="The vertical position of the text on the connector. Default: middle",
 42        alias="textAlignVertical",
 43    )
 44    additional_properties: Dict[str, Any] = {}
 45    __properties: ClassVar[List[str]] = ["content", "position", "textAlignVertical"]
 46
 47    @field_validator("text_align_vertical")
 48    def text_align_vertical_validate_enum(cls, value):
 49        """Validates the enum"""
 50        if value is None:
 51            return value
 52
 53        if value not in set(["top", "middle", "bottom"]):
 54            raise ValueError("must be one of enum values ('top', 'middle', 'bottom')")
 55        return value
 56
 57    model_config = {
 58        "populate_by_name": True,
 59        "validate_assignment": True,
 60        "protected_namespaces": (),
 61    }
 62
 63    def to_str(self) -> str:
 64        """Returns the string representation of the model using alias"""
 65        return pprint.pformat(self.model_dump(by_alias=True))
 66
 67    def to_json(self) -> str:
 68        """Returns the JSON representation of the model using alias"""
 69        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 70        return json.dumps(self.to_dict())
 71
 72    @classmethod
 73    def from_json(cls, json_str: str) -> Optional[Self]:
 74        """Create an instance of Caption from a JSON string"""
 75        return cls.from_dict(json.loads(json_str))
 76
 77    def to_dict(self) -> Dict[str, Any]:
 78        """Return the dictionary representation of the model using alias.
 79
 80        This has the following differences from calling pydantic's
 81        `self.model_dump(by_alias=True)`:
 82
 83        * `None` is only added to the output dict for nullable fields that
 84          were set at model initialization. Other fields with value `None`
 85          are ignored.
 86        * Fields in `self.additional_properties` are added to the output dict.
 87        """
 88        excluded_fields: Set[str] = set(
 89            [
 90                "additional_properties",
 91            ]
 92        )
 93
 94        _dict = self.model_dump(
 95            by_alias=True,
 96            exclude=excluded_fields,
 97            exclude_none=True,
 98        )
 99        # puts key-value pairs in additional_properties in the top level
100        if self.additional_properties is not None:
101            for _key, _value in self.additional_properties.items():
102                _dict[_key] = _value
103
104        return _dict
105
106    @classmethod
107    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108        """Create an instance of Caption from a dict"""
109        if obj is None:
110            return None
111
112        if not isinstance(obj, dict):
113            return cls.model_validate(obj)
114
115        _obj = cls.model_validate(
116            {
117                "content": obj.get("content"),
118                "position": obj.get("position"),
119                "textAlignVertical": obj.get("textAlignVertical"),
120            }
121        )
122        # store additional fields in additional_properties
123        for _key in obj.keys():
124            if _key not in cls.__properties:
125                _obj.additional_properties[_key] = obj.get(_key)
126
127        return _obj