miro_api.models.board_member

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