miro_api.models.board_member_changes

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, field_validator
 20from typing import Any, ClassVar, Dict, List, Optional
 21from typing import Optional, Set
 22from typing_extensions import Self
 23
 24
 25class BoardMemberChanges(BaseModel):
 26    """
 27    BoardMemberChanges
 28    """  # noqa: E501
 29
 30    role: Optional[StrictStr] = Field(default="commenter", description="Role of the board member.")
 31    additional_properties: Dict[str, Any] = {}
 32    __properties: ClassVar[List[str]] = ["role"]
 33
 34    @field_validator("role")
 35    def role_validate_enum(cls, value):
 36        """Validates the enum"""
 37        if value is None:
 38            return value
 39
 40        if value not in set(["viewer", "commenter", "editor", "coowner", "owner"]):
 41            raise ValueError("must be one of enum values ('viewer', 'commenter', 'editor', 'coowner', 'owner')")
 42        return value
 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 BoardMemberChanges 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        # puts key-value pairs in additional_properties in the top level
 87        if self.additional_properties is not None:
 88            for _key, _value in self.additional_properties.items():
 89                _dict[_key] = _value
 90
 91        return _dict
 92
 93    @classmethod
 94    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 95        """Create an instance of BoardMemberChanges from a dict"""
 96        if obj is None:
 97            return None
 98
 99        if not isinstance(obj, dict):
100            return cls.model_validate(obj)
101
102        _obj = cls.model_validate({"role": obj.get("role") if obj.get("role") is not None else "commenter"})
103        # store additional fields in additional_properties
104        for _key in obj.keys():
105            if _key not in cls.__properties:
106                _obj.additional_properties[_key] = obj.get(_key)
107
108        return _obj

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

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

BoardMemberChanges

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

additional_properties: Dict[str, Any]

@field_validator('role')

def role_validate_enum(cls, value): View Source

35    @field_validator("role")
36    def role_validate_enum(cls, value):
37        """Validates the enum"""
38        if value is None:
39            return value
40
41        if value not in set(["viewer", "commenter", "editor", "coowner", "owner"]):
42            raise ValueError("must be one of enum values ('viewer', 'commenter', 'editor', 'coowner', 'owner')")
43        return value

Validates the enum

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

def to_str(self) -> str: View Source

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

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

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

Create an instance of BoardMemberChanges from a JSON string

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

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

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

Create an instance of BoardMemberChanges 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 = {'role': FieldInfo(annotation=Union[Annotated[str, Strict(strict=True)], NoneType], required=False, default='commenter', description='Role of the board member.'), '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