miro_api.models.doc_format_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
 14from __future__ import annotations
 15import json
 16import pprint
 17from pydantic import BaseModel, Field, StrictStr, ValidationError, field_validator
 18from typing import Any, List, Optional
 19from miro_api.models.doc_format_html_data import DocFormatHtmlData
 20from miro_api.models.doc_format_markdown_data import DocFormatMarkdownData
 21from pydantic import StrictStr, Field
 22from typing import Union, List, Optional, Dict
 23from typing_extensions import Literal, Self
 24
 25DOCFORMATDATA_ONE_OF_SCHEMAS = ["DocFormatHtmlData", "DocFormatMarkdownData"]
 26
 27
 28class DocFormatData(BaseModel):
 29    """
 30    DocFormatData
 31    """
 32
 33    # data type: DocFormatHtmlData
 34    oneof_schema_1_validator: Optional[DocFormatHtmlData] = None
 35    # data type: DocFormatMarkdownData
 36    oneof_schema_2_validator: Optional[DocFormatMarkdownData] = None
 37    actual_instance: Optional[Union[DocFormatHtmlData, DocFormatMarkdownData]] = None
 38    one_of_schemas: List[str] = Field(default=Literal["DocFormatHtmlData", "DocFormatMarkdownData"])
 39
 40    model_config = {
 41        "validate_assignment": True,
 42        "protected_namespaces": (),
 43    }
 44
 45    discriminator_value_class_map: Dict[str, str] = {}
 46
 47    def __init__(self, *args, **kwargs) -> None:
 48        if args:
 49            if len(args) > 1:
 50                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
 51            if kwargs:
 52                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
 53            super().__init__(actual_instance=args[0])
 54        else:
 55            super().__init__(**kwargs)
 56
 57    def __getattr__(self, attr: str):
 58        return getattr(self.actual_instance, attr)
 59
 60    @field_validator("actual_instance")
 61    def actual_instance_must_validate_oneof(cls, v):
 62        instance = DocFormatData.model_construct()
 63        error_messages = []
 64        match = 0
 65        # validate data type: DocFormatHtmlData
 66        if not isinstance(v, DocFormatHtmlData):
 67            error_messages.append(f"Error! Input type `{type(v)}` is not `DocFormatHtmlData`")
 68        else:
 69            match += 1
 70        # validate data type: DocFormatMarkdownData
 71        if not isinstance(v, DocFormatMarkdownData):
 72            error_messages.append(f"Error! Input type `{type(v)}` is not `DocFormatMarkdownData`")
 73        else:
 74            match += 1
 75        if match > 1:
 76            # more than 1 match
 77            raise ValueError(
 78                "Multiple matches found when setting `actual_instance` in DocFormatData with oneOf schemas: DocFormatHtmlData, DocFormatMarkdownData. Details: "
 79                + ", ".join(error_messages)
 80            )
 81        elif match == 0:
 82            # no match
 83            raise ValueError(
 84                "No match found when setting `actual_instance` in DocFormatData with oneOf schemas: DocFormatHtmlData, DocFormatMarkdownData. Details: "
 85                + ", ".join(error_messages)
 86            )
 87        else:
 88            return v
 89
 90    @classmethod
 91    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
 92        return cls.from_json(json.dumps(obj))
 93
 94    @classmethod
 95    def from_json(cls, json_str: str) -> Union[DocFormatHtmlData, DocFormatMarkdownData]:
 96        """Returns the object represented by the json string"""
 97        instance = cls.model_construct()
 98        error_messages = []
 99        matches = []
100
101        # deserialize data into DocFormatHtmlData
102        try:
103            instance.actual_instance = DocFormatHtmlData.from_json(json_str)
104            matches.append(instance.actual_instance)
105        except (ValidationError, ValueError) as e:
106            error_messages.append(str(e))
107        # deserialize data into DocFormatMarkdownData
108        try:
109            instance.actual_instance = DocFormatMarkdownData.from_json(json_str)
110            matches.append(instance.actual_instance)
111        except (ValidationError, ValueError) as e:
112            error_messages.append(str(e))
113
114        if not matches:
115            # no match
116            raise ValueError(
117                "No match found when deserializing the JSON string into DocFormatData with oneOf schemas: DocFormatHtmlData, DocFormatMarkdownData. Details: "
118                + ", ".join(error_messages)
119            )
120
121        # Return one match that has least additional_properties
122        if len(matches) > 1:
123            instance.actual_instance = sorted(matches, key=lambda m: len(m.additional_properties))[0]
124
125        return instance
126
127    def to_json(self) -> str:
128        """Returns the JSON representation of the actual instance"""
129        if self.actual_instance is None:
130            return "null"
131
132        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
133            return self.actual_instance.to_json()
134        else:
135            return json.dumps(self.actual_instance)
136
137    def to_dict(self) -> Optional[Union[Dict[str, Any], DocFormatHtmlData, DocFormatMarkdownData]]:
138        """Returns the dict representation of the actual instance"""
139        if self.actual_instance is None:
140            return None
141
142        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
143            return self.actual_instance.to_dict()
144        else:
145            # primitive type
146            return self.actual_instance
147
148    def to_str(self) -> str:
149        """Returns the string representation of the actual instance"""
150        return pprint.pformat(self.model_dump())