miro_api.models.team_sharing_policy_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
 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 TeamSharingPolicySettingsChanges(BaseModel):
 27    """
 28    Team sharing policy settings
 29    """  # noqa: E501
 30
 31    allow_listed_domains: Optional[List[StrictStr]] = Field(
 32        default=None, description="Allow listed domains", alias="allowListedDomains"
 33    )
 34    create_asset_access_level: Optional[StrictStr] = Field(
 35        default=None,
 36        description=' * "company_admins": Only company admins can create assets in a team * "admins": Both team and company admins can create assets in a team. * "all_members": all_members ',
 37        alias="createAssetAccessLevel",
 38    )
 39    default_board_access: Optional[StrictStr] = Field(
 40        default=None,
 41        description=' Default board access * "private": Only board owners can access * "view":    Anyone in the team can view * "comment": Anyone in the team can comment * "edit":    Anyone in the team can edit ',
 42        alias="defaultBoardAccess",
 43    )
 44    default_board_sharing_access: Optional[StrictStr] = Field(
 45        default="team_members_with_editing_rights",
 46        description=' Indicates who can change board access and invite users to boards in this team, by default. * "team_members_with_editing_rights": Any team member with editing rights on the board. * "owner_and_coowners":               Only the owner and co-owners of the board. ',
 47        alias="defaultBoardSharingAccess",
 48    )
 49    default_organization_access: Optional[StrictStr] = Field(
 50        default=None,
 51        description=' Default organization access * "private": Only board owners can access * "view":    Anyone in the team can view * "comment": Anyone in the team can comment * "edit":    Anyone in the team can edit ',
 52        alias="defaultOrganizationAccess",
 53    )
 54    default_project_access: Optional[StrictStr] = Field(
 55        default=None,
 56        description=' Default project access * "private": Only board owners can access * "view":    Anyone in the team can view ',
 57        alias="defaultProjectAccess",
 58    )
 59    move_board_to_account: Optional[StrictStr] = Field(
 60        default=None,
 61        description=' * "allowed": Allow move board to team * "not_allowed": Not allow move board to team ',
 62        alias="moveBoardToAccount",
 63    )
 64    restrict_allowed_domains: Optional[StrictStr] = Field(
 65        default=None,
 66        description=' * "enabled": Enabled. Restrict to listed domain. * "disabled": Disabled. No domain restriction. * "enabled_with_external_users_access": Enabled. Restrict to listed domain but allows external users to access. ',
 67        alias="restrictAllowedDomains",
 68    )
 69    sharing_on_account: Optional[StrictStr] = Field(
 70        default=None,
 71        description=' * "allowed": Allow sharing on team * "not_allowed": Not allow sharing on team ',
 72        alias="sharingOnAccount",
 73    )
 74    sharing_on_organization: Optional[StrictStr] = Field(
 75        default=None,
 76        description=' * "allowed": Allow sharing on organization * "allowed_with_editing": Allow sharing with editing on organization * "not_allowed": Not allow sharing on organization ',
 77        alias="sharingOnOrganization",
 78    )
 79    sharing_via_public_link: Optional[StrictStr] = Field(
 80        default=None,
 81        description=' * "allowed": Allow sharing via public link * "allowed_with_editing": Allow sharing with editing via public link * "not_allowed": Not allow sharing via public link ',
 82        alias="sharingViaPublicLink",
 83    )
 84    additional_properties: Dict[str, Any] = {}
 85    __properties: ClassVar[List[str]] = [
 86        "allowListedDomains",
 87        "createAssetAccessLevel",
 88        "defaultBoardAccess",
 89        "defaultBoardSharingAccess",
 90        "defaultOrganizationAccess",
 91        "defaultProjectAccess",
 92        "moveBoardToAccount",
 93        "restrictAllowedDomains",
 94        "sharingOnAccount",
 95        "sharingOnOrganization",
 96        "sharingViaPublicLink",
 97    ]
 98
 99    @field_validator("create_asset_access_level")
100    def create_asset_access_level_validate_enum(cls, value):
101        """Validates the enum"""
102        if value is None:
103            return value
104
105        if value not in set(["company_admins", "admins", "all_members"]):
106            raise ValueError("must be one of enum values ('company_admins', 'admins', 'all_members')")
107        return value
108
109    @field_validator("default_board_access")
110    def default_board_access_validate_enum(cls, value):
111        """Validates the enum"""
112        if value is None:
113            return value
114
115        if value not in set(["private", "view", "comment", "edit"]):
116            raise ValueError("must be one of enum values ('private', 'view', 'comment', 'edit')")
117        return value
118
119    @field_validator("default_board_sharing_access")
120    def default_board_sharing_access_validate_enum(cls, value):
121        """Validates the enum"""
122        if value is None:
123            return value
124
125        if value not in set(["team_members_with_editing_rights", "owner_and_coowners"]):
126            raise ValueError("must be one of enum values ('team_members_with_editing_rights', 'owner_and_coowners')")
127        return value
128
129    @field_validator("default_organization_access")
130    def default_organization_access_validate_enum(cls, value):
131        """Validates the enum"""
132        if value is None:
133            return value
134
135        if value not in set(["private", "view", "comment", "edit"]):
136            raise ValueError("must be one of enum values ('private', 'view', 'comment', 'edit')")
137        return value
138
139    @field_validator("default_project_access")
140    def default_project_access_validate_enum(cls, value):
141        """Validates the enum"""
142        if value is None:
143            return value
144
145        if value not in set(["private", "view"]):
146            raise ValueError("must be one of enum values ('private', 'view')")
147        return value
148
149    @field_validator("move_board_to_account")
150    def move_board_to_account_validate_enum(cls, value):
151        """Validates the enum"""
152        if value is None:
153            return value
154
155        if value not in set(["allowed", "not_allowed"]):
156            raise ValueError("must be one of enum values ('allowed', 'not_allowed')")
157        return value
158
159    @field_validator("restrict_allowed_domains")
160    def restrict_allowed_domains_validate_enum(cls, value):
161        """Validates the enum"""
162        if value is None:
163            return value
164
165        if value not in set(["enabled", "enabled_with_external_user_access", "disabled"]):
166            raise ValueError("must be one of enum values ('enabled', 'enabled_with_external_user_access', 'disabled')")
167        return value
168
169    @field_validator("sharing_on_account")
170    def sharing_on_account_validate_enum(cls, value):
171        """Validates the enum"""
172        if value is None:
173            return value
174
175        if value not in set(["allowed", "not_allowed"]):
176            raise ValueError("must be one of enum values ('allowed', 'not_allowed')")
177        return value
178
179    @field_validator("sharing_on_organization")
180    def sharing_on_organization_validate_enum(cls, value):
181        """Validates the enum"""
182        if value is None:
183            return value
184
185        if value not in set(["allowed", "allowed_with_editing", "not_allowed"]):
186            raise ValueError("must be one of enum values ('allowed', 'allowed_with_editing', 'not_allowed')")
187        return value
188
189    @field_validator("sharing_via_public_link")
190    def sharing_via_public_link_validate_enum(cls, value):
191        """Validates the enum"""
192        if value is None:
193            return value
194
195        if value not in set(["allowed", "allowed_with_editing", "not_allowed"]):
196            raise ValueError("must be one of enum values ('allowed', 'allowed_with_editing', 'not_allowed')")
197        return value
198
199    model_config = {
200        "populate_by_name": True,
201        "validate_assignment": True,
202        "protected_namespaces": (),
203    }
204
205    def to_str(self) -> str:
206        """Returns the string representation of the model using alias"""
207        return pprint.pformat(self.model_dump(by_alias=True))
208
209    def to_json(self) -> str:
210        """Returns the JSON representation of the model using alias"""
211        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
212        return json.dumps(self.to_dict())
213
214    @classmethod
215    def from_json(cls, json_str: str) -> Optional[Self]:
216        """Create an instance of TeamSharingPolicySettingsChanges from a JSON string"""
217        return cls.from_dict(json.loads(json_str))
218
219    def to_dict(self) -> Dict[str, Any]:
220        """Return the dictionary representation of the model using alias.
221
222        This has the following differences from calling pydantic's
223        `self.model_dump(by_alias=True)`:
224
225        * `None` is only added to the output dict for nullable fields that
226          were set at model initialization. Other fields with value `None`
227          are ignored.
228        * Fields in `self.additional_properties` are added to the output dict.
229        """
230        excluded_fields: Set[str] = set(
231            [
232                "additional_properties",
233            ]
234        )
235
236        _dict = self.model_dump(
237            by_alias=True,
238            exclude=excluded_fields,
239            exclude_none=True,
240        )
241        # puts key-value pairs in additional_properties in the top level
242        if self.additional_properties is not None:
243            for _key, _value in self.additional_properties.items():
244                _dict[_key] = _value
245
246        return _dict
247
248    @classmethod
249    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
250        """Create an instance of TeamSharingPolicySettingsChanges from a dict"""
251        if obj is None:
252            return None
253
254        if not isinstance(obj, dict):
255            return cls.model_validate(obj)
256
257        _obj = cls.model_validate(
258            {
259                "allowListedDomains": obj.get("allowListedDomains"),
260                "createAssetAccessLevel": obj.get("createAssetAccessLevel"),
261                "defaultBoardAccess": obj.get("defaultBoardAccess"),
262                "defaultBoardSharingAccess": (
263                    obj.get("defaultBoardSharingAccess")
264                    if obj.get("defaultBoardSharingAccess") is not None
265                    else "team_members_with_editing_rights"
266                ),
267                "defaultOrganizationAccess": obj.get("defaultOrganizationAccess"),
268                "defaultProjectAccess": obj.get("defaultProjectAccess"),
269                "moveBoardToAccount": obj.get("moveBoardToAccount"),
270                "restrictAllowedDomains": obj.get("restrictAllowedDomains"),
271                "sharingOnAccount": obj.get("sharingOnAccount"),
272                "sharingOnOrganization": obj.get("sharingOnOrganization"),
273                "sharingViaPublicLink": obj.get("sharingViaPublicLink"),
274            }
275        )
276        # store additional fields in additional_properties
277        for _key in obj.keys():
278            if _key not in cls.__properties:
279                _obj.additional_properties[_key] = obj.get(_key)
280
281        return _obj