Skip to content

User Config Dto

immichpy.client.generated.models.user_config_dto.UserConfigDto pydantic-model

Bases: BaseModel

Configuration properties that are visible to a logged user

Show JSON schema: 
{
  "$defs": {
    "HlsVideoResolution": {
      "description": "HLS video resolution",
      "enum": [
        480,
        720,
        1080,
        1440,
        2160
      ],
      "title": "HlsVideoResolution",
      "type": "integer"
    },
    "UserConfigClipDto": {
      "description": "UserConfigClipDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigClipDto",
      "type": "object"
    },
    "UserConfigDuplicateDetectionDto": {
      "description": "UserConfigDuplicateDetectionDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigDuplicateDetectionDto",
      "type": "object"
    },
    "UserConfigFFmpegDto": {
      "description": "UserConfigFFmpegDto",
      "properties": {
        "realtime": {
          "$ref": "#/$defs/UserConfigFFmpegRealtimeDto"
        }
      },
      "required": [
        "realtime"
      ],
      "title": "UserConfigFFmpegDto",
      "type": "object"
    },
    "UserConfigFFmpegRealtimeDto": {
      "description": "UserConfigFFmpegRealtimeDto",
      "properties": {
        "enabled": {
          "description": "Enable real-time HLS transcoding (alpha)",
          "title": "Enabled",
          "type": "boolean"
        },
        "resolutions": {
          "description": "Resolutions to use for real-time HLS transcoding",
          "items": {
            "$ref": "#/$defs/HlsVideoResolution"
          },
          "title": "Resolutions",
          "type": "array"
        },
        "videoCodecs": {
          "description": "Video codecs to use for real-time HLS transcoding",
          "items": {
            "$ref": "#/$defs/VideoCodec"
          },
          "title": "Videocodecs",
          "type": "array"
        }
      },
      "required": [
        "enabled",
        "resolutions",
        "videoCodecs"
      ],
      "title": "UserConfigFFmpegRealtimeDto",
      "type": "object"
    },
    "UserConfigFacialRecognitionDto": {
      "description": "UserConfigFacialRecognitionDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "minFaces": {
          "description": "Minimum number of faces required for recognition",
          "maximum": 9007199254740991,
          "minimum": 1,
          "title": "Minfaces",
          "type": "integer"
        }
      },
      "required": [
        "enabled",
        "minFaces"
      ],
      "title": "UserConfigFacialRecognitionDto",
      "type": "object"
    },
    "UserConfigGeneratedFullsizeImageDto": {
      "description": "UserConfigGeneratedFullsizeImageDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigGeneratedFullsizeImageDto",
      "type": "object"
    },
    "UserConfigGeneratedImageDto": {
      "description": "UserConfigGeneratedImageDto",
      "properties": {
        "size": {
          "description": "Size",
          "maximum": 9007199254740991,
          "minimum": 1,
          "title": "Size",
          "type": "integer"
        }
      },
      "required": [
        "size"
      ],
      "title": "UserConfigGeneratedImageDto",
      "type": "object"
    },
    "UserConfigImageDto": {
      "description": "UserConfigImageDto",
      "properties": {
        "fullsize": {
          "$ref": "#/$defs/UserConfigGeneratedFullsizeImageDto"
        },
        "preview": {
          "$ref": "#/$defs/UserConfigGeneratedImageDto"
        },
        "thumbnail": {
          "$ref": "#/$defs/UserConfigGeneratedImageDto"
        }
      },
      "required": [
        "fullsize",
        "preview",
        "thumbnail"
      ],
      "title": "UserConfigImageDto",
      "type": "object"
    },
    "UserConfigMachineLearningDto": {
      "description": "UserConfigMachineLearningDto",
      "properties": {
        "clip": {
          "$ref": "#/$defs/UserConfigClipDto"
        },
        "duplicateDetection": {
          "$ref": "#/$defs/UserConfigDuplicateDetectionDto"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "facialRecognition": {
          "$ref": "#/$defs/UserConfigFacialRecognitionDto"
        },
        "ocr": {
          "$ref": "#/$defs/UserConfigOcrDto"
        }
      },
      "required": [
        "clip",
        "duplicateDetection",
        "enabled",
        "facialRecognition",
        "ocr"
      ],
      "title": "UserConfigMachineLearningDto",
      "type": "object"
    },
    "UserConfigMapDto": {
      "description": "UserConfigMapDto",
      "properties": {
        "darkStyle": {
          "description": "Dark map style URL",
          "title": "Darkstyle",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        },
        "lightStyle": {
          "description": "Light map style URL",
          "title": "Lightstyle",
          "type": "string"
        }
      },
      "required": [
        "darkStyle",
        "enabled",
        "lightStyle"
      ],
      "title": "UserConfigMapDto",
      "type": "object"
    },
    "UserConfigOAuthDto": {
      "description": "UserConfigOAuthDto",
      "properties": {
        "autoLaunch": {
          "description": "Auto launch",
          "title": "Autolaunch",
          "type": "boolean"
        },
        "buttonText": {
          "description": "Button text",
          "title": "Buttontext",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "autoLaunch",
        "buttonText",
        "enabled"
      ],
      "title": "UserConfigOAuthDto",
      "type": "object"
    },
    "UserConfigOcrDto": {
      "description": "UserConfigOcrDto",
      "properties": {
        "enabled": {
          "description": "Whether the task is enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigOcrDto",
      "type": "object"
    },
    "UserConfigPasswordLoginDto": {
      "description": "UserConfigPasswordLoginDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigPasswordLoginDto",
      "type": "object"
    },
    "UserConfigReverseGeocodingDto": {
      "description": "UserConfigReverseGeocodingDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "UserConfigReverseGeocodingDto",
      "type": "object"
    },
    "UserConfigServerDto": {
      "description": "UserConfigServerDto",
      "properties": {
        "externalDomain": {
          "description": "External domain",
          "title": "Externaldomain",
          "type": "string"
        },
        "loginPageMessage": {
          "description": "Login page message",
          "title": "Loginpagemessage",
          "type": "string"
        },
        "publicUsers": {
          "description": "Public users",
          "title": "Publicusers",
          "type": "boolean"
        }
      },
      "required": [
        "externalDomain",
        "loginPageMessage",
        "publicUsers"
      ],
      "title": "UserConfigServerDto",
      "type": "object"
    },
    "UserConfigThemeDto": {
      "description": "UserConfigThemeDto",
      "properties": {
        "customCss": {
          "description": "Custom CSS for theming",
          "title": "Customcss",
          "type": "string"
        }
      },
      "required": [
        "customCss"
      ],
      "title": "UserConfigThemeDto",
      "type": "object"
    },
    "UserConfigTrashDto": {
      "description": "UserConfigTrashDto",
      "properties": {
        "days": {
          "description": "Days",
          "maximum": 9007199254740991,
          "minimum": 0,
          "title": "Days",
          "type": "integer"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "days",
        "enabled"
      ],
      "title": "UserConfigTrashDto",
      "type": "object"
    },
    "UserConfigUserDto": {
      "description": "UserConfigUserDto",
      "properties": {
        "deleteDelay": {
          "description": "Delete delay",
          "maximum": 9007199254740991,
          "minimum": 1,
          "title": "Deletedelay",
          "type": "integer"
        }
      },
      "required": [
        "deleteDelay"
      ],
      "title": "UserConfigUserDto",
      "type": "object"
    },
    "VideoCodec": {
      "description": "Target video codec",
      "enum": [
        "h264",
        "hevc",
        "vp9",
        "av1"
      ],
      "title": "VideoCodec",
      "type": "string"
    }
  },
  "description": "Configuration properties that are visible to a logged user",
  "properties": {
    "ffmpeg": {
      "$ref": "#/$defs/UserConfigFFmpegDto"
    },
    "image": {
      "$ref": "#/$defs/UserConfigImageDto"
    },
    "machineLearning": {
      "$ref": "#/$defs/UserConfigMachineLearningDto"
    },
    "map": {
      "$ref": "#/$defs/UserConfigMapDto"
    },
    "oauth": {
      "$ref": "#/$defs/UserConfigOAuthDto"
    },
    "passwordLogin": {
      "$ref": "#/$defs/UserConfigPasswordLoginDto"
    },
    "reverseGeocoding": {
      "$ref": "#/$defs/UserConfigReverseGeocodingDto"
    },
    "server": {
      "$ref": "#/$defs/UserConfigServerDto"
    },
    "theme": {
      "$ref": "#/$defs/UserConfigThemeDto"
    },
    "trash": {
      "$ref": "#/$defs/UserConfigTrashDto"
    },
    "user": {
      "$ref": "#/$defs/UserConfigUserDto"
    }
  },
  "required": [
    "ffmpeg",
    "image",
    "machineLearning",
    "map",
    "oauth",
    "passwordLogin",
    "reverseGeocoding",
    "server",
    "theme",
    "trash",
    "user"
  ],
  "title": "UserConfigDto",
  "type": "object"
}

Config:

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

Fields:

from_dict classmethod 

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

Create an instance of UserConfigDto from a dict

Source code in immichpy/client/generated/models/user_config_dto.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of UserConfigDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "ffmpeg": UserConfigFFmpegDto.from_dict(obj["ffmpeg"])
            if obj.get("ffmpeg") is not None
            else None,
            "image": UserConfigImageDto.from_dict(obj["image"])
            if obj.get("image") is not None
            else None,
            "machineLearning": UserConfigMachineLearningDto.from_dict(
                obj["machineLearning"]
            )
            if obj.get("machineLearning") is not None
            else None,
            "map": UserConfigMapDto.from_dict(obj["map"])
            if obj.get("map") is not None
            else None,
            "oauth": UserConfigOAuthDto.from_dict(obj["oauth"])
            if obj.get("oauth") is not None
            else None,
            "passwordLogin": UserConfigPasswordLoginDto.from_dict(
                obj["passwordLogin"]
            )
            if obj.get("passwordLogin") is not None
            else None,
            "reverseGeocoding": UserConfigReverseGeocodingDto.from_dict(
                obj["reverseGeocoding"]
            )
            if obj.get("reverseGeocoding") is not None
            else None,
            "server": UserConfigServerDto.from_dict(obj["server"])
            if obj.get("server") is not None
            else None,
            "theme": UserConfigThemeDto.from_dict(obj["theme"])
            if obj.get("theme") is not None
            else None,
            "trash": UserConfigTrashDto.from_dict(obj["trash"])
            if obj.get("trash") is not None
            else None,
            "user": UserConfigUserDto.from_dict(obj["user"])
            if obj.get("user") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of UserConfigDto from a JSON string

Source code in immichpy/client/generated/models/user_config_dto.py 
88
89
90
91
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of UserConfigDto 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_config_dto.py 
 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
132
133
134
135
136
137
138
139
140
141
142
143
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,
    )
    # override the default output from pydantic by calling `to_dict()` of ffmpeg
    if self.ffmpeg:
        _dict["ffmpeg"] = self.ffmpeg.to_dict()
    # override the default output from pydantic by calling `to_dict()` of image
    if self.image:
        _dict["image"] = self.image.to_dict()
    # override the default output from pydantic by calling `to_dict()` of machine_learning
    if self.machine_learning:
        _dict["machineLearning"] = self.machine_learning.to_dict()
    # override the default output from pydantic by calling `to_dict()` of map
    if self.map:
        _dict["map"] = self.map.to_dict()
    # override the default output from pydantic by calling `to_dict()` of oauth
    if self.oauth:
        _dict["oauth"] = self.oauth.to_dict()
    # override the default output from pydantic by calling `to_dict()` of password_login
    if self.password_login:
        _dict["passwordLogin"] = self.password_login.to_dict()
    # override the default output from pydantic by calling `to_dict()` of reverse_geocoding
    if self.reverse_geocoding:
        _dict["reverseGeocoding"] = self.reverse_geocoding.to_dict()
    # override the default output from pydantic by calling `to_dict()` of server
    if self.server:
        _dict["server"] = self.server.to_dict()
    # override the default output from pydantic by calling `to_dict()` of theme
    if self.theme:
        _dict["theme"] = self.theme.to_dict()
    # override the default output from pydantic by calling `to_dict()` of trash
    if self.trash:
        _dict["trash"] = self.trash.to_dict()
    # override the default output from pydantic by calling `to_dict()` of user
    if self.user:
        _dict["user"] = self.user.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

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