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",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "title": "Birthdate"
    },
    "color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Color",
      "title": "Color"
    },
    "createdAt": {
      "description": "Created at",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Createdat",
      "type": "string"
    },
    "faceAssetId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Face asset ID",
      "title": "Faceassetid"
    },
    "id": {
      "description": "Person ID",
      "format": "uuid",
      "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",
      "format": "uuid",
      "title": "Ownerid",
      "type": "string"
    },
    "updatedAt": {
      "description": "Updated at",
      "examples": [
        "2024-01-01T00:00:00Z"
      ],
      "format": "date-time",
      "title": "Updatedat",
      "type": "string"
    }
  },
  "required": [
    "birthDate",
    "color",
    "createdAt",
    "faceAssetId",
    "id",
    "isFavorite",
    "isHidden",
    "name",
    "ownerId",
    "updatedAt"
  ],
  "title": "SyncPersonV1",
  "type": "object"
}

Config:

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

Fields:

Validators:

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: UUID

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: UUID

Owner ID

updated_at pydantic-field 

updated_at: datetime

Updated at

birth_date_validate_regular_expression pydantic-validator 

birth_date_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_v1.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@field_validator("birth_date", mode="before")
def birth_date_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

created_at_validate_regular_expression pydantic-validator 

created_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_v1.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@field_validator("created_at", mode="before")
def created_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value

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 
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
@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 
155
156
157
158
@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))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_v1.py 
104
105
106
107
108
109
110
111
112
113
114
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

owner_id_validate_regular_expression pydantic-validator 

owner_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_v1.py 
116
117
118
119
120
121
122
123
124
125
126
@field_validator("owner_id", mode="before")
def owner_id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

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 
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
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 
151
152
153
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/sync_person_v1.py 
147
148
149
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))

updated_at_validate_regular_expression pydantic-validator 

updated_at_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_v1.py 
128
129
130
131
132
133
134
135
136
137
138
@field_validator("updated_at", mode="before")
def updated_at_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/"
        )
    return value