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