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

immichpy/client/generated/models/plugin_action_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.
@@ -18,7 +18,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from immichpy.client.generated.models.plugin_context import PluginContext
+from immichpy.client.generated.models.plugin_context_type import PluginContextType
 from typing import Set
 from typing_extensions import Self
 
@@ -28,13 +28,17 @@ class PluginActionResponseDto(BaseModel):
     PluginActionResponseDto
     """  # noqa: E501
 
-    description: StrictStr
-    id: StrictStr
-    method_name: StrictStr = Field(alias="methodName")
-    plugin_id: StrictStr = Field(alias="pluginId")
-    var_schema: Optional[Dict[str, Any]] = Field(alias="schema")
-    supported_contexts: List[PluginContext] = Field(alias="supportedContexts")
-    title: StrictStr
+    description: StrictStr = Field(description="Action description")
+    id: StrictStr = Field(description="Action ID")
+    method_name: StrictStr = Field(description="Method name", alias="methodName")
+    plugin_id: StrictStr = Field(description="Plugin ID", alias="pluginId")
+    var_schema: Optional[Dict[str, Any]] = Field(
+        description="Action schema", alias="schema"
+    )
+    supported_contexts: List[PluginContextType] = Field(
+        description="Supported contexts", alias="supportedContexts"
+    )
+    title: StrictStr = Field(description="Action title")
     __properties: ClassVar[List[str]] = [
         "description",
         "id",

immichpy/client/generated/models/{plugin_context.py → plugin_context_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.
@@ -17,9 +17,9 @@ from enum import Enum
 from typing_extensions import Self
 
 
-class PluginContext(str, Enum):
+class PluginContextType(str, Enum):
     """
-    PluginContext
+    Context type
     """
 
     """
@@ -31,5 +31,5 @@ class PluginContext(str, Enum):
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:
-        """Create an instance of PluginContext from a JSON string"""
+        """Create an instance of PluginContextType from a JSON string"""
         return cls(json.loads(json_str))

immichpy/client/generated/models/plugin_filter_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.
@@ -18,7 +18,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from immichpy.client.generated.models.plugin_context import PluginContext
+from immichpy.client.generated.models.plugin_context_type import PluginContextType
 from typing import Set
 from typing_extensions import Self
 
@@ -28,13 +28,17 @@ class PluginFilterResponseDto(BaseModel):
     PluginFilterResponseDto
     """  # noqa: E501
 
-    description: StrictStr
-    id: StrictStr
-    method_name: StrictStr = Field(alias="methodName")
-    plugin_id: StrictStr = Field(alias="pluginId")
-    var_schema: Optional[Dict[str, Any]] = Field(alias="schema")
-    supported_contexts: List[PluginContext] = Field(alias="supportedContexts")
-    title: StrictStr
+    description: StrictStr = Field(description="Filter description")
+    id: StrictStr = Field(description="Filter ID")
+    method_name: StrictStr = Field(description="Method name", alias="methodName")
+    plugin_id: StrictStr = Field(description="Plugin ID", alias="pluginId")
+    var_schema: Optional[Dict[str, Any]] = Field(
+        description="Filter schema", alias="schema"
+    )
+    supported_contexts: List[PluginContextType] = Field(
+        description="Supported contexts", alias="supportedContexts"
+    )
+    title: StrictStr = Field(description="Filter title")
     __properties: ClassVar[List[str]] = [
         "description",
         "id",

immichpy/client/generated/models/plugin_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.
@@ -33,16 +33,16 @@ class PluginResponseDto(BaseModel):
     PluginResponseDto
     """  # noqa: E501
 
-    actions: List[PluginActionResponseDto]
-    author: StrictStr
-    created_at: StrictStr = Field(alias="createdAt")
-    description: StrictStr
-    filters: List[PluginFilterResponseDto]
-    id: StrictStr
-    name: StrictStr
-    title: StrictStr
-    updated_at: StrictStr = Field(alias="updatedAt")
-    version: StrictStr
+    actions: List[PluginActionResponseDto] = Field(description="Plugin actions")
+    author: StrictStr = Field(description="Plugin author")
+    created_at: StrictStr = Field(description="Creation date", alias="createdAt")
+    description: StrictStr = Field(description="Plugin description")
+    filters: List[PluginFilterResponseDto] = Field(description="Plugin filters")
+    id: StrictStr = Field(description="Plugin ID")
+    name: StrictStr = Field(description="Plugin name")
+    title: StrictStr = Field(description="Plugin title")
+    updated_at: StrictStr = Field(description="Last update date", alias="updatedAt")
+    version: StrictStr = Field(description="Plugin version")
     __properties: ClassVar[List[str]] = [
         "actions",
         "author",

immichpy/client/generated/models/plugin_trigger_response_dto.py

@@ -0,0 +1,89 @@
+# 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.plugin_context_type import PluginContextType
+from immichpy.client.generated.models.plugin_trigger_type import PluginTriggerType
+from typing import Optional, Set
+from typing_extensions import Self
+
+
+class PluginTriggerResponseDto(BaseModel):
+    """
+    PluginTriggerResponseDto
+    """  # noqa: E501
+
+    context_type: PluginContextType = Field(
+        description="Context type", alias="contextType"
+    )
+    type: PluginTriggerType = Field(description="Trigger type")
+    __properties: ClassVar[List[str]] = ["contextType", "type"]
+
+    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 PluginTriggerResponseDto 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 PluginTriggerResponseDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {"contextType": obj.get("contextType"), "type": obj.get("type")}
+        )
+        return _obj

immichpy/client/generated/models/plugin_trigger_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.
@@ -19,7 +19,7 @@ from typing_extensions import Self
 
 class PluginTriggerType(str, Enum):
     """
-    PluginTriggerType
+    Trigger type
     """
 
     """

immichpy/client/generated/models/purchase_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,12 @@ class PurchaseResponse(BaseModel):
     PurchaseResponse
     """  # noqa: E501
 
-    hide_buy_button_until: StrictStr = Field(alias="hideBuyButtonUntil")
-    show_support_badge: StrictBool = Field(alias="showSupportBadge")
+    hide_buy_button_until: StrictStr = Field(
+        description="Date until which to hide buy button", alias="hideBuyButtonUntil"
+    )
+    show_support_badge: StrictBool = Field(
+        description="Whether to show support badge", alias="showSupportBadge"
+    )
     __properties: ClassVar[List[str]] = ["hideBuyButtonUntil", "showSupportBadge"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/purchase_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,10 +28,14 @@ class PurchaseUpdate(BaseModel):
     """  # noqa: E501
 
     hide_buy_button_until: Optional[StrictStr] = Field(
-        default=None, alias="hideBuyButtonUntil"
+        default=None,
+        description="Date until which to hide buy button",
+        alias="hideBuyButtonUntil",
     )
     show_support_badge: Optional[StrictBool] = Field(
-        default=None, alias="showSupportBadge"
+        default=None,
+        description="Whether to show support badge",
+        alias="showSupportBadge",
     )
     __properties: ClassVar[List[str]] = ["hideBuyButtonUntil", "showSupportBadge"]
 

immichpy/client/generated/models/queue_command.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 QueueCommand(str, Enum):
     """
-    QueueCommand
+    Queue command to execute
     """
 
     """

immichpy/client/generated/models/queue_command_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, Optional
 from immichpy.client.generated.models.queue_command import QueueCommand
 from typing import Set
@@ -28,8 +28,10 @@ class QueueCommandDto(BaseModel):
     QueueCommandDto
     """  # noqa: E501
 
-    command: QueueCommand
-    force: Optional[StrictBool] = None
+    command: QueueCommand = Field(description="Queue command to execute")
+    force: Optional[StrictBool] = Field(
+        default=None, description="Force the command execution (if applicable)"
+    )
     __properties: ClassVar[List[str]] = ["command", "force"]
 
     model_config = ConfigDict(

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

immichpy/client/generated/models/queue_job_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, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from immichpy.client.generated.models.job_name import JobName
 from typing import Set
@@ -28,10 +28,10 @@ class QueueJobResponseDto(BaseModel):
     QueueJobResponseDto
     """  # noqa: E501
 
-    data: Dict[str, Any]
-    id: Optional[StrictStr] = None
-    name: JobName
-    timestamp: StrictInt
+    data: Dict[str, Any] = Field(description="Job data payload")
+    id: Optional[StrictStr] = Field(default=None, description="Job ID")
+    name: JobName = Field(description="Job name")
+    timestamp: StrictInt = Field(description="Job creation timestamp")
     __properties: ClassVar[List[str]] = ["data", "id", "name", "timestamp"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/queue_job_status.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/queue_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.
@@ -42,6 +42,7 @@ class QueueName(str, Enum):
     BACKUPDATABASE = "backupDatabase"
     OCR = "ocr"
     WORKFLOW = "workflow"
+    EDITOR = "editor"
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

immichpy/client/generated/models/queue_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,8 +29,10 @@ class QueueResponseDto(BaseModel):
     QueueResponseDto
     """  # noqa: E501
 
-    is_paused: StrictBool = Field(alias="isPaused")
-    name: QueueName
+    is_paused: StrictBool = Field(
+        description="Whether the queue is paused", alias="isPaused"
+    )
+    name: QueueName = Field(description="Queue name")
     statistics: QueueStatisticsDto
     __properties: ClassVar[List[str]] = ["isPaused", "name", "statistics"]
 

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

immichpy/client/generated/models/queue_statistics_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,12 +27,12 @@ class QueueStatisticsDto(BaseModel):
     QueueStatisticsDto
     """  # noqa: E501
 
-    active: StrictInt
-    completed: StrictInt
-    delayed: StrictInt
-    failed: StrictInt
-    paused: StrictInt
-    waiting: StrictInt
+    active: StrictInt = Field(description="Number of active jobs")
+    completed: StrictInt = Field(description="Number of completed jobs")
+    delayed: StrictInt = Field(description="Number of delayed jobs")
+    failed: StrictInt = Field(description="Number of failed jobs")
+    paused: StrictInt = Field(description="Number of paused jobs")
+    waiting: StrictInt = Field(description="Number of waiting jobs")
     __properties: ClassVar[List[str]] = [
         "active",
         "completed",

immichpy/client/generated/models/queue_status_legacy_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.
@@ -27,8 +27,13 @@ class QueueStatusLegacyDto(BaseModel):
     QueueStatusLegacyDto
     """  # noqa: E501
 
-    is_active: StrictBool = Field(alias="isActive")
-    is_paused: StrictBool = Field(alias="isPaused")
+    is_active: StrictBool = Field(
+        description="Whether the queue is currently active (has running jobs)",
+        alias="isActive",
+    )
+    is_paused: StrictBool = Field(
+        description="Whether the queue is paused", alias="isPaused"
+    )
     __properties: ClassVar[List[str]] = ["isActive", "isPaused"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/queue_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.
@@ -27,7 +27,9 @@ class QueueUpdateDto(BaseModel):
     QueueUpdateDto
     """  # noqa: E501
 
-    is_paused: Optional[StrictBool] = Field(default=None, alias="isPaused")
+    is_paused: Optional[StrictBool] = Field(
+        default=None, description="Whether to pause the queue", alias="isPaused"
+    )
     __properties: ClassVar[List[str]] = ["isPaused"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/queues_response_legacy_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.
@@ -33,6 +33,7 @@ class QueuesResponseLegacyDto(BaseModel):
     background_task: QueueResponseLegacyDto = Field(alias="backgroundTask")
     backup_database: QueueResponseLegacyDto = Field(alias="backupDatabase")
     duplicate_detection: QueueResponseLegacyDto = Field(alias="duplicateDetection")
+    editor: QueueResponseLegacyDto
     face_detection: QueueResponseLegacyDto = Field(alias="faceDetection")
     facial_recognition: QueueResponseLegacyDto = Field(alias="facialRecognition")
     library: QueueResponseLegacyDto
@@ -53,6 +54,7 @@ class QueuesResponseLegacyDto(BaseModel):
         "backgroundTask",
         "backupDatabase",
         "duplicateDetection",
+        "editor",
         "faceDetection",
         "facialRecognition",
         "library",
@@ -115,6 +117,9 @@ class QueuesResponseLegacyDto(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of duplicate_detection
         if self.duplicate_detection:
             _dict["duplicateDetection"] = self.duplicate_detection.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of editor
+        if self.editor:
+            _dict["editor"] = self.editor.to_dict()
         # override the default output from pydantic by calling `to_dict()` of face_detection
         if self.face_detection:
             _dict["faceDetection"] = self.face_detection.to_dict()
@@ -187,6 +192,9 @@ class QueuesResponseLegacyDto(BaseModel):
                 )
                 if obj.get("duplicateDetection") is not None
                 else None,
+                "editor": QueueResponseLegacyDto.from_dict(obj["editor"])
+                if obj.get("editor") is not None
+                else None,
                 "faceDetection": QueueResponseLegacyDto.from_dict(obj["faceDetection"])
                 if obj.get("faceDetection") is not None
                 else None,