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

immichpy/client/generated/models/create_library_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,13 +30,17 @@ class CreateLibraryDto(BaseModel):
     """  # noqa: E501
 
     exclusion_patterns: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = (
-        Field(default=None, alias="exclusionPatterns")
+        Field(
+            default=None,
+            description="Exclusion patterns (max 128)",
+            alias="exclusionPatterns",
+        )
     )
     import_paths: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = Field(
-        default=None, alias="importPaths"
+        default=None, description="Import paths (max 128)", alias="importPaths"
     )
-    name: Optional[StrictStr] = None
-    owner_id: UUID = Field(alias="ownerId")
+    name: Optional[StrictStr] = Field(default=None, description="Library name")
+    owner_id: UUID = Field(description="Owner user ID", alias="ownerId")
     __properties: ClassVar[List[str]] = [
         "exclusionPatterns",
         "importPaths",

immichpy/client/generated/models/create_profile_image_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,13 @@ class CreateProfileImageResponseDto(BaseModel):
     CreateProfileImageResponseDto
     """  # noqa: E501
 
-    profile_changed_at: datetime = Field(alias="profileChangedAt")
-    profile_image_path: StrictStr = Field(alias="profileImagePath")
-    user_id: StrictStr = Field(alias="userId")
+    profile_changed_at: datetime = Field(
+        description="Profile image change date", alias="profileChangedAt"
+    )
+    profile_image_path: StrictStr = Field(
+        description="Profile image file path", alias="profileImagePath"
+    )
+    user_id: StrictStr = Field(description="User ID", alias="userId")
     __properties: ClassVar[List[str]] = [
         "profileChangedAt",
         "profileImagePath",

immichpy/client/generated/models/crop_parameters.py

@@ -0,0 +1,105 @@
+# 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, Union
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class CropParameters(BaseModel):
+    """
+    CropParameters
+    """  # noqa: E501
+
+    height: Union[
+        Annotated[float, Field(strict=True, ge=1)],
+        Annotated[int, Field(strict=True, ge=1)],
+    ] = Field(description="Height of the crop")
+    width: Union[
+        Annotated[float, Field(strict=True, ge=1)],
+        Annotated[int, Field(strict=True, ge=1)],
+    ] = Field(description="Width of the crop")
+    x: Union[
+        Annotated[float, Field(strict=True, ge=0)],
+        Annotated[int, Field(strict=True, ge=0)],
+    ] = Field(description="Top-Left X coordinate of crop")
+    y: Union[
+        Annotated[float, Field(strict=True, ge=0)],
+        Annotated[int, Field(strict=True, ge=0)],
+    ] = Field(description="Top-Left Y coordinate of crop")
+    __properties: ClassVar[List[str]] = ["height", "width", "x", "y"]
+
+    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 CropParameters 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CropParameters from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "height": obj.get("height"),
+                "width": obj.get("width"),
+                "x": obj.get("x"),
+                "y": obj.get("y"),
+            }
+        )
+        return _obj

immichpy/client/generated/models/database_backup_config.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,12 +28,14 @@ class DatabaseBackupConfig(BaseModel):
     DatabaseBackupConfig
     """  # noqa: E501
 
-    cron_expression: StrictStr = Field(alias="cronExpression")
-    enabled: StrictBool
+    cron_expression: StrictStr = Field(
+        description="Cron expression", alias="cronExpression"
+    )
+    enabled: StrictBool = Field(description="Enabled")
     keep_last_amount: Union[
         Annotated[float, Field(strict=True, ge=1)],
         Annotated[int, Field(strict=True, ge=1)],
-    ] = Field(alias="keepLastAmount")
+    ] = Field(description="Keep last amount", alias="keepLastAmount")
     __properties: ClassVar[List[str]] = ["cronExpression", "enabled", "keepLastAmount"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/database_backup_delete_dto.py

@@ -0,0 +1,82 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class DatabaseBackupDeleteDto(BaseModel):
+    """
+    DatabaseBackupDeleteDto
+    """  # noqa: E501
+
+    backups: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["backups"]
+
+    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 DatabaseBackupDeleteDto 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatabaseBackupDeleteDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"backups": obj.get("backups")})
+        return _obj

immichpy/client/generated/models/database_backup_dto.py

@@ -0,0 +1,85 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class DatabaseBackupDto(BaseModel):
+    """
+    DatabaseBackupDto
+    """  # noqa: E501
+
+    filename: StrictStr
+    filesize: Union[StrictFloat, StrictInt]
+    __properties: ClassVar[List[str]] = ["filename", "filesize"]
+
+    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 DatabaseBackupDto 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatabaseBackupDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"filename": obj.get("filename"), "filesize": obj.get("filesize")}
+        )
+        return _obj

immichpy/client/generated/models/database_backup_list_response_dto.py

@@ -0,0 +1,98 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from immichpy.client.generated.models.database_backup_dto import DatabaseBackupDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class DatabaseBackupListResponseDto(BaseModel):
+    """
+    DatabaseBackupListResponseDto
+    """  # noqa: E501
+
+    backups: List[DatabaseBackupDto]
+    __properties: ClassVar[List[str]] = ["backups"]
+
+    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 DatabaseBackupListResponseDto 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 backups (list)
+        _items = []
+        if self.backups:
+            for _item_backups in self.backups:
+                if _item_backups:
+                    _items.append(_item_backups.to_dict())
+            _dict["backups"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatabaseBackupListResponseDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "backups": [
+                    DatabaseBackupDto.from_dict(_item) for _item in obj["backups"]
+                ]
+                if obj.get("backups") is not None
+                else None
+            }
+        )
+        return _obj

immichpy/client/generated/models/download_archive_info.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,10 @@ class DownloadArchiveInfo(BaseModel):
     DownloadArchiveInfo
     """  # noqa: E501
 
-    asset_ids: List[StrictStr] = Field(alias="assetIds")
-    size: StrictInt
+    asset_ids: List[StrictStr] = Field(
+        description="Asset IDs in this archive", alias="assetIds"
+    )
+    size: StrictInt = Field(description="Archive size in bytes")
     __properties: ClassVar[List[str]] = ["assetIds", "size"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/download_info_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,12 +29,18 @@ class DownloadInfoDto(BaseModel):
     DownloadInfoDto
     """  # noqa: E501
 
-    album_id: Optional[UUID] = Field(default=None, alias="albumId")
+    album_id: Optional[UUID] = Field(
+        default=None, description="Album ID to download", alias="albumId"
+    )
     archive_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
-        default=None, alias="archiveSize"
+        default=None, description="Archive size limit in bytes", alias="archiveSize"
+    )
+    asset_ids: Optional[List[UUID]] = Field(
+        default=None, description="Asset IDs to download", alias="assetIds"
+    )
+    user_id: Optional[UUID] = Field(
+        default=None, description="User ID to download assets from", alias="userId"
     )
-    asset_ids: Optional[List[UUID]] = Field(default=None, alias="assetIds")
-    user_id: Optional[UUID] = Field(default=None, alias="userId")
     __properties: ClassVar[List[str]] = ["albumId", "archiveSize", "assetIds", "userId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/download_response.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,13 @@ class DownloadResponse(BaseModel):
     DownloadResponse
     """  # noqa: E501
 
-    archive_size: StrictInt = Field(alias="archiveSize")
-    include_embedded_videos: StrictBool = Field(alias="includeEmbeddedVideos")
+    archive_size: StrictInt = Field(
+        description="Maximum archive size in bytes", alias="archiveSize"
+    )
+    include_embedded_videos: StrictBool = Field(
+        description="Whether to include embedded videos in downloads",
+        alias="includeEmbeddedVideos",
+    )
     __properties: ClassVar[List[str]] = ["archiveSize", "includeEmbeddedVideos"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/download_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,8 +28,8 @@ class DownloadResponseDto(BaseModel):
     DownloadResponseDto
     """  # noqa: E501
 
-    archives: List[DownloadArchiveInfo]
-    total_size: StrictInt = Field(alias="totalSize")
+    archives: List[DownloadArchiveInfo] = Field(description="Archive information")
+    total_size: StrictInt = Field(description="Total size in bytes", alias="totalSize")
     __properties: ClassVar[List[str]] = ["archives", "totalSize"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/download_update.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,10 +29,12 @@ class DownloadUpdate(BaseModel):
     """  # noqa: E501
 
     archive_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
-        default=None, alias="archiveSize"
+        default=None, description="Maximum archive size in bytes", alias="archiveSize"
     )
     include_embedded_videos: Optional[StrictBool] = Field(
-        default=None, alias="includeEmbeddedVideos"
+        default=None,
+        description="Whether to include embedded videos in downloads",
+        alias="includeEmbeddedVideos",
     )
     __properties: ClassVar[List[str]] = ["archiveSize", "includeEmbeddedVideos"]
 

immichpy/client/generated/models/duplicate_detection_config.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,11 +28,14 @@ class DuplicateDetectionConfig(BaseModel):
     DuplicateDetectionConfig
     """  # noqa: E501
 
-    enabled: StrictBool
+    enabled: StrictBool = Field(description="Whether the task is enabled")
     max_distance: Union[
         Annotated[float, Field(le=0.1, strict=True, ge=0.001)],
         Annotated[int, Field(le=0, strict=True, ge=1)],
-    ] = Field(alias="maxDistance")
+    ] = Field(
+        description="Maximum distance threshold for duplicate detection",
+        alias="maxDistance",
+    )
     __properties: ClassVar[List[str]] = ["enabled", "maxDistance"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/duplicate_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,8 +28,10 @@ class DuplicateResponseDto(BaseModel):
     DuplicateResponseDto
     """  # noqa: E501
 
-    assets: List[AssetResponseDto]
-    duplicate_id: StrictStr = Field(alias="duplicateId")
+    assets: List[AssetResponseDto] = Field(description="Duplicate assets")
+    duplicate_id: StrictStr = Field(
+        description="Duplicate group ID", alias="duplicateId"
+    )
     __properties: ClassVar[List[str]] = ["assets", "duplicateId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/email_notifications_response.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,9 +27,15 @@ class EmailNotificationsResponse(BaseModel):
     EmailNotificationsResponse
     """  # noqa: E501
 
-    album_invite: StrictBool = Field(alias="albumInvite")
-    album_update: StrictBool = Field(alias="albumUpdate")
-    enabled: StrictBool
+    album_invite: StrictBool = Field(
+        description="Whether to receive email notifications for album invites",
+        alias="albumInvite",
+    )
+    album_update: StrictBool = Field(
+        description="Whether to receive email notifications for album updates",
+        alias="albumUpdate",
+    )
+    enabled: StrictBool = Field(description="Whether email notifications are enabled")
     __properties: ClassVar[List[str]] = ["albumInvite", "albumUpdate", "enabled"]
 
     model_config = ConfigDict(