miro_api.models.sticky_note_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 StickyNoteData(BaseModel):
 27    """
 28    Contains sticky note item data, such as the content or shape of the sticky note.
 29    """  # noqa: E501
 30
 31    content: Optional[StrictStr] = Field(
 32        default=None, description="The actual text (content) that appears in the sticky note item."
 33    )
 34    shape: Optional[StrictStr] = Field(
 35        default="square",
 36        description="Defines the geometric shape of the sticky note and aspect ratio for its dimensions.",
 37    )
 38    additional_properties: Dict[str, Any] = {}
 39    __properties: ClassVar[List[str]] = ["content", "shape"]
 40
 41    @field_validator("shape")
 42    def shape_validate_enum(cls, value):
 43        """Validates the enum"""
 44        if value is None:
 45            return value
 46
 47        if value not in set(["square", "rectangle"]):
 48            raise ValueError("must be one of enum values ('square', 'rectangle')")
 49        return value
 50
 51    model_config = {
 52        "populate_by_name": True,
 53        "validate_assignment": True,
 54        "protected_namespaces": (),
 55    }
 56
 57    def to_str(self) -> str:
 58        """Returns the string representation of the model using alias"""
 59        return pprint.pformat(self.model_dump(by_alias=True))
 60
 61    def to_json(self) -> str:
 62        """Returns the JSON representation of the model using alias"""
 63        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 64        return json.dumps(self.to_dict())
 65
 66    @classmethod
 67    def from_json(cls, json_str: str) -> Optional[Self]:
 68        """Create an instance of StickyNoteData from a JSON string"""
 69        return cls.from_dict(json.loads(json_str))
 70
 71    def to_dict(self) -> Dict[str, Any]:
 72        """Return the dictionary representation of the model using alias.
 73
 74        This has the following differences from calling pydantic's
 75        `self.model_dump(by_alias=True)`:
 76
 77        * `None` is only added to the output dict for nullable fields that
 78          were set at model initialization. Other fields with value `None`
 79          are ignored.
 80        * Fields in `self.additional_properties` are added to the output dict.
 81        """
 82        excluded_fields: Set[str] = set(
 83            [
 84                "additional_properties",
 85            ]
 86        )
 87
 88        _dict = self.model_dump(
 89            by_alias=True,
 90            exclude=excluded_fields,
 91            exclude_none=True,
 92        )
 93        # puts key-value pairs in additional_properties in the top level
 94        if self.additional_properties is not None:
 95            for _key, _value in self.additional_properties.items():
 96                _dict[_key] = _value
 97
 98        return _dict
 99
100    @classmethod
101    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
102        """Create an instance of StickyNoteData from a dict"""
103        if obj is None:
104            return None
105
106        if not isinstance(obj, dict):
107            return cls.model_validate(obj)
108
109        _obj = cls.model_validate(
110            {"content": obj.get("content"), "shape": obj.get("shape") if obj.get("shape") is not None else "square"}
111        )
112        # store additional fields in additional_properties
113        for _key in obj.keys():
114            if _key not in cls.__properties:
115                _obj.additional_properties[_key] = obj.get(_key)
116
117        return _obj