immichpy 1.6.5__py3-none-any.whl

immichpy/.openapi-generator/FILES

@@ -0,0 +1,387 @@
+client/__init__.py
+client/api/__init__.py
+client/api/activities_api.py
+client/api/albums_api.py
+client/api/api_keys_api.py
+client/api/assets_api.py
+client/api/authentication_admin_api.py
+client/api/authentication_api.py
+client/api/deprecated_api.py
+client/api/download_api.py
+client/api/duplicates_api.py
+client/api/faces_api.py
+client/api/jobs_api.py
+client/api/libraries_api.py
+client/api/maintenance_admin_api.py
+client/api/map_api.py
+client/api/memories_api.py
+client/api/notifications_admin_api.py
+client/api/notifications_api.py
+client/api/partners_api.py
+client/api/people_api.py
+client/api/plugins_api.py
+client/api/queues_api.py
+client/api/search_api.py
+client/api/server_api.py
+client/api/sessions_api.py
+client/api/shared_links_api.py
+client/api/stacks_api.py
+client/api/sync_api.py
+client/api/system_config_api.py
+client/api/system_metadata_api.py
+client/api/tags_api.py
+client/api/timeline_api.py
+client/api/trash_api.py
+client/api/users_admin_api.py
+client/api/users_api.py
+client/api/views_api.py
+client/api/workflows_api.py
+client/api_client.py
+client/api_response.py
+client/configuration.py
+client/exceptions.py
+client/models/__init__.py
+client/models/activity_create_dto.py
+client/models/activity_response_dto.py
+client/models/activity_statistics_response_dto.py
+client/models/add_users_dto.py
+client/models/admin_onboarding_update_dto.py
+client/models/album_response_dto.py
+client/models/album_statistics_response_dto.py
+client/models/album_user_add_dto.py
+client/models/album_user_create_dto.py
+client/models/album_user_response_dto.py
+client/models/album_user_role.py
+client/models/albums_add_assets_dto.py
+client/models/albums_add_assets_response_dto.py
+client/models/albums_response.py
+client/models/albums_update.py
+client/models/api_key_create_dto.py
+client/models/api_key_create_response_dto.py
+client/models/api_key_response_dto.py
+client/models/api_key_update_dto.py
+client/models/asset_bulk_delete_dto.py
+client/models/asset_bulk_update_dto.py
+client/models/asset_bulk_upload_check_dto.py
+client/models/asset_bulk_upload_check_item.py
+client/models/asset_bulk_upload_check_response_dto.py
+client/models/asset_bulk_upload_check_result.py
+client/models/asset_copy_dto.py
+client/models/asset_delta_sync_dto.py
+client/models/asset_delta_sync_response_dto.py
+client/models/asset_edit_action.py
+client/models/asset_edit_action_crop.py
+client/models/asset_edit_action_list_dto.py
+client/models/asset_edit_action_list_dto_edits_inner.py
+client/models/asset_edit_action_mirror.py
+client/models/asset_edit_action_rotate.py
+client/models/asset_edits_dto.py
+client/models/asset_face_create_dto.py
+client/models/asset_face_delete_dto.py
+client/models/asset_face_response_dto.py
+client/models/asset_face_update_dto.py
+client/models/asset_face_update_item.py
+client/models/asset_face_without_person_response_dto.py
+client/models/asset_full_sync_dto.py
+client/models/asset_ids_dto.py
+client/models/asset_ids_response_dto.py
+client/models/asset_job_name.py
+client/models/asset_jobs_dto.py
+client/models/asset_media_response_dto.py
+client/models/asset_media_size.py
+client/models/asset_media_status.py
+client/models/asset_metadata_bulk_delete_dto.py
+client/models/asset_metadata_bulk_delete_item_dto.py
+client/models/asset_metadata_bulk_response_dto.py
+client/models/asset_metadata_bulk_upsert_dto.py
+client/models/asset_metadata_bulk_upsert_item_dto.py
+client/models/asset_metadata_response_dto.py
+client/models/asset_metadata_upsert_dto.py
+client/models/asset_metadata_upsert_item_dto.py
+client/models/asset_ocr_response_dto.py
+client/models/asset_order.py
+client/models/asset_response_dto.py
+client/models/asset_stack_response_dto.py
+client/models/asset_stats_response_dto.py
+client/models/asset_type_enum.py
+client/models/asset_visibility.py
+client/models/audio_codec.py
+client/models/auth_status_response_dto.py
+client/models/avatar_update.py
+client/models/bulk_id_error_reason.py
+client/models/bulk_id_response_dto.py
+client/models/bulk_ids_dto.py
+client/models/cast_response.py
+client/models/cast_update.py
+client/models/change_password_dto.py
+client/models/check_existing_assets_dto.py
+client/models/check_existing_assets_response_dto.py
+client/models/clip_config.py
+client/models/colorspace.py
+client/models/contributor_count_response_dto.py
+client/models/cq_mode.py
+client/models/create_album_dto.py
+client/models/create_library_dto.py
+client/models/create_profile_image_response_dto.py
+client/models/crop_parameters.py
+client/models/database_backup_config.py
+client/models/download_archive_info.py
+client/models/download_info_dto.py
+client/models/download_response.py
+client/models/download_response_dto.py
+client/models/download_update.py
+client/models/duplicate_detection_config.py
+client/models/duplicate_response_dto.py
+client/models/email_notifications_response.py
+client/models/email_notifications_update.py
+client/models/exif_response_dto.py
+client/models/face_dto.py
+client/models/facial_recognition_config.py
+client/models/folders_response.py
+client/models/folders_update.py
+client/models/image_format.py
+client/models/job_create_dto.py
+client/models/job_name.py
+client/models/job_settings_dto.py
+client/models/library_response_dto.py
+client/models/library_stats_response_dto.py
+client/models/license_key_dto.py
+client/models/license_response_dto.py
+client/models/log_level.py
+client/models/login_credential_dto.py
+client/models/login_response_dto.py
+client/models/logout_response_dto.py
+client/models/machine_learning_availability_checks_dto.py
+client/models/maintenance_action.py
+client/models/maintenance_auth_dto.py
+client/models/maintenance_login_dto.py
+client/models/manual_job_name.py
+client/models/map_marker_response_dto.py
+client/models/map_reverse_geocode_response_dto.py
+client/models/memories_response.py
+client/models/memories_update.py
+client/models/memory_create_dto.py
+client/models/memory_response_dto.py
+client/models/memory_search_order.py
+client/models/memory_statistics_response_dto.py
+client/models/memory_type.py
+client/models/memory_update_dto.py
+client/models/merge_person_dto.py
+client/models/metadata_search_dto.py
+client/models/mirror_axis.py
+client/models/mirror_parameters.py
+client/models/notification_create_dto.py
+client/models/notification_delete_all_dto.py
+client/models/notification_dto.py
+client/models/notification_level.py
+client/models/notification_type.py
+client/models/notification_update_all_dto.py
+client/models/notification_update_dto.py
+client/models/o_auth_authorize_response_dto.py
+client/models/o_auth_callback_dto.py
+client/models/o_auth_config_dto.py
+client/models/o_auth_token_endpoint_auth_method.py
+client/models/ocr_config.py
+client/models/on_this_day_dto.py
+client/models/onboarding_dto.py
+client/models/onboarding_response_dto.py
+client/models/partner_create_dto.py
+client/models/partner_direction.py
+client/models/partner_response_dto.py
+client/models/partner_update_dto.py
+client/models/people_response.py
+client/models/people_response_dto.py
+client/models/people_update.py
+client/models/people_update_dto.py
+client/models/people_update_item.py
+client/models/permission.py
+client/models/person_create_dto.py
+client/models/person_response_dto.py
+client/models/person_statistics_response_dto.py
+client/models/person_update_dto.py
+client/models/person_with_faces_response_dto.py
+client/models/pin_code_change_dto.py
+client/models/pin_code_reset_dto.py
+client/models/pin_code_setup_dto.py
+client/models/places_response_dto.py
+client/models/plugin_action_response_dto.py
+client/models/plugin_context_type.py
+client/models/plugin_filter_response_dto.py
+client/models/plugin_response_dto.py
+client/models/plugin_trigger_response_dto.py
+client/models/plugin_trigger_type.py
+client/models/purchase_response.py
+client/models/purchase_update.py
+client/models/queue_command.py
+client/models/queue_command_dto.py
+client/models/queue_delete_dto.py
+client/models/queue_job_response_dto.py
+client/models/queue_job_status.py
+client/models/queue_name.py
+client/models/queue_response_dto.py
+client/models/queue_response_legacy_dto.py
+client/models/queue_statistics_dto.py
+client/models/queue_status_legacy_dto.py
+client/models/queue_update_dto.py
+client/models/queues_response_legacy_dto.py
+client/models/random_search_dto.py
+client/models/ratings_response.py
+client/models/ratings_update.py
+client/models/reaction_level.py
+client/models/reaction_type.py
+client/models/reverse_geocoding_state_response_dto.py
+client/models/rotate_parameters.py
+client/models/search_album_response_dto.py
+client/models/search_asset_response_dto.py
+client/models/search_explore_item.py
+client/models/search_explore_response_dto.py
+client/models/search_facet_count_response_dto.py
+client/models/search_facet_response_dto.py
+client/models/search_response_dto.py
+client/models/search_statistics_response_dto.py
+client/models/search_suggestion_type.py
+client/models/server_about_response_dto.py
+client/models/server_apk_links_dto.py
+client/models/server_config_dto.py
+client/models/server_features_dto.py
+client/models/server_media_types_response_dto.py
+client/models/server_ping_response.py
+client/models/server_stats_response_dto.py
+client/models/server_storage_response_dto.py
+client/models/server_theme_dto.py
+client/models/server_version_history_response_dto.py
+client/models/server_version_response_dto.py
+client/models/session_create_dto.py
+client/models/session_create_response_dto.py
+client/models/session_response_dto.py
+client/models/session_unlock_dto.py
+client/models/session_update_dto.py
+client/models/set_maintenance_mode_dto.py
+client/models/shared_link_create_dto.py
+client/models/shared_link_edit_dto.py
+client/models/shared_link_response_dto.py
+client/models/shared_link_type.py
+client/models/shared_links_response.py
+client/models/shared_links_update.py
+client/models/sign_up_dto.py
+client/models/smart_search_dto.py
+client/models/source_type.py
+client/models/stack_create_dto.py
+client/models/stack_response_dto.py
+client/models/stack_update_dto.py
+client/models/statistics_search_dto.py
+client/models/sync_ack_delete_dto.py
+client/models/sync_ack_dto.py
+client/models/sync_ack_set_dto.py
+client/models/sync_album_delete_v1.py
+client/models/sync_album_to_asset_delete_v1.py
+client/models/sync_album_to_asset_v1.py
+client/models/sync_album_user_delete_v1.py
+client/models/sync_album_user_v1.py
+client/models/sync_album_v1.py
+client/models/sync_asset_delete_v1.py
+client/models/sync_asset_exif_v1.py
+client/models/sync_asset_face_delete_v1.py
+client/models/sync_asset_face_v1.py
+client/models/sync_asset_metadata_delete_v1.py
+client/models/sync_asset_metadata_v1.py
+client/models/sync_asset_v1.py
+client/models/sync_auth_user_v1.py
+client/models/sync_entity_type.py
+client/models/sync_memory_asset_delete_v1.py
+client/models/sync_memory_asset_v1.py
+client/models/sync_memory_delete_v1.py
+client/models/sync_memory_v1.py
+client/models/sync_partner_delete_v1.py
+client/models/sync_partner_v1.py
+client/models/sync_person_delete_v1.py
+client/models/sync_person_v1.py
+client/models/sync_request_type.py
+client/models/sync_stack_delete_v1.py
+client/models/sync_stack_v1.py
+client/models/sync_stream_dto.py
+client/models/sync_user_delete_v1.py
+client/models/sync_user_metadata_delete_v1.py
+client/models/sync_user_metadata_v1.py
+client/models/sync_user_v1.py
+client/models/system_config_backups_dto.py
+client/models/system_config_dto.py
+client/models/system_config_f_fmpeg_dto.py
+client/models/system_config_faces_dto.py
+client/models/system_config_generated_fullsize_image_dto.py
+client/models/system_config_generated_image_dto.py
+client/models/system_config_image_dto.py
+client/models/system_config_job_dto.py
+client/models/system_config_library_dto.py
+client/models/system_config_library_scan_dto.py
+client/models/system_config_library_watch_dto.py
+client/models/system_config_logging_dto.py
+client/models/system_config_machine_learning_dto.py
+client/models/system_config_map_dto.py
+client/models/system_config_metadata_dto.py
+client/models/system_config_new_version_check_dto.py
+client/models/system_config_nightly_tasks_dto.py
+client/models/system_config_notifications_dto.py
+client/models/system_config_o_auth_dto.py
+client/models/system_config_password_login_dto.py
+client/models/system_config_reverse_geocoding_dto.py
+client/models/system_config_server_dto.py
+client/models/system_config_smtp_dto.py
+client/models/system_config_smtp_transport_dto.py
+client/models/system_config_storage_template_dto.py
+client/models/system_config_template_emails_dto.py
+client/models/system_config_template_storage_option_dto.py
+client/models/system_config_templates_dto.py
+client/models/system_config_theme_dto.py
+client/models/system_config_trash_dto.py
+client/models/system_config_user_dto.py
+client/models/tag_bulk_assets_dto.py
+client/models/tag_bulk_assets_response_dto.py
+client/models/tag_create_dto.py
+client/models/tag_response_dto.py
+client/models/tag_update_dto.py
+client/models/tag_upsert_dto.py
+client/models/tags_response.py
+client/models/tags_update.py
+client/models/template_dto.py
+client/models/template_response_dto.py
+client/models/test_email_response_dto.py
+client/models/time_bucket_asset_response_dto.py
+client/models/time_buckets_response_dto.py
+client/models/tone_mapping.py
+client/models/transcode_hw_accel.py
+client/models/transcode_policy.py
+client/models/trash_response_dto.py
+client/models/update_album_dto.py
+client/models/update_album_user_dto.py
+client/models/update_asset_dto.py
+client/models/update_library_dto.py
+client/models/usage_by_user_dto.py
+client/models/user_admin_create_dto.py
+client/models/user_admin_delete_dto.py
+client/models/user_admin_response_dto.py
+client/models/user_admin_update_dto.py
+client/models/user_avatar_color.py
+client/models/user_license.py
+client/models/user_metadata_key.py
+client/models/user_preferences_response_dto.py
+client/models/user_preferences_update_dto.py
+client/models/user_response_dto.py
+client/models/user_status.py
+client/models/user_update_me_dto.py
+client/models/validate_access_token_response_dto.py
+client/models/validate_library_dto.py
+client/models/validate_library_import_path_response_dto.py
+client/models/validate_library_response_dto.py
+client/models/version_check_state_response_dto.py
+client/models/video_codec.py
+client/models/video_container.py
+client/models/workflow_action_item_dto.py
+client/models/workflow_action_response_dto.py
+client/models/workflow_create_dto.py
+client/models/workflow_filter_item_dto.py
+client/models/workflow_filter_response_dto.py
+client/models/workflow_response_dto.py
+client/models/workflow_update_dto.py
+client/py.typed
+client/rest.py

immichpy/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.18.0

immichpy/__init__.py

@@ -0,0 +1,3 @@
+from immichpy.client.main import AsyncClient
+
+__all__ = ["AsyncClient"]

immichpy/cli/__main__.py

@@ -0,0 +1,12 @@
+try:  # pragma: no cover
+    from .main import app
+except ImportError:  # pragma: no cover
+    import sys
+
+    message = 'To use the immich command, install the "cli" extra:\n\n\t- pip install immich[cli]\n\tOR\n\t- uv add immich --extra cli\n'
+    print(message, file=sys.stderr)
+    sys.exit(1)
+
+
+def main() -> None:  # pragma: no cover
+    app()

immichpy/cli/commands/activities.py

@@ -0,0 +1,110 @@
+"""Generated CLI commands for Activities 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 activity is a like or a comment made by a user on an asset or album.\n\n[link=https://api.immich.app/endpoints/activities]Immich API documentation[/link]"""
+)
+
+
+@app.command("create-activity", deprecated=False, rich_help_panel="API commands")
+def create_activity(
+    ctx: typer.Context,
+    album_id: str = typer.Option(..., "--album-id", help=""""""),
+    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
+    comment: str | None = typer.Option(None, "--comment", help=""""""),
+    type: str = typer.Option(..., "--type", help=""""""),
+) -> None:
+    """Create an activity
+
+    [link=https://api.immich.app/endpoints/activities/createActivity]Immich API documentation[/link]
+    """
+    kwargs = {}
+    json_data = {}
+    set_nested(json_data, ["album_id"], album_id)
+    if asset_id is not None:
+        set_nested(json_data, ["asset_id"], asset_id)
+    if comment is not None:
+        set_nested(json_data, ["comment"], comment)
+    set_nested(json_data, ["type"], type)
+    activity_create_dto = ActivityCreateDto.model_validate(json_data)
+    kwargs["activity_create_dto"] = activity_create_dto
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.activities, "create_activity", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("delete-activity", deprecated=False, rich_help_panel="API commands")
+def delete_activity(
+    ctx: typer.Context,
+    id: str = typer.Argument(..., help=""""""),
+) -> None:
+    """Delete an activity
+
+    [link=https://api.immich.app/endpoints/activities/deleteActivity]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["id"] = id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.activities, "delete_activity", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command("get-activities", deprecated=False, rich_help_panel="API commands")
+def get_activities(
+    ctx: typer.Context,
+    album_id: str = typer.Option(..., "--album-id", help=""""""),
+    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
+    level: ReactionLevel | None = typer.Option(None, "--level", help=""""""),
+    type: ReactionType | None = typer.Option(None, "--type", help=""""""),
+    user_id: str | None = typer.Option(None, "--user-id", help=""""""),
+) -> None:
+    """List all activities
+
+    [link=https://api.immich.app/endpoints/activities/getActivities]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["album_id"] = album_id
+    if asset_id is not None:
+        kwargs["asset_id"] = asset_id
+    if level is not None:
+        kwargs["level"] = level
+    if type is not None:
+        kwargs["type"] = type
+    if user_id is not None:
+        kwargs["user_id"] = user_id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(client, client.activities, "get_activities", ctx, **kwargs)
+    print_response(result, ctx)
+
+
+@app.command(
+    "get-activity-statistics", deprecated=False, rich_help_panel="API commands"
+)
+def get_activity_statistics(
+    ctx: typer.Context,
+    album_id: str = typer.Option(..., "--album-id", help=""""""),
+    asset_id: str | None = typer.Option(None, "--asset-id", help=""""""),
+) -> None:
+    """Retrieve activity statistics
+
+    [link=https://api.immich.app/endpoints/activities/getActivityStatistics]Immich API documentation[/link]
+    """
+    kwargs = {}
+    kwargs["album_id"] = album_id
+    if asset_id is not None:
+        kwargs["asset_id"] = asset_id
+    client: "AsyncClient" = ctx.obj["client"]
+    result = run_command(
+        client, client.activities, "get_activity_statistics", ctx, **kwargs
+    )
+    print_response(result, ctx)