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

immichpy/cli/commands/authentication.py

@@ -20,12 +20,22 @@ app = typer.Typer(
 def change_password(
     ctx: typer.Context,
     invalidate_sessions: Literal["true", "false"] | None = typer.Option(
-        None, "--invalidate-sessions", help=""""""
+        None, "--invalidate-sessions", help="""Invalidate all other sessions"""
     ),
     new_password: str = typer.Option(
-        ..., "--new-password", help="""Example: password"""
+        ...,
+        "--new-password",
+        help="""New password (min 8 characters)
+
+Example: password""",
+    ),
+    password: str = typer.Option(
+        ...,
+        "--password",
+        help="""Current password
+
+Example: password""",
     ),
-    password: str = typer.Option(..., "--password", help="""Example: password"""),
 ) -> None:
     """Change password
 
@@ -49,9 +59,25 @@ def change_password(
 @app.command("change-pin-code", deprecated=False, rich_help_panel="API commands")
 def change_pin_code(
     ctx: typer.Context,
-    new_pin_code: str = typer.Option(..., "--new-pin-code", help="""Example: 123456"""),
-    password: str | None = typer.Option(None, "--password", help=""""""),
-    pin_code: str | None = typer.Option(None, "--pin-code", help="""Example: 123456"""),
+    new_pin_code: str = typer.Option(
+        ...,
+        "--new-pin-code",
+        help="""New PIN code (4-6 digits)
+
+Example: 123456""",
+    ),
+    password: str | None = typer.Option(
+        None,
+        "--password",
+        help="""User password (required if PIN code is not provided)""",
+    ),
+    pin_code: str | None = typer.Option(
+        None,
+        "--pin-code",
+        help="""New PIN code (4-6 digits)
+
+Example: 123456""",
+    ),
 ) -> None:
     """Change pin code
 
@@ -74,9 +100,11 @@ def change_pin_code(
 @app.command("finish-o-auth", deprecated=False, rich_help_panel="API commands")
 def finish_o_auth(
     ctx: typer.Context,
-    code_verifier: str | None = typer.Option(None, "--code-verifier", help=""""""),
-    state: str | None = typer.Option(None, "--state", help=""""""),
-    url: str = typer.Option(..., "--url", help=""""""),
+    code_verifier: str | None = typer.Option(
+        None, "--code-verifier", help="""OAuth code verifier (PKCE)"""
+    ),
+    state: str | None = typer.Option(None, "--state", help="""OAuth state parameter"""),
+    url: str = typer.Option(..., "--url", help="""OAuth callback URL"""),
 ) -> None:
     """Finish OAuth
 
@@ -113,9 +141,11 @@ def get_auth_status(
 @app.command("link-o-auth-account", deprecated=False, rich_help_panel="API commands")
 def link_o_auth_account(
     ctx: typer.Context,
-    code_verifier: str | None = typer.Option(None, "--code-verifier", help=""""""),
-    state: str | None = typer.Option(None, "--state", help=""""""),
-    url: str = typer.Option(..., "--url", help=""""""),
+    code_verifier: str | None = typer.Option(
+        None, "--code-verifier", help="""OAuth code verifier (PKCE)"""
+    ),
+    state: str | None = typer.Option(None, "--state", help="""OAuth state parameter"""),
+    url: str = typer.Option(..., "--url", help="""OAuth callback URL"""),
 ) -> None:
     """Link OAuth account
 
@@ -152,8 +182,20 @@ def lock_auth_session(
 @app.command("login", deprecated=False, rich_help_panel="API commands")
 def login(
     ctx: typer.Context,
-    email: str = typer.Option(..., "--email", help="""Example: testuser@email.com"""),
-    password: str = typer.Option(..., "--password", help="""Example: password"""),
+    email: str = typer.Option(
+        ...,
+        "--email",
+        help="""User email
+
+Example: testuser@email.com""",
+    ),
+    password: str = typer.Option(
+        ...,
+        "--password",
+        help="""User password
+
+Example: password""",
+    ),
 ) -> None:
     """Login
 
@@ -205,8 +247,18 @@ def redirect_o_auth_to_mobile(
 @app.command("reset-pin-code", deprecated=False, rich_help_panel="API commands")
 def reset_pin_code(
     ctx: typer.Context,
-    password: str | None = typer.Option(None, "--password", help=""""""),
-    pin_code: str | None = typer.Option(None, "--pin-code", help="""Example: 123456"""),
+    password: str | None = typer.Option(
+        None,
+        "--password",
+        help="""User password (required if PIN code is not provided)""",
+    ),
+    pin_code: str | None = typer.Option(
+        None,
+        "--pin-code",
+        help="""New PIN code (4-6 digits)
+
+Example: 123456""",
+    ),
 ) -> None:
     """Reset pin code
 
@@ -228,7 +280,13 @@ def reset_pin_code(
 @app.command("setup-pin-code", deprecated=False, rich_help_panel="API commands")
 def setup_pin_code(
     ctx: typer.Context,
-    pin_code: str = typer.Option(..., "--pin-code", help="""Example: 123456"""),
+    pin_code: str = typer.Option(
+        ...,
+        "--pin-code",
+        help="""PIN code (4-6 digits)
+
+Example: 123456""",
+    ),
 ) -> None:
     """Setup pin code
 
@@ -247,9 +305,27 @@ def setup_pin_code(
 @app.command("sign-up-admin", deprecated=False, rich_help_panel="API commands")
 def sign_up_admin(
     ctx: typer.Context,
-    email: str = typer.Option(..., "--email", help="""Example: testuser@email.com"""),
-    name: str = typer.Option(..., "--name", help="""Example: Admin"""),
-    password: str = typer.Option(..., "--password", help="""Example: password"""),
+    email: str = typer.Option(
+        ...,
+        "--email",
+        help="""User email
+
+Example: testuser@email.com""",
+    ),
+    name: str = typer.Option(
+        ...,
+        "--name",
+        help="""User name
+
+Example: Admin""",
+    ),
+    password: str = typer.Option(
+        ...,
+        "--password",
+        help="""User password
+
+Example: password""",
+    ),
 ) -> None:
     """Register admin
 
@@ -270,9 +346,13 @@ def sign_up_admin(
 @app.command("start-o-auth", deprecated=False, rich_help_panel="API commands")
 def start_o_auth(
     ctx: typer.Context,
-    code_challenge: str | None = typer.Option(None, "--code-challenge", help=""""""),
-    redirect_uri: str = typer.Option(..., "--redirect-uri", help=""""""),
-    state: str | None = typer.Option(None, "--state", help=""""""),
+    code_challenge: str | None = typer.Option(
+        None, "--code-challenge", help="""OAuth code challenge (PKCE)"""
+    ),
+    redirect_uri: str = typer.Option(
+        ..., "--redirect-uri", help="""OAuth redirect URI"""
+    ),
+    state: str | None = typer.Option(None, "--state", help="""OAuth state parameter"""),
 ) -> None:
     """Start OAuth
 
@@ -309,8 +389,18 @@ def unlink_o_auth_account(
 @app.command("unlock-auth-session", deprecated=False, rich_help_panel="API commands")
 def unlock_auth_session(
     ctx: typer.Context,
-    password: str | None = typer.Option(None, "--password", help=""""""),
-    pin_code: str | None = typer.Option(None, "--pin-code", help="""Example: 123456"""),
+    password: str | None = typer.Option(
+        None,
+        "--password",
+        help="""User password (required if PIN code is not provided)""",
+    ),
+    pin_code: str | None = typer.Option(
+        None,
+        "--pin-code",
+        help="""New PIN code (4-6 digits)
+
+Example: 123456""",
+    ),
 ) -> None:
     """Unlock auth session
 

immichpy/cli/commands/database_backups_admin.py

@@ -0,0 +1,111 @@
+"""Generated CLI commands for Database Backups (admin) tag (auto-generated, do not edit)."""
+
+from __future__ import annotations
+
+import typer
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from immichpy import AsyncClient
+
+from immichpy.cli.runtime import print_response, run_command, set_nested
+from immichpy.client.generated.models import *
+
+app = typer.Typer(
+    help="""Manage backups of the Immich database.\n\n[link=https://api.immich.app/endpoints/database-backups-admin]Immich API documentation[/link]"""
+)
+
+
+@app.command("delete-database-backup", deprecated=False, rich_help_panel="API commands")
+def delete_database_backup(
+    ctx: typer.Context,
+    backups: list[str] = typer.Option(..., "--backups", help=""""""),
+) -> None:
+    """Delete database backup
+
+    [link=https://api.immich.app/endpoints/database-backups-admin/deleteDatabaseBackup]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    set_nested(json_data, ["backups"], backups)
+    database_backup_delete_dto = DatabaseBackupDeleteDto.model_validate(json_data)
+    kwargs["database_backup_delete_dto"] = database_backup_delete_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.backups, "delete_database_backup", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command(
+    "download-database-backup", deprecated=False, rich_help_panel="API commands"
+)
+def download_database_backup(
+    ctx: typer.Context,
+    filename: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Download database backup
+
+    [link=https://api.immich.app/endpoints/database-backups-admin/downloadDatabaseBackup]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["filename"] = filename
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.backups, "download_database_backup", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command("list-database-backups", deprecated=False, rich_help_panel="API commands")
+def list_database_backups(
+    ctx: typer.Context,
+) -> None:
+    """List database backups
+
+    [link=https://api.immich.app/endpoints/database-backups-admin/listDatabaseBackups]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.backups, "list_database_backups", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command(
+    "start-database-restore-flow", deprecated=False, rich_help_panel="API commands"
+)
+def start_database_restore_flow(
+    ctx: typer.Context,
+) -> None:
+    """Start database backup restore flow
+
+    [link=https://api.immich.app/endpoints/database-backups-admin/startDatabaseRestoreFlow]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.backups, "start_database_restore_flow", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command("upload-database-backup", deprecated=False, rich_help_panel="API commands")
+def upload_database_backup(
+    ctx: typer.Context,
+    file: Path | None = typer.Option(None, "--file", help="""""", exists=True),
+) -> None:
+    """Upload database backup
+
+    [link=https://api.immich.app/endpoints/database-backups-admin/uploadDatabaseBackup]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    if file is not None:
+        set_nested(json_data, ["file"], (file.name, file.read_bytes()))
+    kwargs.update(json_data)
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.backups, "upload_database_backup", ctx, **kwargs
+    )
+    print_response(result, ctx)

immichpy/cli/commands/download.py

@@ -19,7 +19,7 @@ app = typer.Typer(
 @app.command("download-archive", deprecated=False, rich_help_panel="API commands")
 def download_archive(
     ctx: typer.Context,
-    asset_ids: list[str] = typer.Option(..., "--asset-ids", help=""""""),
+    asset_ids: list[str] = typer.Option(..., "--asset-ids", help="""Asset IDs"""),
     key: str | None = typer.Option(None, "--key", help=""""""),
     slug: str | None = typer.Option(None, "--slug", help=""""""),
 ) -> None:
@@ -44,12 +44,20 @@ def download_archive(
 @app.command("get-download-info", deprecated=False, rich_help_panel="API commands")
 def get_download_info(
     ctx: typer.Context,
-    album_id: str | None = typer.Option(None, "--album-id", help=""""""),
-    archive_size: int | None = typer.Option(None, "--archive-size", help="""""", min=1),
-    asset_ids: list[str] | None = typer.Option(None, "--asset-ids", help=""""""),
+    album_id: str | None = typer.Option(
+        None, "--album-id", help="""Album ID to download"""
+    ),
+    archive_size: int | None = typer.Option(
+        None, "--archive-size", help="""Archive size limit in bytes""", min=1
+    ),
+    asset_ids: list[str] | None = typer.Option(
+        None, "--asset-ids", help="""Asset IDs to download"""
+    ),
     key: str | None = typer.Option(None, "--key", help=""""""),
     slug: str | None = typer.Option(None, "--slug", help=""""""),
-    user_id: str | None = typer.Option(None, "--user-id", help=""""""),
+    user_id: str | None = typer.Option(
+        None, "--user-id", help="""User ID to download assets from"""
+    ),
 ) -> None:
     """Retrieve download information
 

immichpy/cli/commands/duplicates.py

@@ -35,7 +35,7 @@ def delete_duplicate(
 @app.command("delete-duplicates", deprecated=False, rich_help_panel="API commands")
 def delete_duplicates(
     ctx: typer.Context,
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Delete duplicates
 

immichpy/cli/commands/faces.py

@@ -19,14 +19,18 @@ app = typer.Typer(
 @app.command("create-face", deprecated=False, rich_help_panel="API commands")
 def create_face(
     ctx: typer.Context,
-    asset_id: str = typer.Option(..., "--asset-id", help=""""""),
-    height: int = typer.Option(..., "--height", help=""""""),
-    image_height: int = typer.Option(..., "--image-height", help=""""""),
-    image_width: int = typer.Option(..., "--image-width", help=""""""),
-    person_id: str = typer.Option(..., "--person-id", help=""""""),
-    width: int = typer.Option(..., "--width", help=""""""),
-    x: int = typer.Option(..., "--x", help=""""""),
-    y: int = typer.Option(..., "--y", help=""""""),
+    asset_id: str = typer.Option(..., "--asset-id", help="""Asset ID"""),
+    height: int = typer.Option(..., "--height", help="""Face bounding box height"""),
+    image_height: int = typer.Option(
+        ..., "--image-height", help="""Image height in pixels"""
+    ),
+    image_width: int = typer.Option(
+        ..., "--image-width", help="""Image width in pixels"""
+    ),
+    person_id: str = typer.Option(..., "--person-id", help="""Person ID"""),
+    width: int = typer.Option(..., "--width", help="""Face bounding box width"""),
+    x: int = typer.Option(..., "--x", help="""Face bounding box X coordinate"""),
+    y: int = typer.Option(..., "--y", help="""Face bounding box Y coordinate"""),
 ) -> None:
     """Create a face
 
@@ -53,7 +57,9 @@ def create_face(
 def delete_face(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    force: bool = typer.Option(..., "--force", help=""""""),
+    force: bool = typer.Option(
+        ..., "--force", help="""Force delete even if person has other faces"""
+    ),
 ) -> None:
     """Delete a face
 
@@ -73,7 +79,7 @@ def delete_face(
 @app.command("get-faces", deprecated=False, rich_help_panel="API commands")
 def get_faces(
     ctx: typer.Context,
-    id: str = typer.Option(..., "--id", help=""""""),
+    id: str = typer.Option(..., "--id", help="""Face ID"""),
 ) -> None:
     """Retrieve faces for asset
 
@@ -90,7 +96,7 @@ def get_faces(
 def reassign_faces_by_id(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    body_id: str = typer.Option(..., "--body-id", help=""""""),
+    body_id: str = typer.Option(..., "--body-id", help="""Face ID"""),
 ) -> None:
     """Re-assign a face to another person
 

immichpy/cli/commands/jobs.py

@@ -19,7 +19,7 @@ app = typer.Typer(
 @app.command("create-job", deprecated=False, rich_help_panel="API commands")
 def create_job(
     ctx: typer.Context,
-    name: str = typer.Option(..., "--name", help=""""""),
+    name: str = typer.Option(..., "--name", help="""Job name"""),
 ) -> None:
     """Create a manual job
 
@@ -54,9 +54,11 @@ def get_queues_legacy(
 )
 def run_queue_command_legacy(
     ctx: typer.Context,
-    name: QueueName = typer.Argument(..., help=""""""),
-    command: str = typer.Option(..., "--command", help=""""""),
-    force: Literal["true", "false"] | None = typer.Option(None, "--force", help=""""""),
+    name: QueueName = typer.Argument(..., help="""Queue name"""),
+    command: str = typer.Option(..., "--command", help="""Queue command to execute"""),
+    force: Literal["true", "false"] | None = typer.Option(
+        None, "--force", help="""Force the command execution (if applicable)"""
+    ),
 ) -> None:
     """Run jobs
 

immichpy/cli/commands/libraries.py

@@ -20,11 +20,13 @@ app = typer.Typer(
 def create_library(
     ctx: typer.Context,
     exclusion_patterns: list[str] | None = typer.Option(
-        None, "--exclusion-patterns", help=""""""
+        None, "--exclusion-patterns", help="""Exclusion patterns (max 128)"""
     ),
-    import_paths: list[str] | None = typer.Option(None, "--import-paths", help=""""""),
-    name: str | None = typer.Option(None, "--name", help=""""""),
-    owner_id: str = typer.Option(..., "--owner-id", help=""""""),
+    import_paths: list[str] | None = typer.Option(
+        None, "--import-paths", help="""Import paths (max 128)"""
+    ),
+    name: str | None = typer.Option(None, "--name", help="""Library name"""),
+    owner_id: str = typer.Option(..., "--owner-id", help="""Owner user ID"""),
 ) -> None:
     """Create a library
 
@@ -131,10 +133,12 @@ def update_library(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     exclusion_patterns: list[str] | None = typer.Option(
-        None, "--exclusion-patterns", help=""""""
+        None, "--exclusion-patterns", help="""Exclusion patterns (max 128)"""
+    ),
+    import_paths: list[str] | None = typer.Option(
+        None, "--import-paths", help="""Import paths (max 128)"""
     ),
-    import_paths: list[str] | None = typer.Option(None, "--import-paths", help=""""""),
-    name: str | None = typer.Option(None, "--name", help=""""""),
+    name: str | None = typer.Option(None, "--name", help="""Library name"""),
 ) -> None:
     """Update a library
 
@@ -161,9 +165,11 @@ def validate(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     exclusion_patterns: list[str] | None = typer.Option(
-        None, "--exclusion-patterns", help=""""""
+        None, "--exclusion-patterns", help="""Exclusion patterns (max 128)"""
+    ),
+    import_paths: list[str] | None = typer.Option(
+        None, "--import-paths", help="""Import paths to validate (max 128)"""
     ),
-    import_paths: list[str] | None = typer.Option(None, "--import-paths", help=""""""),
 ) -> None:
     """Validate library settings
 

immichpy/cli/commands/maintenance_admin.py

@@ -16,10 +16,42 @@ app = typer.Typer(
 )
 
 
+@app.command("detect-prior-install", deprecated=False, rich_help_panel="API commands")
+def detect_prior_install(
+    ctx: typer.Context,
+) -> None:
+    """Detect existing install
+
+    [link=https://api.immich.app/endpoints/maintenance-admin/detectPriorInstall]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.maintenance_admin, "detect_prior_install", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command("get-maintenance-status", deprecated=False, rich_help_panel="API commands")
+def get_maintenance_status(
+    ctx: typer.Context,
+) -> None:
+    """Get maintenance mode status
+
+    [link=https://api.immich.app/endpoints/maintenance-admin/getMaintenanceStatus]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.maintenance_admin, "get_maintenance_status", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
 @app.command("maintenance-login", deprecated=False, rich_help_panel="API commands")
 def maintenance_login(
     ctx: typer.Context,
-    token: str | None = typer.Option(None, "--token", help=""""""),
+    token: str | None = typer.Option(None, "--token", help="""Maintenance token"""),
 ) -> None:
     """Log into maintenance mode
 
@@ -41,7 +73,10 @@ def maintenance_login(
 @app.command("set-maintenance-mode", deprecated=False, rich_help_panel="API commands")
 def set_maintenance_mode(
     ctx: typer.Context,
-    action: str = typer.Option(..., "--action", help=""""""),
+    action: str = typer.Option(..., "--action", help="""Maintenance action"""),
+    restore_backup_filename: str | None = typer.Option(
+        None, "--restore-backup-filename", help="""Restore backup filename"""
+    ),
 ) -> None:
     """Set maintenance mode
 
@@ -50,6 +85,8 @@ def set_maintenance_mode(
     kwargs = {}
     json_data = {}
     set_nested(json_data, ["action"], action)
+    if restore_backup_filename is not None:
+        set_nested(json_data, ["restore_backup_filename"], restore_backup_filename)
     set_maintenance_mode_dto = SetMaintenanceModeDto.model_validate(json_data)
     kwargs["set_maintenance_mode_dto"] = set_maintenance_mode_dto
     client: "AsyncClient" = ctx.obj["client"]

immichpy/cli/commands/map.py

@@ -21,22 +21,22 @@ app = typer.Typer(
 def get_map_markers(
     ctx: typer.Context,
     file_created_after: datetime | None = typer.Option(
-        None, "--file-created-after", help=""""""
+        None, "--file-created-after", help="""Filter assets created after this date"""
     ),
     file_created_before: datetime | None = typer.Option(
-        None, "--file-created-before", help=""""""
+        None, "--file-created-before", help="""Filter assets created before this date"""
     ),
     is_archived: Literal["true", "false"] | None = typer.Option(
-        None, "--is-archived", help=""""""
+        None, "--is-archived", help="""Filter by archived status"""
     ),
     is_favorite: Literal["true", "false"] | None = typer.Option(
-        None, "--is-favorite", help=""""""
+        None, "--is-favorite", help="""Filter by favorite status"""
     ),
     with_partners: Literal["true", "false"] | None = typer.Option(
-        None, "--with-partners", help=""""""
+        None, "--with-partners", help="""Include partner assets"""
     ),
     with_shared_albums: Literal["true", "false"] | None = typer.Option(
-        None, "--with-shared-albums", help=""""""
+        None, "--with-shared-albums", help="""Include shared album assets"""
     ),
 ) -> None:
     """Retrieve map markers
@@ -64,8 +64,8 @@ def get_map_markers(
 @app.command("reverse-geocode", deprecated=False, rich_help_panel="API commands")
 def reverse_geocode(
     ctx: typer.Context,
-    lat: float = typer.Option(..., "--lat", help=""""""),
-    lon: float = typer.Option(..., "--lon", help=""""""),
+    lat: float = typer.Option(..., "--lat", help="""Latitude (-90 to 90)"""),
+    lon: float = typer.Option(..., "--lon", help="""Longitude (-180 to 180)"""),
 ) -> None:
     """Reverse geocode coordinates