Source code for annofabapi.pydantic_models.my_notification_message

"""


No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
"""

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Set

from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from typing_extensions import Self




class MyNotificationMessage(BaseModel):
    """
    自分への通知メッセージの情報です。
    """

    message_id: StrictStr = Field(description="通知メッセージID。[値の制約についてはこちら。](#section/API-Convention/APIID) ")
    title: StrictStr = Field(description="メッセージ通知のタイトル ")
    body: StrictStr = Field(description="メッセージ通知の本文 ")
    content_type: StrictStr | None = Field(
        default=None, description="メッセージのコンテンツタイプ。 メッセージを表示する際のマークアップのヒントとして使われることを想定しています。 "
    )
    opened: StrictBool = Field(description="自身がメッセージを開封したか(開封済みの場合true) ")
    timestamp: str = Field(description="最後に通知メッセージ内容を更新した日時。更新がない場合はメッセージ作成日時 ")
    created_datetime: str = Field(description="メッセージ作成日時 ")
    __properties: ClassVar[List[str]] = ["message_id", "title", "body", "content_type", "opened", "timestamp", "created_datetime"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )



    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())




    @classmethod
    def from_json(cls, json_str: str) -> Self | None:
        """Create an instance of MyNotificationMessage from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        return _dict




    @classmethod
    def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None:
        """Create an instance of MyNotificationMessage from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "message_id": obj.get("message_id"),
                "title": obj.get("title"),
                "body": obj.get("body"),
                "content_type": obj.get("content_type"),
                "opened": obj.get("opened"),
                "timestamp": obj.get("timestamp"),
                "created_datetime": obj.get("created_datetime"),
            }
        )
        return _obj