Skip to content

Sync Asset Edit V1

immichpy.client.generated.models.sync_asset_edit_v1.SyncAssetEditV1 pydantic-model

Bases: BaseModel

SyncAssetEditV1

Show JSON schema: 
{
  "$defs": {
    "AssetEditAction": {
      "description": "Type of edit action to perform",
      "enum": [
        "crop",
        "rotate",
        "mirror"
      ],
      "title": "AssetEditAction",
      "type": "string"
    }
  },
  "description": "SyncAssetEditV1",
  "properties": {
    "action": {
      "$ref": "#/$defs/AssetEditAction"
    },
    "assetId": {
      "description": "Asset ID",
      "format": "uuid",
      "title": "Assetid",
      "type": "string"
    },
    "id": {
      "description": "Edit ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "parameters": {
      "additionalProperties": true,
      "description": "Edit parameters",
      "title": "Parameters",
      "type": "object"
    },
    "sequence": {
      "description": "Edit sequence",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "title": "Sequence",
      "type": "integer"
    }
  },
  "required": [
    "action",
    "assetId",
    "id",
    "parameters",
    "sequence"
  ],
  "title": "SyncAssetEditV1",
  "type": "object"
}

Config:

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

Fields:

Validators:

asset_id pydantic-field 

asset_id: UUID

Asset ID

id pydantic-field 

id: UUID

Edit ID

parameters pydantic-field 

parameters: Dict[str, Any]

Edit parameters

sequence pydantic-field 

sequence: Annotated[int, Field(le=9007199254740991, strict=True, ge=-9007199254740991)]

Edit sequence

asset_id_validate_regular_expression pydantic-validator 

asset_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/sync_asset_edit_v1.py 
49
50
51
52
53
54
55
56
57
58
59
@field_validator("asset_id", mode="before")
def asset_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

from_dict classmethod 

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

Create an instance of SyncAssetEditV1 from a dict

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

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

    _obj = cls.model_validate(
        {
            "action": obj.get("action"),
            "assetId": obj.get("assetId"),
            "id": obj.get("id"),
            "parameters": obj.get("parameters"),
            "sequence": obj.get("sequence"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of SyncAssetEditV1 from a JSON string

Source code in immichpy/client/generated/models/sync_asset_edit_v1.py 
88
89
90
91
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncAssetEditV1 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_asset_edit_v1.py 
61
62
63
64
65
66
67
68
69
70
71
@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

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_asset_edit_v1.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
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_asset_edit_v1.py 
84
85
86
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_asset_edit_v1.py 
80
81
82
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))