Skip to content

Create Album Dto

immichpy.client.generated.models.create_album_dto.CreateAlbumDto pydantic-model

Bases: BaseModel

CreateAlbumDto

Show JSON schema: 
{
  "$defs": {
    "AlbumUserCreateDto": {
      "description": "AlbumUserCreateDto",
      "properties": {
        "role": {
          "$ref": "#/$defs/AlbumUserRole"
        },
        "userId": {
          "description": "User ID",
          "format": "uuid",
          "title": "Userid",
          "type": "string"
        }
      },
      "required": [
        "role",
        "userId"
      ],
      "title": "AlbumUserCreateDto",
      "type": "object"
    },
    "AlbumUserRole": {
      "description": "Album user role",
      "enum": [
        "editor",
        "viewer"
      ],
      "title": "AlbumUserRole",
      "type": "string"
    }
  },
  "description": "CreateAlbumDto",
  "properties": {
    "albumName": {
      "description": "Album name",
      "title": "Albumname",
      "type": "string"
    },
    "albumUsers": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/AlbumUserCreateDto"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Album users",
      "title": "Albumusers"
    },
    "assetIds": {
      "anyOf": [
        {
          "items": {
            "format": "uuid",
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Initial asset IDs",
      "title": "Assetids"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Album description",
      "title": "Description"
    }
  },
  "required": [
    "albumName"
  ],
  "title": "CreateAlbumDto",
  "type": "object"
}

Config:

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

Fields:

album_name pydantic-field 

album_name: StrictStr

Album name

album_users pydantic-field 

album_users: Optional[List[AlbumUserCreateDto]] = None

Album users

asset_ids pydantic-field 

asset_ids: Optional[List[UUID]] = None

Initial asset IDs

description pydantic-field 

description: Optional[StrictStr] = None

Album description

from_dict classmethod 

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

Create an instance of CreateAlbumDto from a dict

Source code in immichpy/client/generated/models/create_album_dto.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of CreateAlbumDto 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"),
            "albumUsers": [
                AlbumUserCreateDto.from_dict(_item) for _item in obj["albumUsers"]
            ]
            if obj.get("albumUsers") is not None
            else None,
            "assetIds": obj.get("assetIds"),
            "description": obj.get("description"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of CreateAlbumDto from a JSON string

Source code in immichpy/client/generated/models/create_album_dto.py 
64
65
66
67
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of CreateAlbumDto 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/create_album_dto.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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,
    )
    # override the default output from pydantic by calling `to_dict()` of each item in album_users (list)
    _items = []
    if self.album_users:
        for _item_album_users in self.album_users:
            if _item_album_users:
                _items.append(_item_album_users.to_dict())
        _dict["albumUsers"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/create_album_dto.py 
59
60
61
62
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/create_album_dto.py 
55
56
57
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))