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