Skip to content

Sync Person V1

immichpy.client.generated.models.sync_person_v1.SyncPersonV1 pydantic-model

Bases: BaseModel

SyncPersonV1

Show JSON schema: 
{
  "description": "SyncPersonV1",
  "properties": {
    "birthDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Birth date",
      "title": "Birthdate"
    },
    "color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Color",
      "title": "Color"
    },
    "createdAt": {
      "description": "Created at",
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "faceAssetId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Face asset ID",
      "title": "Faceassetid"
    },
    "id": {
      "description": "Person ID",
      "title": "Id",
      "type": "string"
    },
    "isFavorite": {
      "description": "Is favorite",
      "title": "Isfavorite",
      "type": "boolean"
    },
    "isHidden": {
      "description": "Is hidden",
      "title": "Ishidden",
      "type": "boolean"
    },
    "name": {
      "description": "Person name",
      "title": "Name",
      "type": "string"
    },
    "ownerId": {
      "description": "Owner ID",
      "title": "Ownerid",
      "type": "string"
    },
    "updatedAt": {
      "description": "Updated at",
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "birthDate",
    "color",
    "createdAt",
    "faceAssetId",
    "id",
    "isFavorite",
    "isHidden",
    "name",
    "ownerId",
    "updatedAt"
  ],
  "title": "SyncPersonV1",
  "type": "object"
}

Config:

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

Fields:

birth_date pydantic-field 

birth_date: Optional[datetime]

Birth date

color pydantic-field 

color: Optional[StrictStr]

Color

created_at pydantic-field 

created_at: datetime

Created at

face_asset_id pydantic-field 

face_asset_id: Optional[StrictStr]

Face asset ID

id pydantic-field 

id: StrictStr

Person ID

is_favorite pydantic-field 

is_favorite: StrictBool

Is favorite

is_hidden pydantic-field 

is_hidden: StrictBool

Is hidden

name pydantic-field 

name: StrictStr

Person name

owner_id pydantic-field 

owner_id: StrictStr

Owner ID

updated_at pydantic-field 

updated_at: datetime

Updated at

from_dict classmethod 

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

Create an instance of SyncPersonV1 from a dict

Source code in immichpy/client/generated/models/sync_person_v1.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SyncPersonV1 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"),
            "createdAt": obj.get("createdAt"),
            "faceAssetId": obj.get("faceAssetId"),
            "id": obj.get("id"),
            "isFavorite": obj.get("isFavorite"),
            "isHidden": obj.get("isHidden"),
            "name": obj.get("name"),
            "ownerId": obj.get("ownerId"),
            "updatedAt": obj.get("updatedAt"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of SyncPersonV1 from a JSON string

Source code in immichpy/client/generated/models/sync_person_v1.py 
71
72
73
74
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncPersonV1 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_person_v1.py 
 76
 77
 78
 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
107
108
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

    # set to None if face_asset_id (nullable) is None
    # and model_fields_set contains the field
    if self.face_asset_id is None and "face_asset_id" in self.model_fields_set:
        _dict["faceAssetId"] = 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_person_v1.py 
66
67
68
69
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_person_v1.py 
62
63
64
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))