miro_api.models.board_with_links_and_without_project

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