miro_api.models.team_invitation_settings_changes

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