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

immichpy/client/generated/models/asset_bulk_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.
@@ -39,25 +39,41 @@ class AssetBulkUpdateDto(BaseModel):
     """  # noqa: E501
 
     date_time_original: Optional[StrictStr] = Field(
-        default=None, alias="dateTimeOriginal"
+        default=None, description="Original date and time", alias="dateTimeOriginal"
     )
     date_time_relative: Optional[Union[StrictFloat, StrictInt]] = Field(
-        default=None, alias="dateTimeRelative"
+        default=None,
+        description="Relative time offset in seconds",
+        alias="dateTimeRelative",
+    )
+    description: Optional[StrictStr] = Field(
+        default=None, description="Asset description"
+    )
+    duplicate_id: Optional[StrictStr] = Field(
+        default=None, description="Duplicate asset ID", alias="duplicateId"
+    )
+    ids: List[UUID] = Field(description="Asset IDs to update")
+    is_favorite: Optional[StrictBool] = Field(
+        default=None, description="Mark as favorite", alias="isFavorite"
+    )
+    latitude: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None, description="Latitude coordinate"
+    )
+    longitude: Optional[Union[StrictFloat, StrictInt]] = Field(
+        default=None, description="Longitude coordinate"
     )
-    description: Optional[StrictStr] = None
-    duplicate_id: Optional[StrictStr] = Field(default=None, alias="duplicateId")
-    ids: List[UUID]
-    is_favorite: Optional[StrictBool] = Field(default=None, alias="isFavorite")
-    latitude: Optional[Union[StrictFloat, StrictInt]] = None
-    longitude: Optional[Union[StrictFloat, StrictInt]] = None
     rating: Optional[
         Union[
             Annotated[float, Field(le=5, strict=True, ge=-1)],
             Annotated[int, Field(le=5, strict=True, ge=-1)],
         ]
-    ] = None
-    time_zone: Optional[StrictStr] = Field(default=None, alias="timeZone")
-    visibility: Optional[AssetVisibility] = None
+    ] = Field(default=None, description="Rating")
+    time_zone: Optional[StrictStr] = Field(
+        default=None, description="Time zone (IANA timezone)", alias="timeZone"
+    )
+    visibility: Optional[AssetVisibility] = Field(
+        default=None, description="Asset visibility"
+    )
     __properties: ClassVar[List[str]] = [
         "dateTimeOriginal",
         "dateTimeRelative",

immichpy/client/generated/models/asset_bulk_upload_check_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_bulk_upload_check_item import (
     AssetBulkUploadCheckItem,
@@ -30,7 +30,7 @@ class AssetBulkUploadCheckDto(BaseModel):
     AssetBulkUploadCheckDto
     """  # noqa: E501
 
-    assets: List[AssetBulkUploadCheckItem]
+    assets: List[AssetBulkUploadCheckItem] = Field(description="Assets to check")
     __properties: ClassVar[List[str]] = ["assets"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_bulk_upload_check_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.
@@ -27,8 +27,8 @@ class AssetBulkUploadCheckItem(BaseModel):
     AssetBulkUploadCheckItem
     """  # noqa: E501
 
-    checksum: StrictStr = Field(description="base64 or hex encoded sha1 hash")
-    id: StrictStr
+    checksum: StrictStr = Field(description="Base64 or hex encoded SHA1 hash")
+    id: StrictStr = Field(description="Asset ID")
     __properties: ClassVar[List[str]] = ["checksum", "id"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_bulk_upload_check_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
+from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from immichpy.client.generated.models.asset_bulk_upload_check_result import (
     AssetBulkUploadCheckResult,
@@ -30,7 +30,9 @@ class AssetBulkUploadCheckResponseDto(BaseModel):
     AssetBulkUploadCheckResponseDto
     """  # noqa: E501
 
-    results: List[AssetBulkUploadCheckResult]
+    results: List[AssetBulkUploadCheckResult] = Field(
+        description="Upload check results"
+    )
     __properties: ClassVar[List[str]] = ["results"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_bulk_upload_check_result.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,11 +34,17 @@ class AssetBulkUploadCheckResult(BaseModel):
     AssetBulkUploadCheckResult
     """  # noqa: E501
 
-    action: StrictStr
-    asset_id: Optional[StrictStr] = Field(default=None, alias="assetId")
-    id: StrictStr
-    is_trashed: Optional[StrictBool] = Field(default=None, alias="isTrashed")
-    reason: Optional[StrictStr] = None
+    action: StrictStr = Field(description="Upload action")
+    asset_id: Optional[StrictStr] = Field(
+        default=None, description="Existing asset ID if duplicate", alias="assetId"
+    )
+    id: StrictStr = Field(description="Asset ID")
+    is_trashed: Optional[StrictBool] = Field(
+        default=None, description="Whether existing asset is trashed", alias="isTrashed"
+    )
+    reason: Optional[StrictStr] = Field(
+        default=None, description="Rejection reason if rejected"
+    )
     __properties: ClassVar[List[str]] = [
         "action",
         "assetId",

immichpy/client/generated/models/asset_copy_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,13 +28,21 @@ class AssetCopyDto(BaseModel):
     AssetCopyDto
     """  # noqa: E501
 
-    albums: Optional[StrictBool] = True
-    favorite: Optional[StrictBool] = True
-    shared_links: Optional[StrictBool] = Field(default=True, alias="sharedLinks")
-    sidecar: Optional[StrictBool] = True
-    source_id: UUID = Field(alias="sourceId")
-    stack: Optional[StrictBool] = True
-    target_id: UUID = Field(alias="targetId")
+    albums: Optional[StrictBool] = Field(
+        default=True, description="Copy album associations"
+    )
+    favorite: Optional[StrictBool] = Field(
+        default=True, description="Copy favorite status"
+    )
+    shared_links: Optional[StrictBool] = Field(
+        default=True, description="Copy shared links", alias="sharedLinks"
+    )
+    sidecar: Optional[StrictBool] = Field(default=True, description="Copy sidecar file")
+    source_id: UUID = Field(description="Source asset ID", alias="sourceId")
+    stack: Optional[StrictBool] = Field(
+        default=True, description="Copy stack association"
+    )
+    target_id: UUID = Field(description="Target asset ID", alias="targetId")
     __properties: ClassVar[List[str]] = [
         "albums",
         "favorite",

immichpy/client/generated/models/asset_delta_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.
@@ -29,8 +29,10 @@ class AssetDeltaSyncDto(BaseModel):
     AssetDeltaSyncDto
     """  # noqa: E501
 
-    updated_after: datetime = Field(alias="updatedAfter")
-    user_ids: List[UUID] = Field(alias="userIds")
+    updated_after: datetime = Field(
+        description="Sync assets updated after this date", alias="updatedAfter"
+    )
+    user_ids: List[UUID] = Field(description="User IDs to sync", alias="userIds")
     __properties: ClassVar[List[str]] = ["updatedAfter", "userIds"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_delta_sync_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.
@@ -28,9 +28,11 @@ class AssetDeltaSyncResponseDto(BaseModel):
     AssetDeltaSyncResponseDto
     """  # noqa: E501
 
-    deleted: List[StrictStr]
-    needs_full_sync: StrictBool = Field(alias="needsFullSync")
-    upserted: List[AssetResponseDto]
+    deleted: List[StrictStr] = Field(description="Deleted asset IDs")
+    needs_full_sync: StrictBool = Field(
+        description="Whether full sync is needed", alias="needsFullSync"
+    )
+    upserted: List[AssetResponseDto] = Field(description="Upserted assets")
     __properties: ClassVar[List[str]] = ["deleted", "needsFullSync", "upserted"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/asset_edit_action.py

@@ -0,0 +1,35 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AssetEditAction(str, Enum):
+    """
+    Type of edit action to perform
+    """
+
+    """
+    allowed enum values
+    """
+    CROP = "crop"
+    ROTATE = "rotate"
+    MIRROR = "mirror"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AssetEditAction from a JSON string"""
+        return cls(json.loads(json_str))

immichpy/client/generated/models/asset_edit_action_crop.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.crop_parameters import CropParameters
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class AssetEditActionCrop(BaseModel):
+    """
+    AssetEditActionCrop
+    """  # noqa: E501
+
+    action: AssetEditAction = Field(description="Type of edit action to perform")
+    parameters: CropParameters
+    __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 AssetEditActionCrop 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 AssetEditActionCrop 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": CropParameters.from_dict(obj["parameters"])
+                if obj.get("parameters") is not None
+                else None,
+            }
+        )
+        return _obj

immichpy/client/generated/models/asset_edit_action_list_dto.py

@@ -0,0 +1,104 @@
+# 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 immichpy.client.generated.models.asset_edit_action_list_dto_edits_inner import (
+    AssetEditActionListDtoEditsInner,
+)
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class AssetEditActionListDto(BaseModel):
+    """
+    AssetEditActionListDto
+    """  # noqa: E501
+
+    edits: Annotated[List[AssetEditActionListDtoEditsInner], Field(min_length=1)] = (
+        Field(description="List of edit actions to apply (crop, rotate, or mirror)")
+    )
+    __properties: ClassVar[List[str]] = ["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 AssetEditActionListDto 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 AssetEditActionListDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "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_edit_action_list_dto_edits_inner.py

@@ -0,0 +1,188 @@
+# 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 json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ValidationError, field_validator
+from typing import Optional
+from immichpy.client.generated.models.asset_edit_action_crop import AssetEditActionCrop
+from immichpy.client.generated.models.asset_edit_action_mirror import (
+    AssetEditActionMirror,
+)
+from immichpy.client.generated.models.asset_edit_action_rotate import (
+    AssetEditActionRotate,
+)
+from typing import Union, Any, Set, TYPE_CHECKING, Dict
+from typing_extensions import Self
+
+ASSETEDITACTIONLISTDTOEDITSINNER_ANY_OF_SCHEMAS = [
+    "AssetEditActionCrop",
+    "AssetEditActionMirror",
+    "AssetEditActionRotate",
+]
+
+
+class AssetEditActionListDtoEditsInner(BaseModel):
+    """
+    AssetEditActionListDtoEditsInner
+    """
+
+    # data type: AssetEditActionCrop
+    anyof_schema_1_validator: Optional[AssetEditActionCrop] = None
+    # data type: AssetEditActionRotate
+    anyof_schema_2_validator: Optional[AssetEditActionRotate] = None
+    # data type: AssetEditActionMirror
+    anyof_schema_3_validator: Optional[AssetEditActionMirror] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[
+            Union[AssetEditActionCrop, AssetEditActionMirror, AssetEditActionRotate]
+        ] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = {
+        "AssetEditActionCrop",
+        "AssetEditActionMirror",
+        "AssetEditActionRotate",
+    }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError(
+                    "If a position argument is used, only 1 is allowed to set `actual_instance`"
+                )
+            if kwargs:
+                raise ValueError(
+                    "If a position argument is used, keyword arguments cannot be used."
+                )
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator("actual_instance")
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = AssetEditActionListDtoEditsInner.model_construct()
+        error_messages = []
+        # validate data type: AssetEditActionCrop
+        if not isinstance(v, AssetEditActionCrop):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `AssetEditActionCrop`"
+            )
+        else:
+            return v
+
+        # validate data type: AssetEditActionRotate
+        if not isinstance(v, AssetEditActionRotate):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `AssetEditActionRotate`"
+            )
+        else:
+            return v
+
+        # validate data type: AssetEditActionMirror
+        if not isinstance(v, AssetEditActionMirror):
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `AssetEditActionMirror`"
+            )
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when setting the actual_instance in AssetEditActionListDtoEditsInner with anyOf schemas: AssetEditActionCrop, AssetEditActionMirror, AssetEditActionRotate. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[AssetEditActionCrop] = None
+        try:
+            instance.actual_instance = AssetEditActionCrop.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[AssetEditActionRotate] = None
+        try:
+            instance.actual_instance = AssetEditActionRotate.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[AssetEditActionMirror] = None
+        try:
+            instance.actual_instance = AssetEditActionMirror.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError(
+                "No match found when deserializing the JSON string into AssetEditActionListDtoEditsInner with anyOf schemas: AssetEditActionCrop, AssetEditActionMirror, AssetEditActionRotate. Details: "
+                + ", ".join(error_messages)
+            )
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(
+            self.actual_instance.to_json
+        ):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(
+        self,
+    ) -> Optional[
+        Union[
+            Dict[str, Any],
+            AssetEditActionCrop,
+            AssetEditActionMirror,
+            AssetEditActionRotate,
+        ]
+    ]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(
+            self.actual_instance.to_dict
+        ):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())