Skip to content

Session Response Dto

immichpy.client.generated.models.session_response_dto.SessionResponseDto pydantic-model

Bases: BaseModel

SessionResponseDto

Show JSON schema:
{
  "description": "SessionResponseDto",
  "properties": {
    "appVersion": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "App version",
      "title": "Appversion"
    },
    "createdAt": {
      "description": "Creation date",
      "title": "Createdat",
      "type": "string"
    },
    "current": {
      "description": "Is current session",
      "title": "Current",
      "type": "boolean"
    },
    "deviceOS": {
      "description": "Device OS",
      "title": "Deviceos",
      "type": "string"
    },
    "deviceType": {
      "description": "Device type",
      "title": "Devicetype",
      "type": "string"
    },
    "expiresAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Expiration date",
      "title": "Expiresat"
    },
    "id": {
      "description": "Session ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "isPendingSyncReset": {
      "description": "Is pending sync reset",
      "title": "Ispendingsyncreset",
      "type": "boolean"
    },
    "updatedAt": {
      "description": "Last update date",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "appVersion",
    "createdAt",
    "current",
    "deviceOS",
    "deviceType",
    "id",
    "isPendingSyncReset",
    "updatedAt"
  ],
  "title": "SessionResponseDto",
  "type": "object"
}

Config:

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

Fields:

Validators:

app_version pydantic-field

app_version: Optional[StrictStr]

App version

created_at pydantic-field

created_at: StrictStr

Creation date

current pydantic-field

current: StrictBool

Is current session

device_os pydantic-field

device_os: StrictStr

Device OS

device_type pydantic-field

device_type: StrictStr

Device type

expires_at pydantic-field

expires_at: Optional[StrictStr] = None

Expiration date

id pydantic-field

id: UUID

Session ID

is_pending_sync_reset pydantic-field

is_pending_sync_reset: StrictBool

Is pending sync reset

updated_at pydantic-field

updated_at: StrictStr

Last update date

from_dict classmethod

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

Create an instance of SessionResponseDto from a dict

Source code in immichpy/client/generated/models/session_response_dto.py
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SessionResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "appVersion": obj.get("appVersion"),
            "createdAt": obj.get("createdAt"),
            "current": obj.get("current"),
            "deviceOS": obj.get("deviceOS"),
            "deviceType": obj.get("deviceType"),
            "expiresAt": obj.get("expiresAt"),
            "id": obj.get("id"),
            "isPendingSyncReset": obj.get("isPendingSyncReset"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of SessionResponseDto from a JSON string

Source code in immichpy/client/generated/models/session_response_dto.py
93
94
95
96
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SessionResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

id_validate_regular_expression pydantic-validator

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/session_response_dto.py
66
67
68
69
70
71
72
73
74
75
76
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    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_response_dto.py
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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 app_version (nullable) is None
    # and model_fields_set contains the field
    if self.app_version is None and "app_version" in self.model_fields_set:
        _dict["appVersion"] = None

    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/session_response_dto.py
89
90
91
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_response_dto.py
85
86
87
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))