Skip to content

User Admin Create Dto

immichpy.client.generated.models.user_admin_create_dto.UserAdminCreateDto pydantic-model

Bases: BaseModel

UserAdminCreateDto

Show JSON schema:
{
  "$defs": {
    "UserAvatarColor": {
      "description": "Avatar color",
      "enum": [
        "primary",
        "pink",
        "red",
        "yellow",
        "blue",
        "green",
        "purple",
        "orange",
        "gray",
        "amber"
      ],
      "title": "UserAvatarColor",
      "type": "string"
    }
  },
  "description": "UserAdminCreateDto",
  "properties": {
    "avatarColor": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserAvatarColor"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Avatar color"
    },
    "email": {
      "description": "User email",
      "title": "Email",
      "type": "string"
    },
    "isAdmin": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Grant admin privileges",
      "title": "Isadmin"
    },
    "name": {
      "description": "User name",
      "title": "Name",
      "type": "string"
    },
    "notify": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Send notification email",
      "title": "Notify"
    },
    "password": {
      "description": "User password",
      "title": "Password",
      "type": "string"
    },
    "pinCode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "PIN code",
      "title": "Pincode"
    },
    "quotaSizeInBytes": {
      "anyOf": [
        {
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Storage quota in bytes",
      "title": "Quotasizeinbytes"
    },
    "shouldChangePassword": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Require password change on next login",
      "title": "Shouldchangepassword"
    },
    "storageLabel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Storage label",
      "title": "Storagelabel"
    }
  },
  "required": [
    "email",
    "name",
    "password"
  ],
  "title": "UserAdminCreateDto",
  "type": "object"
}

Config:

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

Fields:

avatar_color pydantic-field

avatar_color: Optional[UserAvatarColor] = None

Avatar color

email pydantic-field

email: StrictStr

User email

is_admin pydantic-field

is_admin: Optional[StrictBool] = None

Grant admin privileges

name pydantic-field

name: StrictStr

User name

notify pydantic-field

notify: Optional[StrictBool] = None

Send notification email

password pydantic-field

password: StrictStr

User password

pin_code pydantic-field

pin_code: Optional[StrictStr] = None

PIN code

quota_size_in_bytes pydantic-field

quota_size_in_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = None

Storage quota in bytes

should_change_password pydantic-field

should_change_password: Optional[StrictBool] = None

Require password change on next login

storage_label pydantic-field

storage_label: Optional[StrictStr] = None

Storage label

from_dict classmethod

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

Create an instance of UserAdminCreateDto from a dict

Source code in immichpy/client/generated/models/user_admin_create_dto.py
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserAdminCreateDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "avatarColor": obj.get("avatarColor"),
            "email": obj.get("email"),
            "isAdmin": obj.get("isAdmin"),
            "name": obj.get("name"),
            "notify": obj.get("notify"),
            "password": obj.get("password"),
            "pinCode": obj.get("pinCode"),
            "quotaSizeInBytes": obj.get("quotaSizeInBytes"),
            "shouldChangePassword": obj.get("shouldChangePassword"),
            "storageLabel": obj.get("storageLabel"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of UserAdminCreateDto from a JSON string

Source code in immichpy/client/generated/models/user_admin_create_dto.py
86
87
88
89
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserAdminCreateDto 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/user_admin_create_dto.py
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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 avatar_color (nullable) is None
    # and model_fields_set contains the field
    if self.avatar_color is None and "avatar_color" in self.model_fields_set:
        _dict["avatarColor"] = None

    # set to None if pin_code (nullable) is None
    # and model_fields_set contains the field
    if self.pin_code is None and "pin_code" in self.model_fields_set:
        _dict["pinCode"] = None

    # set to None if quota_size_in_bytes (nullable) is None
    # and model_fields_set contains the field
    if (
        self.quota_size_in_bytes is None
        and "quota_size_in_bytes" in self.model_fields_set
    ):
        _dict["quotaSizeInBytes"] = None

    # set to None if storage_label (nullable) is None
    # and model_fields_set contains the field
    if self.storage_label is None and "storage_label" in self.model_fields_set:
        _dict["storageLabel"] = None

    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/user_admin_create_dto.py
81
82
83
84
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/user_admin_create_dto.py
77
78
79
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))