miro_api.models.board_item_content_log

  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, field_validator
 22from typing import Any, ClassVar, Dict, List, Optional
 23from miro_api.models.actor import Actor
 24from typing import Optional, Set
 25from typing_extensions import Self
 26
 27
 28class BoardItemContentLog(BaseModel):
 29    """
 30    Contains information about the content log of for a board item.
 31    """  # noqa: E501
 32
 33    id: Optional[StrictStr] = Field(default=None, description="Unique identifier of the content log.")
 34    content_id: Optional[StrictStr] = Field(
 35        default=None, description="Unique identifier of the board where the action happened.", alias="contentId"
 36    )
 37    action_type: Optional[StrictStr] = Field(
 38        default=None,
 39        description="Type of action within the board, such as creation of a widget, update of a comment message, and so on.",
 40        alias="actionType",
 41    )
 42    action_time: Optional[datetime] = Field(
 43        default=None,
 44        description="Date and time when the action happened.<br>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)). ",
 45        alias="actionTime",
 46    )
 47    actor: Optional[Actor] = None
 48    item_type: Optional[StrictStr] = Field(
 49        default=None, description="Type of the board item on which the action happened.", alias="itemType"
 50    )
 51    item_id: Optional[StrictStr] = Field(
 52        default=None,
 53        description="Unique identifier of the board item on which the action happened. For example, the widget ID.",
 54        alias="itemId",
 55    )
 56    state: Optional[Dict[str, Any]] = Field(
 57        default=None,
 58        description="Object that contains information about the state of the board item after the action was performed.",
 59    )
 60    additional_properties: Dict[str, Any] = {}
 61    __properties: ClassVar[List[str]] = [
 62        "id",
 63        "contentId",
 64        "actionType",
 65        "actionTime",
 66        "actor",
 67        "itemType",
 68        "itemId",
 69        "state",
 70    ]
 71
 72    @field_validator("action_type")
 73    def action_type_validate_enum(cls, value):
 74        """Validates the enum"""
 75        if value is None:
 76            return value
 77
 78        if value not in set(["create", "update", "delete"]):
 79            raise ValueError("must be one of enum values ('create', 'update', 'delete')")
 80        return value
 81
 82    @field_validator("item_type")
 83    def item_type_validate_enum(cls, value):
 84        """Validates the enum"""
 85        if value is None:
 86            return value
 87
 88        if value not in set(["widget", "comment_thread", "comment_message"]):
 89            raise ValueError("must be one of enum values ('widget', 'comment_thread', 'comment_message')")
 90        return value
 91
 92    model_config = {
 93        "populate_by_name": True,
 94        "validate_assignment": True,
 95        "protected_namespaces": (),
 96    }
 97
 98    def to_str(self) -> str:
 99        """Returns the string representation of the model using alias"""
100        return pprint.pformat(self.model_dump(by_alias=True))
101
102    def to_json(self) -> str:
103        """Returns the JSON representation of the model using alias"""
104        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
105        return json.dumps(self.to_dict())
106
107    @classmethod
108    def from_json(cls, json_str: str) -> Optional[Self]:
109        """Create an instance of BoardItemContentLog from a JSON string"""
110        return cls.from_dict(json.loads(json_str))
111
112    def to_dict(self) -> Dict[str, Any]:
113        """Return the dictionary representation of the model using alias.
114
115        This has the following differences from calling pydantic's
116        `self.model_dump(by_alias=True)`:
117
118        * `None` is only added to the output dict for nullable fields that
119          were set at model initialization. Other fields with value `None`
120          are ignored.
121        * Fields in `self.additional_properties` are added to the output dict.
122        """
123        excluded_fields: Set[str] = set(
124            [
125                "additional_properties",
126            ]
127        )
128
129        _dict = self.model_dump(
130            by_alias=True,
131            exclude=excluded_fields,
132            exclude_none=True,
133        )
134        # override the default output from pydantic by calling `to_dict()` of actor
135        if self.actor:
136            _dict["actor"] = self.actor.to_dict()
137        # puts key-value pairs in additional_properties in the top level
138        if self.additional_properties is not None:
139            for _key, _value in self.additional_properties.items():
140                _dict[_key] = _value
141
142        return _dict
143
144    @classmethod
145    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
146        """Create an instance of BoardItemContentLog from a dict"""
147        if obj is None:
148            return None
149
150        if not isinstance(obj, dict):
151            return cls.model_validate(obj)
152
153        _obj = cls.model_validate(
154            {
155                "id": obj.get("id"),
156                "contentId": obj.get("contentId"),
157                "actionType": obj.get("actionType"),
158                "actionTime": obj.get("actionTime"),
159                "actor": Actor.from_dict(obj["actor"]) if obj.get("actor") is not None else None,
160                "itemType": obj.get("itemType"),
161                "itemId": obj.get("itemId"),
162                "state": obj.get("state"),
163            }
164        )
165        # store additional fields in additional_properties
166        for _key in obj.keys():
167            if _key not in cls.__properties:
168                _obj.additional_properties[_key] = obj.get(_key)
169
170        return _obj