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

immichpy/client/generated/models/maintenance_detect_install_response_dto.py

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

immichpy/client/generated/models/maintenance_detect_install_storage_folder_dto.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, StrictBool, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from immichpy.client.generated.models.storage_folder import StorageFolder
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class MaintenanceDetectInstallStorageFolderDto(BaseModel):
+    """
+    MaintenanceDetectInstallStorageFolderDto
+    """  # noqa: E501
+
+    files: Union[StrictFloat, StrictInt] = Field(
+        description="Number of files in the folder"
+    )
+    folder: StorageFolder = Field(description="Storage folder")
+    readable: StrictBool = Field(description="Whether the folder is readable")
+    writable: StrictBool = Field(description="Whether the folder is writable")
+    __properties: ClassVar[List[str]] = ["files", "folder", "readable", "writable"]
+
+    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 MaintenanceDetectInstallStorageFolderDto 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 MaintenanceDetectInstallStorageFolderDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "files": obj.get("files"),
+                "folder": obj.get("folder"),
+                "readable": obj.get("readable"),
+                "writable": obj.get("writable"),
+            }
+        )
+        return _obj

immichpy/client/generated/models/maintenance_login_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, Optional
 from typing import Set
 from typing_extensions import Self
@@ -27,7 +27,7 @@ class MaintenanceLoginDto(BaseModel):
     MaintenanceLoginDto
     """  # noqa: E501
 
-    token: Optional[StrictStr] = None
+    token: Optional[StrictStr] = Field(default=None, description="Maintenance token")
     __properties: ClassVar[List[str]] = ["token"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/maintenance_status_response_dto.py

@@ -0,0 +1,109 @@
+# 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,
+    StrictBool,
+    StrictFloat,
+    StrictInt,
+    StrictStr,
+)
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from immichpy.client.generated.models.maintenance_action import MaintenanceAction
+from typing import Set
+from typing_extensions import Self
+
+
+class MaintenanceStatusResponseDto(BaseModel):
+    """
+    MaintenanceStatusResponseDto
+    """  # noqa: E501
+
+    action: MaintenanceAction = Field(description="Maintenance action")
+    active: StrictBool
+    error: Optional[StrictStr] = None
+    progress: Optional[Union[StrictFloat, StrictInt]] = None
+    task: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = [
+        "action",
+        "active",
+        "error",
+        "progress",
+        "task",
+    ]
+
+    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 MaintenanceStatusResponseDto 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 MaintenanceStatusResponseDto 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"),
+                "active": obj.get("active"),
+                "error": obj.get("error"),
+                "progress": obj.get("progress"),
+                "task": obj.get("task"),
+            }
+        )
+        return _obj

immichpy/client/generated/models/manual_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 ManualJobName(str, Enum):
     """
-    ManualJobName
+    Job name
     """
 
     """

immichpy/client/generated/models/map_marker_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, StrictFloat, StrictInt, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Set
 from typing_extensions import Self
@@ -27,12 +27,12 @@ class MapMarkerResponseDto(BaseModel):
     MapMarkerResponseDto
     """  # noqa: E501
 
-    city: Optional[StrictStr]
-    country: Optional[StrictStr]
-    id: StrictStr
-    lat: Union[StrictFloat, StrictInt]
-    lon: Union[StrictFloat, StrictInt]
-    state: Optional[StrictStr]
+    city: Optional[StrictStr] = Field(description="City name")
+    country: Optional[StrictStr] = Field(description="Country name")
+    id: StrictStr = Field(description="Asset ID")
+    lat: Union[StrictFloat, StrictInt] = Field(description="Latitude")
+    lon: Union[StrictFloat, StrictInt] = Field(description="Longitude")
+    state: Optional[StrictStr] = Field(description="State/Province name")
     __properties: ClassVar[List[str]] = ["city", "country", "id", "lat", "lon", "state"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/map_reverse_geocode_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, Optional
 from typing import Set
 from typing_extensions import Self
@@ -27,9 +27,9 @@ class MapReverseGeocodeResponseDto(BaseModel):
     MapReverseGeocodeResponseDto
     """  # noqa: E501
 
-    city: Optional[StrictStr]
-    country: Optional[StrictStr]
-    state: Optional[StrictStr]
+    city: Optional[StrictStr] = Field(description="City name")
+    country: Optional[StrictStr] = Field(description="Country name")
+    state: Optional[StrictStr] = Field(description="State/Province name")
     __properties: ClassVar[List[str]] = ["city", "country", "state"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/memories_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.
@@ -16,7 +16,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -27,8 +27,8 @@ class MemoriesResponse(BaseModel):
     MemoriesResponse
     """  # noqa: E501
 
-    duration: StrictInt
-    enabled: StrictBool
+    duration: StrictInt = Field(description="Memory duration in seconds")
+    enabled: StrictBool = Field(description="Whether memories are enabled")
     __properties: ClassVar[List[str]] = ["duration", "enabled"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/memories_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.
@@ -28,8 +28,12 @@ class MemoriesUpdate(BaseModel):
     MemoriesUpdate
     """  # noqa: E501
 
-    duration: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
-    enabled: Optional[StrictBool] = None
+    duration: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(
+        default=None, description="Memory duration in seconds"
+    )
+    enabled: Optional[StrictBool] = Field(
+        default=None, description="Whether memories are enabled"
+    )
     __properties: ClassVar[List[str]] = ["duration", "enabled"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/memory_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.
@@ -31,12 +31,18 @@ class MemoryCreateDto(BaseModel):
     MemoryCreateDto
     """  # noqa: E501
 
-    asset_ids: Optional[List[UUID]] = Field(default=None, alias="assetIds")
+    asset_ids: Optional[List[UUID]] = Field(
+        default=None, description="Asset IDs to associate with memory", alias="assetIds"
+    )
     data: OnThisDayDto
-    is_saved: Optional[StrictBool] = Field(default=None, alias="isSaved")
-    memory_at: datetime = Field(alias="memoryAt")
-    seen_at: Optional[datetime] = Field(default=None, alias="seenAt")
-    type: MemoryType
+    is_saved: Optional[StrictBool] = Field(
+        default=None, description="Is memory saved", alias="isSaved"
+    )
+    memory_at: datetime = Field(description="Memory date", alias="memoryAt")
+    seen_at: Optional[datetime] = Field(
+        default=None, description="Date when memory was seen", alias="seenAt"
+    )
+    type: MemoryType = Field(description="Memory type")
     __properties: ClassVar[List[str]] = [
         "assetIds",
         "data",

immichpy/client/generated/models/memory_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.
@@ -32,18 +32,26 @@ class MemoryResponseDto(BaseModel):
     """  # noqa: E501
 
     assets: List[AssetResponseDto]
-    created_at: datetime = Field(alias="createdAt")
+    created_at: datetime = Field(description="Creation date", alias="createdAt")
     data: OnThisDayDto
-    deleted_at: Optional[datetime] = Field(default=None, alias="deletedAt")
-    hide_at: Optional[datetime] = Field(default=None, alias="hideAt")
-    id: StrictStr
-    is_saved: StrictBool = Field(alias="isSaved")
-    memory_at: datetime = Field(alias="memoryAt")
-    owner_id: StrictStr = Field(alias="ownerId")
-    seen_at: Optional[datetime] = Field(default=None, alias="seenAt")
-    show_at: Optional[datetime] = Field(default=None, alias="showAt")
-    type: MemoryType
-    updated_at: datetime = Field(alias="updatedAt")
+    deleted_at: Optional[datetime] = Field(
+        default=None, description="Deletion date", alias="deletedAt"
+    )
+    hide_at: Optional[datetime] = Field(
+        default=None, description="Date when memory should be hidden", alias="hideAt"
+    )
+    id: StrictStr = Field(description="Memory ID")
+    is_saved: StrictBool = Field(description="Is memory saved", alias="isSaved")
+    memory_at: datetime = Field(description="Memory date", alias="memoryAt")
+    owner_id: StrictStr = Field(description="Owner user ID", alias="ownerId")
+    seen_at: Optional[datetime] = Field(
+        default=None, description="Date when memory was seen", alias="seenAt"
+    )
+    show_at: Optional[datetime] = Field(
+        default=None, description="Date when memory should be shown", alias="showAt"
+    )
+    type: MemoryType = Field(description="Memory type")
+    updated_at: datetime = Field(description="Last update date", alias="updatedAt")
     __properties: ClassVar[List[str]] = [
         "assets",
         "createdAt",

immichpy/client/generated/models/memory_search_order.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.

immichpy/client/generated/models/memory_statistics_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, StrictInt
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -27,7 +27,7 @@ class MemoryStatisticsResponseDto(BaseModel):
     MemoryStatisticsResponseDto
     """  # noqa: E501
 
-    total: StrictInt
+    total: StrictInt = Field(description="Total number of memories")
     __properties: ClassVar[List[str]] = ["total"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/memory_type.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.

immichpy/client/generated/models/memory_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.
@@ -28,9 +28,15 @@ class MemoryUpdateDto(BaseModel):
     MemoryUpdateDto
     """  # noqa: E501
 
-    is_saved: Optional[StrictBool] = Field(default=None, alias="isSaved")
-    memory_at: Optional[datetime] = Field(default=None, alias="memoryAt")
-    seen_at: Optional[datetime] = Field(default=None, alias="seenAt")
+    is_saved: Optional[StrictBool] = Field(
+        default=None, description="Is memory saved", alias="isSaved"
+    )
+    memory_at: Optional[datetime] = Field(
+        default=None, description="Memory date", alias="memoryAt"
+    )
+    seen_at: Optional[datetime] = Field(
+        default=None, description="Date when memory was seen", alias="seenAt"
+    )
     __properties: ClassVar[List[str]] = ["isSaved", "memoryAt", "seenAt"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/merge_person_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 uuid import UUID
 from typing import Optional, Set
@@ -28,7 +28,7 @@ class MergePersonDto(BaseModel):
     MergePersonDto
     """  # noqa: E501
 
-    ids: List[UUID]
+    ids: List[UUID] = Field(description="Person IDs to merge")
     __properties: ClassVar[List[str]] = ["ids"]
 
     model_config = ConfigDict(