miro_api.models.self_link

Miro Developer Platform

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): 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 ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

  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 pydantic import BaseModel, Field, StrictStr
 20from typing import Any, ClassVar, Dict, List, Optional
 21from typing import Optional, Set
 22from typing_extensions import Self
 23
 24
 25class SelfLink(BaseModel):
 26    """
 27    Contains applicable links for the current object.
 28    """  # noqa: E501
 29
 30    var_self: Optional[StrictStr] = Field(
 31        default=None, description="Link to obtain more information about the current object.", alias="self"
 32    )
 33    additional_properties: Dict[str, Any] = {}
 34    __properties: ClassVar[List[str]] = ["self"]
 35
 36    model_config = {
 37        "populate_by_name": True,
 38        "validate_assignment": True,
 39        "protected_namespaces": (),
 40    }
 41
 42    def to_str(self) -> str:
 43        """Returns the string representation of the model using alias"""
 44        return pprint.pformat(self.model_dump(by_alias=True))
 45
 46    def to_json(self) -> str:
 47        """Returns the JSON representation of the model using alias"""
 48        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 49        return json.dumps(self.to_dict())
 50
 51    @classmethod
 52    def from_json(cls, json_str: str) -> Optional[Self]:
 53        """Create an instance of SelfLink from a JSON string"""
 54        return cls.from_dict(json.loads(json_str))
 55
 56    def to_dict(self) -> Dict[str, Any]:
 57        """Return the dictionary representation of the model using alias.
 58
 59        This has the following differences from calling pydantic's
 60        `self.model_dump(by_alias=True)`:
 61
 62        * `None` is only added to the output dict for nullable fields that
 63          were set at model initialization. Other fields with value `None`
 64          are ignored.
 65        * Fields in `self.additional_properties` are added to the output dict.
 66        """
 67        excluded_fields: Set[str] = set(
 68            [
 69                "additional_properties",
 70            ]
 71        )
 72
 73        _dict = self.model_dump(
 74            by_alias=True,
 75            exclude=excluded_fields,
 76            exclude_none=True,
 77        )
 78        # puts key-value pairs in additional_properties in the top level
 79        if self.additional_properties is not None:
 80            for _key, _value in self.additional_properties.items():
 81                _dict[_key] = _value
 82
 83        return _dict
 84
 85    @classmethod
 86    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 87        """Create an instance of SelfLink from a dict"""
 88        if obj is None:
 89            return None
 90
 91        if not isinstance(obj, dict):
 92            return cls.model_validate(obj)
 93
 94        _obj = cls.model_validate({"self": obj.get("self")})
 95        # store additional fields in additional_properties
 96        for _key in obj.keys():
 97            if _key not in cls.__properties:
 98                _obj.additional_properties[_key] = obj.get(_key)
 99
100        return _obj

class SelfLink(pydantic.main.BaseModel): View Source

 26class SelfLink(BaseModel):
 27    """
 28    Contains applicable links for the current object.
 29    """  # noqa: E501
 30
 31    var_self: Optional[StrictStr] = Field(
 32        default=None, description="Link to obtain more information about the current object.", alias="self"
 33    )
 34    additional_properties: Dict[str, Any] = {}
 35    __properties: ClassVar[List[str]] = ["self"]
 36
 37    model_config = {
 38        "populate_by_name": True,
 39        "validate_assignment": True,
 40        "protected_namespaces": (),
 41    }
 42
 43    def to_str(self) -> str:
 44        """Returns the string representation of the model using alias"""
 45        return pprint.pformat(self.model_dump(by_alias=True))
 46
 47    def to_json(self) -> str:
 48        """Returns the JSON representation of the model using alias"""
 49        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 50        return json.dumps(self.to_dict())
 51
 52    @classmethod
 53    def from_json(cls, json_str: str) -> Optional[Self]:
 54        """Create an instance of SelfLink from a JSON string"""
 55        return cls.from_dict(json.loads(json_str))
 56
 57    def to_dict(self) -> Dict[str, Any]:
 58        """Return the dictionary representation of the model using alias.
 59
 60        This has the following differences from calling pydantic's
 61        `self.model_dump(by_alias=True)`:
 62
 63        * `None` is only added to the output dict for nullable fields that
 64          were set at model initialization. Other fields with value `None`
 65          are ignored.
 66        * Fields in `self.additional_properties` are added to the output dict.
 67        """
 68        excluded_fields: Set[str] = set(
 69            [
 70                "additional_properties",
 71            ]
 72        )
 73
 74        _dict = self.model_dump(
 75            by_alias=True,
 76            exclude=excluded_fields,
 77            exclude_none=True,
 78        )
 79        # puts key-value pairs in additional_properties in the top level
 80        if self.additional_properties is not None:
 81            for _key, _value in self.additional_properties.items():
 82                _dict[_key] = _value
 83
 84        return _dict
 85
 86    @classmethod
 87    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 88        """Create an instance of SelfLink from a dict"""
 89        if obj is None:
 90            return None
 91
 92        if not isinstance(obj, dict):
 93            return cls.model_validate(obj)
 94
 95        _obj = cls.model_validate({"self": obj.get("self")})
 96        # store additional fields in additional_properties
 97        for _key in obj.keys():
 98            if _key not in cls.__properties:
 99                _obj.additional_properties[_key] = obj.get(_key)
100
101        return _obj

Contains applicable links for the current object.

var_self: Optional[Annotated[str, Strict(strict=True)]]

additional_properties: Dict[str, Any]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

43    def to_str(self) -> str:
44        """Returns the string representation of the model using alias"""
45        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

47    def to_json(self) -> str:
48        """Returns the JSON representation of the model using alias"""
49        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
50        return json.dumps(self.to_dict())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: View Source

52    @classmethod
53    def from_json(cls, json_str: str) -> Optional[Self]:
54        """Create an instance of SelfLink from a JSON string"""
55        return cls.from_dict(json.loads(json_str))

Create an instance of SelfLink from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

57    def to_dict(self) -> Dict[str, Any]:
58        """Return the dictionary representation of the model using alias.
59
60        This has the following differences from calling pydantic's
61        `self.model_dump(by_alias=True)`:
62
63        * `None` is only added to the output dict for nullable fields that
64          were set at model initialization. Other fields with value `None`
65          are ignored.
66        * Fields in `self.additional_properties` are added to the output dict.
67        """
68        excluded_fields: Set[str] = set(
69            [
70                "additional_properties",
71            ]
72        )
73
74        _dict = self.model_dump(
75            by_alias=True,
76            exclude=excluded_fields,
77            exclude_none=True,
78        )
79        # puts key-value pairs in additional_properties in the top level
80        if self.additional_properties is not None:
81            for _key, _value in self.additional_properties.items():
82                _dict[_key] = _value
83
84        return _dict

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Fields in self.additional_properties are added to the output dict.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[typing_extensions.Self]: View Source

 86    @classmethod
 87    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 88        """Create an instance of SelfLink from a dict"""
 89        if obj is None:
 90            return None
 91
 92        if not isinstance(obj, dict):
 93            return cls.model_validate(obj)
 94
 95        _obj = cls.model_validate({"self": obj.get("self")})
 96        # store additional fields in additional_properties
 97        for _key in obj.keys():
 98            if _key not in cls.__properties:
 99                _obj.additional_properties[_key] = obj.get(_key)
100
101        return _obj

Create an instance of SelfLink from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

265def init_private_attributes(self: BaseModel, __context: Any) -> None:
266    """This function is meant to behave like a BaseModel method to initialise private attributes.
267
268    It takes context as an argument since that's what pydantic-core passes when calling it.
269
270    Args:
271        self: The BaseModel instance.
272        __context: The context.
273    """
274    if getattr(self, '__pydantic_private__', None) is None:
275        pydantic_private = {}
276        for name, private_attr in self.__private_attributes__.items():
277            default = private_attr.get_default()
278            if default is not PydanticUndefined:
279                pydantic_private[name] = default
280        object_setattr(self, '__pydantic_private__', pydantic_private)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Args: self: The BaseModel instance. __context: The context.

model_fields = {'var_self': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, alias='self', alias_priority=2, description='Link to obtain more information about the current object.'), 'additional_properties': FieldInfo(annotation=Dict[str, Any], required=False, default={})}

model_computed_fields = {}

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs