miro_api.models.team_invitation_settings

  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 TeamInvitationSettings(BaseModel):
 27    """
 28    Team invitation settings
 29    """  # noqa: E501
 30
 31    invite_external_users: Optional[StrictStr] = Field(
 32        default=None,
 33        description=' * "allowed": Allow non-team collaborators for team * "not_allowed": Not Allow non-team collaborators for team ',
 34        alias="inviteExternalUsers",
 35    )
 36    who_can_invite: Optional[StrictStr] = Field(
 37        default=None,
 38        description=' * "only_org_admins": Company admins only can invite * "admins":          Company admins and team admins can invite * "all_members":     All team members can invite ',
 39        alias="whoCanInvite",
 40    )
 41    additional_properties: Dict[str, Any] = {}
 42    __properties: ClassVar[List[str]] = ["inviteExternalUsers", "whoCanInvite"]
 43
 44    @field_validator("invite_external_users")
 45    def invite_external_users_validate_enum(cls, value):
 46        """Validates the enum"""
 47        if value is None:
 48            return value
 49
 50        if value not in set(["allowed", "not_allowed"]):
 51            raise ValueError("must be one of enum values ('allowed', 'not_allowed')")
 52        return value
 53
 54    @field_validator("who_can_invite")
 55    def who_can_invite_validate_enum(cls, value):
 56        """Validates the enum"""
 57        if value is None:
 58            return value
 59
 60        if value not in set(["only_org_admins", "admins", "all_members"]):
 61            raise ValueError("must be one of enum values ('only_org_admins', 'admins', 'all_members')")
 62        return value
 63
 64    model_config = {
 65        "populate_by_name": True,
 66        "validate_assignment": True,
 67        "protected_namespaces": (),
 68    }
 69
 70    def to_str(self) -> str:
 71        """Returns the string representation of the model using alias"""
 72        return pprint.pformat(self.model_dump(by_alias=True))
 73
 74    def to_json(self) -> str:
 75        """Returns the JSON representation of the model using alias"""
 76        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 77        return json.dumps(self.to_dict())
 78
 79    @classmethod
 80    def from_json(cls, json_str: str) -> Optional[Self]:
 81        """Create an instance of TeamInvitationSettings from a JSON string"""
 82        return cls.from_dict(json.loads(json_str))
 83
 84    def to_dict(self) -> Dict[str, Any]:
 85        """Return the dictionary representation of the model using alias.
 86
 87        This has the following differences from calling pydantic's
 88        `self.model_dump(by_alias=True)`:
 89
 90        * `None` is only added to the output dict for nullable fields that
 91          were set at model initialization. Other fields with value `None`
 92          are ignored.
 93        * Fields in `self.additional_properties` are added to the output dict.
 94        """
 95        excluded_fields: Set[str] = set(
 96            [
 97                "additional_properties",
 98            ]
 99        )
100
101        _dict = self.model_dump(
102            by_alias=True,
103            exclude=excluded_fields,
104            exclude_none=True,
105        )
106        # puts key-value pairs in additional_properties in the top level
107        if self.additional_properties is not None:
108            for _key, _value in self.additional_properties.items():
109                _dict[_key] = _value
110
111        return _dict
112
113    @classmethod
114    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
115        """Create an instance of TeamInvitationSettings from a dict"""
116        if obj is None:
117            return None
118
119        if not isinstance(obj, dict):
120            return cls.model_validate(obj)
121
122        _obj = cls.model_validate(
123            {"inviteExternalUsers": obj.get("inviteExternalUsers"), "whoCanInvite": obj.get("whoCanInvite")}
124        )
125        # store additional fields in additional_properties
126        for _key in obj.keys():
127            if _key not in cls.__properties:
128                _obj.additional_properties[_key] = obj.get(_key)
129
130        return _obj