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