Skip to content

People Update Item

immichpy.client.generated.models.people_update_item.PeopleUpdateItem pydantic-model

Bases: BaseModel

PeopleUpdateItem

Show JSON schema: 
{
  "description": "PeopleUpdateItem",
  "properties": {
    "birthDate": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Person date of birth",
      "title": "Birthdate"
    },
    "color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Person color (hex)",
      "title": "Color"
    },
    "featureFaceAssetId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Asset ID used for feature face thumbnail",
      "title": "Featurefaceassetid"
    },
    "id": {
      "description": "Person ID",
      "title": "Id",
      "type": "string"
    },
    "isFavorite": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Mark as favorite",
      "title": "Isfavorite"
    },
    "isHidden": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Person visibility (hidden)",
      "title": "Ishidden"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Person name",
      "title": "Name"
    }
  },
  "required": [
    "id"
  ],
  "title": "PeopleUpdateItem",
  "type": "object"
}

Config:

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

Fields:

birth_date pydantic-field 

birth_date: Optional[date] = None

Person date of birth

color pydantic-field 

color: Optional[StrictStr] = None

Person color (hex)

feature_face_asset_id pydantic-field 

feature_face_asset_id: Optional[UUID] = None

Asset ID used for feature face thumbnail

id pydantic-field 

id: StrictStr

Person ID

is_favorite pydantic-field 

is_favorite: Optional[StrictBool] = None

Mark as favorite

is_hidden pydantic-field 

is_hidden: Optional[StrictBool] = None

Person visibility (hidden)

name pydantic-field 

name: Optional[StrictStr] = None

Person name

from_dict classmethod 

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

Create an instance of PeopleUpdateItem from a dict

Source code in immichpy/client/generated/models/people_update_item.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of PeopleUpdateItem from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "birthDate": obj.get("birthDate"),
            "color": obj.get("color"),
            "featureFaceAssetId": obj.get("featureFaceAssetId"),
            "id": obj.get("id"),
            "isFavorite": obj.get("isFavorite"),
            "isHidden": obj.get("isHidden"),
            "name": obj.get("name"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of PeopleUpdateItem from a JSON string

Source code in immichpy/client/generated/models/people_update_item.py 
74
75
76
77
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of PeopleUpdateItem 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/people_update_item.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
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 birth_date (nullable) is None
    # and model_fields_set contains the field
    if self.birth_date is None and "birth_date" in self.model_fields_set:
        _dict["birthDate"] = None

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

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/people_update_item.py 
69
70
71
72
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/people_update_item.py 
65
66
67
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))