miro_api.models.board_policy_change

Miro Developer Platform

### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): 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 ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.

The version of the OpenAPI document: v2.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

  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
 20from typing import Any, ClassVar, Dict, List, Optional
 21from miro_api.models.board_permissions_policy import BoardPermissionsPolicy
 22from miro_api.models.board_sharing_policy_change import BoardSharingPolicyChange
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26
 27class BoardPolicyChange(BaseModel):
 28    """
 29    Defines the permissions policies and sharing policies for the board.
 30    """  # noqa: E501
 31
 32    permissions_policy: Optional[BoardPermissionsPolicy] = Field(default=None, alias="permissionsPolicy")
 33    sharing_policy: Optional[BoardSharingPolicyChange] = Field(default=None, alias="sharingPolicy")
 34    additional_properties: Dict[str, Any] = {}
 35    __properties: ClassVar[List[str]] = ["permissionsPolicy", "sharingPolicy"]
 36
 37    model_config = {
 38        "populate_by_name": True,
 39        "validate_assignment": True,
 40        "protected_namespaces": (),
 41    }
 42
 43    def to_str(self) -> str:
 44        """Returns the string representation of the model using alias"""
 45        return pprint.pformat(self.model_dump(by_alias=True))
 46
 47    def to_json(self) -> str:
 48        """Returns the JSON representation of the model using alias"""
 49        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 50        return json.dumps(self.to_dict())
 51
 52    @classmethod
 53    def from_json(cls, json_str: str) -> Optional[Self]:
 54        """Create an instance of BoardPolicyChange from a JSON string"""
 55        return cls.from_dict(json.loads(json_str))
 56
 57    def to_dict(self) -> Dict[str, Any]:
 58        """Return the dictionary representation of the model using alias.
 59
 60        This has the following differences from calling pydantic's
 61        `self.model_dump(by_alias=True)`:
 62
 63        * `None` is only added to the output dict for nullable fields that
 64          were set at model initialization. Other fields with value `None`
 65          are ignored.
 66        * Fields in `self.additional_properties` are added to the output dict.
 67        """
 68        excluded_fields: Set[str] = set(
 69            [
 70                "additional_properties",
 71            ]
 72        )
 73
 74        _dict = self.model_dump(
 75            by_alias=True,
 76            exclude=excluded_fields,
 77            exclude_none=True,
 78        )
 79        # override the default output from pydantic by calling `to_dict()` of permissions_policy
 80        if self.permissions_policy:
 81            _dict["permissionsPolicy"] = self.permissions_policy.to_dict()
 82        # override the default output from pydantic by calling `to_dict()` of sharing_policy
 83        if self.sharing_policy:
 84            _dict["sharingPolicy"] = self.sharing_policy.to_dict()
 85        # puts key-value pairs in additional_properties in the top level
 86        if self.additional_properties is not None:
 87            for _key, _value in self.additional_properties.items():
 88                _dict[_key] = _value
 89
 90        return _dict
 91
 92    @classmethod
 93    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 94        """Create an instance of BoardPolicyChange from a dict"""
 95        if obj is None:
 96            return None
 97
 98        if not isinstance(obj, dict):
 99            return cls.model_validate(obj)
100
101        _obj = cls.model_validate(
102            {
103                "permissionsPolicy": (
104                    BoardPermissionsPolicy.from_dict(obj["permissionsPolicy"])
105                    if obj.get("permissionsPolicy") is not None
106                    else None
107                ),
108                "sharingPolicy": (
109                    BoardSharingPolicyChange.from_dict(obj["sharingPolicy"])
110                    if obj.get("sharingPolicy") is not None
111                    else None
112                ),
113            }
114        )
115        # store additional fields in additional_properties
116        for _key in obj.keys():
117            if _key not in cls.__properties:
118                _obj.additional_properties[_key] = obj.get(_key)
119
120        return _obj

class BoardPolicyChange(pydantic.main.BaseModel): View Source

 28class BoardPolicyChange(BaseModel):
 29    """
 30    Defines the permissions policies and sharing policies for the board.
 31    """  # noqa: E501
 32
 33    permissions_policy: Optional[BoardPermissionsPolicy] = Field(default=None, alias="permissionsPolicy")
 34    sharing_policy: Optional[BoardSharingPolicyChange] = Field(default=None, alias="sharingPolicy")
 35    additional_properties: Dict[str, Any] = {}
 36    __properties: ClassVar[List[str]] = ["permissionsPolicy", "sharingPolicy"]
 37
 38    model_config = {
 39        "populate_by_name": True,
 40        "validate_assignment": True,
 41        "protected_namespaces": (),
 42    }
 43
 44    def to_str(self) -> str:
 45        """Returns the string representation of the model using alias"""
 46        return pprint.pformat(self.model_dump(by_alias=True))
 47
 48    def to_json(self) -> str:
 49        """Returns the JSON representation of the model using alias"""
 50        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 51        return json.dumps(self.to_dict())
 52
 53    @classmethod
 54    def from_json(cls, json_str: str) -> Optional[Self]:
 55        """Create an instance of BoardPolicyChange from a JSON string"""
 56        return cls.from_dict(json.loads(json_str))
 57
 58    def to_dict(self) -> Dict[str, Any]:
 59        """Return the dictionary representation of the model using alias.
 60
 61        This has the following differences from calling pydantic's
 62        `self.model_dump(by_alias=True)`:
 63
 64        * `None` is only added to the output dict for nullable fields that
 65          were set at model initialization. Other fields with value `None`
 66          are ignored.
 67        * Fields in `self.additional_properties` are added to the output dict.
 68        """
 69        excluded_fields: Set[str] = set(
 70            [
 71                "additional_properties",
 72            ]
 73        )
 74
 75        _dict = self.model_dump(
 76            by_alias=True,
 77            exclude=excluded_fields,
 78            exclude_none=True,
 79        )
 80        # override the default output from pydantic by calling `to_dict()` of permissions_policy
 81        if self.permissions_policy:
 82            _dict["permissionsPolicy"] = self.permissions_policy.to_dict()
 83        # override the default output from pydantic by calling `to_dict()` of sharing_policy
 84        if self.sharing_policy:
 85            _dict["sharingPolicy"] = self.sharing_policy.to_dict()
 86        # puts key-value pairs in additional_properties in the top level
 87        if self.additional_properties is not None:
 88            for _key, _value in self.additional_properties.items():
 89                _dict[_key] = _value
 90
 91        return _dict
 92
 93    @classmethod
 94    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 95        """Create an instance of BoardPolicyChange from a dict"""
 96        if obj is None:
 97            return None
 98
 99        if not isinstance(obj, dict):
100            return cls.model_validate(obj)
101
102        _obj = cls.model_validate(
103            {
104                "permissionsPolicy": (
105                    BoardPermissionsPolicy.from_dict(obj["permissionsPolicy"])
106                    if obj.get("permissionsPolicy") is not None
107                    else None
108                ),
109                "sharingPolicy": (
110                    BoardSharingPolicyChange.from_dict(obj["sharingPolicy"])
111                    if obj.get("sharingPolicy") is not None
112                    else None
113                ),
114            }
115        )
116        # store additional fields in additional_properties
117        for _key in obj.keys():
118            if _key not in cls.__properties:
119                _obj.additional_properties[_key] = obj.get(_key)
120
121        return _obj

Defines the permissions policies and sharing policies for the board.

permissions_policy: Optional[miro_api.models.board_permissions_policy.BoardPermissionsPolicy]

sharing_policy: Optional[miro_api.models.board_sharing_policy_change.BoardSharingPolicyChange]

additional_properties: Dict[str, Any]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

def to_str(self) -> str: View Source

44    def to_str(self) -> str:
45        """Returns the string representation of the model using alias"""
46        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

48    def to_json(self) -> str:
49        """Returns the JSON representation of the model using alias"""
50        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
51        return json.dumps(self.to_dict())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[typing_extensions.Self]: View Source

53    @classmethod
54    def from_json(cls, json_str: str) -> Optional[Self]:
55        """Create an instance of BoardPolicyChange from a JSON string"""
56        return cls.from_dict(json.loads(json_str))

Create an instance of BoardPolicyChange from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

58    def to_dict(self) -> Dict[str, Any]:
59        """Return the dictionary representation of the model using alias.
60
61        This has the following differences from calling pydantic's
62        `self.model_dump(by_alias=True)`:
63
64        * `None` is only added to the output dict for nullable fields that
65          were set at model initialization. Other fields with value `None`
66          are ignored.
67        * Fields in `self.additional_properties` are added to the output dict.
68        """
69        excluded_fields: Set[str] = set(
70            [
71                "additional_properties",
72            ]
73        )
74
75        _dict = self.model_dump(
76            by_alias=True,
77            exclude=excluded_fields,
78            exclude_none=True,
79        )
80        # override the default output from pydantic by calling `to_dict()` of permissions_policy
81        if self.permissions_policy:
82            _dict["permissionsPolicy"] = self.permissions_policy.to_dict()
83        # override the default output from pydantic by calling `to_dict()` of sharing_policy
84        if self.sharing_policy:
85            _dict["sharingPolicy"] = self.sharing_policy.to_dict()
86        # puts key-value pairs in additional_properties in the top level
87        if self.additional_properties is not None:
88            for _key, _value in self.additional_properties.items():
89                _dict[_key] = _value
90
91        return _dict

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Fields in self.additional_properties are added to the output dict.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[typing_extensions.Self]: View Source

 93    @classmethod
 94    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 95        """Create an instance of BoardPolicyChange from a dict"""
 96        if obj is None:
 97            return None
 98
 99        if not isinstance(obj, dict):
100            return cls.model_validate(obj)
101
102        _obj = cls.model_validate(
103            {
104                "permissionsPolicy": (
105                    BoardPermissionsPolicy.from_dict(obj["permissionsPolicy"])
106                    if obj.get("permissionsPolicy") is not None
107                    else None
108                ),
109                "sharingPolicy": (
110                    BoardSharingPolicyChange.from_dict(obj["sharingPolicy"])
111                    if obj.get("sharingPolicy") is not None
112                    else None
113                ),
114            }
115        )
116        # store additional fields in additional_properties
117        for _key in obj.keys():
118            if _key not in cls.__properties:
119                _obj.additional_properties[_key] = obj.get(_key)
120
121        return _obj

Create an instance of BoardPolicyChange from a dict

def model_post_init(self: pydantic.main.BaseModel, __context: Any) -> None: View Source

265def init_private_attributes(self: BaseModel, __context: Any) -> None:
266    """This function is meant to behave like a BaseModel method to initialise private attributes.
267
268    It takes context as an argument since that's what pydantic-core passes when calling it.
269
270    Args:
271        self: The BaseModel instance.
272        __context: The context.
273    """
274    if getattr(self, '__pydantic_private__', None) is None:
275        pydantic_private = {}
276        for name, private_attr in self.__private_attributes__.items():
277            default = private_attr.get_default()
278            if default is not PydanticUndefined:
279                pydantic_private[name] = default
280        object_setattr(self, '__pydantic_private__', pydantic_private)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Args: self: The BaseModel instance. __context: The context.

model_fields = {'permissions_policy': FieldInfo(annotation=Union[BoardPermissionsPolicy, NoneType], required=False, alias='permissionsPolicy', alias_priority=2), 'sharing_policy': FieldInfo(annotation=Union[BoardSharingPolicyChange, NoneType], required=False, alias='sharingPolicy', alias_priority=2), 'additional_properties': FieldInfo(annotation=Dict[str, Any], required=False, default={})}

model_computed_fields = {}

Inherited Members

pydantic.main.BaseModel: BaseModel; model_extra; model_fields_set; model_construct; model_copy; model_dump; model_dump_json; model_json_schema; model_parametrized_name; model_rebuild; model_validate; model_validate_json; model_validate_strings; dict; json; parse_obj; parse_raw; parse_file; from_orm; construct; copy; schema; schema_json; validate; update_forward_refs