immichpy 1.6.5__py3-none-any.whl

immichpy/cli/commands/albums.py

@@ -0,0 +1,317 @@
+"""Generated CLI commands for Albums tag (auto-generated, do not edit)."""
+
+from __future__ import annotations
+
+import typer
+import json
+from typing import Literal, 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="""An album is a collection of assets that can be shared with other users or via shared links.\n\n[link=https://api.immich.app/endpoints/albums]Immich API documentation[/link]"""
+)
+
+
+@app.command("add-assets-to-album", deprecated=False, rich_help_panel="API commands")
+def add_assets_to_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+) -> None:
+    """Add assets to an album
+
+    [link=https://api.immich.app/endpoints/albums/addAssetsToAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    set_nested(json_data, ["ids"], ids)
+    bulk_ids_dto = BulkIdsDto.model_validate(json_data)
+    kwargs["bulk_ids_dto"] = bulk_ids_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_assets_to_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("add-assets-to-albums", deprecated=False, rich_help_panel="API commands")
+def add_assets_to_albums(
+    ctx: typer.Context,
+    album_ids: list[str] = typer.Option(..., "--album-ids", help=""""""),
+    asset_ids: list[str] = typer.Option(..., "--asset-ids", help=""""""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+) -> None:
+    """Add assets to albums
+
+    [link=https://api.immich.app/endpoints/albums/addAssetsToAlbums]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    set_nested(json_data, ["album_ids"], album_ids)
+    set_nested(json_data, ["asset_ids"], asset_ids)
+    albums_add_assets_dto = AlbumsAddAssetsDto.model_validate(json_data)
+    kwargs["albums_add_assets_dto"] = albums_add_assets_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_assets_to_albums", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("add-users-to-album", deprecated=False, rich_help_panel="API commands")
+def add_users_to_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    album_users: list[str] = typer.Option(
+        ..., "--album-users", help="""As a JSON string"""
+    ),
+) -> None:
+    """Share album with users
+
+    [link=https://api.immich.app/endpoints/albums/addUsersToAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    value_album_users = [json.loads(i) for i in album_users]
+    set_nested(json_data, ["album_users"], value_album_users)
+    add_users_dto = AddUsersDto.model_validate(json_data)
+    kwargs["add_users_dto"] = add_users_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "add_users_to_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("create-album", deprecated=False, rich_help_panel="API commands")
+def create_album(
+    ctx: typer.Context,
+    album_name: str = typer.Option(..., "--album-name", help=""""""),
+    album_users: list[str] | None = typer.Option(
+        None, "--album-users", help="""As a JSON string"""
+    ),
+    asset_ids: list[str] | None = typer.Option(None, "--asset-ids", help=""""""),
+    description: str | None = typer.Option(None, "--description", help=""""""),
+) -> None:
+    """Create an album
+
+    [link=https://api.immich.app/endpoints/albums/createAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    set_nested(json_data, ["album_name"], album_name)
+    if album_users is not None:
+        value_album_users = [json.loads(i) for i in album_users]
+        set_nested(json_data, ["album_users"], value_album_users)
+    if asset_ids is not None:
+        set_nested(json_data, ["asset_ids"], asset_ids)
+    if description is not None:
+        set_nested(json_data, ["description"], description)
+    create_album_dto = CreateAlbumDto.model_validate(json_data)
+    kwargs["create_album_dto"] = create_album_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "create_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("delete-album", deprecated=False, rich_help_panel="API commands")
+def delete_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Delete an album
+
+    [link=https://api.immich.app/endpoints/albums/deleteAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "delete_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-album-info", deprecated=False, rich_help_panel="API commands")
+def get_album_info(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    key: str | None = typer.Option(None, "--key", help=""""""),
+    slug: str | None = typer.Option(None, "--slug", help=""""""),
+    without_assets: Literal["true", "false"] | None = typer.Option(
+        None, "--without-assets", help=""""""
+    ),
+) -> None:
+    """Retrieve an album
+
+    [link=https://api.immich.app/endpoints/albums/getAlbumInfo]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    if key is not None:
+        kwargs["key"] = key
+    if slug is not None:
+        kwargs["slug"] = slug
+    if without_assets is not None:
+        kwargs["without_assets"] = without_assets.lower() == "true"
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_album_info", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-album-statistics", deprecated=False, rich_help_panel="API commands")
+def get_album_statistics(
+    ctx: typer.Context,
+) -> None:
+    """Retrieve album statistics
+
+    [link=https://api.immich.app/endpoints/albums/getAlbumStatistics]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_album_statistics", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-all-albums", deprecated=False, rich_help_panel="API commands")
+def get_all_albums(
+    ctx: typer.Context,
+    asset_id: str | None = typer.Option(
+        None,
+        "--asset-id",
+        help="""Only returns albums that contain the asset
+Ignores the shared parameter
+undefined: get all albums""",
+    ),
+    shared: Literal["true", "false"] | None = typer.Option(
+        None, "--shared", help=""""""
+    ),
+) -> None:
+    """List all albums
+
+    [link=https://api.immich.app/endpoints/albums/getAllAlbums]Immich API documentation[/link]
+    """
+    kwargs = {}
+    if asset_id is not None:
+        kwargs["asset_id"] = asset_id
+    if shared is not None:
+        kwargs["shared"] = shared.lower() == "true"
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "get_all_albums", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command(
+    "remove-asset-from-album", deprecated=False, rich_help_panel="API commands"
+)
+def remove_asset_from_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    ids: list[str] = typer.Option(..., "--ids", help=""""""),
+) -> None:
+    """Remove assets from an album
+
+    [link=https://api.immich.app/endpoints/albums/removeAssetFromAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    set_nested(json_data, ["ids"], ids)
+    bulk_ids_dto = BulkIdsDto.model_validate(json_data)
+    kwargs["bulk_ids_dto"] = bulk_ids_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.albums, "remove_asset_from_album", ctx, **kwargs
+    )
+    print_response(result, ctx)
+
+
+@app.command("remove-user-from-album", deprecated=False, rich_help_panel="API commands")
+def remove_user_from_album(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    user_id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Remove user from album
+
+    [link=https://api.immich.app/endpoints/albums/removeUserFromAlbum]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    kwargs["user_id"] = user_id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "remove_user_from_album", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("update-album-info", deprecated=False, rich_help_panel="API commands")
+def update_album_info(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    album_name: str | None = typer.Option(None, "--album-name", help=""""""),
+    album_thumbnail_asset_id: str | None = typer.Option(
+        None, "--album-thumbnail-asset-id", help=""""""
+    ),
+    description: str | None = typer.Option(None, "--description", help=""""""),
+    is_activity_enabled: Literal["true", "false"] | None = typer.Option(
+        None, "--is-activity-enabled", help=""""""
+    ),
+    order: str | None = typer.Option(None, "--order", help=""""""),
+) -> None:
+    """Update an album
+
+    [link=https://api.immich.app/endpoints/albums/updateAlbumInfo]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    if album_name is not None:
+        set_nested(json_data, ["album_name"], album_name)
+    if album_thumbnail_asset_id is not None:
+        set_nested(json_data, ["album_thumbnail_asset_id"], album_thumbnail_asset_id)
+    if description is not None:
+        set_nested(json_data, ["description"], description)
+    if is_activity_enabled is not None:
+        set_nested(
+            json_data, ["is_activity_enabled"], is_activity_enabled.lower() == "true"
+        )
+    if order is not None:
+        set_nested(json_data, ["order"], order)
+    update_album_dto = UpdateAlbumDto.model_validate(json_data)
+    kwargs["update_album_dto"] = update_album_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "update_album_info", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("update-album-user", deprecated=False, rich_help_panel="API commands")
+def update_album_user(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    user_id: str = typer.Argument(..., help=""""""),
+    role: str = typer.Option(..., "--role", help=""""""),
+) -> None:
+    """Update user role
+
+    [link=https://api.immich.app/endpoints/albums/updateAlbumUser]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    kwargs["user_id"] = user_id
+    set_nested(json_data, ["role"], role)
+    update_album_user_dto = UpdateAlbumUserDto.model_validate(json_data)
+    kwargs["update_album_user_dto"] = update_album_user_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.albums, "update_album_user", ctx, **kwargs)
+    print_response(result, ctx)

immichpy/cli/commands/api_keys.py

@@ -0,0 +1,125 @@
+"""Generated CLI commands for API keys tag (auto-generated, do not edit)."""
+
+from __future__ import annotations
+
+import typer
+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="""An api key can be used to programmatically access the Immich API.\n\n[link=https://api.immich.app/endpoints/api-keys]Immich API documentation[/link]"""
+)
+
+
+@app.command("create-api-key", deprecated=False, rich_help_panel="API commands")
+def create_api_key(
+    ctx: typer.Context,
+    name: str | None = typer.Option(None, "--name", help=""""""),
+    permissions: list[Permission] = typer.Option(..., "--permissions", help=""""""),
+) -> None:
+    """Create an API key
+
+    [link=https://api.immich.app/endpoints/api-keys/createApiKey]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    if name is not None:
+        set_nested(json_data, ["name"], name)
+    set_nested(json_data, ["permissions"], permissions)
+    api_key_create_dto = APIKeyCreateDto.model_validate(json_data)
+    kwargs["api_key_create_dto"] = api_key_create_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "create_api_key", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("delete-api-key", deprecated=False, rich_help_panel="API commands")
+def delete_api_key(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Delete an API key
+
+    [link=https://api.immich.app/endpoints/api-keys/deleteApiKey]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "delete_api_key", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-api-key", deprecated=False, rich_help_panel="API commands")
+def get_api_key(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Retrieve an API key
+
+    [link=https://api.immich.app/endpoints/api-keys/getApiKey]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "get_api_key", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-api-keys", deprecated=False, rich_help_panel="API commands")
+def get_api_keys(
+    ctx: typer.Context,
+) -> None:
+    """List all API keys
+
+    [link=https://api.immich.app/endpoints/api-keys/getApiKeys]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "get_api_keys", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-my-api-key", deprecated=False, rich_help_panel="API commands")
+def get_my_api_key(
+    ctx: typer.Context,
+) -> None:
+    """Retrieve the current API key
+
+    [link=https://api.immich.app/endpoints/api-keys/getMyApiKey]Immich API documentation[/link]
+    """
+    kwargs = {}
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "get_my_api_key", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("update-api-key", deprecated=False, rich_help_panel="API commands")
+def update_api_key(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+    name: str | None = typer.Option(None, "--name", help=""""""),
+    permissions: list[Permission] | None = typer.Option(
+        None, "--permissions", help=""""""
+    ),
+) -> None:
+    """Update an API key
+
+    [link=https://api.immich.app/endpoints/api-keys/updateApiKey]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    kwargs["id"] = id
+    if name is not None:
+        set_nested(json_data, ["name"], name)
+    if permissions is not None:
+        set_nested(json_data, ["permissions"], permissions)
+    api_key_update_dto = APIKeyUpdateDto.model_validate(json_data)
+    kwargs["api_key_update_dto"] = api_key_update_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.api_keys, "update_api_key", ctx, **kwargs)
+    print_response(result, ctx)