miro_api.models.board_members_invite

  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_extensions import Annotated
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class BoardMembersInvite(BaseModel):
 28    """
 29    BoardMembersInvite
 30    """  # noqa: E501
 31
 32    emails: Annotated[List[StrictStr], Field(min_length=1, max_length=20)] = Field(
 33        description="Email IDs of the users you want to invite to the board. You can invite up to 20 members per call."
 34    )
 35    role: Optional[StrictStr] = Field(
 36        default="commenter",
 37        description="Role of the board member. Inviting users with the role `owner` has the same effect as the role `coowner`.",
 38    )
 39    message: Optional[StrictStr] = Field(
 40        default=None, description="The message that will be sent in the invitation email."
 41    )
 42    additional_properties: Dict[str, Any] = {}
 43    __properties: ClassVar[List[str]] = ["emails", "role", "message"]
 44
 45    @field_validator("role")
 46    def role_validate_enum(cls, value):
 47        """Validates the enum"""
 48        if value is None:
 49            return value
 50
 51        if value not in set(["viewer", "commenter", "editor", "coowner", "owner"]):
 52            raise ValueError("must be one of enum values ('viewer', 'commenter', 'editor', 'coowner', 'owner')")
 53        return value
 54
 55    model_config = {
 56        "populate_by_name": True,
 57        "validate_assignment": True,
 58        "protected_namespaces": (),
 59    }
 60
 61    def to_str(self) -> str:
 62        """Returns the string representation of the model using alias"""
 63        return pprint.pformat(self.model_dump(by_alias=True))
 64
 65    def to_json(self) -> str:
 66        """Returns the JSON representation of the model using alias"""
 67        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 68        return json.dumps(self.to_dict())
 69
 70    @classmethod
 71    def from_json(cls, json_str: str) -> Optional[Self]:
 72        """Create an instance of BoardMembersInvite from a JSON string"""
 73        return cls.from_dict(json.loads(json_str))
 74
 75    def to_dict(self) -> Dict[str, Any]:
 76        """Return the dictionary representation of the model using alias.
 77
 78        This has the following differences from calling pydantic's
 79        `self.model_dump(by_alias=True)`:
 80
 81        * `None` is only added to the output dict for nullable fields that
 82          were set at model initialization. Other fields with value `None`
 83          are ignored.
 84        * Fields in `self.additional_properties` are added to the output dict.
 85        """
 86        excluded_fields: Set[str] = set(
 87            [
 88                "additional_properties",
 89            ]
 90        )
 91
 92        _dict = self.model_dump(
 93            by_alias=True,
 94            exclude=excluded_fields,
 95            exclude_none=True,
 96        )
 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 BoardMembersInvite 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                "emails": obj.get("emails"),
116                "role": obj.get("role") if obj.get("role") is not None else "commenter",
117                "message": obj.get("message"),
118            }
119        )
120        # store additional fields in additional_properties
121        for _key in obj.keys():
122            if _key not in cls.__properties:
123                _obj.additional_properties[_key] = obj.get(_key)
124
125        return _obj