miro_api.models.group_response_short

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
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.group import Group
 23from miro_api.models.page_links import PageLinks
 24from typing import Optional, Set
 25from typing_extensions import Self
 26
 27
 28class GroupResponseShort(BaseModel):
 29    """
 30    Contains the result data.
 31    """  # noqa: E501
 32
 33    id: Optional[StrictStr] = Field(default=None, description="Unique identifier (ID) of the group.")
 34    type: Optional[StrictStr] = Field(
 35        default=None, description="Indicates the type of object returned. In this case, `type` returns `group`."
 36    )
 37    data: Optional[Group] = None
 38    links: Optional[PageLinks] = None
 39    additional_properties: Dict[str, Any] = {}
 40    __properties: ClassVar[List[str]] = ["id", "type", "data", "links"]
 41
 42    model_config = {
 43        "populate_by_name": True,
 44        "validate_assignment": True,
 45        "protected_namespaces": (),
 46    }
 47
 48    def to_str(self) -> str:
 49        """Returns the string representation of the model using alias"""
 50        return pprint.pformat(self.model_dump(by_alias=True))
 51
 52    def to_json(self) -> str:
 53        """Returns the JSON representation of the model using alias"""
 54        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 55        return json.dumps(self.to_dict())
 56
 57    @classmethod
 58    def from_json(cls, json_str: str) -> Optional[Self]:
 59        """Create an instance of GroupResponseShort from a JSON string"""
 60        return cls.from_dict(json.loads(json_str))
 61
 62    def to_dict(self) -> Dict[str, Any]:
 63        """Return the dictionary representation of the model using alias.
 64
 65        This has the following differences from calling pydantic's
 66        `self.model_dump(by_alias=True)`:
 67
 68        * `None` is only added to the output dict for nullable fields that
 69          were set at model initialization. Other fields with value `None`
 70          are ignored.
 71        * Fields in `self.additional_properties` are added to the output dict.
 72        """
 73        excluded_fields: Set[str] = set(
 74            [
 75                "additional_properties",
 76            ]
 77        )
 78
 79        _dict = self.model_dump(
 80            by_alias=True,
 81            exclude=excluded_fields,
 82            exclude_none=True,
 83        )
 84        # override the default output from pydantic by calling `to_dict()` of data
 85        if self.data:
 86            _dict["data"] = self.data.to_dict()
 87        # override the default output from pydantic by calling `to_dict()` of links
 88        if self.links:
 89            _dict["links"] = self.links.to_dict()
 90        # puts key-value pairs in additional_properties in the top level
 91        if self.additional_properties is not None:
 92            for _key, _value in self.additional_properties.items():
 93                _dict[_key] = _value
 94
 95        return _dict
 96
 97    @classmethod
 98    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 99        """Create an instance of GroupResponseShort from a dict"""
100        if obj is None:
101            return None
102
103        if not isinstance(obj, dict):
104            return cls.model_validate(obj)
105
106        _obj = cls.model_validate(
107            {
108                "id": obj.get("id"),
109                "type": obj.get("type"),
110                "data": Group.from_dict(obj["data"]) if obj.get("data") is not None else None,
111                "links": PageLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
112            }
113        )
114        # store additional fields in additional_properties
115        for _key in obj.keys():
116            if _key not in cls.__properties:
117                _obj.additional_properties[_key] = obj.get(_key)
118
119        return _obj

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

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

Contains the result data.

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

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

data: Optional[miro_api.models.group.Group]

links: Optional[miro_api.models.page_links.PageLinks]

additional_properties: Dict[str, Any]

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

def to_str(self) -> str: View Source

49    def to_str(self) -> str:
50        """Returns the string representation of the model using alias"""
51        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

53    def to_json(self) -> str:
54        """Returns the JSON representation of the model using alias"""
55        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
56        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

58    @classmethod
59    def from_json(cls, json_str: str) -> Optional[Self]:
60        """Create an instance of GroupResponseShort from a JSON string"""
61        return cls.from_dict(json.loads(json_str))

Create an instance of GroupResponseShort from a JSON string

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

63    def to_dict(self) -> Dict[str, Any]:
64        """Return the dictionary representation of the model using alias.
65
66        This has the following differences from calling pydantic's
67        `self.model_dump(by_alias=True)`:
68
69        * `None` is only added to the output dict for nullable fields that
70          were set at model initialization. Other fields with value `None`
71          are ignored.
72        * Fields in `self.additional_properties` are added to the output dict.
73        """
74        excluded_fields: Set[str] = set(
75            [
76                "additional_properties",
77            ]
78        )
79
80        _dict = self.model_dump(
81            by_alias=True,
82            exclude=excluded_fields,
83            exclude_none=True,
84        )
85        # override the default output from pydantic by calling `to_dict()` of data
86        if self.data:
87            _dict["data"] = self.data.to_dict()
88        # override the default output from pydantic by calling `to_dict()` of links
89        if self.links:
90            _dict["links"] = self.links.to_dict()
91        # puts key-value pairs in additional_properties in the top level
92        if self.additional_properties is not None:
93            for _key, _value in self.additional_properties.items():
94                _dict[_key] = _value
95
96        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

 98    @classmethod
 99    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
100        """Create an instance of GroupResponseShort from a dict"""
101        if obj is None:
102            return None
103
104        if not isinstance(obj, dict):
105            return cls.model_validate(obj)
106
107        _obj = cls.model_validate(
108            {
109                "id": obj.get("id"),
110                "type": obj.get("type"),
111                "data": Group.from_dict(obj["data"]) if obj.get("data") is not None else None,
112                "links": PageLinks.from_dict(obj["links"]) if obj.get("links") is not None else None,
113            }
114        )
115        # store additional fields in additional_properties
116        for _key in obj.keys():
117            if _key not in cls.__properties:
118                _obj.additional_properties[_key] = obj.get(_key)
119
120        return _obj

Create an instance of GroupResponseShort 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 = {'id': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Unique identifier (ID) of the group.'), 'type': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Indicates the type of object returned. In this case, `type` returns `group`.'), 'data': FieldInfo(annotation=Union[Group, NoneType], required=False), 'links': FieldInfo(annotation=Union[PageLinks, NoneType], required=False), '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