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,
"description": "Asset sort order"
}
},
"title": "UpdateAlbumDto",
"type": "object"
}
Config:
populate_by_name:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
album_name(Optional[StrictStr]) -
album_thumbnail_asset_id(Optional[UUID]) -
description(Optional[StrictStr]) -
is_activity_enabled(Optional[StrictBool]) -
order(Optional[AssetOrder])
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
order
pydantic-field
order: Optional[AssetOrder] = None
Asset sort order
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
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 | |
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
70 71 72 73 | |
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):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/update_album_dto.py
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
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
65 66 67 68 | |
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
61 62 63 | |