Skip to content

Sync Auth User V1

immichpy.client.generated.models.sync_auth_user_v1.SyncAuthUserV1 pydantic-model

Bases: BaseModel

SyncAuthUserV1

Show JSON schema:
{
  "$defs": {
    "UserAvatarColor": {
      "description": "Avatar color",
      "enum": [
        "primary",
        "pink",
        "red",
        "yellow",
        "blue",
        "green",
        "purple",
        "orange",
        "gray",
        "amber"
      ],
      "title": "UserAvatarColor",
      "type": "string"
    }
  },
  "description": "SyncAuthUserV1",
  "properties": {
    "avatarColor": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserAvatarColor"
        },
        {
          "type": "null"
        }
      ],
      "description": "User avatar color"
    },
    "deletedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "User deleted at",
      "title": "Deletedat"
    },
    "email": {
      "description": "User email",
      "title": "Email",
      "type": "string"
    },
    "hasProfileImage": {
      "description": "User has profile image",
      "title": "Hasprofileimage",
      "type": "boolean"
    },
    "id": {
      "description": "User ID",
      "title": "Id",
      "type": "string"
    },
    "isAdmin": {
      "description": "User is admin",
      "title": "Isadmin",
      "type": "boolean"
    },
    "name": {
      "description": "User name",
      "title": "Name",
      "type": "string"
    },
    "oauthId": {
      "description": "User OAuth ID",
      "title": "Oauthid",
      "type": "string"
    },
    "pinCode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "User pin code",
      "title": "Pincode"
    },
    "profileChangedAt": {
      "description": "User profile changed at",
      "format": "date-time",
      "title": "Profilechangedat",
      "type": "string"
    },
    "quotaSizeInBytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Quotasizeinbytes"
    },
    "quotaUsageInBytes": {
      "title": "Quotausageinbytes",
      "type": "integer"
    },
    "storageLabel": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "User storage label",
      "title": "Storagelabel"
    }
  },
  "required": [
    "avatarColor",
    "deletedAt",
    "email",
    "hasProfileImage",
    "id",
    "isAdmin",
    "name",
    "oauthId",
    "pinCode",
    "profileChangedAt",
    "quotaSizeInBytes",
    "quotaUsageInBytes",
    "storageLabel"
  ],
  "title": "SyncAuthUserV1",
  "type": "object"
}

Config:

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

Fields:

avatar_color pydantic-field

avatar_color: Optional[UserAvatarColor]

User avatar color

deleted_at pydantic-field

deleted_at: Optional[datetime]

User deleted at

email pydantic-field

email: StrictStr

User email

has_profile_image pydantic-field

has_profile_image: StrictBool

User has profile image

id pydantic-field

id: StrictStr

User ID

is_admin pydantic-field

is_admin: StrictBool

User is admin

name pydantic-field

name: StrictStr

User name

oauth_id pydantic-field

oauth_id: StrictStr

User OAuth ID

pin_code pydantic-field

pin_code: Optional[StrictStr]

User pin code

profile_changed_at pydantic-field

profile_changed_at: datetime

User profile changed at

storage_label pydantic-field

storage_label: Optional[StrictStr]

User storage label

from_dict classmethod

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

Create an instance of SyncAuthUserV1 from a dict

Source code in immichpy/client/generated/models/sync_auth_user_v1.py
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SyncAuthUserV1 from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "avatarColor": obj.get("avatarColor"),
            "deletedAt": obj.get("deletedAt"),
            "email": obj.get("email"),
            "hasProfileImage": obj.get("hasProfileImage"),
            "id": obj.get("id"),
            "isAdmin": obj.get("isAdmin"),
            "name": obj.get("name"),
            "oauthId": obj.get("oauthId"),
            "pinCode": obj.get("pinCode"),
            "profileChangedAt": obj.get("profileChangedAt"),
            "quotaSizeInBytes": obj.get("quotaSizeInBytes"),
            "quotaUsageInBytes": obj.get("quotaUsageInBytes"),
            "storageLabel": obj.get("storageLabel"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of SyncAuthUserV1 from a JSON string

Source code in immichpy/client/generated/models/sync_auth_user_v1.py
86
87
88
89
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncAuthUserV1 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/sync_auth_user_v1.py
 91
 92
 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
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 avatar_color (nullable) is None
    # and model_fields_set contains the field
    if self.avatar_color is None and "avatar_color" in self.model_fields_set:
        _dict["avatarColor"] = None

    # set to None if deleted_at (nullable) is None
    # and model_fields_set contains the field
    if self.deleted_at is None and "deleted_at" in self.model_fields_set:
        _dict["deletedAt"] = None

    # set to None if pin_code (nullable) is None
    # and model_fields_set contains the field
    if self.pin_code is None and "pin_code" in self.model_fields_set:
        _dict["pinCode"] = None

    # set to None if quota_size_in_bytes (nullable) is None
    # and model_fields_set contains the field
    if (
        self.quota_size_in_bytes is None
        and "quota_size_in_bytes" in self.model_fields_set
    ):
        _dict["quotaSizeInBytes"] = None

    # set to None if storage_label (nullable) is None
    # and model_fields_set contains the field
    if self.storage_label is None and "storage_label" in self.model_fields_set:
        _dict["storageLabel"] = None

    return _dict

to_json

to_json() -> str

Returns the JSON representation of the model using alias

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