Skip to content

Notification Update All Dto

immichpy.client.generated.models.notification_update_all_dto.NotificationUpdateAllDto pydantic-model

Bases: BaseModel

NotificationUpdateAllDto

Show JSON schema: 
{
  "description": "NotificationUpdateAllDto",
  "properties": {
    "ids": {
      "description": "Notification IDs to update",
      "items": {
        "format": "uuid",
        "type": "string"
      },
      "minItems": 1,
      "title": "Ids",
      "type": "array"
    },
    "readAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date when notifications were read",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "title": "Readat"
    }
  },
  "required": [
    "ids"
  ],
  "title": "NotificationUpdateAllDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

ids pydantic-field 

ids: Annotated[List[UUID], Field(min_length=1)]

Notification IDs to update

read_at pydantic-field 

read_at: Optional[datetime] = None

Date when notifications were read

from_dict classmethod 

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

Create an instance of NotificationUpdateAllDto from a dict

Source code in immichpy/client/generated/models/notification_update_all_dto.py 
104
105
106
107
108
109
110
111
112
113
114
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of NotificationUpdateAllDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({"ids": obj.get("ids"), "readAt": obj.get("readAt")})
    return _obj

from_json classmethod 

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

Create an instance of NotificationUpdateAllDto from a JSON string

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

read_at_validate_regular_expression pydantic-validator 

read_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/notification_update_all_dto.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
@field_validator("read_at", mode="before")
def read_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

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_update_all_dto.py 
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
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 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_update_all_dto.py 
71
72
73
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(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_update_all_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))