Skip to content

Login Response Dto

immichpy.client.generated.models.login_response_dto.LoginResponseDto pydantic-model

Bases: BaseModel

LoginResponseDto

Show JSON schema:
{
  "description": "LoginResponseDto",
  "properties": {
    "accessToken": {
      "description": "Access token",
      "title": "Accesstoken",
      "type": "string"
    },
    "isAdmin": {
      "description": "Is admin user",
      "title": "Isadmin",
      "type": "boolean"
    },
    "isOnboarded": {
      "description": "Is onboarded",
      "title": "Isonboarded",
      "type": "boolean"
    },
    "name": {
      "description": "User name",
      "title": "Name",
      "type": "string"
    },
    "profileImagePath": {
      "description": "Profile image path",
      "title": "Profileimagepath",
      "type": "string"
    },
    "shouldChangePassword": {
      "description": "Should change password",
      "title": "Shouldchangepassword",
      "type": "boolean"
    },
    "userEmail": {
      "description": "User email",
      "title": "Useremail",
      "type": "string"
    },
    "userId": {
      "description": "User ID",
      "title": "Userid",
      "type": "string"
    }
  },
  "required": [
    "accessToken",
    "isAdmin",
    "isOnboarded",
    "name",
    "profileImagePath",
    "shouldChangePassword",
    "userEmail",
    "userId"
  ],
  "title": "LoginResponseDto",
  "type": "object"
}

Config:

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

Fields:

access_token pydantic-field

access_token: StrictStr

Access token

is_admin pydantic-field

is_admin: StrictBool

Is admin user

is_onboarded pydantic-field

is_onboarded: StrictBool

Is onboarded

name pydantic-field

name: StrictStr

User name

profile_image_path pydantic-field

profile_image_path: StrictStr

Profile image path

should_change_password pydantic-field

should_change_password: StrictBool

Should change password

user_email pydantic-field

user_email: StrictStr

User email

user_id pydantic-field

user_id: StrictStr

User ID

from_dict classmethod

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

Create an instance of LoginResponseDto from a dict

Source code in immichpy/client/generated/models/login_response_dto.py
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of LoginResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "accessToken": obj.get("accessToken"),
            "isAdmin": obj.get("isAdmin"),
            "isOnboarded": obj.get("isOnboarded"),
            "name": obj.get("name"),
            "profileImagePath": obj.get("profileImagePath"),
            "shouldChangePassword": obj.get("shouldChangePassword"),
            "userEmail": obj.get("userEmail"),
            "userId": obj.get("userId"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of LoginResponseDto from a JSON string

Source code in immichpy/client/generated/models/login_response_dto.py
68
69
70
71
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of LoginResponseDto 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/login_response_dto.py
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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,
    )
    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

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