Skip to content

Update Album Dto

immichpy.client.generated.models.update_album_dto.UpdateAlbumDto pydantic-model

Bases: BaseModel

UpdateAlbumDto

Show JSON schema: 
{
  "$defs": {
    "AssetOrder": {
      "description": "Asset sort order",
      "enum": [
        "asc",
        "desc"
      ],
      "title": "AssetOrder",
      "type": "string"
    }
  },
  "description": "UpdateAlbumDto",
  "properties": {
    "albumName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Album name",
      "title": "Albumname"
    },
    "albumThumbnailAssetId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Album thumbnail asset ID",
      "title": "Albumthumbnailassetid"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Album description",
      "title": "Description"
    },
    "isActivityEnabled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Enable activity feed",
      "title": "Isactivityenabled"
    },
    "order": {
      "anyOf": [
        {
          "$ref": "#/$defs/AssetOrder"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "UpdateAlbumDto",
  "type": "object"
}

Config:

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

Fields:

Validators:

album_name pydantic-field 

album_name: Optional[StrictStr] = None

Album name

album_thumbnail_asset_id pydantic-field 

album_thumbnail_asset_id: Optional[UUID] = None

Album thumbnail asset ID

description pydantic-field 

description: Optional[StrictStr] = None

Album description

is_activity_enabled pydantic-field 

is_activity_enabled: Optional[StrictBool] = None

Enable activity feed

album_thumbnail_asset_id_validate_regular_expression pydantic-validator 

album_thumbnail_asset_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/update_album_dto.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@field_validator("album_thumbnail_asset_id", mode="before")
def album_thumbnail_asset_id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

from_dict classmethod 

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

Create an instance of UpdateAlbumDto from a dict

Source code in immichpy/client/generated/models/update_album_dto.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UpdateAlbumDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "albumName": obj.get("albumName"),
            "albumThumbnailAssetId": obj.get("albumThumbnailAssetId"),
            "description": obj.get("description"),
            "isActivityEnabled": obj.get("isActivityEnabled"),
            "order": obj.get("order"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of UpdateAlbumDto from a JSON string

Source code in immichpy/client/generated/models/update_album_dto.py 
93
94
95
96
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UpdateAlbumDto 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/update_album_dto.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/update_album_dto.py 
89
90
91
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/update_album_dto.py 
85
86
87
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))