Skip to content

Public Config Dto

immichpy.client.generated.models.public_config_dto.PublicConfigDto pydantic-model

Bases: BaseModel

Configuration properties that are visible to everyone

Show JSON schema: 
{
  "$defs": {
    "PublicConfigOAuthDto": {
      "description": "PublicConfigOAuthDto",
      "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": "PublicConfigOAuthDto",
      "type": "object"
    },
    "PublicConfigPasswordLoginDto": {
      "description": "PublicConfigPasswordLoginDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "PublicConfigPasswordLoginDto",
      "type": "object"
    },
    "PublicConfigServerDto": {
      "description": "PublicConfigServerDto",
      "properties": {
        "loginPageMessage": {
          "description": "Login page message",
          "title": "Loginpagemessage",
          "type": "string"
        }
      },
      "required": [
        "loginPageMessage"
      ],
      "title": "PublicConfigServerDto",
      "type": "object"
    },
    "PublicConfigThemeDto": {
      "description": "PublicConfigThemeDto",
      "properties": {
        "customCss": {
          "description": "Custom CSS for theming",
          "title": "Customcss",
          "type": "string"
        }
      },
      "required": [
        "customCss"
      ],
      "title": "PublicConfigThemeDto",
      "type": "object"
    }
  },
  "description": "Configuration properties that are visible to everyone",
  "properties": {
    "oauth": {
      "$ref": "#/$defs/PublicConfigOAuthDto"
    },
    "passwordLogin": {
      "$ref": "#/$defs/PublicConfigPasswordLoginDto"
    },
    "server": {
      "$ref": "#/$defs/PublicConfigServerDto"
    },
    "theme": {
      "$ref": "#/$defs/PublicConfigThemeDto"
    }
  },
  "required": [
    "oauth",
    "passwordLogin",
    "server",
    "theme"
  ],
  "title": "PublicConfigDto",
  "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 PublicConfigDto from a dict

Source code in immichpy/client/generated/models/public_config_dto.py 
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
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PublicConfigDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "oauth": PublicConfigOAuthDto.from_dict(obj["oauth"])
            if obj.get("oauth") is not None
            else None,
            "passwordLogin": PublicConfigPasswordLoginDto.from_dict(
                obj["passwordLogin"]
            )
            if obj.get("passwordLogin") is not None
            else None,
            "server": PublicConfigServerDto.from_dict(obj["server"])
            if obj.get("server") is not None
            else None,
            "theme": PublicConfigThemeDto.from_dict(obj["theme"])
            if obj.get("theme") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PublicConfigDto from a JSON string

Source code in immichpy/client/generated/models/public_config_dto.py 
64
65
66
67
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PublicConfigDto 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/public_config_dto.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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 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 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()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/public_config_dto.py 
60
61
62
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/public_config_dto.py 
56
57
58
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))