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

immichpy/cli/commands/memories.py

@@ -21,7 +21,7 @@ app = typer.Typer(
 def add_memory_assets(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Add assets to a memory
 
@@ -41,14 +41,20 @@ def add_memory_assets(
 @app.command("create-memory", deprecated=False, rich_help_panel="API commands")
 def create_memory(
     ctx: typer.Context,
-    asset_ids: list[str] | None = typer.Option(None, "--asset-ids", help=""""""),
-    data_year: float = typer.Option(..., "--data-year", help="""""", min=1),
+    asset_ids: list[str] | None = typer.Option(
+        None, "--asset-ids", help="""Asset IDs to associate with memory"""
+    ),
+    data_year: float = typer.Option(
+        ..., "--data-year", help="""Year for on this day memory""", min=1
+    ),
     is_saved: Literal["true", "false"] | None = typer.Option(
-        None, "--is-saved", help=""""""
+        None, "--is-saved", help="""Is memory saved"""
     ),
-    memory_at: datetime = typer.Option(..., "--memory-at", help=""""""),
-    seen_at: datetime | None = typer.Option(None, "--seen-at", help=""""""),
-    type: str = typer.Option(..., "--type", help=""""""),
+    memory_at: datetime = typer.Option(..., "--memory-at", help="""Memory date"""),
+    seen_at: datetime | None = typer.Option(
+        None, "--seen-at", help="""Date when memory was seen"""
+    ),
+    type: str = typer.Option(..., "--type", help="""Memory type"""),
 ) -> None:
     """Create a memory
 
@@ -107,18 +113,20 @@ def get_memory(
 @app.command("memories-statistics", deprecated=False, rich_help_panel="API commands")
 def memories_statistics(
     ctx: typer.Context,
-    for_: datetime | None = typer.Option(None, "--for", help=""""""),
+    for_: datetime | None = typer.Option(None, "--for", help="""Filter by date"""),
     is_saved: Literal["true", "false"] | None = typer.Option(
-        None, "--is-saved", help=""""""
+        None, "--is-saved", help="""Filter by saved status"""
     ),
     is_trashed: Literal["true", "false"] | None = typer.Option(
-        None, "--is-trashed", help=""""""
+        None, "--is-trashed", help="""Include trashed memories"""
+    ),
+    order: MemorySearchOrder | None = typer.Option(
+        None, "--order", help="""Sort order"""
     ),
-    order: MemorySearchOrder | None = typer.Option(None, "--order", help=""""""),
     size: int | None = typer.Option(
         None, "--size", help="""Number of memories to return""", min=1
     ),
-    type: MemoryType | None = typer.Option(None, "--type", help=""""""),
+    type: MemoryType | None = typer.Option(None, "--type", help="""Memory type"""),
 ) -> None:
     """Retrieve memories statistics
 
@@ -146,7 +154,7 @@ def memories_statistics(
 def remove_memory_assets(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Remove assets from a memory
 
@@ -166,18 +174,20 @@ def remove_memory_assets(
 @app.command("search-memories", deprecated=False, rich_help_panel="API commands")
 def search_memories(
     ctx: typer.Context,
-    for_: datetime | None = typer.Option(None, "--for", help=""""""),
+    for_: datetime | None = typer.Option(None, "--for", help="""Filter by date"""),
     is_saved: Literal["true", "false"] | None = typer.Option(
-        None, "--is-saved", help=""""""
+        None, "--is-saved", help="""Filter by saved status"""
     ),
     is_trashed: Literal["true", "false"] | None = typer.Option(
-        None, "--is-trashed", help=""""""
+        None, "--is-trashed", help="""Include trashed memories"""
+    ),
+    order: MemorySearchOrder | None = typer.Option(
+        None, "--order", help="""Sort order"""
     ),
-    order: MemorySearchOrder | None = typer.Option(None, "--order", help=""""""),
     size: int | None = typer.Option(
         None, "--size", help="""Number of memories to return""", min=1
     ),
-    type: MemoryType | None = typer.Option(None, "--type", help=""""""),
+    type: MemoryType | None = typer.Option(None, "--type", help="""Memory type"""),
 ) -> None:
     """Retrieve memories
 
@@ -206,10 +216,14 @@ def update_memory(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     is_saved: Literal["true", "false"] | None = typer.Option(
-        None, "--is-saved", help=""""""
+        None, "--is-saved", help="""Is memory saved"""
+    ),
+    memory_at: datetime | None = typer.Option(
+        None, "--memory-at", help="""Memory date"""
+    ),
+    seen_at: datetime | None = typer.Option(
+        None, "--seen-at", help="""Date when memory was seen"""
     ),
-    memory_at: datetime | None = typer.Option(None, "--memory-at", help=""""""),
-    seen_at: datetime | None = typer.Option(None, "--seen-at", help=""""""),
 ) -> None:
     """Update a memory
 

immichpy/cli/commands/notifications.py

@@ -38,7 +38,7 @@ def delete_notification(
 @app.command("delete-notifications", deprecated=False, rich_help_panel="API commands")
 def delete_notifications(
     ctx: typer.Context,
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""Notification IDs to delete"""),
 ) -> None:
     """Delete notifications
 
@@ -77,11 +77,15 @@ def get_notification(
 @app.command("get-notifications", deprecated=False, rich_help_panel="API commands")
 def get_notifications(
     ctx: typer.Context,
-    id: str | None = typer.Option(None, "--id", help=""""""),
-    level: NotificationLevel | None = typer.Option(None, "--level", help=""""""),
-    type: NotificationType | None = typer.Option(None, "--type", help=""""""),
+    id: str | None = typer.Option(None, "--id", help="""Filter by notification ID"""),
+    level: NotificationLevel | None = typer.Option(
+        None, "--level", help="""Filter by notification level"""
+    ),
+    type: NotificationType | None = typer.Option(
+        None, "--type", help="""Filter by notification type"""
+    ),
     unread: Literal["true", "false"] | None = typer.Option(
-        None, "--unread", help=""""""
+        None, "--unread", help="""Filter by unread status"""
     ),
 ) -> None:
     """Retrieve notifications
@@ -108,7 +112,9 @@ def get_notifications(
 def update_notification(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    read_at: datetime | None = typer.Option(None, "--read-at", help=""""""),
+    read_at: datetime | None = typer.Option(
+        None, "--read-at", help="""Date when notification was read"""
+    ),
 ) -> None:
     """Update a notification
 
@@ -131,8 +137,10 @@ def update_notification(
 @app.command("update-notifications", deprecated=False, rich_help_panel="API commands")
 def update_notifications(
     ctx: typer.Context,
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
-    read_at: datetime | None = typer.Option(None, "--read-at", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""Notification IDs to update"""),
+    read_at: datetime | None = typer.Option(
+        None, "--read-at", help="""Date when notifications were read"""
+    ),
 ) -> None:
     """Update notifications
 

immichpy/cli/commands/notifications_admin.py

@@ -21,13 +21,25 @@ app = typer.Typer(
 @app.command("create-notification", deprecated=False, rich_help_panel="API commands")
 def create_notification(
     ctx: typer.Context,
-    data: str | None = typer.Option(None, "--data", help="""As a JSON string"""),
-    description: str | None = typer.Option(None, "--description", help=""""""),
-    level: str | None = typer.Option(None, "--level", help=""""""),
-    read_at: datetime | None = typer.Option(None, "--read-at", help=""""""),
-    title: str = typer.Option(..., "--title", help=""""""),
-    type: str | None = typer.Option(None, "--type", help=""""""),
-    user_id: str = typer.Option(..., "--user-id", help=""""""),
+    data: str | None = typer.Option(
+        None,
+        "--data",
+        help="""Additional notification data
+
+As a JSON string""",
+    ),
+    description: str | None = typer.Option(
+        None, "--description", help="""Notification description"""
+    ),
+    level: str | None = typer.Option(None, "--level", help="""Notification level"""),
+    read_at: datetime | None = typer.Option(
+        None, "--read-at", help="""Date when notification was read"""
+    ),
+    title: str = typer.Option(..., "--title", help="""Notification title"""),
+    type: str | None = typer.Option(None, "--type", help="""Notification type"""),
+    user_id: str = typer.Option(
+        ..., "--user-id", help="""User ID to send notification to"""
+    ),
 ) -> None:
     """Create a notification
 
@@ -63,7 +75,7 @@ def create_notification(
 def get_notification_template_admin(
     ctx: typer.Context,
     name: str = typer.Argument(..., help=""""""),
-    template: str = typer.Option(..., "--template", help=""""""),
+    template: str = typer.Option(..., "--template", help="""Template name"""),
 ) -> None:
     """Render email template
 
@@ -89,19 +101,33 @@ def get_notification_template_admin(
 @app.command("send-test-email-admin", deprecated=False, rich_help_panel="API commands")
 def send_test_email_admin(
     ctx: typer.Context,
-    enabled: bool = typer.Option(..., "--enabled", help=""""""),
-    from_: str = typer.Option(..., "--from", help=""""""),
-    reply_to: str = typer.Option(..., "--reply-to", help=""""""),
-    transport_host: str = typer.Option(..., "--transport-host", help=""""""),
+    enabled: bool = typer.Option(
+        ..., "--enabled", help="""Whether SMTP email notifications are enabled"""
+    ),
+    from_: str = typer.Option(..., "--from", help="""Email address to send from"""),
+    reply_to: str = typer.Option(
+        ..., "--reply-to", help="""Email address for replies"""
+    ),
+    transport_host: str = typer.Option(
+        ..., "--transport-host", help="""SMTP server hostname"""
+    ),
     transport_ignore_cert: bool = typer.Option(
-        ..., "--transport-ignore-cert", help=""""""
+        ...,
+        "--transport-ignore-cert",
+        help="""Whether to ignore SSL certificate errors""",
+    ),
+    transport_password: str = typer.Option(
+        ..., "--transport-password", help="""SMTP password"""
     ),
-    transport_password: str = typer.Option(..., "--transport-password", help=""""""),
     transport_port: float = typer.Option(
-        ..., "--transport-port", help="""""", min=0, max=65535
+        ..., "--transport-port", help="""SMTP server port""", min=0, max=65535
+    ),
+    transport_secure: bool = typer.Option(
+        ..., "--transport-secure", help="""Whether to use secure connection (TLS/SSL)"""
+    ),
+    transport_username: str = typer.Option(
+        ..., "--transport-username", help="""SMTP username"""
     ),
-    transport_secure: bool = typer.Option(..., "--transport-secure", help=""""""),
-    transport_username: str = typer.Option(..., "--transport-username", help=""""""),
 ) -> None:
     """Send test email
 

immichpy/cli/commands/partners.py

@@ -19,7 +19,9 @@ app = typer.Typer(
 @app.command("create-partner", deprecated=False, rich_help_panel="API commands")
 def create_partner(
     ctx: typer.Context,
-    shared_with_id: str = typer.Option(..., "--shared-with-id", help=""""""),
+    shared_with_id: str = typer.Option(
+        ..., "--shared-with-id", help="""User ID to share with"""
+    ),
 ) -> None:
     """Create a partner
 
@@ -58,7 +60,9 @@ def create_partner_deprecated(
 @app.command("get-partners", deprecated=False, rich_help_panel="API commands")
 def get_partners(
     ctx: typer.Context,
-    direction: PartnerDirection = typer.Option(..., "--direction", help=""""""),
+    direction: PartnerDirection = typer.Option(
+        ..., "--direction", help="""Partner direction"""
+    ),
 ) -> None:
     """Retrieve partners
 
@@ -91,7 +95,9 @@ def remove_partner(
 def update_partner(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    in_timeline: bool = typer.Option(..., "--in-timeline", help=""""""),
+    in_timeline: bool = typer.Option(
+        ..., "--in-timeline", help="""Show partner assets in timeline"""
+    ),
 ) -> None:
     """Update a partner
 

immichpy/cli/commands/people.py

@@ -21,19 +21,16 @@ app = typer.Typer(
 def create_person(
     ctx: typer.Context,
     birth_date: str | None = typer.Option(
-        None,
-        "--birth-date",
-        help="""Person date of birth.
-Note: the mobile app cannot currently set the birth date to null.""",
+        None, "--birth-date", help="""Person date of birth"""
     ),
-    color: str | None = typer.Option(None, "--color", help=""""""),
+    color: str | None = typer.Option(None, "--color", help="""Person color (hex)"""),
     is_favorite: Literal["true", "false"] | None = typer.Option(
-        None, "--is-favorite", help=""""""
+        None, "--is-favorite", help="""Mark as favorite"""
     ),
     is_hidden: Literal["true", "false"] | None = typer.Option(
-        None, "--is-hidden", help="""Person visibility"""
+        None, "--is-hidden", help="""Person visibility (hidden)"""
     ),
-    name: str | None = typer.Option(None, "--name", help="""Person name."""),
+    name: str | None = typer.Option(None, "--name", help="""Person name"""),
 ) -> None:
     """Create a person
 
@@ -61,7 +58,7 @@ Note: the mobile app cannot currently set the birth date to null.""",
 @app.command("delete-people", deprecated=False, rich_help_panel="API commands")
 def delete_people(
     ctx: typer.Context,
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""IDs to process"""),
 ) -> None:
     """Delete people
 
@@ -97,10 +94,10 @@ def delete_person(
 def get_all_people(
     ctx: typer.Context,
     closest_asset_id: str | None = typer.Option(
-        None, "--closest-asset-id", help=""""""
+        None, "--closest-asset-id", help="""Closest asset ID for similarity search"""
     ),
     closest_person_id: str | None = typer.Option(
-        None, "--closest-person-id", help=""""""
+        None, "--closest-person-id", help="""Closest person ID for similarity search"""
     ),
     page: float | None = typer.Option(
         None, "--page", help="""Page number for pagination""", min=1
@@ -109,7 +106,7 @@ def get_all_people(
         None, "--size", help="""Number of items per page""", min=1, max=1000
     ),
     with_hidden: Literal["true", "false"] | None = typer.Option(
-        None, "--with-hidden", help=""""""
+        None, "--with-hidden", help="""Include hidden people"""
     ),
 ) -> None:
     """Get all people
@@ -184,7 +181,7 @@ def get_person_thumbnail(
 def merge_person(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help="""Person IDs to merge"""),
 ) -> None:
     """Merge people
 
@@ -205,7 +202,13 @@ def merge_person(
 def reassign_faces(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
-    data: list[str] = typer.Option(..., "--data", help="""As a JSON string"""),
+    data: list[str] = typer.Option(
+        ...,
+        "--data",
+        help="""Face update items
+
+As a JSON string""",
+    ),
 ) -> None:
     """Reassign faces
 
@@ -226,7 +229,13 @@ def reassign_faces(
 @app.command("update-people", deprecated=False, rich_help_panel="API commands")
 def update_people(
     ctx: typer.Context,
-    people: list[str] = typer.Option(..., "--people", help="""As a JSON string"""),
+    people: list[str] = typer.Option(
+        ...,
+        "--people",
+        help="""People to update
+
+As a JSON string""",
+    ),
 ) -> None:
     """Update people
 
@@ -248,24 +257,21 @@ def update_person(
     ctx: typer.Context,
     id: str = typer.Argument(..., help=""""""),
     birth_date: str | None = typer.Option(
-        None,
-        "--birth-date",
-        help="""Person date of birth.
-Note: the mobile app cannot currently set the birth date to null.""",
+        None, "--birth-date", help="""Person date of birth"""
     ),
-    color: str | None = typer.Option(None, "--color", help=""""""),
+    color: str | None = typer.Option(None, "--color", help="""Person color (hex)"""),
     feature_face_asset_id: str | None = typer.Option(
         None,
         "--feature-face-asset-id",
-        help="""Asset is used to get the feature face thumbnail.""",
+        help="""Asset ID used for feature face thumbnail""",
     ),
     is_favorite: Literal["true", "false"] | None = typer.Option(
-        None, "--is-favorite", help=""""""
+        None, "--is-favorite", help="""Mark as favorite"""
     ),
     is_hidden: Literal["true", "false"] | None = typer.Option(
-        None, "--is-hidden", help="""Person visibility"""
+        None, "--is-hidden", help="""Person visibility (hidden)"""
     ),
-    name: str | None = typer.Option(None, "--name", help="""Person name."""),
+    name: str | None = typer.Option(None, "--name", help="""Person name"""),
 ) -> None:
     """Update person
 

immichpy/cli/commands/plugins.py

@@ -32,6 +32,20 @@ def get_plugin(
     print_response(result, ctx)
 
 
+@app.command("get-plugin-triggers", deprecated=False, rich_help_panel="API commands")
+def get_plugin_triggers(
+    ctx: typer.Context,
+) -> None:
+    """List all plugin triggers
+
+    [link=https://api.immich.app/endpoints/plugins/getPluginTriggers]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.plugins, "get_plugin_triggers", ctx, **kwargs)
+    print_response(result, ctx)
+
+
 @app.command("get-plugins", deprecated=False, rich_help_panel="API commands")
 def get_plugins(
     ctx: typer.Context,

immichpy/cli/commands/queues.py

@@ -19,7 +19,7 @@ app = typer.Typer(
 @app.command("empty-queue", deprecated=False, rich_help_panel="API commands")
 def empty_queue(
     ctx: typer.Context,
-    name: QueueName = typer.Argument(..., help=""""""),
+    name: QueueName = typer.Argument(..., help="""Queue name"""),
     failed: Literal["true", "false"] | None = typer.Option(
         None,
         "--failed",
@@ -45,7 +45,7 @@ def empty_queue(
 @app.command("get-queue", deprecated=False, rich_help_panel="API commands")
 def get_queue(
     ctx: typer.Context,
-    name: QueueName = typer.Argument(..., help=""""""),
+    name: QueueName = typer.Argument(..., help="""Queue name"""),
 ) -> None:
     """Retrieve a queue
 
@@ -61,8 +61,10 @@ def get_queue(
 @app.command("get-queue-jobs", deprecated=False, rich_help_panel="API commands")
 def get_queue_jobs(
     ctx: typer.Context,
-    name: QueueName = typer.Argument(..., help=""""""),
-    status: list[QueueJobStatus] | None = typer.Option(None, "--status", help=""""""),
+    name: QueueName = typer.Argument(..., help="""Queue name"""),
+    status: list[QueueJobStatus] | None = typer.Option(
+        None, "--status", help="""Filter jobs by status"""
+    ),
 ) -> None:
     """Retrieve queue jobs
 
@@ -94,9 +96,9 @@ def get_queues(
 @app.command("update-queue", deprecated=False, rich_help_panel="API commands")
 def update_queue(
     ctx: typer.Context,
-    name: QueueName = typer.Argument(..., help=""""""),
+    name: QueueName = typer.Argument(..., help="""Queue name"""),
     is_paused: Literal["true", "false"] | None = typer.Option(
-        None, "--is-paused", help=""""""
+        None, "--is-paused", help="""Whether to pause the queue"""
     ),
 ) -> None:
     """Update a queue