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

immichpy/cli/commands/server.py

@@ -219,8 +219,12 @@ def ping_server(
 @app.command("set-server-license", deprecated=False, rich_help_panel="API commands")
 def set_server_license(
     ctx: typer.Context,
-    activation_key: str = typer.Option(..., "--activation-key", help=""""""),
-    license_key: str = typer.Option(..., "--license-key", help=""""""),
+    activation_key: str = typer.Option(
+        ..., "--activation-key", help="""Activation key"""
+    ),
+    license_key: str = typer.Option(
+        ..., "--license-key", help="""License key (format: IM(SV|CL)(-XXXX){8})"""
+    ),
 ) -> None:
     """Set server product key
 

immichpy/cli/commands/sessions.py

@@ -19,10 +19,12 @@ app = typer.Typer(
 @app.command("create-session", deprecated=False, rich_help_panel="API commands")
 def create_session(
     ctx: typer.Context,
-    device_os: str | None = typer.Option(None, "--device-os", help=""""""),
-    device_type: str | None = typer.Option(None, "--device-type", help=""""""),
+    device_os: str | None = typer.Option(None, "--device-os", help="""Device OS"""),
+    device_type: str | None = typer.Option(
+        None, "--device-type", help="""Device type"""
+    ),
     duration: float | None = typer.Option(
-        None, "--duration", help="""session duration, in seconds""", min=1
+        None, "--duration", help="""Session duration in seconds""", min=1
     ),
 ) -> None:
     """Create a session
@@ -109,7 +111,7 @@ def update_session(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     is_pending_sync_reset: Literal["true", "false"] | None = typer.Option(
-        None, "--is-pending-sync-reset", help=""""""
+        None, "--is-pending-sync-reset", help="""Reset pending sync state"""
     ),
 ) -> None:
     """Update a session

immichpy/cli/commands/shared_links.py

@@ -21,7 +21,7 @@ app = typer.Typer(
 def add_shared_link_assets(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    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:
@@ -49,22 +49,30 @@ def add_shared_link_assets(
 @app.command("create-shared-link", deprecated=False, rich_help_panel="API commands")
 def create_shared_link(
     ctx: typer.Context,
-    album_id: str | None = typer.Option(None, "--album-id", help=""""""),
+    album_id: str | None = typer.Option(
+        None, "--album-id", help="""Album ID (for album sharing)"""
+    ),
     allow_download: Literal["true", "false"] | None = typer.Option(
-        None, "--allow-download", help=""""""
+        None, "--allow-download", help="""Allow downloads"""
     ),
     allow_upload: Literal["true", "false"] | None = typer.Option(
-        None, "--allow-upload", help=""""""
+        None, "--allow-upload", help="""Allow uploads"""
+    ),
+    asset_ids: list[str] | None = typer.Option(
+        None, "--asset-ids", help="""Asset IDs (for individual assets)"""
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Link description"""
     ),
-    asset_ids: list[str] | None = typer.Option(None, "--asset-ids", help=""""""),
-    description: str | None = typer.Option(None, "--description", help=""""""),
-    expires_at: datetime | None = typer.Option(None, "--expires-at", help=""""""),
-    password: str | None = typer.Option(None, "--password", help=""""""),
+    expires_at: datetime | None = typer.Option(
+        None, "--expires-at", help="""Expiration date"""
+    ),
+    password: str | None = typer.Option(None, "--password", help="""Link password"""),
     show_metadata: Literal["true", "false"] | None = typer.Option(
-        None, "--show-metadata", help=""""""
+        None, "--show-metadata", help="""Show metadata"""
     ),
-    slug: str | None = typer.Option(None, "--slug", help=""""""),
-    type: str = typer.Option(..., "--type", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help="""Custom URL slug"""),
+    type: str = typer.Option(..., "--type", help="""Shared link type"""),
 ) -> None:
     """Create a shared link
 
@@ -103,7 +111,10 @@ def create_shared_link(
 @app.command("get-all-shared-links", deprecated=False, rich_help_panel="API commands")
 def get_all_shared_links(
     ctx: typer.Context,
-    album_id: str | None = typer.Option(None, "--album-id", help=""""""),
+    album_id: str | None = typer.Option(
+        None, "--album-id", help="""Filter by album ID"""
+    ),
+    id: str | None = typer.Option(None, "--id", help="""Filter by shared link ID"""),
 ) -> None:
     """Retrieve all shared links
 
@@ -112,6 +123,8 @@ def get_all_shared_links(
     kwargs = {}
     if album_id is not None:
         kwargs["album_id"] = album_id
+    if id is not None:
+        kwargs["id"] = id
     client: "AsyncClient" = ctx.obj["client"]
     result = run_command(
         client, client.shared_links, "get_all_shared_links", ctx, **kwargs
@@ -123,9 +136,11 @@ def get_all_shared_links(
 def get_my_shared_link(
     ctx: typer.Context,
     key: str | None = typer.Option(None, "--key", help=""""""),
-    password: str | None = typer.Option(None, "--password", help="""password"""),
+    password: str | None = typer.Option(
+        None, "--password", help="""Link passwordpassword"""
+    ),
     slug: str | None = typer.Option(None, "--slug", help=""""""),
-    token: str | None = typer.Option(None, "--token", help=""""""),
+    token: str | None = typer.Option(None, "--token", help="""Access token"""),
 ) -> None:
     """Retrieve current shared link
 
@@ -189,7 +204,7 @@ def remove_shared_link(
 def remove_shared_link_assets(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    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:
@@ -219,25 +234,27 @@ def update_shared_link(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     allow_download: Literal["true", "false"] | None = typer.Option(
-        None, "--allow-download", help=""""""
+        None, "--allow-download", help="""Allow downloads"""
     ),
     allow_upload: Literal["true", "false"] | None = typer.Option(
-        None, "--allow-upload", help=""""""
+        None, "--allow-upload", help="""Allow uploads"""
     ),
     change_expiry_time: Literal["true", "false"] | None = typer.Option(
         None,
         "--change-expiry-time",
-        help="""Few clients cannot send null to set the expiryTime to never.
-Setting this flag and not sending expiryAt is considered as null instead.
-Clients that can send null values can ignore this.""",
+        help="""Whether to change the expiry time. Few clients cannot send null to set the expiryTime to never. Setting this flag and not sending expiryAt is considered as null instead. Clients that can send null values can ignore this.""",
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Link description"""
     ),
-    description: str | None = typer.Option(None, "--description", help=""""""),
-    expires_at: datetime | None = typer.Option(None, "--expires-at", help=""""""),
-    password: str | None = typer.Option(None, "--password", help=""""""),
+    expires_at: datetime | None = typer.Option(
+        None, "--expires-at", help="""Expiration date"""
+    ),
+    password: str | None = typer.Option(None, "--password", help="""Link password"""),
     show_metadata: Literal["true", "false"] | None = typer.Option(
-        None, "--show-metadata", help=""""""
+        None, "--show-metadata", help="""Show metadata"""
     ),
-    slug: str | None = typer.Option(None, "--slug", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help="""Custom URL slug"""),
 ) -> None:
     """Update a shared link
 

immichpy/cli/commands/stacks.py

@@ -20,7 +20,7 @@ app = typer.Typer(
 def create_stack(
     ctx: typer.Context,
     asset_ids: list[str] = typer.Option(
-        ..., "--asset-ids", help="""first asset becomes the primary"""
+        ..., "--asset-ids", help="""Asset IDs (first becomes primary, min 2)"""
     ),
 ) -> None:
     """Create a stack
@@ -56,7 +56,7 @@ def delete_stack(
 @app.command("delete-stacks", deprecated=False, rich_help_panel="API commands")
 def delete_stacks(
     ctx: typer.Context,
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Delete stacks
 
@@ -114,7 +114,7 @@ def remove_asset_from_stack(
 def search_stacks(
     ctx: typer.Context,
     primary_asset_id: str | None = typer.Option(
-        None, "--primary-asset-id", help=""""""
+        None, "--primary-asset-id", help="""Filter by primary asset ID"""
     ),
 ) -> None:
     """Retrieve stacks
@@ -134,7 +134,7 @@ def update_stack(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     primary_asset_id: str | None = typer.Option(
-        None, "--primary-asset-id", help=""""""
+        None, "--primary-asset-id", help="""Primary asset ID"""
     ),
 ) -> None:
     """Update a stack

immichpy/cli/commands/sync.py

@@ -20,7 +20,9 @@ app = typer.Typer(
 @app.command("delete-sync-ack", deprecated=False, rich_help_panel="API commands")
 def delete_sync_ack(
     ctx: typer.Context,
-    types: list[SyncEntityType] | None = typer.Option(None, "--types", help=""""""),
+    types: list[SyncEntityType] | None = typer.Option(
+        None, "--types", help="""Sync entity types to delete acks for"""
+    ),
 ) -> None:
     """Delete acknowledgements
 
@@ -40,8 +42,10 @@ def delete_sync_ack(
 @app.command("get-delta-sync", deprecated=True, rich_help_panel="API commands")
 def get_delta_sync(
     ctx: typer.Context,
-    updated_after: datetime = typer.Option(..., "--updated-after", help=""""""),
-    user_ids: list[str] = typer.Option(..., "--user-ids", help=""""""),
+    updated_after: datetime = typer.Option(
+        ..., "--updated-after", help="""Sync assets updated after this date"""
+    ),
+    user_ids: list[str] = typer.Option(..., "--user-ids", help="""User IDs to sync"""),
 ) -> None:
     """Get delta sync for user
 
@@ -61,10 +65,16 @@ def get_delta_sync(
 @app.command("get-full-sync-for-user", deprecated=True, rich_help_panel="API commands")
 def get_full_sync_for_user(
     ctx: typer.Context,
-    last_id: str | None = typer.Option(None, "--last-id", help=""""""),
-    limit: int = typer.Option(..., "--limit", help="""""", min=1),
-    updated_until: datetime = typer.Option(..., "--updated-until", help=""""""),
-    user_id: str | None = typer.Option(None, "--user-id", help=""""""),
+    last_id: str | None = typer.Option(
+        None, "--last-id", help="""Last asset ID (pagination)"""
+    ),
+    limit: int = typer.Option(
+        ..., "--limit", help="""Maximum number of assets to return""", min=1
+    ),
+    updated_until: datetime = typer.Option(
+        ..., "--updated-until", help="""Sync assets updated until this date"""
+    ),
+    user_id: str | None = typer.Option(None, "--user-id", help="""Filter by user ID"""),
 ) -> None:
     """Get full sync for user
 
@@ -102,8 +112,12 @@ def get_sync_ack(
 @app.command("get-sync-stream", deprecated=False, rich_help_panel="API commands")
 def get_sync_stream(
     ctx: typer.Context,
-    reset: Literal["true", "false"] | None = typer.Option(None, "--reset", help=""""""),
-    types: list[SyncRequestType] = typer.Option(..., "--types", help=""""""),
+    reset: Literal["true", "false"] | None = typer.Option(
+        None, "--reset", help="""Reset sync state"""
+    ),
+    types: list[SyncRequestType] = typer.Option(
+        ..., "--types", help="""Sync request types"""
+    ),
 ) -> None:
     """Stream sync changes
 
@@ -124,7 +138,9 @@ def get_sync_stream(
 @app.command("send-sync-ack", deprecated=False, rich_help_panel="API commands")
 def send_sync_ack(
     ctx: typer.Context,
-    acks: list[str] = typer.Option(..., "--acks", help=""""""),
+    acks: list[str] = typer.Option(
+        ..., "--acks", help="""Acknowledgment IDs (max 1000)"""
+    ),
 ) -> None:
     """Acknowledge changes