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

immichpy/client/generated/models/user_admin_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.
@@ -29,19 +29,29 @@ class UserAdminUpdateDto(BaseModel):
     UserAdminUpdateDto
     """  # noqa: E501
 
-    avatar_color: Optional[UserAvatarColor] = Field(default=None, alias="avatarColor")
-    email: Optional[StrictStr] = None
-    is_admin: Optional[StrictBool] = Field(default=None, alias="isAdmin")
-    name: Optional[StrictStr] = None
-    password: Optional[StrictStr] = None
-    pin_code: Optional[StrictStr] = Field(default=None, alias="pinCode")
+    avatar_color: Optional[UserAvatarColor] = Field(
+        default=None, description="Avatar color", alias="avatarColor"
+    )
+    email: Optional[StrictStr] = Field(default=None, description="User email")
+    is_admin: Optional[StrictBool] = Field(
+        default=None, description="Grant admin privileges", alias="isAdmin"
+    )
+    name: Optional[StrictStr] = Field(default=None, description="User name")
+    password: Optional[StrictStr] = Field(default=None, description="User password")
+    pin_code: Optional[StrictStr] = Field(
+        default=None, description="PIN code", alias="pinCode"
+    )
     quota_size_in_bytes: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(
-        default=None, alias="quotaSizeInBytes"
+        default=None, description="Storage quota in bytes", alias="quotaSizeInBytes"
     )
     should_change_password: Optional[StrictBool] = Field(
-        default=None, alias="shouldChangePassword"
+        default=None,
+        description="Require password change on next login",
+        alias="shouldChangePassword",
+    )
+    storage_label: Optional[StrictStr] = Field(
+        default=None, description="Storage label", alias="storageLabel"
     )
-    storage_label: Optional[StrictStr] = Field(default=None, alias="storageLabel")
     __properties: ClassVar[List[str]] = [
         "avatarColor",
         "email",

immichpy/client/generated/models/user_avatar_color.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 UserAvatarColor(str, Enum):
     """
-    UserAvatarColor
+    Avatar color
     """
 
     """

immichpy/client/generated/models/user_license.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 UserLicense(BaseModel):
     UserLicense
     """  # noqa: E501
 
-    activated_at: datetime = Field(alias="activatedAt")
-    activation_key: StrictStr = Field(alias="activationKey")
-    license_key: StrictStr = Field(alias="licenseKey")
+    activated_at: datetime = Field(description="Activation date", alias="activatedAt")
+    activation_key: StrictStr = Field(
+        description="Activation key", alias="activationKey"
+    )
+    license_key: StrictStr = Field(description="License key", alias="licenseKey")
     __properties: ClassVar[List[str]] = ["activatedAt", "activationKey", "licenseKey"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/user_metadata_key.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 UserMetadataKey(str, Enum):
     """
-    UserMetadataKey
+    User metadata key
     """
 
     """

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

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

immichpy/client/generated/models/user_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,12 +29,18 @@ class UserResponseDto(BaseModel):
     UserResponseDto
     """  # noqa: E501
 
-    avatar_color: UserAvatarColor = Field(alias="avatarColor")
-    email: StrictStr
-    id: StrictStr
-    name: StrictStr
-    profile_changed_at: datetime = Field(alias="profileChangedAt")
-    profile_image_path: StrictStr = Field(alias="profileImagePath")
+    avatar_color: UserAvatarColor = Field(
+        description="Avatar color", alias="avatarColor"
+    )
+    email: StrictStr = Field(description="User email")
+    id: StrictStr = Field(description="User ID")
+    name: StrictStr = Field(description="User name")
+    profile_changed_at: datetime = Field(
+        description="Profile change date", alias="profileChangedAt"
+    )
+    profile_image_path: StrictStr = Field(
+        description="Profile image path", alias="profileImagePath"
+    )
     __properties: ClassVar[List[str]] = [
         "avatarColor",
         "email",

immichpy/client/generated/models/user_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.
@@ -19,7 +19,7 @@ from typing_extensions import Self
 
 class UserStatus(str, Enum):
     """
-    UserStatus
+    User status
     """
 
     """

immichpy/client/generated/models/user_update_me_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,10 +28,15 @@ class UserUpdateMeDto(BaseModel):
     UserUpdateMeDto
     """  # noqa: E501
 
-    avatar_color: Optional[UserAvatarColor] = Field(default=None, alias="avatarColor")
-    email: Optional[StrictStr] = None
-    name: Optional[StrictStr] = None
-    password: Optional[StrictStr] = None
+    avatar_color: Optional[UserAvatarColor] = Field(
+        default=None, description="Avatar color", alias="avatarColor"
+    )
+    email: Optional[StrictStr] = Field(default=None, description="User email")
+    name: Optional[StrictStr] = Field(default=None, description="User name")
+    password: Optional[StrictStr] = Field(
+        default=None,
+        description="User password (deprecated, use change password endpoint)",
+    )
     __properties: ClassVar[List[str]] = ["avatarColor", "email", "name", "password"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/validate_access_token_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.
@@ -27,7 +27,9 @@ class ValidateAccessTokenResponseDto(BaseModel):
     ValidateAccessTokenResponseDto
     """  # noqa: E501
 
-    auth_status: StrictBool = Field(alias="authStatus")
+    auth_status: StrictBool = Field(
+        description="Authentication status", alias="authStatus"
+    )
     __properties: ClassVar[List[str]] = ["authStatus"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/validate_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.
@@ -29,10 +29,16 @@ class ValidateLibraryDto(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 to validate (max 128)",
+        alias="importPaths",
     )
     __properties: ClassVar[List[str]] = ["exclusionPatterns", "importPaths"]
 

immichpy/client/generated/models/validate_library_import_path_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.
@@ -27,9 +27,9 @@ class ValidateLibraryImportPathResponseDto(BaseModel):
     ValidateLibraryImportPathResponseDto
     """  # noqa: E501
 
-    import_path: StrictStr = Field(alias="importPath")
-    is_valid: StrictBool = Field(alias="isValid")
-    message: Optional[StrictStr] = None
+    import_path: StrictStr = Field(description="Import path", alias="importPath")
+    is_valid: StrictBool = Field(description="Is valid", alias="isValid")
+    message: Optional[StrictStr] = Field(default=None, description="Validation message")
     __properties: ClassVar[List[str]] = ["importPath", "isValid", "message"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/validate_library_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.
@@ -31,7 +31,9 @@ class ValidateLibraryResponseDto(BaseModel):
     """  # noqa: E501
 
     import_paths: Optional[List[ValidateLibraryImportPathResponseDto]] = Field(
-        default=None, alias="importPaths"
+        default=None,
+        description="Validation results for import paths",
+        alias="importPaths",
     )
     __properties: ClassVar[List[str]] = ["importPaths"]
 

immichpy/client/generated/models/version_check_state_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.
@@ -27,8 +27,12 @@ class VersionCheckStateResponseDto(BaseModel):
     VersionCheckStateResponseDto
     """  # noqa: E501
 
-    checked_at: Optional[StrictStr] = Field(alias="checkedAt")
-    release_version: Optional[StrictStr] = Field(alias="releaseVersion")
+    checked_at: Optional[StrictStr] = Field(
+        description="Last check timestamp", alias="checkedAt"
+    )
+    release_version: Optional[StrictStr] = Field(
+        description="Release version", alias="releaseVersion"
+    )
     __properties: ClassVar[List[str]] = ["checkedAt", "releaseVersion"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/video_codec.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 VideoCodec(str, Enum):
     """
-    VideoCodec
+    Target video codec
     """
 
     """

immichpy/client/generated/models/video_container.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 VideoContainer(str, Enum):
     """
-    VideoContainer
+    Accepted containers
     """
 
     """

immichpy/client/generated/models/workflow_action_item_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,12 @@ class WorkflowActionItemDto(BaseModel):
     WorkflowActionItemDto
     """  # noqa: E501
 
-    action_config: Optional[Dict[str, Any]] = Field(default=None, alias="actionConfig")
-    plugin_action_id: UUID = Field(alias="pluginActionId")
+    action_config: Optional[Dict[str, Any]] = Field(
+        default=None, description="Action configuration", alias="actionConfig"
+    )
+    plugin_action_id: UUID = Field(
+        description="Plugin action ID", alias="pluginActionId"
+    )
     __properties: ClassVar[List[str]] = ["actionConfig", "pluginActionId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/workflow_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.
@@ -27,11 +27,15 @@ class WorkflowActionResponseDto(BaseModel):
     WorkflowActionResponseDto
     """  # noqa: E501
 
-    action_config: Optional[Dict[str, Any]] = Field(alias="actionConfig")
-    id: StrictStr
-    order: Union[StrictFloat, StrictInt]
-    plugin_action_id: StrictStr = Field(alias="pluginActionId")
-    workflow_id: StrictStr = Field(alias="workflowId")
+    action_config: Optional[Dict[str, Any]] = Field(
+        description="Action configuration", alias="actionConfig"
+    )
+    id: StrictStr = Field(description="Action ID")
+    order: Union[StrictFloat, StrictInt] = Field(description="Action order")
+    plugin_action_id: StrictStr = Field(
+        description="Plugin action ID", alias="pluginActionId"
+    )
+    workflow_id: StrictStr = Field(description="Workflow ID", alias="workflowId")
     __properties: ClassVar[List[str]] = [
         "actionConfig",
         "id",

immichpy/client/generated/models/workflow_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.
@@ -34,12 +34,16 @@ class WorkflowCreateDto(BaseModel):
     WorkflowCreateDto
     """  # noqa: E501
 
-    actions: List[WorkflowActionItemDto]
-    description: Optional[StrictStr] = None
-    enabled: Optional[StrictBool] = None
-    filters: List[WorkflowFilterItemDto]
-    name: StrictStr
-    trigger_type: PluginTriggerType = Field(alias="triggerType")
+    actions: List[WorkflowActionItemDto] = Field(description="Workflow actions")
+    description: Optional[StrictStr] = Field(
+        default=None, description="Workflow description"
+    )
+    enabled: Optional[StrictBool] = Field(default=None, description="Workflow enabled")
+    filters: List[WorkflowFilterItemDto] = Field(description="Workflow filters")
+    name: StrictStr = Field(description="Workflow name")
+    trigger_type: PluginTriggerType = Field(
+        description="Workflow trigger type", alias="triggerType"
+    )
     __properties: ClassVar[List[str]] = [
         "actions",
         "description",

immichpy/client/generated/models/workflow_filter_item_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,12 @@ class WorkflowFilterItemDto(BaseModel):
     WorkflowFilterItemDto
     """  # noqa: E501
 
-    filter_config: Optional[Dict[str, Any]] = Field(default=None, alias="filterConfig")
-    plugin_filter_id: UUID = Field(alias="pluginFilterId")
+    filter_config: Optional[Dict[str, Any]] = Field(
+        default=None, description="Filter configuration", alias="filterConfig"
+    )
+    plugin_filter_id: UUID = Field(
+        description="Plugin filter ID", alias="pluginFilterId"
+    )
     __properties: ClassVar[List[str]] = ["filterConfig", "pluginFilterId"]
 
     model_config = ConfigDict(

immichpy/client/generated/models/workflow_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.
@@ -27,11 +27,15 @@ class WorkflowFilterResponseDto(BaseModel):
     WorkflowFilterResponseDto
     """  # noqa: E501
 
-    filter_config: Optional[Dict[str, Any]] = Field(alias="filterConfig")
-    id: StrictStr
-    order: Union[StrictFloat, StrictInt]
-    plugin_filter_id: StrictStr = Field(alias="pluginFilterId")
-    workflow_id: StrictStr = Field(alias="workflowId")
+    filter_config: Optional[Dict[str, Any]] = Field(
+        description="Filter configuration", alias="filterConfig"
+    )
+    id: StrictStr = Field(description="Filter ID")
+    order: Union[StrictFloat, StrictInt] = Field(description="Filter order")
+    plugin_filter_id: StrictStr = Field(
+        description="Plugin filter ID", alias="pluginFilterId"
+    )
+    workflow_id: StrictStr = Field(description="Workflow ID", alias="workflowId")
     __properties: ClassVar[List[str]] = [
         "filterConfig",
         "id",

immichpy/client/generated/models/workflow_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,15 +16,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    StrictBool,
-    StrictStr,
-    field_validator,
-)
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from immichpy.client.generated.models.plugin_trigger_type import PluginTriggerType
 from immichpy.client.generated.models.workflow_action_response_dto import (
     WorkflowActionResponseDto,
 )
@@ -40,15 +34,17 @@ class WorkflowResponseDto(BaseModel):
     WorkflowResponseDto
     """  # noqa: E501
 
-    actions: List[WorkflowActionResponseDto]
-    created_at: StrictStr = Field(alias="createdAt")
-    description: StrictStr
-    enabled: StrictBool
-    filters: List[WorkflowFilterResponseDto]
-    id: StrictStr
-    name: Optional[StrictStr]
-    owner_id: StrictStr = Field(alias="ownerId")
-    trigger_type: StrictStr = Field(alias="triggerType")
+    actions: List[WorkflowActionResponseDto] = Field(description="Workflow actions")
+    created_at: StrictStr = Field(description="Creation date", alias="createdAt")
+    description: StrictStr = Field(description="Workflow description")
+    enabled: StrictBool = Field(description="Workflow enabled")
+    filters: List[WorkflowFilterResponseDto] = Field(description="Workflow filters")
+    id: StrictStr = Field(description="Workflow ID")
+    name: Optional[StrictStr] = Field(description="Workflow name")
+    owner_id: StrictStr = Field(description="Owner user ID", alias="ownerId")
+    trigger_type: PluginTriggerType = Field(
+        description="Workflow trigger type", alias="triggerType"
+    )
     __properties: ClassVar[List[str]] = [
         "actions",
         "createdAt",
@@ -61,15 +57,6 @@ class WorkflowResponseDto(BaseModel):
         "triggerType",
     ]
 
-    @field_validator("trigger_type")
-    def trigger_type_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(["AssetCreate", "PersonRecognized"]):
-            raise ValueError(
-                "must be one of enum values ('AssetCreate', 'PersonRecognized')"
-            )
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

immichpy/client/generated/models/workflow_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,8 +16,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from immichpy.client.generated.models.plugin_trigger_type import PluginTriggerType
 from immichpy.client.generated.models.workflow_action_item_dto import (
     WorkflowActionItemDto,
 )
@@ -33,17 +34,27 @@ class WorkflowUpdateDto(BaseModel):
     WorkflowUpdateDto
     """  # noqa: E501
 
-    actions: Optional[List[WorkflowActionItemDto]] = None
-    description: Optional[StrictStr] = None
-    enabled: Optional[StrictBool] = None
-    filters: Optional[List[WorkflowFilterItemDto]] = None
-    name: Optional[StrictStr] = None
+    actions: Optional[List[WorkflowActionItemDto]] = Field(
+        default=None, description="Workflow actions"
+    )
+    description: Optional[StrictStr] = Field(
+        default=None, description="Workflow description"
+    )
+    enabled: Optional[StrictBool] = Field(default=None, description="Workflow enabled")
+    filters: Optional[List[WorkflowFilterItemDto]] = Field(
+        default=None, description="Workflow filters"
+    )
+    name: Optional[StrictStr] = Field(default=None, description="Workflow name")
+    trigger_type: Optional[PluginTriggerType] = Field(
+        default=None, description="Workflow trigger type", alias="triggerType"
+    )
     __properties: ClassVar[List[str]] = [
         "actions",
         "description",
         "enabled",
         "filters",
         "name",
+        "triggerType",
     ]
 
     model_config = ConfigDict(
@@ -123,6 +134,7 @@ class WorkflowUpdateDto(BaseModel):
                 if obj.get("filters") is not None
                 else None,
                 "name": obj.get("name"),
+                "triggerType": obj.get("triggerType"),
             }
         )
         return _obj

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