miro_api.models.token_information

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.organization_information import OrganizationInformation
 23from miro_api.models.team_information import TeamInformation
 24from miro_api.models.user_information import UserInformation
 25from typing import Optional, Set
 26from typing_extensions import Self
 27
 28
 29class TokenInformation(BaseModel):
 30    """
 31    TokenInformation
 32    """  # noqa: E501
 33
 34    type: StrictStr
 35    organization: OrganizationInformation
 36    team: TeamInformation
 37    created_by: UserInformation = Field(alias="createdBy")
 38    user: UserInformation
 39    scopes: Optional[List[StrictStr]] = None
 40    additional_properties: Dict[str, Any] = {}
 41    __properties: ClassVar[List[str]] = ["type", "organization", "team", "createdBy", "user", "scopes"]
 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 TokenInformation 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 organization
 86        if self.organization:
 87            _dict["organization"] = self.organization.to_dict()
 88        # override the default output from pydantic by calling `to_dict()` of team
 89        if self.team:
 90            _dict["team"] = self.team.to_dict()
 91        # override the default output from pydantic by calling `to_dict()` of created_by
 92        if self.created_by:
 93            _dict["createdBy"] = self.created_by.to_dict()
 94        # override the default output from pydantic by calling `to_dict()` of user
 95        if self.user:
 96            _dict["user"] = self.user.to_dict()
 97        # puts key-value pairs in additional_properties in the top level
 98        if self.additional_properties is not None:
 99            for _key, _value in self.additional_properties.items():
100                _dict[_key] = _value
101
102        return _dict
103
104    @classmethod
105    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
106        """Create an instance of TokenInformation from a dict"""
107        if obj is None:
108            return None
109
110        if not isinstance(obj, dict):
111            return cls.model_validate(obj)
112
113        _obj = cls.model_validate(
114            {
115                "type": obj.get("type"),
116                "organization": (
117                    OrganizationInformation.from_dict(obj["organization"])
118                    if obj.get("organization") is not None
119                    else None
120                ),
121                "team": TeamInformation.from_dict(obj["team"]) if obj.get("team") is not None else None,
122                "createdBy": UserInformation.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
123                "user": UserInformation.from_dict(obj["user"]) if obj.get("user") is not None else None,
124                "scopes": obj.get("scopes"),
125            }
126        )
127        # store additional fields in additional_properties
128        for _key in obj.keys():
129            if _key not in cls.__properties:
130                _obj.additional_properties[_key] = obj.get(_key)
131
132        return _obj

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

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

TokenInformation

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

organization: miro_api.models.organization_information.OrganizationInformation

team: miro_api.models.team_information.TeamInformation

created_by: miro_api.models.user_information.UserInformation

user: miro_api.models.user_information.UserInformation

scopes: Optional[List[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

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

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

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

Create an instance of TokenInformation from a JSON string

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

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

105    @classmethod
106    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
107        """Create an instance of TokenInformation from a dict"""
108        if obj is None:
109            return None
110
111        if not isinstance(obj, dict):
112            return cls.model_validate(obj)
113
114        _obj = cls.model_validate(
115            {
116                "type": obj.get("type"),
117                "organization": (
118                    OrganizationInformation.from_dict(obj["organization"])
119                    if obj.get("organization") is not None
120                    else None
121                ),
122                "team": TeamInformation.from_dict(obj["team"]) if obj.get("team") is not None else None,
123                "createdBy": UserInformation.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
124                "user": UserInformation.from_dict(obj["user"]) if obj.get("user") is not None else None,
125                "scopes": obj.get("scopes"),
126            }
127        )
128        # store additional fields in additional_properties
129        for _key in obj.keys():
130            if _key not in cls.__properties:
131                _obj.additional_properties[_key] = obj.get(_key)
132
133        return _obj

Create an instance of TokenInformation 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 = {'type': FieldInfo(annotation=str, required=True, metadata=[Strict(strict=True)]), 'organization': FieldInfo(annotation=OrganizationInformation, required=True), 'team': FieldInfo(annotation=TeamInformation, required=True), 'created_by': FieldInfo(annotation=UserInformation, required=True, alias='createdBy', alias_priority=2), 'user': FieldInfo(annotation=UserInformation, required=True), 'scopes': FieldInfo(annotation=Union[List[Annotated[str, Strict(strict=True)]], 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