Skip to content

Add Users Dto

immichpy.client.generated.models.add_users_dto.AddUsersDto pydantic-model

Bases: BaseModel

AddUsersDto

Show JSON schema: 
{
  "$defs": {
    "AlbumUserAddDto": {
      "description": "AlbumUserAddDto",
      "properties": {
        "role": {
          "anyOf": [
            {
              "$ref": "#/$defs/AlbumUserRole"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Album user role"
        },
        "userId": {
          "description": "User ID",
          "format": "uuid",
          "title": "Userid",
          "type": "string"
        }
      },
      "required": [
        "userId"
      ],
      "title": "AlbumUserAddDto",
      "type": "object"
    },
    "AlbumUserRole": {
      "description": "Album user role",
      "enum": [
        "editor",
        "viewer"
      ],
      "title": "AlbumUserRole",
      "type": "string"
    }
  },
  "description": "AddUsersDto",
  "properties": {
    "albumUsers": {
      "description": "Album users to add",
      "items": {
        "$ref": "#/$defs/AlbumUserAddDto"
      },
      "minItems": 1,
      "title": "Albumusers",
      "type": "array"
    }
  },
  "required": [
    "albumUsers"
  ],
  "title": "AddUsersDto",
  "type": "object"
}

Config:

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

Fields:

album_users pydantic-field 

album_users: Annotated[List[AlbumUserAddDto], Field(min_length=1)]

Album users to add

from_dict classmethod 

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

Create an instance of AddUsersDto from a dict

Source code in immichpy/client/generated/models/add_users_dto.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AddUsersDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "albumUsers": [
                AlbumUserAddDto.from_dict(_item) for _item in obj["albumUsers"]
            ]
            if obj.get("albumUsers") is not None
            else None
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AddUsersDto from a JSON string

Source code in immichpy/client/generated/models/add_users_dto.py 
52
53
54
55
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AddUsersDto 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/add_users_dto.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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/add_users_dto.py 
47
48
49
50
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/add_users_dto.py 
43
44
45
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))