immichpy 1.6.5__py3-none-any.whl → 1.7.5__py3-none-any.whl

immichpy/client/generated/models/asset_edit_action_mirror.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+Immich
+
+Immich API
+
+The version of the OpenAPI document: 2.5.2
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from immichpy.client.generated.models.asset_edit_action import AssetEditAction
+from immichpy.client.generated.models.mirror_parameters import MirrorParameters
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class AssetEditActionMirror(BaseModel):
+    """
+    AssetEditActionMirror
+    """  # noqa: E501
+
+    action: AssetEditAction = Field(description="Type of edit action to perform")
+    parameters: MirrorParameters
+    __properties: ClassVar[List[str]] = ["action", "parameters"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    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())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AssetEditActionMirror from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of parameters
+        if self.parameters:
+            _dict["parameters"] = self.parameters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssetEditActionMirror 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"),
+                "parameters": MirrorParameters.from_dict(obj["parameters"])
+                if obj.get("parameters") is not None
+                else None,
+            }
+        )
+        return _obj

immichpy/client/generated/models/asset_edit_action_rotate.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+Immich
+
+Immich API
+
+The version of the OpenAPI document: 2.5.2
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from immichpy.client.generated.models.asset_edit_action import AssetEditAction
+from immichpy.client.generated.models.rotate_parameters import RotateParameters
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class AssetEditActionRotate(BaseModel):
+    """
+    AssetEditActionRotate
+    """  # noqa: E501
+
+    action: AssetEditAction = Field(description="Type of edit action to perform")
+    parameters: RotateParameters
+    __properties: ClassVar[List[str]] = ["action", "parameters"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    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())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AssetEditActionRotate from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of parameters
+        if self.parameters:
+            _dict["parameters"] = self.parameters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssetEditActionRotate 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"),
+                "parameters": RotateParameters.from_dict(obj["parameters"])
+                if obj.get("parameters") is not None
+                else None,
+            }
+        )
+        return _obj

immichpy/client/generated/models/asset_edits_dto.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+Immich
+
+Immich API
+
+The version of the OpenAPI document: 2.5.2
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List
+from typing_extensions import Annotated
+from uuid import UUID
+from immichpy.client.generated.models.asset_edit_action_list_dto_edits_inner import (
+    AssetEditActionListDtoEditsInner,
+)
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class AssetEditsDto(BaseModel):
+    """
+    AssetEditsDto
+    """  # noqa: E501
+
+    asset_id: UUID = Field(description="Asset ID to apply edits to", alias="assetId")
+    edits: Annotated[List[AssetEditActionListDtoEditsInner], Field(min_length=1)] = (
+        Field(description="List of edit actions to apply (crop, rotate, or mirror)")
+    )
+    __properties: ClassVar[List[str]] = ["assetId", "edits"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    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())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AssetEditsDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in edits (list)
+        _items = []
+        if self.edits:
+            for _item_edits in self.edits:
+                if _item_edits:
+                    _items.append(_item_edits.to_dict())
+            _dict["edits"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssetEditsDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "assetId": obj.get("assetId"),
+                "edits": [
+                    AssetEditActionListDtoEditsInner.from_dict(_item)
+                    for _item in obj["edits"]
+                ]
+                if obj.get("edits") is not None
+                else None,
+            }
+        )
+        return _obj

immichpy/client/generated/models/asset_face_create_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -28,14 +28,18 @@ class AssetFaceCreateDto(BaseModel):
     AssetFaceCreateDto
     """  # noqa: E501
 
-    asset_id: UUID = Field(alias="assetId")
-    height: StrictInt
-    image_height: StrictInt = Field(alias="imageHeight")
-    image_width: StrictInt = Field(alias="imageWidth")
-    person_id: UUID = Field(alias="personId")
-    width: StrictInt
-    x: StrictInt
-    y: StrictInt
+    asset_id: UUID = Field(description="Asset ID", alias="assetId")
+    height: StrictInt = Field(description="Face bounding box height")
+    image_height: StrictInt = Field(
+        description="Image height in pixels", alias="imageHeight"
+    )
+    image_width: StrictInt = Field(
+        description="Image width in pixels", alias="imageWidth"
+    )
+    person_id: UUID = Field(description="Person ID", alias="personId")
+    width: StrictInt = Field(description="Face bounding box width")
+    x: StrictInt = Field(description="Face bounding box X coordinate")
+    y: StrictInt = Field(description="Face bounding box Y coordinate")
     __properties: ClassVar[List[str]] = [
         "assetId",
         "height",

immichpy/client/generated/models/asset_face_delete_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -16,7 +16,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -27,7 +27,7 @@ class AssetFaceDeleteDto(BaseModel):
     AssetFaceDeleteDto
     """  # noqa: E501
 
-    force: StrictBool
+    force: StrictBool = Field(description="Force delete even if person has other faces")
     __properties: ClassVar[List[str]] = ["force"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_face_response_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -30,15 +30,31 @@ class AssetFaceResponseDto(BaseModel):
     AssetFaceResponseDto
     """  # noqa: E501
 
-    bounding_box_x1: StrictInt = Field(alias="boundingBoxX1")
-    bounding_box_x2: StrictInt = Field(alias="boundingBoxX2")
-    bounding_box_y1: StrictInt = Field(alias="boundingBoxY1")
-    bounding_box_y2: StrictInt = Field(alias="boundingBoxY2")
-    id: UUID
-    image_height: StrictInt = Field(alias="imageHeight")
-    image_width: StrictInt = Field(alias="imageWidth")
-    person: Optional[PersonResponseDto]
-    source_type: Optional[SourceType] = Field(default=None, alias="sourceType")
+    bounding_box_x1: StrictInt = Field(
+        description="Bounding box X1 coordinate", alias="boundingBoxX1"
+    )
+    bounding_box_x2: StrictInt = Field(
+        description="Bounding box X2 coordinate", alias="boundingBoxX2"
+    )
+    bounding_box_y1: StrictInt = Field(
+        description="Bounding box Y1 coordinate", alias="boundingBoxY1"
+    )
+    bounding_box_y2: StrictInt = Field(
+        description="Bounding box Y2 coordinate", alias="boundingBoxY2"
+    )
+    id: UUID = Field(description="Face ID")
+    image_height: StrictInt = Field(
+        description="Image height in pixels", alias="imageHeight"
+    )
+    image_width: StrictInt = Field(
+        description="Image width in pixels", alias="imageWidth"
+    )
+    person: Optional[PersonResponseDto] = Field(
+        description="Person associated with face"
+    )
+    source_type: Optional[SourceType] = Field(
+        default=None, description="Face detection source type", alias="sourceType"
+    )
     __properties: ClassVar[List[str]] = [
         "boundingBoxX1",
         "boundingBoxX2",

immichpy/client/generated/models/asset_face_update_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -16,7 +16,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from immichpy.client.generated.models.asset_face_update_item import AssetFaceUpdateItem
 from typing import Optional, Set
@@ -28,7 +28,7 @@ class AssetFaceUpdateDto(BaseModel):
     AssetFaceUpdateDto
     """  # noqa: E501
 
-    data: List[AssetFaceUpdateItem]
+    data: List[AssetFaceUpdateItem] = Field(description="Face update items")
     __properties: ClassVar[List[str]] = ["data"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_face_update_item.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -28,8 +28,8 @@ class AssetFaceUpdateItem(BaseModel):
     AssetFaceUpdateItem
     """  # noqa: E501
 
-    asset_id: UUID = Field(alias="assetId")
-    person_id: UUID = Field(alias="personId")
+    asset_id: UUID = Field(description="Asset ID", alias="assetId")
+    person_id: UUID = Field(description="Person ID", alias="personId")
     __properties: ClassVar[List[str]] = ["assetId", "personId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_face_without_person_response_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -29,14 +29,28 @@ class AssetFaceWithoutPersonResponseDto(BaseModel):
     AssetFaceWithoutPersonResponseDto
     """  # noqa: E501
 
-    bounding_box_x1: StrictInt = Field(alias="boundingBoxX1")
-    bounding_box_x2: StrictInt = Field(alias="boundingBoxX2")
-    bounding_box_y1: StrictInt = Field(alias="boundingBoxY1")
-    bounding_box_y2: StrictInt = Field(alias="boundingBoxY2")
-    id: UUID
-    image_height: StrictInt = Field(alias="imageHeight")
-    image_width: StrictInt = Field(alias="imageWidth")
-    source_type: Optional[SourceType] = Field(default=None, alias="sourceType")
+    bounding_box_x1: StrictInt = Field(
+        description="Bounding box X1 coordinate", alias="boundingBoxX1"
+    )
+    bounding_box_x2: StrictInt = Field(
+        description="Bounding box X2 coordinate", alias="boundingBoxX2"
+    )
+    bounding_box_y1: StrictInt = Field(
+        description="Bounding box Y1 coordinate", alias="boundingBoxY1"
+    )
+    bounding_box_y2: StrictInt = Field(
+        description="Bounding box Y2 coordinate", alias="boundingBoxY2"
+    )
+    id: UUID = Field(description="Face ID")
+    image_height: StrictInt = Field(
+        description="Image height in pixels", alias="imageHeight"
+    )
+    image_width: StrictInt = Field(
+        description="Image width in pixels", alias="imageWidth"
+    )
+    source_type: Optional[SourceType] = Field(
+        default=None, description="Face detection source type", alias="sourceType"
+    )
     __properties: ClassVar[List[str]] = [
         "boundingBoxX1",
         "boundingBoxX2",

immichpy/client/generated/models/asset_full_sync_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -30,10 +30,18 @@ class AssetFullSyncDto(BaseModel):
     AssetFullSyncDto
     """  # noqa: E501
 
-    last_id: Optional[UUID] = Field(default=None, alias="lastId")
-    limit: Annotated[int, Field(strict=True, ge=1)]
-    updated_until: datetime = Field(alias="updatedUntil")
-    user_id: Optional[UUID] = Field(default=None, alias="userId")
+    last_id: Optional[UUID] = Field(
+        default=None, description="Last asset ID (pagination)", alias="lastId"
+    )
+    limit: Annotated[int, Field(strict=True, ge=1)] = Field(
+        description="Maximum number of assets to return"
+    )
+    updated_until: datetime = Field(
+        description="Sync assets updated until this date", alias="updatedUntil"
+    )
+    user_id: Optional[UUID] = Field(
+        default=None, description="Filter by user ID", alias="userId"
+    )
     __properties: ClassVar[List[str]] = ["lastId", "limit", "updatedUntil", "userId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_ids_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -28,7 +28,7 @@ class AssetIdsDto(BaseModel):
     AssetIdsDto
     """  # noqa: E501
 
-    asset_ids: List[UUID] = Field(alias="assetIds")
+    asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds")
     __properties: ClassVar[List[str]] = ["assetIds"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_ids_response_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -34,9 +34,11 @@ class AssetIdsResponseDto(BaseModel):
     AssetIdsResponseDto
     """  # noqa: E501
 
-    asset_id: StrictStr = Field(alias="assetId")
-    error: Optional[StrictStr] = None
-    success: StrictBool
+    asset_id: StrictStr = Field(description="Asset ID", alias="assetId")
+    error: Optional[StrictStr] = Field(
+        default=None, description="Error reason if failed"
+    )
+    success: StrictBool = Field(description="Whether operation succeeded")
     __properties: ClassVar[List[str]] = ["assetId", "error", "success"]
 
     @field_validator("error")

immichpy/client/generated/models/asset_job_name.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -19,7 +19,7 @@ from typing_extensions import Self
 
 class AssetJobName(str, Enum):
     """
-    AssetJobName
+    Job name
     """
 
     """

immichpy/client/generated/models/asset_jobs_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -29,8 +29,8 @@ class AssetJobsDto(BaseModel):
     AssetJobsDto
     """  # noqa: E501
 
-    asset_ids: List[UUID] = Field(alias="assetIds")
-    name: AssetJobName
+    asset_ids: List[UUID] = Field(description="Asset IDs", alias="assetIds")
+    name: AssetJobName = Field(description="Job name")
     __properties: ClassVar[List[str]] = ["assetIds", "name"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_media_response_dto.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -16,7 +16,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List
 from immichpy.client.generated.models.asset_media_status import AssetMediaStatus
 from typing import Optional, Set
@@ -28,8 +28,8 @@ class AssetMediaResponseDto(BaseModel):
     AssetMediaResponseDto
     """  # noqa: E501
 
-    id: StrictStr
-    status: AssetMediaStatus
+    id: StrictStr = Field(description="Asset media ID")
+    status: AssetMediaStatus = Field(description="Upload status")
     __properties: ClassVar[List[str]] = ["id", "status"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_media_size.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -25,6 +25,7 @@ class AssetMediaSize(str, Enum):
     """
     allowed enum values
     """
+    ORIGINAL = "original"
     FULLSIZE = "fullsize"
     PREVIEW = "preview"
     THUMBNAIL = "thumbnail"