Skip to content

Session Unlock Dto

immichpy.client.generated.models.session_unlock_dto.SessionUnlockDto pydantic-model

Bases: BaseModel

SessionUnlockDto

Show JSON schema: 
{
  "description": "SessionUnlockDto",
  "properties": {
    "password": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "User password (required if PIN code is not provided)",
      "examples": [
        "password"
      ],
      "title": "Password"
    },
    "pinCode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "New PIN code (4-6 digits)",
      "examples": [
        "123456"
      ],
      "title": "Pincode"
    }
  },
  "title": "SessionUnlockDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

password pydantic-field 

password: Optional[StrictStr] = None

User password (required if PIN code is not provided)

pin_code pydantic-field 

pin_code: Optional[Annotated[str, Field(strict=True)]] = None

New PIN code (4-6 digits)

from_dict classmethod 

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

Create an instance of SessionUnlockDto from a dict

Source code in immichpy/client/generated/models/session_unlock_dto.py 
 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 SessionUnlockDto from a dict"""
    if obj is None:
        return None

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

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

from_json classmethod 

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

Create an instance of SessionUnlockDto from a JSON string

Source code in immichpy/client/generated/models/session_unlock_dto.py 
70
71
72
73
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SessionUnlockDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

pin_code_validate_regular_expression pydantic-validator 

pin_code_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/session_unlock_dto.py 
45
46
47
48
49
50
51
52
53
@field_validator("pin_code", mode="before")
def pin_code_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(r"^\d{6}$", value):
        raise ValueError(r"must validate the regular expression /^\d{6}$/")
    return value

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/session_unlock_dto.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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/session_unlock_dto.py 
66
67
68
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/session_unlock_dto.py 
62
63
64
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))