Skip to content

Sync Person Delete V1

immichpy.client.generated.models.sync_person_delete_v1.SyncPersonDeleteV1 pydantic-model

Bases: BaseModel

SyncPersonDeleteV1

Show JSON schema:
{
  "description": "SyncPersonDeleteV1",
  "properties": {
    "personId": {
      "description": "Person ID",
      "format": "uuid",
      "title": "Personid",
      "type": "string"
    }
  },
  "required": [
    "personId"
  ],
  "title": "SyncPersonDeleteV1",
  "type": "object"
}

Config:

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

Fields:

Validators:

person_id pydantic-field

person_id: UUID

Person ID

from_dict classmethod

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

Create an instance of SyncPersonDeleteV1 from a dict

Source code in immichpy/client/generated/models/sync_person_delete_v1.py
86
87
88
89
90
91
92
93
94
95
96
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SyncPersonDeleteV1 from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({"personId": obj.get("personId")})
    return _obj

from_json classmethod

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

Create an instance of SyncPersonDeleteV1 from a JSON string

Source code in immichpy/client/generated/models/sync_person_delete_v1.py
62
63
64
65
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncPersonDeleteV1 from a JSON string"""
    return cls.from_dict(json.loads(json_str))

person_id_validate_regular_expression pydantic-validator

person_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_person_delete_v1.py
35
36
37
38
39
40
41
42
43
44
45
@field_validator("person_id", mode="before")
def person_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_delete_v1.py
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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,
    )
    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_delete_v1.py
58
59
60
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_delete_v1.py
54
55
56
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))