miro_api.models.admin_role

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

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

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

AdminRole

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

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

additional_properties: Dict[str, Any]

@field_validator('type')

def type_validate_enum(cls, value): View Source

37    @field_validator("type")
38    def type_validate_enum(cls, value):
39        """Validates the enum"""
40        if value is None:
41            return value
42
43        if value not in set(["prebuilt", "custom"]):
44            raise ValueError("must be one of enum values ('prebuilt', 'custom')")
45        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of AdminRole from a JSON string

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

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

 96    @classmethod
 97    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 98        """Create an instance of AdminRole from a dict"""
 99        if obj is None:
100            return None
101
102        if not isinstance(obj, dict):
103            return cls.model_validate(obj)
104
105        _obj = cls.model_validate({"type": obj.get("type"), "name": obj.get("name")})
106        # store additional fields in additional_properties
107        for _key in obj.keys():
108            if _key not in cls.__properties:
109                _obj.additional_properties[_key] = obj.get(_key)
110
111        return _obj

Create an instance of AdminRole 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=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Type of the admin role prebuilt or custom'), 'name': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, description='Name of the admin role'), '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