Skip to content

Notification Create Dto

immichpy.client.generated.models.notification_create_dto.NotificationCreateDto pydantic-model

Bases: BaseModel

NotificationCreateDto

Show JSON schema: 
{
  "$defs": {
    "NotificationLevel": {
      "description": "NotificationLevel",
      "enum": [
        "success",
        "error",
        "warning",
        "info"
      ],
      "title": "NotificationLevel",
      "type": "string"
    },
    "NotificationType": {
      "description": "NotificationType",
      "enum": [
        "JobFailed",
        "BackupFailed",
        "SystemMessage",
        "AlbumInvite",
        "AlbumUpdate",
        "Custom"
      ],
      "title": "NotificationType",
      "type": "string"
    }
  },
  "description": "NotificationCreateDto",
  "properties": {
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Additional notification data",
      "title": "Data"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Notification description",
      "title": "Description"
    },
    "level": {
      "anyOf": [
        {
          "$ref": "#/$defs/NotificationLevel"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Notification level"
    },
    "readAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date when notification was read",
      "title": "Readat"
    },
    "title": {
      "description": "Notification title",
      "title": "Title",
      "type": "string"
    },
    "type": {
      "anyOf": [
        {
          "$ref": "#/$defs/NotificationType"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Notification type"
    },
    "userId": {
      "description": "User ID to send notification to",
      "format": "uuid",
      "title": "Userid",
      "type": "string"
    }
  },
  "required": [
    "title",
    "userId"
  ],
  "title": "NotificationCreateDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

data pydantic-field 

data: Optional[Dict[str, Any]] = None

Additional notification data

description pydantic-field 

description: Optional[StrictStr] = None

Notification description

level pydantic-field 

level: Optional[NotificationLevel] = None

Notification level

read_at pydantic-field 

read_at: Optional[datetime] = None

Date when notification was read

title pydantic-field 

title: StrictStr

Notification title

type pydantic-field 

type: Optional[NotificationType] = None

Notification type

user_id pydantic-field 

user_id: UUID

User ID to send notification to

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of NotificationCreateDto from a dict

Source code in immichpy/client/generated/models/notification_create_dto.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of NotificationCreateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "data": obj.get("data"),
            "description": obj.get("description"),
            "level": obj.get("level"),
            "readAt": obj.get("readAt"),
            "title": obj.get("title"),
            "type": obj.get("type"),
            "userId": obj.get("userId"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of NotificationCreateDto from a JSON string

Source code in immichpy/client/generated/models/notification_create_dto.py 
76
77
78
79
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of NotificationCreateDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> 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.
Source code in immichpy/client/generated/models/notification_create_dto.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
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,
    )
    # set to None if description (nullable) is None
    # and model_fields_set contains the field
    if self.description is None and "description" in self.model_fields_set:
        _dict["description"] = None

    # set to None if read_at (nullable) is None
    # and model_fields_set contains the field
    if self.read_at is None and "read_at" in self.model_fields_set:
        _dict["readAt"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/notification_create_dto.py 
71
72
73
74
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())

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/notification_create_dto.py 
67
68
69
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))