miro_api.models.board

  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 datetime import datetime
 20from pydantic import BaseModel, Field, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional
 22from miro_api.models.board_member import BoardMember
 23from miro_api.models.board_policy import BoardPolicy
 24from miro_api.models.board_project import BoardProject
 25from miro_api.models.picture import Picture
 26from miro_api.models.team import Team
 27from miro_api.models.user_info_last_opened_by import UserInfoLastOpenedBy
 28from miro_api.models.user_info_short import UserInfoShort
 29from typing import Optional, Set
 30from typing_extensions import Self
 31
 32
 33class Board(BaseModel):
 34    """
 35    Contains the result data.
 36    """  # noqa: E501
 37
 38    created_at: Optional[datetime] = Field(
 39        default=None,
 40        description="Date and time when the board was created. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 41        alias="createdAt",
 42    )
 43    created_by: Optional[UserInfoShort] = Field(default=None, alias="createdBy")
 44    current_user_membership: Optional[BoardMember] = Field(default=None, alias="currentUserMembership")
 45    description: StrictStr = Field(description="Description of the board.")
 46    id: StrictStr = Field(description="Unique identifier (ID) of the board.")
 47    last_opened_at: Optional[datetime] = Field(
 48        default=None,
 49        description="Date and time when the board was last opened by any user. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 50        alias="lastOpenedAt",
 51    )
 52    last_opened_by: Optional[UserInfoLastOpenedBy] = Field(default=None, alias="lastOpenedBy")
 53    modified_at: Optional[datetime] = Field(
 54        default=None,
 55        description="Date and time when the board was last modified. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
 56        alias="modifiedAt",
 57    )
 58    modified_by: Optional[UserInfoShort] = Field(default=None, alias="modifiedBy")
 59    name: StrictStr = Field(description="Name of the board.")
 60    owner: Optional[UserInfoShort] = None
 61    picture: Optional[Picture] = None
 62    policy: Optional[BoardPolicy] = None
 63    team: Optional[Team] = None
 64    project: Optional[BoardProject] = None
 65    type: StrictStr = Field(description="Type of the object that is returned. In this case, type returns `board`.")
 66    view_link: Optional[StrictStr] = Field(default=None, description="URL to view the board.", alias="viewLink")
 67    additional_properties: Dict[str, Any] = {}
 68    __properties: ClassVar[List[str]] = [
 69        "createdAt",
 70        "createdBy",
 71        "currentUserMembership",
 72        "description",
 73        "id",
 74        "lastOpenedAt",
 75        "lastOpenedBy",
 76        "modifiedAt",
 77        "modifiedBy",
 78        "name",
 79        "owner",
 80        "picture",
 81        "policy",
 82        "team",
 83        "project",
 84        "type",
 85        "viewLink",
 86    ]
 87
 88    model_config = {
 89        "populate_by_name": True,
 90        "validate_assignment": True,
 91        "protected_namespaces": (),
 92    }
 93
 94    def to_str(self) -> str:
 95        """Returns the string representation of the model using alias"""
 96        return pprint.pformat(self.model_dump(by_alias=True))
 97
 98    def to_json(self) -> str:
 99        """Returns the JSON representation of the model using alias"""
100        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
101        return json.dumps(self.to_dict())
102
103    @classmethod
104    def from_json(cls, json_str: str) -> Optional[Self]:
105        """Create an instance of Board from a JSON string"""
106        return cls.from_dict(json.loads(json_str))
107
108    def to_dict(self) -> Dict[str, Any]:
109        """Return the dictionary representation of the model using alias.
110
111        This has the following differences from calling pydantic's
112        `self.model_dump(by_alias=True)`:
113
114        * `None` is only added to the output dict for nullable fields that
115          were set at model initialization. Other fields with value `None`
116          are ignored.
117        * Fields in `self.additional_properties` are added to the output dict.
118        """
119        excluded_fields: Set[str] = set(
120            [
121                "additional_properties",
122            ]
123        )
124
125        _dict = self.model_dump(
126            by_alias=True,
127            exclude=excluded_fields,
128            exclude_none=True,
129        )
130        # override the default output from pydantic by calling `to_dict()` of created_by
131        if self.created_by:
132            _dict["createdBy"] = self.created_by.to_dict()
133        # override the default output from pydantic by calling `to_dict()` of current_user_membership
134        if self.current_user_membership:
135            _dict["currentUserMembership"] = self.current_user_membership.to_dict()
136        # override the default output from pydantic by calling `to_dict()` of last_opened_by
137        if self.last_opened_by:
138            _dict["lastOpenedBy"] = self.last_opened_by.to_dict()
139        # override the default output from pydantic by calling `to_dict()` of modified_by
140        if self.modified_by:
141            _dict["modifiedBy"] = self.modified_by.to_dict()
142        # override the default output from pydantic by calling `to_dict()` of owner
143        if self.owner:
144            _dict["owner"] = self.owner.to_dict()
145        # override the default output from pydantic by calling `to_dict()` of picture
146        if self.picture:
147            _dict["picture"] = self.picture.to_dict()
148        # override the default output from pydantic by calling `to_dict()` of policy
149        if self.policy:
150            _dict["policy"] = self.policy.to_dict()
151        # override the default output from pydantic by calling `to_dict()` of team
152        if self.team:
153            _dict["team"] = self.team.to_dict()
154        # override the default output from pydantic by calling `to_dict()` of project
155        if self.project:
156            _dict["project"] = self.project.to_dict()
157        # puts key-value pairs in additional_properties in the top level
158        if self.additional_properties is not None:
159            for _key, _value in self.additional_properties.items():
160                _dict[_key] = _value
161
162        return _dict
163
164    @classmethod
165    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
166        """Create an instance of Board from a dict"""
167        if obj is None:
168            return None
169
170        if not isinstance(obj, dict):
171            return cls.model_validate(obj)
172
173        _obj = cls.model_validate(
174            {
175                "createdAt": obj.get("createdAt"),
176                "createdBy": UserInfoShort.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None,
177                "currentUserMembership": (
178                    BoardMember.from_dict(obj["currentUserMembership"])
179                    if obj.get("currentUserMembership") is not None
180                    else None
181                ),
182                "description": obj.get("description"),
183                "id": obj.get("id"),
184                "lastOpenedAt": obj.get("lastOpenedAt"),
185                "lastOpenedBy": (
186                    UserInfoLastOpenedBy.from_dict(obj["lastOpenedBy"]) if obj.get("lastOpenedBy") is not None else None
187                ),
188                "modifiedAt": obj.get("modifiedAt"),
189                "modifiedBy": UserInfoShort.from_dict(obj["modifiedBy"]) if obj.get("modifiedBy") is not None else None,
190                "name": obj.get("name"),
191                "owner": UserInfoShort.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
192                "picture": Picture.from_dict(obj["picture"]) if obj.get("picture") is not None else None,
193                "policy": BoardPolicy.from_dict(obj["policy"]) if obj.get("policy") is not None else None,
194                "team": Team.from_dict(obj["team"]) if obj.get("team") is not None else None,
195                "project": BoardProject.from_dict(obj["project"]) if obj.get("project") is not None else None,
196                "type": obj.get("type"),
197                "viewLink": obj.get("viewLink"),
198            }
199        )
200        # store additional fields in additional_properties
201        for _key in obj.keys():
202            if _key not in cls.__properties:
203                _obj.additional_properties[_key] = obj.get(_key)
204
205        return _obj