Skip to content

Auth Status Response Dto

immichpy.client.generated.models.auth_status_response_dto.AuthStatusResponseDto pydantic-model

Bases: BaseModel

AuthStatusResponseDto

Show JSON schema: 
{
  "description": "AuthStatusResponseDto",
  "properties": {
    "expiresAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Session expiration date",
      "title": "Expiresat"
    },
    "isElevated": {
      "description": "Is elevated session",
      "title": "Iselevated",
      "type": "boolean"
    },
    "password": {
      "description": "Has password set",
      "title": "Password",
      "type": "boolean"
    },
    "pinCode": {
      "description": "Has PIN code set",
      "title": "Pincode",
      "type": "boolean"
    },
    "pinExpiresAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "PIN expiration date",
      "title": "Pinexpiresat"
    }
  },
  "required": [
    "isElevated",
    "password",
    "pinCode"
  ],
  "title": "AuthStatusResponseDto",
  "type": "object"
}

Config:

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

Fields:

expires_at pydantic-field 

expires_at: Optional[StrictStr] = None

Session expiration date

is_elevated pydantic-field 

is_elevated: StrictBool

Is elevated session

password pydantic-field 

password: StrictBool

Has password set

pin_code pydantic-field 

pin_code: StrictBool

Has PIN code set

pin_expires_at pydantic-field 

pin_expires_at: Optional[StrictStr] = None

PIN expiration date

from_dict classmethod 

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

Create an instance of AuthStatusResponseDto from a dict

Source code in immichpy/client/generated/models/auth_status_response_dto.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AuthStatusResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "expiresAt": obj.get("expiresAt"),
            "isElevated": obj.get("isElevated"),
            "password": obj.get("password"),
            "pinCode": obj.get("pinCode"),
            "pinExpiresAt": obj.get("pinExpiresAt"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AuthStatusResponseDto from a JSON string

Source code in immichpy/client/generated/models/auth_status_response_dto.py 
64
65
66
67
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AuthStatusResponseDto 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/auth_status_response_dto.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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/auth_status_response_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/auth_status_response_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))