[CLEANUP] Cleaner API gen (less unneeded stuff)

This commit is contained in:
2026-07-03 20:42:47 +02:00
parent d50345fc64
commit fe08201250
750 changed files with 15316 additions and 100454 deletions
+384
View File
@@ -0,0 +1,384 @@
generated/__init__.py
generated/immich/__init__.py
generated/immich/openapi_client/__init__.py
generated/immich/openapi_client/api/__init__.py
generated/immich/openapi_client/api/albums_api.py
generated/immich/openapi_client/api/assets_api.py
generated/immich/openapi_client/api/search_api.py
generated/immich/openapi_client/api_client.py
generated/immich/openapi_client/api_response.py
generated/immich/openapi_client/configuration.py
generated/immich/openapi_client/exceptions.py
generated/immich/openapi_client/models/__init__.py
generated/immich/openapi_client/models/activity_create_dto.py
generated/immich/openapi_client/models/activity_response_dto.py
generated/immich/openapi_client/models/activity_statistics_response_dto.py
generated/immich/openapi_client/models/add_users_dto.py
generated/immich/openapi_client/models/admin_onboarding_update_dto.py
generated/immich/openapi_client/models/album_response_dto.py
generated/immich/openapi_client/models/album_statistics_response_dto.py
generated/immich/openapi_client/models/album_user_add_dto.py
generated/immich/openapi_client/models/album_user_create_dto.py
generated/immich/openapi_client/models/album_user_response_dto.py
generated/immich/openapi_client/models/album_user_role.py
generated/immich/openapi_client/models/albums_add_assets_dto.py
generated/immich/openapi_client/models/albums_add_assets_response_dto.py
generated/immich/openapi_client/models/albums_response.py
generated/immich/openapi_client/models/albums_update.py
generated/immich/openapi_client/models/api_key_create_dto.py
generated/immich/openapi_client/models/api_key_create_response_dto.py
generated/immich/openapi_client/models/api_key_response_dto.py
generated/immich/openapi_client/models/api_key_update_dto.py
generated/immich/openapi_client/models/asset_bulk_delete_dto.py
generated/immich/openapi_client/models/asset_bulk_update_dto.py
generated/immich/openapi_client/models/asset_bulk_upload_check_dto.py
generated/immich/openapi_client/models/asset_bulk_upload_check_item.py
generated/immich/openapi_client/models/asset_bulk_upload_check_response_dto.py
generated/immich/openapi_client/models/asset_bulk_upload_check_result.py
generated/immich/openapi_client/models/asset_copy_dto.py
generated/immich/openapi_client/models/asset_edit_action.py
generated/immich/openapi_client/models/asset_edit_action_item_dto.py
generated/immich/openapi_client/models/asset_edit_action_item_dto_parameters.py
generated/immich/openapi_client/models/asset_edit_action_item_response_dto.py
generated/immich/openapi_client/models/asset_edits_create_dto.py
generated/immich/openapi_client/models/asset_edits_response_dto.py
generated/immich/openapi_client/models/asset_face_create_dto.py
generated/immich/openapi_client/models/asset_face_delete_dto.py
generated/immich/openapi_client/models/asset_face_response_dto.py
generated/immich/openapi_client/models/asset_face_update_dto.py
generated/immich/openapi_client/models/asset_face_update_item.py
generated/immich/openapi_client/models/asset_id_error_reason.py
generated/immich/openapi_client/models/asset_ids_dto.py
generated/immich/openapi_client/models/asset_ids_response_dto.py
generated/immich/openapi_client/models/asset_job_name.py
generated/immich/openapi_client/models/asset_jobs_dto.py
generated/immich/openapi_client/models/asset_media_response_dto.py
generated/immich/openapi_client/models/asset_media_size.py
generated/immich/openapi_client/models/asset_media_status.py
generated/immich/openapi_client/models/asset_metadata_bulk_delete_dto.py
generated/immich/openapi_client/models/asset_metadata_bulk_delete_item_dto.py
generated/immich/openapi_client/models/asset_metadata_bulk_response_dto.py
generated/immich/openapi_client/models/asset_metadata_bulk_upsert_dto.py
generated/immich/openapi_client/models/asset_metadata_bulk_upsert_item_dto.py
generated/immich/openapi_client/models/asset_metadata_response_dto.py
generated/immich/openapi_client/models/asset_metadata_upsert_dto.py
generated/immich/openapi_client/models/asset_metadata_upsert_item_dto.py
generated/immich/openapi_client/models/asset_ocr_response_dto.py
generated/immich/openapi_client/models/asset_order.py
generated/immich/openapi_client/models/asset_order_by.py
generated/immich/openapi_client/models/asset_reject_reason.py
generated/immich/openapi_client/models/asset_response_dto.py
generated/immich/openapi_client/models/asset_stack_response_dto.py
generated/immich/openapi_client/models/asset_stats_response_dto.py
generated/immich/openapi_client/models/asset_type_enum.py
generated/immich/openapi_client/models/asset_upload_action.py
generated/immich/openapi_client/models/asset_visibility.py
generated/immich/openapi_client/models/audio_codec.py
generated/immich/openapi_client/models/auth_status_response_dto.py
generated/immich/openapi_client/models/avatar_update.py
generated/immich/openapi_client/models/bulk_id_error_reason.py
generated/immich/openapi_client/models/bulk_id_response_dto.py
generated/immich/openapi_client/models/bulk_ids_dto.py
generated/immich/openapi_client/models/calendar_heatmap_response_dto.py
generated/immich/openapi_client/models/calendar_heatmap_response_dto_series_inner.py
generated/immich/openapi_client/models/calendar_heatmap_type.py
generated/immich/openapi_client/models/cast_response.py
generated/immich/openapi_client/models/cast_update.py
generated/immich/openapi_client/models/change_password_dto.py
generated/immich/openapi_client/models/clip_config.py
generated/immich/openapi_client/models/colorspace.py
generated/immich/openapi_client/models/contributor_count_response_dto.py
generated/immich/openapi_client/models/cq_mode.py
generated/immich/openapi_client/models/create_album_dto.py
generated/immich/openapi_client/models/create_library_dto.py
generated/immich/openapi_client/models/create_profile_image_response_dto.py
generated/immich/openapi_client/models/crop_parameters.py
generated/immich/openapi_client/models/database_backup_config.py
generated/immich/openapi_client/models/database_backup_delete_dto.py
generated/immich/openapi_client/models/database_backup_dto.py
generated/immich/openapi_client/models/database_backup_list_response_dto.py
generated/immich/openapi_client/models/download_archive_dto.py
generated/immich/openapi_client/models/download_archive_info.py
generated/immich/openapi_client/models/download_info_dto.py
generated/immich/openapi_client/models/download_response.py
generated/immich/openapi_client/models/download_response_dto.py
generated/immich/openapi_client/models/download_update.py
generated/immich/openapi_client/models/duplicate_detection_config.py
generated/immich/openapi_client/models/duplicate_resolve_dto.py
generated/immich/openapi_client/models/duplicate_resolve_group_dto.py
generated/immich/openapi_client/models/duplicate_response_dto.py
generated/immich/openapi_client/models/email_notifications_response.py
generated/immich/openapi_client/models/email_notifications_update.py
generated/immich/openapi_client/models/exif_response_dto.py
generated/immich/openapi_client/models/face_dto.py
generated/immich/openapi_client/models/facial_recognition_config.py
generated/immich/openapi_client/models/folders_response.py
generated/immich/openapi_client/models/folders_update.py
generated/immich/openapi_client/models/image_format.py
generated/immich/openapi_client/models/integrity_report.py
generated/immich/openapi_client/models/integrity_report_response_dto.py
generated/immich/openapi_client/models/integrity_report_response_dto_items_inner.py
generated/immich/openapi_client/models/integrity_report_summary_response_dto.py
generated/immich/openapi_client/models/job_create_dto.py
generated/immich/openapi_client/models/job_name.py
generated/immich/openapi_client/models/job_settings_dto.py
generated/immich/openapi_client/models/library_response_dto.py
generated/immich/openapi_client/models/library_stats_response_dto.py
generated/immich/openapi_client/models/license_key_dto.py
generated/immich/openapi_client/models/log_level.py
generated/immich/openapi_client/models/login_credential_dto.py
generated/immich/openapi_client/models/login_response_dto.py
generated/immich/openapi_client/models/logout_response_dto.py
generated/immich/openapi_client/models/machine_learning_availability_checks_dto.py
generated/immich/openapi_client/models/maintenance_action.py
generated/immich/openapi_client/models/maintenance_auth_dto.py
generated/immich/openapi_client/models/maintenance_detect_install_response_dto.py
generated/immich/openapi_client/models/maintenance_detect_install_storage_folder_dto.py
generated/immich/openapi_client/models/maintenance_login_dto.py
generated/immich/openapi_client/models/maintenance_status_response_dto.py
generated/immich/openapi_client/models/manual_job_name.py
generated/immich/openapi_client/models/map_marker_response_dto.py
generated/immich/openapi_client/models/map_reverse_geocode_response_dto.py
generated/immich/openapi_client/models/memories_response.py
generated/immich/openapi_client/models/memories_update.py
generated/immich/openapi_client/models/memory_create_dto.py
generated/immich/openapi_client/models/memory_response_dto.py
generated/immich/openapi_client/models/memory_search_order.py
generated/immich/openapi_client/models/memory_statistics_response_dto.py
generated/immich/openapi_client/models/memory_type.py
generated/immich/openapi_client/models/memory_update_dto.py
generated/immich/openapi_client/models/merge_person_dto.py
generated/immich/openapi_client/models/metadata_search_dto.py
generated/immich/openapi_client/models/mirror_axis.py
generated/immich/openapi_client/models/mirror_parameters.py
generated/immich/openapi_client/models/notification_create_dto.py
generated/immich/openapi_client/models/notification_delete_all_dto.py
generated/immich/openapi_client/models/notification_dto.py
generated/immich/openapi_client/models/notification_level.py
generated/immich/openapi_client/models/notification_type.py
generated/immich/openapi_client/models/notification_update_all_dto.py
generated/immich/openapi_client/models/notification_update_dto.py
generated/immich/openapi_client/models/o_auth_authorize_response_dto.py
generated/immich/openapi_client/models/o_auth_callback_dto.py
generated/immich/openapi_client/models/o_auth_config_dto.py
generated/immich/openapi_client/models/o_auth_token_endpoint_auth_method.py
generated/immich/openapi_client/models/ocr_config.py
generated/immich/openapi_client/models/on_this_day_dto.py
generated/immich/openapi_client/models/onboarding_dto.py
generated/immich/openapi_client/models/onboarding_response_dto.py
generated/immich/openapi_client/models/partner_create_dto.py
generated/immich/openapi_client/models/partner_direction.py
generated/immich/openapi_client/models/partner_response_dto.py
generated/immich/openapi_client/models/partner_update_dto.py
generated/immich/openapi_client/models/people_response.py
generated/immich/openapi_client/models/people_response_dto.py
generated/immich/openapi_client/models/people_update.py
generated/immich/openapi_client/models/people_update_dto.py
generated/immich/openapi_client/models/people_update_item.py
generated/immich/openapi_client/models/permission.py
generated/immich/openapi_client/models/person_create_dto.py
generated/immich/openapi_client/models/person_response_dto.py
generated/immich/openapi_client/models/person_statistics_response_dto.py
generated/immich/openapi_client/models/person_update_dto.py
generated/immich/openapi_client/models/pin_code_change_dto.py
generated/immich/openapi_client/models/pin_code_reset_dto.py
generated/immich/openapi_client/models/pin_code_setup_dto.py
generated/immich/openapi_client/models/places_response_dto.py
generated/immich/openapi_client/models/plugin_method_response_dto.py
generated/immich/openapi_client/models/plugin_response_dto.py
generated/immich/openapi_client/models/plugin_template_response_dto.py
generated/immich/openapi_client/models/plugin_template_step_response_dto.py
generated/immich/openapi_client/models/purchase_response.py
generated/immich/openapi_client/models/purchase_update.py
generated/immich/openapi_client/models/queue_command.py
generated/immich/openapi_client/models/queue_command_dto.py
generated/immich/openapi_client/models/queue_delete_dto.py
generated/immich/openapi_client/models/queue_job_response_dto.py
generated/immich/openapi_client/models/queue_job_status.py
generated/immich/openapi_client/models/queue_name.py
generated/immich/openapi_client/models/queue_response_dto.py
generated/immich/openapi_client/models/queue_response_legacy_dto.py
generated/immich/openapi_client/models/queue_statistics_dto.py
generated/immich/openapi_client/models/queue_status_legacy_dto.py
generated/immich/openapi_client/models/queue_update_dto.py
generated/immich/openapi_client/models/queues_response_legacy_dto.py
generated/immich/openapi_client/models/random_search_dto.py
generated/immich/openapi_client/models/ratings_response.py
generated/immich/openapi_client/models/ratings_update.py
generated/immich/openapi_client/models/reaction_level.py
generated/immich/openapi_client/models/reaction_type.py
generated/immich/openapi_client/models/recently_added_response.py
generated/immich/openapi_client/models/recently_added_update.py
generated/immich/openapi_client/models/release_channel.py
generated/immich/openapi_client/models/release_event_v1.py
generated/immich/openapi_client/models/release_type.py
generated/immich/openapi_client/models/reverse_geocoding_state_response_dto.py
generated/immich/openapi_client/models/rotate_parameters.py
generated/immich/openapi_client/models/search_album_response_dto.py
generated/immich/openapi_client/models/search_asset_response_dto.py
generated/immich/openapi_client/models/search_explore_item.py
generated/immich/openapi_client/models/search_explore_response_dto.py
generated/immich/openapi_client/models/search_facet_count_response_dto.py
generated/immich/openapi_client/models/search_facet_response_dto.py
generated/immich/openapi_client/models/search_response_dto.py
generated/immich/openapi_client/models/search_statistics_response_dto.py
generated/immich/openapi_client/models/search_suggestion_type.py
generated/immich/openapi_client/models/server_about_response_dto.py
generated/immich/openapi_client/models/server_apk_links_dto.py
generated/immich/openapi_client/models/server_config_dto.py
generated/immich/openapi_client/models/server_features_dto.py
generated/immich/openapi_client/models/server_media_types_response_dto.py
generated/immich/openapi_client/models/server_ping_response.py
generated/immich/openapi_client/models/server_stats_response_dto.py
generated/immich/openapi_client/models/server_storage_response_dto.py
generated/immich/openapi_client/models/server_version_history_response_dto.py
generated/immich/openapi_client/models/server_version_response_dto.py
generated/immich/openapi_client/models/session_create_dto.py
generated/immich/openapi_client/models/session_create_response_dto.py
generated/immich/openapi_client/models/session_response_dto.py
generated/immich/openapi_client/models/session_unlock_dto.py
generated/immich/openapi_client/models/session_update_dto.py
generated/immich/openapi_client/models/set_maintenance_mode_dto.py
generated/immich/openapi_client/models/shared_link_create_dto.py
generated/immich/openapi_client/models/shared_link_edit_dto.py
generated/immich/openapi_client/models/shared_link_login_dto.py
generated/immich/openapi_client/models/shared_link_response_dto.py
generated/immich/openapi_client/models/shared_link_type.py
generated/immich/openapi_client/models/shared_links_response.py
generated/immich/openapi_client/models/shared_links_update.py
generated/immich/openapi_client/models/sign_up_dto.py
generated/immich/openapi_client/models/smart_search_dto.py
generated/immich/openapi_client/models/source_type.py
generated/immich/openapi_client/models/stack_create_dto.py
generated/immich/openapi_client/models/stack_response_dto.py
generated/immich/openapi_client/models/stack_update_dto.py
generated/immich/openapi_client/models/statistics_search_dto.py
generated/immich/openapi_client/models/storage_folder.py
generated/immich/openapi_client/models/sync_ack_delete_dto.py
generated/immich/openapi_client/models/sync_ack_dto.py
generated/immich/openapi_client/models/sync_ack_set_dto.py
generated/immich/openapi_client/models/sync_album_delete_v1.py
generated/immich/openapi_client/models/sync_album_to_asset_delete_v1.py
generated/immich/openapi_client/models/sync_album_to_asset_v1.py
generated/immich/openapi_client/models/sync_album_user_delete_v1.py
generated/immich/openapi_client/models/sync_album_user_v1.py
generated/immich/openapi_client/models/sync_album_v1.py
generated/immich/openapi_client/models/sync_album_v2.py
generated/immich/openapi_client/models/sync_asset_delete_v1.py
generated/immich/openapi_client/models/sync_asset_edit_delete_v1.py
generated/immich/openapi_client/models/sync_asset_edit_v1.py
generated/immich/openapi_client/models/sync_asset_exif_v1.py
generated/immich/openapi_client/models/sync_asset_face_delete_v1.py
generated/immich/openapi_client/models/sync_asset_face_v1.py
generated/immich/openapi_client/models/sync_asset_face_v2.py
generated/immich/openapi_client/models/sync_asset_metadata_delete_v1.py
generated/immich/openapi_client/models/sync_asset_metadata_v1.py
generated/immich/openapi_client/models/sync_asset_ocr_delete_v1.py
generated/immich/openapi_client/models/sync_asset_ocr_v1.py
generated/immich/openapi_client/models/sync_asset_v1.py
generated/immich/openapi_client/models/sync_asset_v2.py
generated/immich/openapi_client/models/sync_auth_user_v1.py
generated/immich/openapi_client/models/sync_entity_type.py
generated/immich/openapi_client/models/sync_memory_asset_delete_v1.py
generated/immich/openapi_client/models/sync_memory_asset_v1.py
generated/immich/openapi_client/models/sync_memory_delete_v1.py
generated/immich/openapi_client/models/sync_memory_v1.py
generated/immich/openapi_client/models/sync_partner_delete_v1.py
generated/immich/openapi_client/models/sync_partner_v1.py
generated/immich/openapi_client/models/sync_person_delete_v1.py
generated/immich/openapi_client/models/sync_person_v1.py
generated/immich/openapi_client/models/sync_request_type.py
generated/immich/openapi_client/models/sync_stack_delete_v1.py
generated/immich/openapi_client/models/sync_stack_v1.py
generated/immich/openapi_client/models/sync_stream_dto.py
generated/immich/openapi_client/models/sync_user_delete_v1.py
generated/immich/openapi_client/models/sync_user_metadata_delete_v1.py
generated/immich/openapi_client/models/sync_user_metadata_v1.py
generated/immich/openapi_client/models/sync_user_v1.py
generated/immich/openapi_client/models/system_config_backups_dto.py
generated/immich/openapi_client/models/system_config_dto.py
generated/immich/openapi_client/models/system_config_f_fmpeg_dto.py
generated/immich/openapi_client/models/system_config_f_fmpeg_realtime_dto.py
generated/immich/openapi_client/models/system_config_faces_dto.py
generated/immich/openapi_client/models/system_config_generated_fullsize_image_dto.py
generated/immich/openapi_client/models/system_config_generated_image_dto.py
generated/immich/openapi_client/models/system_config_image_dto.py
generated/immich/openapi_client/models/system_config_integrity_checks.py
generated/immich/openapi_client/models/system_config_integrity_checksum_job.py
generated/immich/openapi_client/models/system_config_integrity_job.py
generated/immich/openapi_client/models/system_config_job_dto.py
generated/immich/openapi_client/models/system_config_library_dto.py
generated/immich/openapi_client/models/system_config_library_scan_dto.py
generated/immich/openapi_client/models/system_config_library_watch_dto.py
generated/immich/openapi_client/models/system_config_logging_dto.py
generated/immich/openapi_client/models/system_config_machine_learning_dto.py
generated/immich/openapi_client/models/system_config_map_dto.py
generated/immich/openapi_client/models/system_config_metadata_dto.py
generated/immich/openapi_client/models/system_config_new_version_check_dto.py
generated/immich/openapi_client/models/system_config_nightly_tasks_dto.py
generated/immich/openapi_client/models/system_config_notifications_dto.py
generated/immich/openapi_client/models/system_config_o_auth_dto.py
generated/immich/openapi_client/models/system_config_password_login_dto.py
generated/immich/openapi_client/models/system_config_reverse_geocoding_dto.py
generated/immich/openapi_client/models/system_config_server_dto.py
generated/immich/openapi_client/models/system_config_smtp_dto.py
generated/immich/openapi_client/models/system_config_smtp_transport_dto.py
generated/immich/openapi_client/models/system_config_storage_template_dto.py
generated/immich/openapi_client/models/system_config_template_emails_dto.py
generated/immich/openapi_client/models/system_config_template_storage_option_dto.py
generated/immich/openapi_client/models/system_config_templates_dto.py
generated/immich/openapi_client/models/system_config_theme_dto.py
generated/immich/openapi_client/models/system_config_trash_dto.py
generated/immich/openapi_client/models/system_config_user_dto.py
generated/immich/openapi_client/models/tag_bulk_assets_dto.py
generated/immich/openapi_client/models/tag_bulk_assets_response_dto.py
generated/immich/openapi_client/models/tag_create_dto.py
generated/immich/openapi_client/models/tag_response_dto.py
generated/immich/openapi_client/models/tag_update_dto.py
generated/immich/openapi_client/models/tag_upsert_dto.py
generated/immich/openapi_client/models/tags_response.py
generated/immich/openapi_client/models/tags_update.py
generated/immich/openapi_client/models/template_dto.py
generated/immich/openapi_client/models/template_response_dto.py
generated/immich/openapi_client/models/test_email_response_dto.py
generated/immich/openapi_client/models/time_bucket_asset_response_dto.py
generated/immich/openapi_client/models/time_buckets_response_dto.py
generated/immich/openapi_client/models/tone_mapping.py
generated/immich/openapi_client/models/transcode_hw_accel.py
generated/immich/openapi_client/models/transcode_policy.py
generated/immich/openapi_client/models/trash_response_dto.py
generated/immich/openapi_client/models/update_album_dto.py
generated/immich/openapi_client/models/update_album_user_dto.py
generated/immich/openapi_client/models/update_asset_dto.py
generated/immich/openapi_client/models/update_library_dto.py
generated/immich/openapi_client/models/usage_by_user_dto.py
generated/immich/openapi_client/models/user_admin_create_dto.py
generated/immich/openapi_client/models/user_admin_delete_dto.py
generated/immich/openapi_client/models/user_admin_response_dto.py
generated/immich/openapi_client/models/user_admin_update_dto.py
generated/immich/openapi_client/models/user_avatar_color.py
generated/immich/openapi_client/models/user_license.py
generated/immich/openapi_client/models/user_metadata_key.py
generated/immich/openapi_client/models/user_preferences_response_dto.py
generated/immich/openapi_client/models/user_preferences_update_dto.py
generated/immich/openapi_client/models/user_response_dto.py
generated/immich/openapi_client/models/user_status.py
generated/immich/openapi_client/models/user_update_me_dto.py
generated/immich/openapi_client/models/validate_access_token_response_dto.py
generated/immich/openapi_client/models/validate_library_dto.py
generated/immich/openapi_client/models/validate_library_import_path_response_dto.py
generated/immich/openapi_client/models/validate_library_response_dto.py
generated/immich/openapi_client/models/version_check_state_response_dto.py
generated/immich/openapi_client/models/video_codec.py
generated/immich/openapi_client/models/video_container.py
generated/immich/openapi_client/models/workflow_create_dto.py
generated/immich/openapi_client/models/workflow_response_dto.py
generated/immich/openapi_client/models/workflow_share_response_dto.py
generated/immich/openapi_client/models/workflow_share_step_dto.py
generated/immich/openapi_client/models/workflow_step_dto.py
generated/immich/openapi_client/models/workflow_trigger.py
generated/immich/openapi_client/models/workflow_trigger_response_dto.py
generated/immich/openapi_client/models/workflow_type.py
generated/immich/openapi_client/models/workflow_update_dto.py
generated/immich/openapi_client/rest.py
generated/immich/openapi_client_README.md
+1
View File
@@ -0,0 +1 @@
7.9.0
+10 -2
View File
@@ -49,14 +49,22 @@ docker push immortaly007/immich-exporter
### Generate OpenAPI spec
Only the Albums, Assets, and Search APIs are generated (the only ones this
tool uses) and docs/tests are skipped, to keep the generated client small.
The generator version is pinned to v7.9.0 because newer versions ship a
codegen bug that drops the `field_validator` import from some pydantic
models; `scripts/fix_field_validator_imports.py` patches around it.
```bash
rm -rf generated/immich
docker run --rm \
-u $UID:$UID \
-v ${PWD}:/local openapitools/openapi-generator-cli generate \
-v ${PWD}:/local openapitools/openapi-generator-cli:v7.9.0 generate \
-i https://github.com/immich-app/immich/raw/refs/heads/main/open-api/immich-openapi-specs.json \
-g python \
--skip-operation-example \
--global-property apis="Albums:Assets:Search",models="",supportingFiles="",apiTests=false,apiDocs=false,modelTests=false,modelDocs=false \
--additional-properties generateSourceCodeOnly=true,packageName="generated.immich.openapi_client" \
-o /local/
python3 scripts/fix_field_validator_imports.py
```
File diff suppressed because it is too large Load Diff
@@ -1,41 +1,7 @@
# flake8: noqa
# import apis into api package
from generated.immich.openapi_client.api.api_keys_api import APIKeysApi
from generated.immich.openapi_client.api.activities_api import ActivitiesApi
from generated.immich.openapi_client.api.albums_api import AlbumsApi
from generated.immich.openapi_client.api.assets_api import AssetsApi
from generated.immich.openapi_client.api.authentication_api import AuthenticationApi
from generated.immich.openapi_client.api.authentication_admin_api import AuthenticationAdminApi
from generated.immich.openapi_client.api.database_backups_admin_api import DatabaseBackupsAdminApi
from generated.immich.openapi_client.api.deprecated_api import DeprecatedApi
from generated.immich.openapi_client.api.download_api import DownloadApi
from generated.immich.openapi_client.api.duplicates_api import DuplicatesApi
from generated.immich.openapi_client.api.faces_api import FacesApi
from generated.immich.openapi_client.api.jobs_api import JobsApi
from generated.immich.openapi_client.api.libraries_api import LibrariesApi
from generated.immich.openapi_client.api.maintenance_admin_api import MaintenanceAdminApi
from generated.immich.openapi_client.api.map_api import MapApi
from generated.immich.openapi_client.api.memories_api import MemoriesApi
from generated.immich.openapi_client.api.notifications_api import NotificationsApi
from generated.immich.openapi_client.api.notifications_admin_api import NotificationsAdminApi
from generated.immich.openapi_client.api.partners_api import PartnersApi
from generated.immich.openapi_client.api.people_api import PeopleApi
from generated.immich.openapi_client.api.plugins_api import PluginsApi
from generated.immich.openapi_client.api.queues_api import QueuesApi
from generated.immich.openapi_client.api.search_api import SearchApi
from generated.immich.openapi_client.api.server_api import ServerApi
from generated.immich.openapi_client.api.sessions_api import SessionsApi
from generated.immich.openapi_client.api.shared_links_api import SharedLinksApi
from generated.immich.openapi_client.api.stacks_api import StacksApi
from generated.immich.openapi_client.api.sync_api import SyncApi
from generated.immich.openapi_client.api.system_config_api import SystemConfigApi
from generated.immich.openapi_client.api.system_metadata_api import SystemMetadataApi
from generated.immich.openapi_client.api.tags_api import TagsApi
from generated.immich.openapi_client.api.timeline_api import TimelineApi
from generated.immich.openapi_client.api.trash_api import TrashApi
from generated.immich.openapi_client.api.users_api import UsersApi
from generated.immich.openapi_client.api.users_admin_api import UsersAdminApi
from generated.immich.openapi_client.api.views_api import ViewsApi
from generated.immich.openapi_client.api.workflows_api import WorkflowsApi
File diff suppressed because it is too large Load Diff
@@ -16,10 +16,9 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import Field, StrictBool, StrictStr
from pydantic import Field, StrictBool, StrictStr, field_validator
from typing import List, Optional
from typing_extensions import Annotated
from uuid import UUID
from generated.immich.openapi_client.models.add_users_dto import AddUsersDto
from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto
from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto
@@ -53,7 +52,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -73,7 +72,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -124,7 +123,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -144,7 +143,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -195,7 +194,7 @@ class AlbumsApi:
@validate_call
def add_assets_to_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -215,7 +214,7 @@ class AlbumsApi:
Add multiple assets to a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -620,7 +619,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -640,7 +639,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -691,7 +690,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -711,7 +710,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -762,7 +761,7 @@ class AlbumsApi:
@validate_call
def add_users_to_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
add_users_dto: AddUsersDto,
_request_timeout: Union[
None,
@@ -782,7 +781,7 @@ class AlbumsApi:
Share an album with multiple users. Each user can be given a specific role in the album.
:param id: (required)
:type id: UUID
:type id: str
:param add_users_dto: (required)
:type add_users_dto: AddUsersDto
:param _request_timeout: timeout setting for this request. If one
@@ -1187,7 +1186,7 @@ class AlbumsApi:
@validate_call
def delete_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1206,7 +1205,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1254,7 +1253,7 @@ class AlbumsApi:
@validate_call
def delete_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1273,7 +1272,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1321,7 +1320,7 @@ class AlbumsApi:
@validate_call
def delete_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -1340,7 +1339,7 @@ class AlbumsApi:
Delete a specific album by its ID. Note the album is initially trashed and then immediately scheduled for deletion, but relies on a background job to complete the process.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -1443,7 +1442,7 @@ class AlbumsApi:
@validate_call
def get_album_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1464,7 +1463,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1518,7 +1517,7 @@ class AlbumsApi:
@validate_call
def get_album_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1539,7 +1538,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1593,7 +1592,7 @@ class AlbumsApi:
@validate_call
def get_album_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1614,7 +1613,7 @@ class AlbumsApi:
Retrieve information about a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1740,7 +1739,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1761,7 +1760,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1815,7 +1814,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1836,7 +1835,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -1890,7 +1889,7 @@ class AlbumsApi:
@validate_call
def get_album_map_markers_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -1911,7 +1910,7 @@ class AlbumsApi:
Retrieve map marker information for a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2285,8 +2284,8 @@ class AlbumsApi:
@validate_call
def get_all_albums(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2308,9 +2307,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2368,8 +2367,8 @@ class AlbumsApi:
@validate_call
def get_all_albums_with_http_info(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2391,9 +2390,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2451,8 +2450,8 @@ class AlbumsApi:
@validate_call
def get_all_albums_without_preload_content(
self,
asset_id: Annotated[Optional[UUID], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[UUID], Field(description="Album ID")] = None,
asset_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Filter albums containing this asset ID (ignores other parameters)")] = None,
id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Album ID")] = None,
is_owned: Annotated[Optional[StrictBool], Field(description="Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter")] = None,
is_shared: Annotated[Optional[StrictBool], Field(description="Filter by shared status: true = only shared, false = not shared, undefined = no filter")] = None,
name: Annotated[Optional[StrictStr], Field(description="Album name (exact match)")] = None,
@@ -2474,9 +2473,9 @@ class AlbumsApi:
Retrieve a list of albums available to the authenticated user.
:param asset_id: Filter albums containing this asset ID (ignores other parameters)
:type asset_id: UUID
:type asset_id: str
:param id: Album ID
:type id: UUID
:type id: str
:param is_owned: Filter by ownership: true = only owned, false = only shared-with-me, undefined = no filter
:type is_owned: bool
:param is_shared: Filter by shared status: true = only shared, false = not shared, undefined = no filter
@@ -2618,7 +2617,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2638,7 +2637,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2689,7 +2688,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2709,7 +2708,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2760,7 +2759,7 @@ class AlbumsApi:
@validate_call
def remove_asset_from_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
@@ -2780,7 +2779,7 @@ class AlbumsApi:
Remove multiple assets from a specific album by its ID.
:param id: (required)
:type id: UUID
:type id: str
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
@@ -2909,7 +2908,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -2929,7 +2928,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -2980,7 +2979,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -3000,7 +2999,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -3051,7 +3050,7 @@ class AlbumsApi:
@validate_call
def remove_user_from_album_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
_request_timeout: Union[
None,
@@ -3071,7 +3070,7 @@ class AlbumsApi:
Remove a user from an album. Use an ID of \"me\" to leave a shared album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param _request_timeout: timeout setting for this request. If one
@@ -3180,7 +3179,7 @@ class AlbumsApi:
@validate_call
def update_album_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3200,7 +3199,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3251,7 +3250,7 @@ class AlbumsApi:
@validate_call
def update_album_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3271,7 +3270,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3322,7 +3321,7 @@ class AlbumsApi:
@validate_call
def update_album_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_album_dto: UpdateAlbumDto,
_request_timeout: Union[
None,
@@ -3342,7 +3341,7 @@ class AlbumsApi:
Update the information of a specific album by its ID. This endpoint can be used to update the album name, description, sort order, etc. However, it is not used to add or remove assets or users from the album.
:param id: (required)
:type id: UUID
:type id: str
:param update_album_dto: (required)
:type update_album_dto: UpdateAlbumDto
:param _request_timeout: timeout setting for this request. If one
@@ -3471,7 +3470,7 @@ class AlbumsApi:
@validate_call
def update_album_user(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3492,7 +3491,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
@@ -3546,7 +3545,7 @@ class AlbumsApi:
@validate_call
def update_album_user_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3567,7 +3566,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
@@ -3621,7 +3620,7 @@ class AlbumsApi:
@validate_call
def update_album_user_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
user_id: StrictStr,
update_album_user_dto: UpdateAlbumUserDto,
_request_timeout: Union[
@@ -3642,7 +3641,7 @@ class AlbumsApi:
Change the role for a specific user in a specific album.
:param id: (required)
:type id: UUID
:type id: str
:param user_id: (required)
:type user_id: str
:param update_album_user_dto: (required)
File diff suppressed because it is too large Load Diff
+126 -127
View File
@@ -20,7 +20,6 @@ from datetime import datetime
from pydantic import Field, StrictBool, StrictBytes, StrictStr, field_validator
from typing import List, Optional, Tuple, Union
from typing_extensions import Annotated
from uuid import UUID
from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto
from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto
from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto
@@ -609,7 +608,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -629,7 +628,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -680,7 +679,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata_with_http_info(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -700,7 +699,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -751,7 +750,7 @@ class AssetsApi:
@validate_call
def delete_asset_metadata_without_preload_content(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -771,7 +770,7 @@ class AssetsApi:
Delete a specific metadata key-value pair associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -1418,7 +1417,7 @@ class AssetsApi:
@validate_call
def download_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1440,7 +1439,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1497,7 +1496,7 @@ class AssetsApi:
@validate_call
def download_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1519,7 +1518,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1576,7 +1575,7 @@ class AssetsApi:
@validate_call
def download_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -1598,7 +1597,7 @@ class AssetsApi:
Downloads the original file of the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -1732,7 +1731,7 @@ class AssetsApi:
@validate_call
def edit_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1752,7 +1751,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -1803,7 +1802,7 @@ class AssetsApi:
@validate_call
def edit_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1823,7 +1822,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -1874,7 +1873,7 @@ class AssetsApi:
@validate_call
def edit_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_edits_create_dto: AssetEditsCreateDto,
_request_timeout: Union[
None,
@@ -1894,7 +1893,7 @@ class AssetsApi:
Apply a series of edit actions (crop, rotate, mirror) to the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_edits_create_dto: (required)
:type asset_edits_create_dto: AssetEditsCreateDto
:param _request_timeout: timeout setting for this request. If one
@@ -2023,8 +2022,8 @@ class AssetsApi:
@validate_call
def end_session(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2045,9 +2044,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2102,8 +2101,8 @@ class AssetsApi:
@validate_call
def end_session_with_http_info(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2124,9 +2123,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2181,8 +2180,8 @@ class AssetsApi:
@validate_call
def end_session_without_preload_content(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2203,9 +2202,9 @@ class AssetsApi:
Releases server resources for the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param key:
:type key: str
:param slug:
@@ -2328,7 +2327,7 @@ class AssetsApi:
@validate_call
def get_asset_edits(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2347,7 +2346,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2395,7 +2394,7 @@ class AssetsApi:
@validate_call
def get_asset_edits_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2414,7 +2413,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2462,7 +2461,7 @@ class AssetsApi:
@validate_call
def get_asset_edits_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2481,7 +2480,7 @@ class AssetsApi:
Retrieve a series of edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2591,7 +2590,7 @@ class AssetsApi:
@validate_call
def get_asset_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2612,7 +2611,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2666,7 +2665,7 @@ class AssetsApi:
@validate_call
def get_asset_info_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2687,7 +2686,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2741,7 +2740,7 @@ class AssetsApi:
@validate_call
def get_asset_info_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -2762,7 +2761,7 @@ class AssetsApi:
Retrieve detailed information about a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -2888,7 +2887,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2907,7 +2906,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -2955,7 +2954,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -2974,7 +2973,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3022,7 +3021,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3041,7 +3040,7 @@ class AssetsApi:
Retrieve all metadata key-value pairs associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3151,7 +3150,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3171,7 +3170,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3222,7 +3221,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key_with_http_info(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3242,7 +3241,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3293,7 +3292,7 @@ class AssetsApi:
@validate_call
def get_asset_metadata_by_key_without_preload_content(
self,
id: Annotated[UUID, Field(description="Asset ID")],
id: Annotated[str, Field(strict=True, description="Asset ID")],
key: Annotated[StrictStr, Field(description="Metadata key")],
_request_timeout: Union[
None,
@@ -3313,7 +3312,7 @@ class AssetsApi:
Retrieve the value of a specific metadata key associated with the specified asset.
:param id: Asset ID (required)
:type id: UUID
:type id: str
:param key: Metadata key (required)
:type key: str
:param _request_timeout: timeout setting for this request. If one
@@ -3429,7 +3428,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3448,7 +3447,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3496,7 +3495,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3515,7 +3514,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3563,7 +3562,7 @@ class AssetsApi:
@validate_call
def get_asset_ocr_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -3582,7 +3581,7 @@ class AssetsApi:
Retrieve all OCR (Optical Character Recognition) data associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -3991,7 +3990,7 @@ class AssetsApi:
@validate_call
def get_main_playlist(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4012,7 +4011,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4066,7 +4065,7 @@ class AssetsApi:
@validate_call
def get_main_playlist_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4087,7 +4086,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4141,7 +4140,7 @@ class AssetsApi:
@validate_call
def get_main_playlist_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -4162,7 +4161,7 @@ class AssetsApi:
Returns an HLS main playlist with all available variants for the asset.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -4288,8 +4287,8 @@ class AssetsApi:
@validate_call
def get_media_playlist(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4312,9 +4311,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4375,8 +4374,8 @@ class AssetsApi:
@validate_call
def get_media_playlist_with_http_info(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4399,9 +4398,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4462,8 +4461,8 @@ class AssetsApi:
@validate_call
def get_media_playlist_without_preload_content(
self,
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4486,9 +4485,9 @@ class AssetsApi:
Returns an HLS media playlist for one variant of the streaming session.
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4631,8 +4630,8 @@ class AssetsApi:
def get_segment(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4657,9 +4656,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4722,8 +4721,8 @@ class AssetsApi:
def get_segment_with_http_info(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4748,9 +4747,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4813,8 +4812,8 @@ class AssetsApi:
def get_segment_without_preload_content(
self,
filename: Annotated[str, Field(strict=True)],
id: UUID,
session_id: UUID,
id: Annotated[str, Field(strict=True)],
session_id: Annotated[str, Field(strict=True)],
variant_index: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
@@ -4839,9 +4838,9 @@ class AssetsApi:
:param filename: (required)
:type filename: str
:param id: (required)
:type id: UUID
:type id: str
:param session_id: (required)
:type session_id: UUID
:type session_id: str
:param variant_index: (required)
:type variant_index: int
:param key:
@@ -4987,7 +4986,7 @@ class AssetsApi:
@validate_call
def play_asset_video(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5008,7 +5007,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5062,7 +5061,7 @@ class AssetsApi:
@validate_call
def play_asset_video_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5083,7 +5082,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5137,7 +5136,7 @@ class AssetsApi:
@validate_call
def play_asset_video_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
@@ -5158,7 +5157,7 @@ class AssetsApi:
Streams the video file for the specified asset. This endpoint also supports byte range requests.
:param id: (required)
:type id: UUID
:type id: str
:param key:
:type key: str
:param slug:
@@ -5284,7 +5283,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5303,7 +5302,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5351,7 +5350,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5370,7 +5369,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5418,7 +5417,7 @@ class AssetsApi:
@validate_call
def remove_asset_edits_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
@@ -5437,7 +5436,7 @@ class AssetsApi:
Removes all edit actions (crop, rotate, mirror) associated with the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
@@ -5809,7 +5808,7 @@ class AssetsApi:
@validate_call
def update_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5829,7 +5828,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -5881,7 +5880,7 @@ class AssetsApi:
@validate_call
def update_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5901,7 +5900,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -5953,7 +5952,7 @@ class AssetsApi:
@validate_call
def update_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
update_asset_dto: UpdateAssetDto,
_request_timeout: Union[
None,
@@ -5973,7 +5972,7 @@ class AssetsApi:
Update information of a specific asset.
:param id: (required)
:type id: UUID
:type id: str
:param update_asset_dto: (required)
:type update_asset_dto: UpdateAssetDto
:param _request_timeout: timeout setting for this request. If one
@@ -6103,7 +6102,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6123,7 +6122,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6174,7 +6173,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6194,7 +6193,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6245,7 +6244,7 @@ class AssetsApi:
@validate_call
def update_asset_metadata_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
asset_metadata_upsert_dto: AssetMetadataUpsertDto,
_request_timeout: Union[
None,
@@ -6265,7 +6264,7 @@ class AssetsApi:
Update or add metadata key-value pairs for the specified asset.
:param id: (required)
:type id: UUID
:type id: str
:param asset_metadata_upsert_dto: (required)
:type asset_metadata_upsert_dto: AssetMetadataUpsertDto
:param _request_timeout: timeout setting for this request. If one
@@ -6951,7 +6950,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -6991,7 +6990,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7067,7 +7066,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -7107,7 +7106,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7183,7 +7182,7 @@ class AssetsApi:
duration: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Duration in milliseconds (for videos)")] = None,
filename: Annotated[Optional[StrictStr], Field(description="Filename")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Mark as favorite")] = None,
live_photo_video_id: Annotated[Optional[UUID], Field(description="Live photo video ID")] = None,
live_photo_video_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Live photo video ID")] = None,
metadata: Annotated[Optional[List[AssetMetadataUpsertItemDto]], Field(description="Asset metadata items")] = None,
sidecar_data: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="Sidecar file data")] = None,
visibility: Optional[AssetVisibility] = None,
@@ -7223,7 +7222,7 @@ class AssetsApi:
:param is_favorite: Mark as favorite
:type is_favorite: bool
:param live_photo_video_id: Live photo video ID
:type live_photo_video_id: UUID
:type live_photo_video_id: str
:param metadata: Asset metadata items
:type metadata: List[AssetMetadataUpsertItemDto]
:param sidecar_data: Sidecar file data
@@ -7406,7 +7405,7 @@ class AssetsApi:
@validate_call
def view_asset(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7429,7 +7428,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -7489,7 +7488,7 @@ class AssetsApi:
@validate_call
def view_asset_with_http_info(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7512,7 +7511,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
@@ -7572,7 +7571,7 @@ class AssetsApi:
@validate_call
def view_asset_without_preload_content(
self,
id: UUID,
id: Annotated[str, Field(strict=True)],
edited: Annotated[Optional[StrictBool], Field(description="Return edited asset if available")] = None,
key: Optional[StrictStr] = None,
size: Optional[AssetMediaSize] = None,
@@ -7595,7 +7594,7 @@ class AssetsApi:
Retrieve the thumbnail image for the specified asset. Viewing the fullsize thumbnail might redirect to downloadAsset, which requires a different permission.
:param id: (required)
:type id: UUID
:type id: str
:param edited: Return edited asset if available
:type edited: bool
:param key:
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -1,660 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from pydantic import StrictBytes, StrictStr
from typing import Optional, Tuple, Union
from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto
from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto
from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class DownloadApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def download_archive(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> bytearray:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def download_archive_with_http_info(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[bytearray]:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def download_archive_without_preload_content(
self,
download_archive_dto: DownloadArchiveDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the \"getDownloadInfo\" endpoint.
:param download_archive_dto: (required)
:type download_archive_dto: DownloadArchiveDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._download_archive_serialize(
download_archive_dto=download_archive_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "bytearray",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _download_archive_serialize(
self,
download_archive_dto,
key,
slug,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if key is not None:
_query_params.append(('key', key))
if slug is not None:
_query_params.append(('slug', slug))
# process the header parameters
# process the form parameters
# process the body parameter
if download_archive_dto is not None:
_body_params = download_archive_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/octet-stream'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/download/archive',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def get_download_info(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> DownloadResponseDto:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_download_info_with_http_info(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[DownloadResponseDto]:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_download_info_without_preload_content(
self,
download_info_dto: DownloadInfoDto,
key: Optional[StrictStr] = None,
slug: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
:param download_info_dto: (required)
:type download_info_dto: DownloadInfoDto
:param key:
:type key: str
:param slug:
:type slug: str
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_download_info_serialize(
download_info_dto=download_info_dto,
key=key,
slug=slug,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'201': "DownloadResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_download_info_serialize(
self,
download_info_dto,
key,
slug,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if key is not None:
_query_params.append(('key', key))
if slug is not None:
_query_params.append(('slug', slug))
# process the header parameters
# process the form parameters
# process the body parameter
if download_info_dto is not None:
_body_params = download_info_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/download/info',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -1,854 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.job_create_dto import JobCreateDto
from generated.immich.openapi_client.models.queue_command_dto import QueueCommandDto
from generated.immich.openapi_client.models.queue_name import QueueName
from generated.immich.openapi_client.models.queue_response_legacy_dto import QueueResponseLegacyDto
from generated.immich.openapi_client.models.queues_response_legacy_dto import QueuesResponseLegacyDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class JobsApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def create_job(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> None:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def create_job_with_http_info(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[None]:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def create_job_without_preload_content(
self,
job_create_dto: JobCreateDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Create a manual job
Run a specific job. Most jobs are queued automatically, but this endpoint allows for manual creation of a handful of jobs, including various cleanup tasks, as well as creating a new database backup.
:param job_create_dto: (required)
:type job_create_dto: JobCreateDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._create_job_serialize(
job_create_dto=job_create_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'204': None,
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _create_job_serialize(
self,
job_create_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if job_create_dto is not None:
_body_params = job_create_dto
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/jobs',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def get_queues_legacy(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> QueuesResponseLegacyDto:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_queues_legacy_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[QueuesResponseLegacyDto]:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_queues_legacy_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""(Deprecated) Retrieve queue counts and status
Retrieve the counts of the current queue, as well as the current status.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("GET /jobs is deprecated.", DeprecationWarning)
_param = self._get_queues_legacy_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueuesResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_queues_legacy_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/jobs',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def run_queue_command_legacy(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> QueueResponseLegacyDto:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def run_queue_command_legacy_with_http_info(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[QueueResponseLegacyDto]:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def run_queue_command_legacy_without_preload_content(
self,
name: QueueName,
queue_command_dto: QueueCommandDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""(Deprecated) Run jobs
Queue all assets for a specific job type. Defaults to only queueing assets that have not yet been processed, but the force command can be used to re-process all assets.
:param name: (required)
:type name: QueueName
:param queue_command_dto: (required)
:type queue_command_dto: QueueCommandDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
warnings.warn("PUT /jobs/{name} is deprecated.", DeprecationWarning)
_param = self._run_queue_command_legacy_serialize(
name=name,
queue_command_dto=queue_command_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "QueueResponseLegacyDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _run_queue_command_legacy_serialize(
self,
name,
queue_command_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
if name is not None:
_path_params['name'] = name.value
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if queue_command_dto is not None:
_body_params = queue_command_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='PUT',
resource_path='/jobs/{name}',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
File diff suppressed because it is too large Load Diff
@@ -1,691 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from datetime import datetime
from pydantic import Field, StrictBool, StrictFloat, StrictInt
from typing import List, Optional, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto
from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class MapApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def get_map_markers(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapMarkerResponseDto]:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def get_map_markers_with_http_info(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapMarkerResponseDto]]:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def get_map_markers_without_preload_content(
self,
file_created_after: Annotated[Optional[datetime], Field(description="Filter assets created after this date")] = None,
file_created_before: Annotated[Optional[datetime], Field(description="Filter assets created before this date")] = None,
is_archived: Annotated[Optional[StrictBool], Field(description="Filter by archived status")] = None,
is_favorite: Annotated[Optional[StrictBool], Field(description="Filter by favorite status")] = None,
with_partners: Annotated[Optional[StrictBool], Field(description="Include partner assets")] = None,
with_shared_albums: Annotated[Optional[StrictBool], Field(description="Include shared album assets")] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Retrieve map markers
Retrieve a list of latitude and longitude coordinates for every asset with location data.
:param file_created_after: Filter assets created after this date
:type file_created_after: datetime
:param file_created_before: Filter assets created before this date
:type file_created_before: datetime
:param is_archived: Filter by archived status
:type is_archived: bool
:param is_favorite: Filter by favorite status
:type is_favorite: bool
:param with_partners: Include partner assets
:type with_partners: bool
:param with_shared_albums: Include shared album assets
:type with_shared_albums: bool
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._get_map_markers_serialize(
file_created_after=file_created_after,
file_created_before=file_created_before,
is_archived=is_archived,
is_favorite=is_favorite,
with_partners=with_partners,
with_shared_albums=with_shared_albums,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapMarkerResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _get_map_markers_serialize(
self,
file_created_after,
file_created_before,
is_archived,
is_favorite,
with_partners,
with_shared_albums,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if file_created_after is not None:
if isinstance(file_created_after, datetime):
_query_params.append(
(
'fileCreatedAfter',
file_created_after.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('fileCreatedAfter', file_created_after))
if file_created_before is not None:
if isinstance(file_created_before, datetime):
_query_params.append(
(
'fileCreatedBefore',
file_created_before.strftime(
self.api_client.configuration.datetime_format
)
)
)
else:
_query_params.append(('fileCreatedBefore', file_created_before))
if is_archived is not None:
_query_params.append(('isArchived', is_archived))
if is_favorite is not None:
_query_params.append(('isFavorite', is_favorite))
if with_partners is not None:
_query_params.append(('withPartners', with_partners))
if with_shared_albums is not None:
_query_params.append(('withSharedAlbums', with_shared_albums))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/map/markers',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def reverse_geocode(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapReverseGeocodeResponseDto]:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def reverse_geocode_with_http_info(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapReverseGeocodeResponseDto]]:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def reverse_geocode_without_preload_content(
self,
lat: Annotated[Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")],
lon: Annotated[Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Reverse geocode coordinates
Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.
:param lat: Latitude (-90 to 90) (required)
:type lat: float
:param lon: Longitude (-180 to 180) (required)
:type lon: float
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._reverse_geocode_serialize(
lat=lat,
lon=lon,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "List[MapReverseGeocodeResponseDto]",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _reverse_geocode_serialize(
self,
lat,
lon,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
if lat is not None:
_query_params.append(('lat', lat))
if lon is not None:
_query_params.append(('lon', lon))
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='GET',
resource_path='/map/reverse-geocode',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -17,10 +17,9 @@ from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from datetime import datetime
from pydantic import Field, StrictBool, StrictStr
from pydantic import Field, StrictBool, StrictStr, field_validator
from typing import List, Optional
from typing_extensions import Annotated
from uuid import UUID
from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto
from generated.immich.openapi_client.models.asset_type_enum import AssetTypeEnum
from generated.immich.openapi_client.models.asset_visibility import AssetVisibility
@@ -1471,7 +1470,7 @@ class SearchApi:
@validate_call
def search_large_assets(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1482,16 +1481,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1520,7 +1519,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1542,7 +1541,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1552,7 +1551,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1560,7 +1559,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
@@ -1658,7 +1657,7 @@ class SearchApi:
@validate_call
def search_large_assets_with_http_info(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1669,16 +1668,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1707,7 +1706,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1729,7 +1728,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1739,7 +1738,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1747,7 +1746,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
@@ -1845,7 +1844,7 @@ class SearchApi:
@validate_call
def search_large_assets_without_preload_content(
self,
album_ids: Annotated[Optional[List[UUID]], Field(description="Filter by album IDs")] = None,
album_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by album IDs")] = None,
city: Annotated[Optional[StrictStr], Field(description="Filter by city name")] = None,
country: Annotated[Optional[StrictStr], Field(description="Filter by country name")] = None,
created_after: Annotated[Optional[datetime], Field(description="Filter by creation date (after)")] = None,
@@ -1856,16 +1855,16 @@ class SearchApi:
is_not_in_album: Annotated[Optional[StrictBool], Field(description="Filter assets not in any album")] = None,
is_offline: Annotated[Optional[StrictBool], Field(description="Filter by offline status")] = None,
lens_model: Annotated[Optional[StrictStr], Field(description="Filter by lens model")] = None,
library_id: Annotated[Optional[UUID], Field(description="Library ID to filter by")] = None,
library_id: Annotated[Optional[Annotated[str, Field(strict=True)]], Field(description="Library ID to filter by")] = None,
make: Annotated[Optional[StrictStr], Field(description="Filter by camera make")] = None,
min_file_size: Annotated[Optional[Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]], Field(description="Minimum file size in bytes")] = None,
model: Annotated[Optional[StrictStr], Field(description="Filter by camera model")] = None,
ocr: Annotated[Optional[StrictStr], Field(description="Filter by OCR text content")] = None,
person_ids: Annotated[Optional[List[UUID]], Field(description="Filter by person IDs")] = None,
person_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by person IDs")] = None,
rating: Annotated[Optional[Annotated[int, Field(le=5, strict=True, ge=1)]], Field(description="Filter by rating [1-5], or null for unrated")] = None,
size: Annotated[Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]], Field(description="Number of results to return")] = None,
state: Annotated[Optional[StrictStr], Field(description="Filter by state/province name")] = None,
tag_ids: Annotated[Optional[List[UUID]], Field(description="Filter by tag IDs")] = None,
tag_ids: Annotated[Optional[List[Annotated[str, Field(strict=True)]]], Field(description="Filter by tag IDs")] = None,
taken_after: Annotated[Optional[datetime], Field(description="Filter by taken date (after)")] = None,
taken_before: Annotated[Optional[datetime], Field(description="Filter by taken date (before)")] = None,
trashed_after: Annotated[Optional[datetime], Field(description="Filter by trash date (after)")] = None,
@@ -1894,7 +1893,7 @@ class SearchApi:
Search for assets that are considered large based on specified criteria.
:param album_ids: Filter by album IDs
:type album_ids: List[UUID]
:type album_ids: List[str]
:param city: Filter by city name
:type city: str
:param country: Filter by country name
@@ -1916,7 +1915,7 @@ class SearchApi:
:param lens_model: Filter by lens model
:type lens_model: str
:param library_id: Library ID to filter by
:type library_id: UUID
:type library_id: str
:param make: Filter by camera make
:type make: str
:param min_file_size: Minimum file size in bytes
@@ -1926,7 +1925,7 @@ class SearchApi:
:param ocr: Filter by OCR text content
:type ocr: str
:param person_ids: Filter by person IDs
:type person_ids: List[UUID]
:type person_ids: List[str]
:param rating: Filter by rating [1-5], or null for unrated
:type rating: int
:param size: Number of results to return
@@ -1934,7 +1933,7 @@ class SearchApi:
:param state: Filter by state/province name
:type state: str
:param tag_ids: Filter by tag IDs
:type tag_ids: List[UUID]
:type tag_ids: List[str]
:param taken_after: Filter by taken date (after)
:type taken_after: datetime
:param taken_before: Filter by taken date (before)
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -1,809 +0,0 @@
# coding: utf-8
"""
Immich
Immich API
The version of the OpenAPI document: 3.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
from generated.immich.openapi_client.models.trash_response_dto import TrashResponseDto
from generated.immich.openapi_client.api_client import ApiClient, RequestSerialized
from generated.immich.openapi_client.api_response import ApiResponse
from generated.immich.openapi_client.rest import RESTResponseType
class TrashApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_call
def empty_trash(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def empty_trash_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def empty_trash_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Empty trash
Permanently delete all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._empty_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _empty_trash_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/empty',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def restore_assets(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def restore_assets_with_http_info(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def restore_assets_without_preload_content(
self,
bulk_ids_dto: BulkIdsDto,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Restore assets
Restore specific assets from the trash.
:param bulk_ids_dto: (required)
:type bulk_ids_dto: BulkIdsDto
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_assets_serialize(
bulk_ids_dto=bulk_ids_dto,
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _restore_assets_serialize(
self,
bulk_ids_dto,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
if bulk_ids_dto is not None:
_body_params = bulk_ids_dto
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# set the HTTP header `Content-Type`
if _content_type:
_header_params['Content-Type'] = _content_type
else:
_default_content_type = (
self.api_client.select_header_content_type(
[
'application/json'
]
)
)
if _default_content_type is not None:
_header_params['Content-Type'] = _default_content_type
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/restore/assets',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
@validate_call
def restore_trash(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> TrashResponseDto:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
).data
@validate_call
def restore_trash_with_http_info(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[TrashResponseDto]:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
response_data.read()
return self.api_client.response_deserialize(
response_data=response_data,
response_types_map=_response_types_map,
)
@validate_call
def restore_trash_without_preload_content(
self,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
"""Restore trash
Restore all items in the trash.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:type _request_timeout: int, tuple(int, int), optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the
authentication in the spec for a single request.
:type _request_auth: dict, optional
:param _content_type: force content-type for the request.
:type _content_type: str, Optional
:param _headers: set to override the headers for a single
request; this effectively ignores the headers
in the spec for a single request.
:type _headers: dict, optional
:param _host_index: set to override the host_index for a single
request; this effectively ignores the host_index
in the spec for a single request.
:type _host_index: int, optional
:return: Returns the result object.
""" # noqa: E501
_param = self._restore_trash_serialize(
_request_auth=_request_auth,
_content_type=_content_type,
_headers=_headers,
_host_index=_host_index
)
_response_types_map: Dict[str, Optional[str]] = {
'200': "TrashResponseDto",
}
response_data = self.api_client.call_api(
*_param,
_request_timeout=_request_timeout
)
return response_data.response
def _restore_trash_serialize(
self,
_request_auth,
_content_type,
_headers,
_host_index,
) -> RequestSerialized:
_host = None
_collection_formats: Dict[str, str] = {
}
_path_params: Dict[str, str] = {}
_query_params: List[Tuple[str, str]] = []
_header_params: Dict[str, Optional[str]] = _headers or {}
_form_params: List[Tuple[str, str]] = []
_files: Dict[
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
] = {}
_body_params: Optional[bytes] = None
# process the path parameters
# process the query parameters
# process the header parameters
# process the form parameters
# process the body parameter
# set the HTTP header `Accept`
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
# authentication setting
_auth_settings: List[str] = [
'cookie',
'api_key',
'bearer'
]
return self.api_client.param_serialize(
method='POST',
resource_path='/trash/restore',
path_params=_path_params,
query_params=_query_params,
header_params=_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
auth_settings=_auth_settings,
collection_formats=_collection_formats,
_host=_host,
_request_auth=_request_auth
)
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+9 -16
View File
@@ -21,7 +21,6 @@ import mimetypes
import os
import re
import tempfile
import uuid
from urllib.parse import quote
from typing import Tuple, Optional, List, Dict, Union
@@ -312,7 +311,7 @@ class ApiClient:
return_data = self.__deserialize_file(response_data)
elif response_type is not None:
match = None
content_type = response_data.headers.get('content-type')
content_type = response_data.getheader('content-type')
if content_type is not None:
match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
encoding = match.group(1) if match else "utf-8"
@@ -329,7 +328,7 @@ class ApiClient:
return ApiResponse(
status_code = response_data.status,
data = return_data,
headers = response_data.headers,
headers = response_data.getheaders(),
raw_data = response_data.data
)
@@ -357,8 +356,6 @@ class ApiClient:
return obj.get_secret_value()
elif isinstance(obj, self.PRIMITIVE_TYPES):
return obj
elif isinstance(obj, uuid.UUID):
return str(obj)
elif isinstance(obj, list):
return [
self.sanitize_for_serialization(sub_obj) for sub_obj in obj
@@ -385,10 +382,6 @@ class ApiClient:
else:
obj_dict = obj.__dict__
if isinstance(obj_dict, list):
# here we handle instances that can either be a list or something else, and only became a real list by calling to_dict()
return self.sanitize_for_serialization(obj_dict)
return {
key: self.sanitize_for_serialization(val)
for key, val in obj_dict.items()
@@ -411,7 +404,7 @@ class ApiClient:
data = json.loads(response_text)
except ValueError:
data = response_text
elif re.match(r'^application/(json|[\w!#$&.+\-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
if response_text == "":
data = ""
else:
@@ -460,13 +453,13 @@ class ApiClient:
if klass in self.PRIMITIVE_TYPES:
return self.__deserialize_primitive(data, klass)
elif klass is object:
elif klass == object:
return self.__deserialize_object(data)
elif klass is datetime.date:
elif klass == datetime.date:
return self.__deserialize_date(data)
elif klass is datetime.datetime:
elif klass == datetime.datetime:
return self.__deserialize_datetime(data)
elif klass is decimal.Decimal:
elif klass == decimal.Decimal:
return decimal.Decimal(data)
elif issubclass(klass, Enum):
return self.__deserialize_enum(data, klass)
@@ -524,7 +517,7 @@ class ApiClient:
if k in collection_formats:
collection_format = collection_formats[k]
if collection_format == 'multi':
new_params.extend((k, quote(str(value))) for value in v)
new_params.extend((k, str(value)) for value in v)
else:
if collection_format == 'ssv':
delimiter = ' '
@@ -701,7 +694,7 @@ class ApiClient:
os.close(fd)
os.remove(path)
content_disposition = response.headers.get("Content-Disposition")
content_disposition = response.getheader("Content-Disposition")
if content_disposition:
m = re.search(
r'filename=[\'"]?([^\'"\s]+)[\'"]?',
+38 -169
View File
@@ -13,16 +13,14 @@
import copy
import http.client as httplib
import logging
from logging import FileHandler
import multiprocessing
import sys
from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union
from typing_extensions import NotRequired, Self
from typing import Optional
import urllib3
import http.client as httplib
JSON_SCHEMA_VALIDATION_KEYWORDS = {
'multipleOf', 'maximum', 'exclusiveMaximum',
@@ -30,109 +28,6 @@ JSON_SCHEMA_VALIDATION_KEYWORDS = {
'minLength', 'pattern', 'maxItems', 'minItems'
}
ServerVariablesT = Dict[str, str]
GenericAuthSetting = TypedDict(
"GenericAuthSetting",
{
"type": str,
"in": str,
"key": str,
"value": str,
},
)
OAuth2AuthSetting = TypedDict(
"OAuth2AuthSetting",
{
"type": Literal["oauth2"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": str,
},
)
APIKeyAuthSetting = TypedDict(
"APIKeyAuthSetting",
{
"type": Literal["api_key"],
"in": str,
"key": str,
"value": Optional[str],
},
)
BasicAuthSetting = TypedDict(
"BasicAuthSetting",
{
"type": Literal["basic"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": Optional[str],
},
)
BearerFormatAuthSetting = TypedDict(
"BearerFormatAuthSetting",
{
"type": Literal["bearer"],
"in": Literal["header"],
"format": Literal["JWT"],
"key": Literal["Authorization"],
"value": str,
},
)
BearerAuthSetting = TypedDict(
"BearerAuthSetting",
{
"type": Literal["bearer"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": str,
},
)
HTTPSignatureAuthSetting = TypedDict(
"HTTPSignatureAuthSetting",
{
"type": Literal["http-signature"],
"in": Literal["header"],
"key": Literal["Authorization"],
"value": None,
},
)
AuthSettings = TypedDict(
"AuthSettings",
{
"bearer": BearerFormatAuthSetting,
"cookie": APIKeyAuthSetting,
"api_key": APIKeyAuthSetting,
},
total=False,
)
class HostSettingVariable(TypedDict):
description: str
default_value: str
enum_values: List[str]
class HostSetting(TypedDict):
url: str
description: str
variables: NotRequired[Dict[str, HostSettingVariable]]
class Configuration:
"""This class contains various settings of the API client.
@@ -163,10 +58,6 @@ class Configuration:
:param ssl_ca_cert: str - the path to a file of concatenated CA certificates
in PEM format.
:param retries: Number of retries for API requests.
:param ca_cert_data: verify the peer using concatenated CA certificate data
in PEM (str) or DER (bytes) format.
:param cert_file: the path to a client certificate file, for mTLS.
:param key_file: the path to a client key file, for mTLS.
:Example:
@@ -190,29 +81,20 @@ conf = generated.immich.openapi_client.Configuration(
Cookie: JSESSIONID abc123
"""
_default: ClassVar[Optional[Self]] = None
_default = None
def __init__(
self,
host: Optional[str]=None,
api_key: Optional[Dict[str, str]]=None,
api_key_prefix: Optional[Dict[str, str]]=None,
username: Optional[str]=None,
password: Optional[str]=None,
access_token: Optional[str]=None,
server_index: Optional[int]=None,
server_variables: Optional[ServerVariablesT]=None,
server_operation_index: Optional[Dict[int, int]]=None,
server_operation_variables: Optional[Dict[int, ServerVariablesT]]=None,
ignore_operation_servers: bool=False,
ssl_ca_cert: Optional[str]=None,
retries: Optional[int] = None,
ca_cert_data: Optional[Union[str, bytes]] = None,
cert_file: Optional[str]=None,
key_file: Optional[str]=None,
*,
debug: Optional[bool] = None,
) -> None:
def __init__(self, host=None,
api_key=None, api_key_prefix=None,
username=None, password=None,
access_token=None,
server_index=None, server_variables=None,
server_operation_index=None, server_operation_variables=None,
ignore_operation_servers=False,
ssl_ca_cert=None,
retries=None,
*,
debug: Optional[bool] = None
) -> None:
"""Constructor
"""
self._base_path = "https://github.com/api" if host is None else host
@@ -287,14 +169,10 @@ conf = generated.immich.openapi_client.Configuration(
self.ssl_ca_cert = ssl_ca_cert
"""Set this to customize the certificate file to verify the peer.
"""
self.ca_cert_data = ca_cert_data
"""Set this to verify the peer using PEM (str) or DER (bytes)
certificate data.
"""
self.cert_file = cert_file
self.cert_file = None
"""client certificate file
"""
self.key_file = key_file
self.key_file = None
"""client key file
"""
self.assert_hostname = None
@@ -340,7 +218,7 @@ conf = generated.immich.openapi_client.Configuration(
"""date format
"""
def __deepcopy__(self, memo: Dict[int, Any]) -> Self:
def __deepcopy__(self, memo):
cls = self.__class__
result = cls.__new__(cls)
memo[id(self)] = result
@@ -354,11 +232,11 @@ conf = generated.immich.openapi_client.Configuration(
result.debug = self.debug
return result
def __setattr__(self, name: str, value: Any) -> None:
def __setattr__(self, name, value):
object.__setattr__(self, name, value)
@classmethod
def set_default(cls, default: Optional[Self]) -> None:
def set_default(cls, default):
"""Set default instance of configuration.
It stores default configuration, which can be
@@ -369,7 +247,7 @@ conf = generated.immich.openapi_client.Configuration(
cls._default = default
@classmethod
def get_default_copy(cls) -> Self:
def get_default_copy(cls):
"""Deprecated. Please use `get_default` instead.
Deprecated. Please use `get_default` instead.
@@ -379,7 +257,7 @@ conf = generated.immich.openapi_client.Configuration(
return cls.get_default()
@classmethod
def get_default(cls) -> Self:
def get_default(cls):
"""Return the default configuration.
This method returns newly created, based on default constructor,
@@ -389,11 +267,11 @@ conf = generated.immich.openapi_client.Configuration(
:return: The configuration object.
"""
if cls._default is None:
cls._default = cls()
cls._default = Configuration()
return cls._default
@property
def logger_file(self) -> Optional[str]:
def logger_file(self):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
@@ -405,7 +283,7 @@ conf = generated.immich.openapi_client.Configuration(
return self.__logger_file
@logger_file.setter
def logger_file(self, value: Optional[str]) -> None:
def logger_file(self, value):
"""The logger file.
If the logger_file is None, then add stream handler and remove file
@@ -424,7 +302,7 @@ conf = generated.immich.openapi_client.Configuration(
logger.addHandler(self.logger_file_handler)
@property
def debug(self) -> bool:
def debug(self):
"""Debug status
:param value: The debug status, True or False.
@@ -433,7 +311,7 @@ conf = generated.immich.openapi_client.Configuration(
return self.__debug
@debug.setter
def debug(self, value: bool) -> None:
def debug(self, value):
"""Debug status
:param value: The debug status, True or False.
@@ -455,7 +333,7 @@ conf = generated.immich.openapi_client.Configuration(
httplib.HTTPConnection.debuglevel = 0
@property
def logger_format(self) -> str:
def logger_format(self):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
@@ -466,7 +344,7 @@ conf = generated.immich.openapi_client.Configuration(
return self.__logger_format
@logger_format.setter
def logger_format(self, value: str) -> None:
def logger_format(self, value):
"""The logger format.
The logger_formatter will be updated when sets logger_format.
@@ -477,7 +355,7 @@ conf = generated.immich.openapi_client.Configuration(
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier: str, alias: Optional[str]=None) -> Optional[str]:
def get_api_key_with_prefix(self, identifier, alias=None):
"""Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
@@ -494,9 +372,7 @@ conf = generated.immich.openapi_client.Configuration(
else:
return key
return None
def get_basic_auth_token(self) -> Optional[str]:
def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
@@ -507,17 +383,16 @@ conf = generated.immich.openapi_client.Configuration(
password = ""
if self.password is not None:
password = self.password
return urllib3.util.make_headers(
basic_auth=username + ':' + password
).get('authorization')
def auth_settings(self)-> AuthSettings:
def auth_settings(self):
"""Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
"""
auth: AuthSettings = {}
auth = {}
if self.access_token is not None:
auth['bearer'] = {
'type': 'bearer',
@@ -546,7 +421,7 @@ conf = generated.immich.openapi_client.Configuration(
}
return auth
def to_debug_report(self) -> str:
def to_debug_report(self):
"""Gets the essential information for debugging.
:return: The report for debugging.
@@ -558,7 +433,7 @@ conf = generated.immich.openapi_client.Configuration(
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)
def get_host_settings(self) -> List[HostSetting]:
def get_host_settings(self):
"""Gets an array of host settings
:return: An array of host settings
@@ -570,12 +445,7 @@ conf = generated.immich.openapi_client.Configuration(
}
]
def get_host_from_settings(
self,
index: Optional[int],
variables: Optional[ServerVariablesT]=None,
servers: Optional[List[HostSetting]]=None,
) -> str:
def get_host_from_settings(self, index, variables=None, servers=None):
"""Gets host URL based on the index and variables
:param index: array index of the host settings
:param variables: hash of variable and the corresponding value
@@ -603,7 +473,6 @@ conf = generated.immich.openapi_client.Configuration(
variable_name, variable['default_value'])
if 'enum_values' in variable \
and variable['enum_values'] \
and used_value not in variable['enum_values']:
raise ValueError(
"The variable `{0}` in the host URL has invalid value "
@@ -616,12 +485,12 @@ conf = generated.immich.openapi_client.Configuration(
return url
@property
def host(self) -> str:
def host(self):
"""Return generated host."""
return self.get_host_from_settings(self.server_index, variables=self.server_variables)
@host.setter
def host(self, value: str) -> None:
def host(self, value):
"""Fix base path."""
self._base_path = value
self.server_index = None
@@ -1,559 +0,0 @@
# generated.immich.openapi_client.APIKeysApi
All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api-keys | Create an API key
[**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api-keys/{id} | Delete an API key
[**get_api_key**](APIKeysApi.md#get_api_key) | **GET** /api-keys/{id} | Retrieve an API key
[**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api-keys | List all API keys
[**get_my_api_key**](APIKeysApi.md#get_my_api_key) | **GET** /api-keys/me | Retrieve the current API key
[**update_api_key**](APIKeysApi.md#update_api_key) | **PUT** /api-keys/{id} | Update an API key
# **create_api_key**
> ApiKeyCreateResponseDto create_api_key(api_key_create_dto)
Create an API key
Creates a new API key. It will be limited to the permissions specified.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_create_dto import ApiKeyCreateDto
from generated.immich.openapi_client.models.api_key_create_response_dto import ApiKeyCreateResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
api_key_create_dto = generated.immich.openapi_client.ApiKeyCreateDto() # ApiKeyCreateDto |
try:
# Create an API key
api_response = api_instance.create_api_key(api_key_create_dto)
print("The response of APIKeysApi->create_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**api_key_create_dto** | [**ApiKeyCreateDto**](ApiKeyCreateDto.md)| |
### Return type
[**ApiKeyCreateResponseDto**](ApiKeyCreateResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_api_key**
> delete_api_key(id)
Delete an API key
Deletes an API key identified by its ID. The current user must own this API key.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete an API key
api_instance.delete_api_key(id)
except Exception as e:
print("Exception when calling APIKeysApi->delete_api_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
### Return type
void (empty response body)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_api_key**
> ApiKeyResponseDto get_api_key(id)
Retrieve an API key
Retrieve an API key by its ID. The current user must own this API key.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Retrieve an API key
api_response = api_instance.get_api_key(id)
print("The response of APIKeysApi->get_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->get_api_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
### Return type
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_api_keys**
> List[ApiKeyResponseDto] get_api_keys()
List all API keys
Retrieve all API keys of the current user.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
try:
# List all API keys
api_response = api_instance.get_api_keys()
print("The response of APIKeysApi->get_api_keys:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->get_api_keys: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List[ApiKeyResponseDto]**](ApiKeyResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_my_api_key**
> ApiKeyResponseDto get_my_api_key()
Retrieve the current API key
Retrieve the API key that is used to access this endpoint.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
try:
# Retrieve the current API key
api_response = api_instance.get_my_api_key()
print("The response of APIKeysApi->get_my_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->get_my_api_key: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_api_key**
> ApiKeyResponseDto update_api_key(id, api_key_update_dto)
Update an API key
Updates the name and permissions of an API key by its ID. The current user must own this API key.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.api_key_response_dto import ApiKeyResponseDto
from generated.immich.openapi_client.models.api_key_update_dto import ApiKeyUpdateDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.APIKeysApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
api_key_update_dto = generated.immich.openapi_client.ApiKeyUpdateDto() # ApiKeyUpdateDto |
try:
# Update an API key
api_response = api_instance.update_api_key(id, api_key_update_dto)
print("The response of APIKeysApi->update_api_key:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling APIKeysApi->update_api_key: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
**api_key_update_dto** | [**ApiKeyUpdateDto**](ApiKeyUpdateDto.md)| |
### Return type
[**ApiKeyResponseDto**](ApiKeyResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -1,390 +0,0 @@
# generated.immich.openapi_client.ActivitiesApi
All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_activity**](ActivitiesApi.md#create_activity) | **POST** /activities | Create an activity
[**delete_activity**](ActivitiesApi.md#delete_activity) | **DELETE** /activities/{id} | Delete an activity
[**get_activities**](ActivitiesApi.md#get_activities) | **GET** /activities | List all activities
[**get_activity_statistics**](ActivitiesApi.md#get_activity_statistics) | **GET** /activities/statistics | Retrieve activity statistics
# **create_activity**
> ActivityResponseDto create_activity(activity_create_dto)
Create an activity
Create a like or a comment for an album, or an asset in an album.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto
from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
activity_create_dto = generated.immich.openapi_client.ActivityCreateDto() # ActivityCreateDto |
try:
# Create an activity
api_response = api_instance.create_activity(activity_create_dto)
print("The response of ActivitiesApi->create_activity:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ActivitiesApi->create_activity: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**activity_create_dto** | [**ActivityCreateDto**](ActivityCreateDto.md)| |
### Return type
[**ActivityResponseDto**](ActivityResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_activity**
> delete_activity(id)
Delete an activity
Removes a like or comment from a given album or asset in an album.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Delete an activity
api_instance.delete_activity(id)
except Exception as e:
print("Exception when calling ActivitiesApi->delete_activity: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
### Return type
void (empty response body)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_activities**
> List[ActivityResponseDto] get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_id)
List all activities
Returns a list of activities for the selected asset or album. The activities are returned in sorted order, with the oldest activities appearing first.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto
from generated.immich.openapi_client.models.reaction_level import ReactionLevel
from generated.immich.openapi_client.models.reaction_type import ReactionType
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID
asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID (if activity is for an asset) (optional)
level = generated.immich.openapi_client.ReactionLevel() # ReactionLevel | (optional)
type = generated.immich.openapi_client.ReactionType() # ReactionType | (optional)
user_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Filter by user ID (optional)
try:
# List all activities
api_response = api_instance.get_activities(album_id, asset_id=asset_id, level=level, type=type, user_id=user_id)
print("The response of ActivitiesApi->get_activities:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ActivitiesApi->get_activities: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**album_id** | **UUID**| Album ID |
**asset_id** | **UUID**| Asset ID (if activity is for an asset) | [optional]
**level** | [**ReactionLevel**](.md)| | [optional]
**type** | [**ReactionType**](.md)| | [optional]
**user_id** | **UUID**| Filter by user ID | [optional]
### Return type
[**List[ActivityResponseDto]**](ActivityResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_activity_statistics**
> ActivityStatisticsResponseDto get_activity_statistics(album_id, asset_id=asset_id)
Retrieve activity statistics
Returns the number of likes and comments for a given album or asset in an album.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.activity_statistics_response_dto import ActivityStatisticsResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.ActivitiesApi(api_client)
album_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Album ID
asset_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Asset ID (if activity is for an asset) (optional)
try:
# Retrieve activity statistics
api_response = api_instance.get_activity_statistics(album_id, asset_id=asset_id)
print("The response of ActivitiesApi->get_activity_statistics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ActivitiesApi->get_activity_statistics: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**album_id** | **UUID**| Album ID |
**asset_id** | **UUID**| Asset ID (if activity is for an asset) | [optional]
### Return type
[**ActivityStatisticsResponseDto**](ActivityStatisticsResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -1,33 +0,0 @@
# ActivityCreateDto
Activity create
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_id** | **UUID** | Album ID |
**asset_id** | **UUID** | Asset ID (if activity is for an asset) | [optional]
**comment** | **str** | Comment text (required if type is comment) | [optional]
**type** | [**ReactionType**](ReactionType.md) | |
## Example
```python
from generated.immich.openapi_client.models.activity_create_dto import ActivityCreateDto
# TODO update the JSON string below
json = "{}"
# create an instance of ActivityCreateDto from a JSON string
activity_create_dto_instance = ActivityCreateDto.from_json(json)
# print the JSON string representation of the object
print(ActivityCreateDto.to_json())
# convert the object into a dict
activity_create_dto_dict = activity_create_dto_instance.to_dict()
# create an instance of ActivityCreateDto from a dict
activity_create_dto_from_dict = ActivityCreateDto.from_dict(activity_create_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,34 +0,0 @@
# ActivityResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **UUID** | Asset ID (if activity is for an asset) |
**comment** | **str** | Comment text (for comment activities) | [optional]
**created_at** | **datetime** | Creation date |
**id** | **UUID** | Activity ID |
**type** | [**ReactionType**](ReactionType.md) | |
**user** | [**UserResponseDto**](UserResponseDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.activity_response_dto import ActivityResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of ActivityResponseDto from a JSON string
activity_response_dto_instance = ActivityResponseDto.from_json(json)
# print the JSON string representation of the object
print(ActivityResponseDto.to_json())
# convert the object into a dict
activity_response_dto_dict = activity_response_dto_instance.to_dict()
# create an instance of ActivityResponseDto from a dict
activity_response_dto_from_dict = ActivityResponseDto.from_dict(activity_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# ActivityStatisticsResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments** | **int** | Number of comments |
**likes** | **int** | Number of likes |
## Example
```python
from generated.immich.openapi_client.models.activity_statistics_response_dto import ActivityStatisticsResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of ActivityStatisticsResponseDto from a JSON string
activity_statistics_response_dto_instance = ActivityStatisticsResponseDto.from_json(json)
# print the JSON string representation of the object
print(ActivityStatisticsResponseDto.to_json())
# convert the object into a dict
activity_statistics_response_dto_dict = activity_statistics_response_dto_instance.to_dict()
# create an instance of ActivityStatisticsResponseDto from a dict
activity_statistics_response_dto_from_dict = ActivityStatisticsResponseDto.from_dict(activity_statistics_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AddUsersDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_users** | [**List[AlbumUserAddDto]**](AlbumUserAddDto.md) | Album users to add |
## Example
```python
from generated.immich.openapi_client.models.add_users_dto import AddUsersDto
# TODO update the JSON string below
json = "{}"
# create an instance of AddUsersDto from a JSON string
add_users_dto_instance = AddUsersDto.from_json(json)
# print the JSON string representation of the object
print(AddUsersDto.to_json())
# convert the object into a dict
add_users_dto_dict = add_users_dto_instance.to_dict()
# create an instance of AddUsersDto from a dict
add_users_dto_from_dict = AddUsersDto.from_dict(add_users_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AdminOnboardingUpdateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is_onboarded** | **bool** | Is admin onboarded |
## Example
```python
from generated.immich.openapi_client.models.admin_onboarding_update_dto import AdminOnboardingUpdateDto
# TODO update the JSON string below
json = "{}"
# create an instance of AdminOnboardingUpdateDto from a JSON string
admin_onboarding_update_dto_instance = AdminOnboardingUpdateDto.from_json(json)
# print the JSON string representation of the object
print(AdminOnboardingUpdateDto.to_json())
# convert the object into a dict
admin_onboarding_update_dto_dict = admin_onboarding_update_dto_instance.to_dict()
# create an instance of AdminOnboardingUpdateDto from a dict
admin_onboarding_update_dto_from_dict = AdminOnboardingUpdateDto.from_dict(admin_onboarding_update_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,44 +0,0 @@
# AlbumResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_name** | **str** | Album name |
**album_thumbnail_asset_id** | **UUID** | Thumbnail asset ID |
**album_users** | [**List[AlbumUserResponseDto]**](AlbumUserResponseDto.md) | First entry is always the album owner. Second entry is the auth user, if it differs from the owner. The rest are ordered alphabetically. |
**asset_count** | **int** | Number of assets |
**contributor_counts** | [**List[ContributorCountResponseDto]**](ContributorCountResponseDto.md) | | [optional]
**created_at** | **datetime** | Creation date |
**description** | **str** | Album description |
**end_date** | **datetime** | End date (latest asset) | [optional]
**has_shared_link** | **bool** | Has shared link |
**id** | **UUID** | Album ID |
**is_activity_enabled** | **bool** | Activity feed enabled |
**last_modified_asset_timestamp** | **datetime** | Last modified asset timestamp | [optional]
**order** | [**AssetOrder**](AssetOrder.md) | | [optional]
**shared** | **bool** | Is shared album |
**start_date** | **datetime** | Start date (earliest asset) | [optional]
**updated_at** | **datetime** | Last update date |
## Example
```python
from generated.immich.openapi_client.models.album_response_dto import AlbumResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AlbumResponseDto from a JSON string
album_response_dto_instance = AlbumResponseDto.from_json(json)
# print the JSON string representation of the object
print(AlbumResponseDto.to_json())
# convert the object into a dict
album_response_dto_dict = album_response_dto_instance.to_dict()
# create an instance of AlbumResponseDto from a dict
album_response_dto_from_dict = AlbumResponseDto.from_dict(album_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# AlbumStatisticsResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**not_shared** | **int** | Number of non-shared albums |
**owned** | **int** | Number of owned albums |
**shared** | **int** | Number of shared albums |
## Example
```python
from generated.immich.openapi_client.models.album_statistics_response_dto import AlbumStatisticsResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AlbumStatisticsResponseDto from a JSON string
album_statistics_response_dto_instance = AlbumStatisticsResponseDto.from_json(json)
# print the JSON string representation of the object
print(AlbumStatisticsResponseDto.to_json())
# convert the object into a dict
album_statistics_response_dto_dict = album_statistics_response_dto_instance.to_dict()
# create an instance of AlbumStatisticsResponseDto from a dict
album_statistics_response_dto_from_dict = AlbumStatisticsResponseDto.from_dict(album_statistics_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AlbumUserAddDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role** | [**AlbumUserRole**](AlbumUserRole.md) | | [optional]
**user_id** | **UUID** | User ID |
## Example
```python
from generated.immich.openapi_client.models.album_user_add_dto import AlbumUserAddDto
# TODO update the JSON string below
json = "{}"
# create an instance of AlbumUserAddDto from a JSON string
album_user_add_dto_instance = AlbumUserAddDto.from_json(json)
# print the JSON string representation of the object
print(AlbumUserAddDto.to_json())
# convert the object into a dict
album_user_add_dto_dict = album_user_add_dto_instance.to_dict()
# create an instance of AlbumUserAddDto from a dict
album_user_add_dto_from_dict = AlbumUserAddDto.from_dict(album_user_add_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AlbumUserCreateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role** | [**AlbumUserRole**](AlbumUserRole.md) | |
**user_id** | **UUID** | User ID |
## Example
```python
from generated.immich.openapi_client.models.album_user_create_dto import AlbumUserCreateDto
# TODO update the JSON string below
json = "{}"
# create an instance of AlbumUserCreateDto from a JSON string
album_user_create_dto_instance = AlbumUserCreateDto.from_json(json)
# print the JSON string representation of the object
print(AlbumUserCreateDto.to_json())
# convert the object into a dict
album_user_create_dto_dict = album_user_create_dto_instance.to_dict()
# create an instance of AlbumUserCreateDto from a dict
album_user_create_dto_from_dict = AlbumUserCreateDto.from_dict(album_user_create_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AlbumUserResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role** | [**AlbumUserRole**](AlbumUserRole.md) | |
**user** | [**UserResponseDto**](UserResponseDto.md) | |
## Example
```python
from generated.immich.openapi_client.models.album_user_response_dto import AlbumUserResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AlbumUserResponseDto from a JSON string
album_user_response_dto_instance = AlbumUserResponseDto.from_json(json)
# print the JSON string representation of the object
print(AlbumUserResponseDto.to_json())
# convert the object into a dict
album_user_response_dto_dict = album_user_response_dto_instance.to_dict()
# create an instance of AlbumUserResponseDto from a dict
album_user_response_dto_from_dict = AlbumUserResponseDto.from_dict(album_user_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,15 +0,0 @@
# AlbumUserRole
Album user role
## Enum
* `EDITOR` (value: `'editor'`)
* `OWNER` (value: `'owner'`)
* `VIEWER` (value: `'viewer'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
File diff suppressed because it is too large Load Diff
@@ -1,30 +0,0 @@
# AssetBulkDeleteDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**force** | **bool** | Force delete even if in use | [optional]
**ids** | **List[UUID]** | IDs to process |
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_delete_dto import AssetBulkDeleteDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkDeleteDto from a JSON string
asset_bulk_delete_dto_instance = AssetBulkDeleteDto.from_json(json)
# print the JSON string representation of the object
print(AssetBulkDeleteDto.to_json())
# convert the object into a dict
asset_bulk_delete_dto_dict = asset_bulk_delete_dto_instance.to_dict()
# create an instance of AssetBulkDeleteDto from a dict
asset_bulk_delete_dto_from_dict = AssetBulkDeleteDto.from_dict(asset_bulk_delete_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,39 +0,0 @@
# AssetBulkUpdateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**date_time_original** | **str** | Original date and time | [optional]
**date_time_relative** | **int** | Relative time offset in minutes | [optional]
**description** | **str** | Asset description | [optional]
**duplicate_id** | **str** | Duplicate ID | [optional]
**ids** | **List[UUID]** | Asset IDs to update |
**is_favorite** | **bool** | Mark as favorite | [optional]
**latitude** | **float** | Latitude coordinate | [optional]
**longitude** | **float** | Longitude coordinate | [optional]
**rating** | **int** | Rating in range [1-5] (starred), -1 (rejected), or null (unrated) | [optional]
**time_zone** | **str** | Time zone (IANA timezone) | [optional]
**visibility** | [**AssetVisibility**](AssetVisibility.md) | | [optional]
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_update_dto import AssetBulkUpdateDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkUpdateDto from a JSON string
asset_bulk_update_dto_instance = AssetBulkUpdateDto.from_json(json)
# print the JSON string representation of the object
print(AssetBulkUpdateDto.to_json())
# convert the object into a dict
asset_bulk_update_dto_dict = asset_bulk_update_dto_instance.to_dict()
# create an instance of AssetBulkUpdateDto from a dict
asset_bulk_update_dto_from_dict = AssetBulkUpdateDto.from_dict(asset_bulk_update_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AssetBulkUploadCheckDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assets** | [**List[AssetBulkUploadCheckItem]**](AssetBulkUploadCheckItem.md) | Assets to check |
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_upload_check_dto import AssetBulkUploadCheckDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkUploadCheckDto from a JSON string
asset_bulk_upload_check_dto_instance = AssetBulkUploadCheckDto.from_json(json)
# print the JSON string representation of the object
print(AssetBulkUploadCheckDto.to_json())
# convert the object into a dict
asset_bulk_upload_check_dto_dict = asset_bulk_upload_check_dto_instance.to_dict()
# create an instance of AssetBulkUploadCheckDto from a dict
asset_bulk_upload_check_dto_from_dict = AssetBulkUploadCheckDto.from_dict(asset_bulk_upload_check_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AssetBulkUploadCheckItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | Base64 or hex encoded SHA1 hash |
**id** | **str** | Client-side identifier echoed in the response to match results to inputs (e.g. filename) |
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_upload_check_item import AssetBulkUploadCheckItem
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkUploadCheckItem from a JSON string
asset_bulk_upload_check_item_instance = AssetBulkUploadCheckItem.from_json(json)
# print the JSON string representation of the object
print(AssetBulkUploadCheckItem.to_json())
# convert the object into a dict
asset_bulk_upload_check_item_dict = asset_bulk_upload_check_item_instance.to_dict()
# create an instance of AssetBulkUploadCheckItem from a dict
asset_bulk_upload_check_item_from_dict = AssetBulkUploadCheckItem.from_dict(asset_bulk_upload_check_item_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AssetBulkUploadCheckResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results** | [**List[AssetBulkUploadCheckResult]**](AssetBulkUploadCheckResult.md) | Upload check results |
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_upload_check_response_dto import AssetBulkUploadCheckResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkUploadCheckResponseDto from a JSON string
asset_bulk_upload_check_response_dto_instance = AssetBulkUploadCheckResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetBulkUploadCheckResponseDto.to_json())
# convert the object into a dict
asset_bulk_upload_check_response_dto_dict = asset_bulk_upload_check_response_dto_instance.to_dict()
# create an instance of AssetBulkUploadCheckResponseDto from a dict
asset_bulk_upload_check_response_dto_from_dict = AssetBulkUploadCheckResponseDto.from_dict(asset_bulk_upload_check_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,33 +0,0 @@
# AssetBulkUploadCheckResult
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | [**AssetUploadAction**](AssetUploadAction.md) | |
**asset_id** | **UUID** | Existing asset ID if duplicate | [optional]
**id** | **str** | Client-side identifier echoed from the request to match results to inputs |
**is_trashed** | **bool** | Whether existing asset is trashed | [optional]
**reason** | [**AssetRejectReason**](AssetRejectReason.md) | | [optional]
## Example
```python
from generated.immich.openapi_client.models.asset_bulk_upload_check_result import AssetBulkUploadCheckResult
# TODO update the JSON string below
json = "{}"
# create an instance of AssetBulkUploadCheckResult from a JSON string
asset_bulk_upload_check_result_instance = AssetBulkUploadCheckResult.from_json(json)
# print the JSON string representation of the object
print(AssetBulkUploadCheckResult.to_json())
# convert the object into a dict
asset_bulk_upload_check_result_dict = asset_bulk_upload_check_result_instance.to_dict()
# create an instance of AssetBulkUploadCheckResult from a dict
asset_bulk_upload_check_result_from_dict = AssetBulkUploadCheckResult.from_dict(asset_bulk_upload_check_result_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,36 +0,0 @@
# AssetFaceCreateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **UUID** | Asset ID |
**height** | **int** | Face bounding box height |
**image_height** | **int** | Image height in pixels |
**image_width** | **int** | Image width in pixels |
**person_id** | **UUID** | Person ID |
**width** | **int** | Face bounding box width |
**x** | **int** | Face bounding box X coordinate |
**y** | **int** | Face bounding box Y coordinate |
## Example
```python
from generated.immich.openapi_client.models.asset_face_create_dto import AssetFaceCreateDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceCreateDto from a JSON string
asset_face_create_dto_instance = AssetFaceCreateDto.from_json(json)
# print the JSON string representation of the object
print(AssetFaceCreateDto.to_json())
# convert the object into a dict
asset_face_create_dto_dict = asset_face_create_dto_instance.to_dict()
# create an instance of AssetFaceCreateDto from a dict
asset_face_create_dto_from_dict = AssetFaceCreateDto.from_dict(asset_face_create_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AssetFaceDeleteDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**force** | **bool** | Force delete even if person has other faces |
## Example
```python
from generated.immich.openapi_client.models.asset_face_delete_dto import AssetFaceDeleteDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceDeleteDto from a JSON string
asset_face_delete_dto_instance = AssetFaceDeleteDto.from_json(json)
# print the JSON string representation of the object
print(AssetFaceDeleteDto.to_json())
# convert the object into a dict
asset_face_delete_dto_dict = asset_face_delete_dto_instance.to_dict()
# create an instance of AssetFaceDeleteDto from a dict
asset_face_delete_dto_from_dict = AssetFaceDeleteDto.from_dict(asset_face_delete_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,38 +0,0 @@
# AssetFaceResponseDto
Asset face with person
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bounding_box_x1** | **int** | Bounding box X1 coordinate |
**bounding_box_x2** | **int** | Bounding box X2 coordinate |
**bounding_box_y1** | **int** | Bounding box Y1 coordinate |
**bounding_box_y2** | **int** | Bounding box Y2 coordinate |
**id** | **UUID** | Face ID |
**image_height** | **int** | Image height in pixels |
**image_width** | **int** | Image width in pixels |
**person** | [**PersonResponseDto**](PersonResponseDto.md) | |
**source_type** | [**SourceType**](SourceType.md) | | [optional]
## Example
```python
from generated.immich.openapi_client.models.asset_face_response_dto import AssetFaceResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceResponseDto from a JSON string
asset_face_response_dto_instance = AssetFaceResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetFaceResponseDto.to_json())
# convert the object into a dict
asset_face_response_dto_dict = asset_face_response_dto_instance.to_dict()
# create an instance of AssetFaceResponseDto from a dict
asset_face_response_dto_from_dict = AssetFaceResponseDto.from_dict(asset_face_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AssetFaceUpdateDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**List[AssetFaceUpdateItem]**](AssetFaceUpdateItem.md) | Face update items |
## Example
```python
from generated.immich.openapi_client.models.asset_face_update_dto import AssetFaceUpdateDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceUpdateDto from a JSON string
asset_face_update_dto_instance = AssetFaceUpdateDto.from_json(json)
# print the JSON string representation of the object
print(AssetFaceUpdateDto.to_json())
# convert the object into a dict
asset_face_update_dto_dict = asset_face_update_dto_instance.to_dict()
# create an instance of AssetFaceUpdateDto from a dict
asset_face_update_dto_from_dict = AssetFaceUpdateDto.from_dict(asset_face_update_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AssetFaceUpdateItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **UUID** | Asset ID |
**person_id** | **UUID** | Person ID |
## Example
```python
from generated.immich.openapi_client.models.asset_face_update_item import AssetFaceUpdateItem
# TODO update the JSON string below
json = "{}"
# create an instance of AssetFaceUpdateItem from a JSON string
asset_face_update_item_instance = AssetFaceUpdateItem.from_json(json)
# print the JSON string representation of the object
print(AssetFaceUpdateItem.to_json())
# convert the object into a dict
asset_face_update_item_dict = asset_face_update_item_instance.to_dict()
# create an instance of AssetFaceUpdateItem from a dict
asset_face_update_item_from_dict = AssetFaceUpdateItem.from_dict(asset_face_update_item_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# AssetIdsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[UUID]** | Asset IDs |
## Example
```python
from generated.immich.openapi_client.models.asset_ids_dto import AssetIdsDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetIdsDto from a JSON string
asset_ids_dto_instance = AssetIdsDto.from_json(json)
# print the JSON string representation of the object
print(AssetIdsDto.to_json())
# convert the object into a dict
asset_ids_dto_dict = asset_ids_dto_instance.to_dict()
# create an instance of AssetIdsDto from a dict
asset_ids_dto_from_dict = AssetIdsDto.from_dict(asset_ids_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# AssetIdsResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **UUID** | Asset ID |
**error** | [**AssetIdErrorReason**](AssetIdErrorReason.md) | | [optional]
**success** | **bool** | Whether operation succeeded |
## Example
```python
from generated.immich.openapi_client.models.asset_ids_response_dto import AssetIdsResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetIdsResponseDto from a JSON string
asset_ids_response_dto_instance = AssetIdsResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetIdsResponseDto.to_json())
# convert the object into a dict
asset_ids_response_dto_dict = asset_ids_response_dto_instance.to_dict()
# create an instance of AssetIdsResponseDto from a dict
asset_ids_response_dto_from_dict = AssetIdsResponseDto.from_dict(asset_ids_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,17 +0,0 @@
# AssetJobName
Job name
## Enum
* `REFRESH_MINUS_FACES` (value: `'refresh-faces'`)
* `REFRESH_MINUS_METADATA` (value: `'refresh-metadata'`)
* `REGENERATE_MINUS_THUMBNAIL` (value: `'regenerate-thumbnail'`)
* `TRANSCODE_MINUS_VIDEO` (value: `'transcode-video'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AssetJobsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[UUID]** | Asset IDs |
**name** | [**AssetJobName**](AssetJobName.md) | |
## Example
```python
from generated.immich.openapi_client.models.asset_jobs_dto import AssetJobsDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetJobsDto from a JSON string
asset_jobs_dto_instance = AssetJobsDto.from_json(json)
# print the JSON string representation of the object
print(AssetJobsDto.to_json())
# convert the object into a dict
asset_jobs_dto_dict = asset_jobs_dto_instance.to_dict()
# create an instance of AssetJobsDto from a dict
asset_jobs_dto_from_dict = AssetJobsDto.from_dict(asset_jobs_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# AssetMediaResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **UUID** | Asset media ID |
**status** | [**AssetMediaStatus**](AssetMediaStatus.md) | |
## Example
```python
from generated.immich.openapi_client.models.asset_media_response_dto import AssetMediaResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetMediaResponseDto from a JSON string
asset_media_response_dto_instance = AssetMediaResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetMediaResponseDto.to_json())
# convert the object into a dict
asset_media_response_dto_dict = asset_media_response_dto_instance.to_dict()
# create an instance of AssetMediaResponseDto from a dict
asset_media_response_dto_from_dict = AssetMediaResponseDto.from_dict(asset_media_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,17 +0,0 @@
# AssetMediaSize
Asset media size
## Enum
* `ORIGINAL` (value: `'original'`)
* `FULLSIZE` (value: `'fullsize'`)
* `PREVIEW` (value: `'preview'`)
* `THUMBNAIL` (value: `'thumbnail'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,13 +0,0 @@
# AssetMediaStatus
Upload status
## Enum
* `CREATED` (value: `'created'`)
* `DUPLICATE` (value: `'duplicate'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,13 +0,0 @@
# AssetOrder
Asset sort order
## Enum
* `ASC` (value: `'asc'`)
* `DESC` (value: `'desc'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,60 +0,0 @@
# AssetResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**checksum** | **str** | Base64 encoded SHA1 hash |
**created_at** | **datetime** | The UTC timestamp when the asset was originally uploaded to Immich. |
**duplicate_id** | **UUID** | Duplicate group ID | [optional]
**duration** | **int** | Video/gif duration in milliseconds (null for static images) |
**exif_info** | [**ExifResponseDto**](ExifResponseDto.md) | | [optional]
**file_created_at** | **datetime** | The actual UTC timestamp when the file was created/captured, preserving timezone information. This is the authoritative timestamp for chronological sorting within timeline groups. Combined with timezone data, this can be used to determine the exact moment the photo was taken. |
**file_modified_at** | **datetime** | The UTC timestamp when the file was last modified on the filesystem. This reflects the last time the physical file was changed, which may be different from when the photo was originally taken. |
**has_metadata** | **bool** | Whether asset has metadata |
**height** | **int** | Asset height |
**id** | **UUID** | Asset ID |
**is_archived** | **bool** | Is archived |
**is_edited** | **bool** | Is edited |
**is_favorite** | **bool** | Is favorite |
**is_offline** | **bool** | Is offline |
**is_trashed** | **bool** | Is trashed |
**library_id** | **UUID** | Library ID | [optional]
**live_photo_video_id** | **str** | Live photo video ID | [optional]
**local_date_time** | **datetime** | The local date and time when the photo/video was taken, derived from EXIF metadata. This represents the photographer's local time regardless of timezone, stored as a timezone-agnostic timestamp. Used for timeline grouping by \"local\" days and months. |
**original_file_name** | **str** | Original file name |
**original_mime_type** | **str** | Original MIME type | [optional]
**original_path** | **str** | Original file path |
**owner** | [**UserResponseDto**](UserResponseDto.md) | | [optional]
**owner_id** | **UUID** | Owner user ID |
**people** | [**List[PersonResponseDto]**](PersonResponseDto.md) | | [optional]
**resized** | **bool** | Is resized | [optional]
**stack** | [**AssetStackResponseDto**](AssetStackResponseDto.md) | | [optional]
**tags** | [**List[TagResponseDto]**](TagResponseDto.md) | | [optional]
**thumbhash** | **str** | Thumbhash for thumbnail generation (base64) also used as the c query param for thumbnail cache busting. |
**type** | [**AssetTypeEnum**](AssetTypeEnum.md) | |
**updated_at** | **datetime** | The UTC timestamp when the asset record was last updated in the database. This is automatically maintained by the database and reflects when any field in the asset was last modified. |
**visibility** | [**AssetVisibility**](AssetVisibility.md) | |
**width** | **int** | Asset width |
## Example
```python
from generated.immich.openapi_client.models.asset_response_dto import AssetResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetResponseDto from a JSON string
asset_response_dto_instance = AssetResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetResponseDto.to_json())
# convert the object into a dict
asset_response_dto_dict = asset_response_dto_instance.to_dict()
# create an instance of AssetResponseDto from a dict
asset_response_dto_from_dict = AssetResponseDto.from_dict(asset_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# AssetStackResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_count** | **int** | Number of assets in stack |
**id** | **UUID** | Stack ID |
**primary_asset_id** | **UUID** | Primary asset ID |
## Example
```python
from generated.immich.openapi_client.models.asset_stack_response_dto import AssetStackResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetStackResponseDto from a JSON string
asset_stack_response_dto_instance = AssetStackResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetStackResponseDto.to_json())
# convert the object into a dict
asset_stack_response_dto_dict = asset_stack_response_dto_instance.to_dict()
# create an instance of AssetStackResponseDto from a dict
asset_stack_response_dto_from_dict = AssetStackResponseDto.from_dict(asset_stack_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# AssetStatsResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**images** | **int** | Number of images |
**total** | **int** | Total number of assets |
**videos** | **int** | Number of videos |
## Example
```python
from generated.immich.openapi_client.models.asset_stats_response_dto import AssetStatsResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of AssetStatsResponseDto from a JSON string
asset_stats_response_dto_instance = AssetStatsResponseDto.from_json(json)
# print the JSON string representation of the object
print(AssetStatsResponseDto.to_json())
# convert the object into a dict
asset_stats_response_dto_dict = asset_stats_response_dto_instance.to_dict()
# create an instance of AssetStatsResponseDto from a dict
asset_stats_response_dto_from_dict = AssetStatsResponseDto.from_dict(asset_stats_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,17 +0,0 @@
# AssetTypeEnum
Asset type
## Enum
* `IMAGE` (value: `'IMAGE'`)
* `VIDEO` (value: `'VIDEO'`)
* `AUDIO` (value: `'AUDIO'`)
* `OTHER` (value: `'OTHER'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
File diff suppressed because it is too large Load Diff
@@ -1,17 +0,0 @@
# AudioCodec
Target audio codec
## Enum
* `MP3` (value: `'mp3'`)
* `AAC` (value: `'aac'`)
* `OPUS` (value: `'opus'`)
* `PCM_S16LE` (value: `'pcm_s16le'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
File diff suppressed because it is too large Load Diff
@@ -1,29 +0,0 @@
# AvatarUpdate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**color** | [**UserAvatarColor**](UserAvatarColor.md) | | [optional]
## Example
```python
from generated.immich.openapi_client.models.avatar_update import AvatarUpdate
# TODO update the JSON string below
json = "{}"
# create an instance of AvatarUpdate from a JSON string
avatar_update_instance = AvatarUpdate.from_json(json)
# print the JSON string representation of the object
print(AvatarUpdate.to_json())
# convert the object into a dict
avatar_update_dict = avatar_update_instance.to_dict()
# create an instance of AvatarUpdate from a dict
avatar_update_from_dict = AvatarUpdate.from_dict(avatar_update_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,32 +0,0 @@
# BulkIdResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | [**BulkIdErrorReason**](BulkIdErrorReason.md) | | [optional]
**error_message** | **str** | | [optional]
**id** | **UUID** | ID |
**success** | **bool** | Whether operation succeeded |
## Example
```python
from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of BulkIdResponseDto from a JSON string
bulk_id_response_dto_instance = BulkIdResponseDto.from_json(json)
# print the JSON string representation of the object
print(BulkIdResponseDto.to_json())
# convert the object into a dict
bulk_id_response_dto_dict = bulk_id_response_dto_instance.to_dict()
# create an instance of BulkIdResponseDto from a dict
bulk_id_response_dto_from_dict = BulkIdResponseDto.from_dict(bulk_id_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,29 +0,0 @@
# BulkIdsDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ids** | **List[UUID]** | IDs to process |
## Example
```python
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
# TODO update the JSON string below
json = "{}"
# create an instance of BulkIdsDto from a JSON string
bulk_ids_dto_instance = BulkIdsDto.from_json(json)
# print the JSON string representation of the object
print(BulkIdsDto.to_json())
# convert the object into a dict
bulk_ids_dto_dict = bulk_ids_dto_instance.to_dict()
# create an instance of BulkIdsDto from a dict
bulk_ids_dto_from_dict = BulkIdsDto.from_dict(bulk_ids_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# CLIPConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Whether the task is enabled |
**model_name** | **str** | Name of the model to use |
## Example
```python
from generated.immich.openapi_client.models.clip_config import CLIPConfig
# TODO update the JSON string below
json = "{}"
# create an instance of CLIPConfig from a JSON string
clip_config_instance = CLIPConfig.from_json(json)
# print the JSON string representation of the object
print(CLIPConfig.to_json())
# convert the object into a dict
clip_config_dict = clip_config_instance.to_dict()
# create an instance of CLIPConfig from a dict
clip_config_from_dict = CLIPConfig.from_dict(clip_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,15 +0,0 @@
# CQMode
CQ mode
## Enum
* `AUTO` (value: `'auto'`)
* `CQP` (value: `'cqp'`)
* `ICQ` (value: `'icq'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# ChangePasswordDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**invalidate_sessions** | **bool** | Invalidate all other sessions | [optional] [default to False]
**new_password** | **str** | New password (min 8 characters) |
**password** | **str** | Current password |
## Example
```python
from generated.immich.openapi_client.models.change_password_dto import ChangePasswordDto
# TODO update the JSON string below
json = "{}"
# create an instance of ChangePasswordDto from a JSON string
change_password_dto_instance = ChangePasswordDto.from_json(json)
# print the JSON string representation of the object
print(ChangePasswordDto.to_json())
# convert the object into a dict
change_password_dto_dict = change_password_dto_instance.to_dict()
# create an instance of ChangePasswordDto from a dict
change_password_dto_from_dict = ChangePasswordDto.from_dict(change_password_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,13 +0,0 @@
# Colorspace
Colorspace
## Enum
* `SRGB` (value: `'srgb'`)
* `P3` (value: `'p3'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,32 +0,0 @@
# CreateAlbumDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_name** | **str** | Album name |
**album_users** | [**List[AlbumUserCreateDto]**](AlbumUserCreateDto.md) | Album users | [optional]
**asset_ids** | **List[UUID]** | Initial asset IDs | [optional]
**description** | **str** | Album description | [optional]
## Example
```python
from generated.immich.openapi_client.models.create_album_dto import CreateAlbumDto
# TODO update the JSON string below
json = "{}"
# create an instance of CreateAlbumDto from a JSON string
create_album_dto_instance = CreateAlbumDto.from_json(json)
# print the JSON string representation of the object
print(CreateAlbumDto.to_json())
# convert the object into a dict
create_album_dto_dict = create_album_dto_instance.to_dict()
# create an instance of CreateAlbumDto from a dict
create_album_dto_from_dict = CreateAlbumDto.from_dict(create_album_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,32 +0,0 @@
# CreateLibraryDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**exclusion_patterns** | **List[str]** | Exclusion patterns (max 128) | [optional]
**import_paths** | **List[str]** | Import paths (max 128) | [optional]
**name** | **str** | Library name | [optional]
**owner_id** | **UUID** | Owner user ID |
## Example
```python
from generated.immich.openapi_client.models.create_library_dto import CreateLibraryDto
# TODO update the JSON string below
json = "{}"
# create an instance of CreateLibraryDto from a JSON string
create_library_dto_instance = CreateLibraryDto.from_json(json)
# print the JSON string representation of the object
print(CreateLibraryDto.to_json())
# convert the object into a dict
create_library_dto_dict = create_library_dto_instance.to_dict()
# create an instance of CreateLibraryDto from a dict
create_library_dto_from_dict = CreateLibraryDto.from_dict(create_library_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# CreateProfileImageResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**profile_changed_at** | **datetime** | Profile image change date |
**profile_image_path** | **str** | Profile image file path |
**user_id** | **UUID** | User ID |
## Example
```python
from generated.immich.openapi_client.models.create_profile_image_response_dto import CreateProfileImageResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of CreateProfileImageResponseDto from a JSON string
create_profile_image_response_dto_instance = CreateProfileImageResponseDto.from_json(json)
# print the JSON string representation of the object
print(CreateProfileImageResponseDto.to_json())
# convert the object into a dict
create_profile_image_response_dto_dict = create_profile_image_response_dto_instance.to_dict()
# create an instance of CreateProfileImageResponseDto from a dict
create_profile_image_response_dto_from_dict = CreateProfileImageResponseDto.from_dict(create_profile_image_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# DatabaseBackupConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cron_expression** | **str** | Cron expression |
**enabled** | **bool** | Enabled |
**keep_last_amount** | **int** | Keep last amount |
## Example
```python
from generated.immich.openapi_client.models.database_backup_config import DatabaseBackupConfig
# TODO update the JSON string below
json = "{}"
# create an instance of DatabaseBackupConfig from a JSON string
database_backup_config_instance = DatabaseBackupConfig.from_json(json)
# print the JSON string representation of the object
print(DatabaseBackupConfig.to_json())
# convert the object into a dict
database_backup_config_dict = database_backup_config_instance.to_dict()
# create an instance of DatabaseBackupConfig from a dict
database_backup_config_from_dict = DatabaseBackupConfig.from_dict(database_backup_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
File diff suppressed because it is too large Load Diff
@@ -1,203 +0,0 @@
# generated.immich.openapi_client.DownloadApi
All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**download_archive**](DownloadApi.md#download_archive) | **POST** /download/archive | Download asset archive
[**get_download_info**](DownloadApi.md#get_download_info) | **POST** /download/info | Retrieve download information
# **download_archive**
> bytearray download_archive(download_archive_dto, key=key, slug=slug)
Download asset archive
Download a ZIP archive containing the specified assets. The assets must have been previously requested via the "getDownloadInfo" endpoint.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.download_archive_dto import DownloadArchiveDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DownloadApi(api_client)
download_archive_dto = generated.immich.openapi_client.DownloadArchiveDto() # DownloadArchiveDto |
key = 'key_example' # str | (optional)
slug = 'slug_example' # str | (optional)
try:
# Download asset archive
api_response = api_instance.download_archive(download_archive_dto, key=key, slug=slug)
print("The response of DownloadApi->download_archive:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DownloadApi->download_archive: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**download_archive_dto** | [**DownloadArchiveDto**](DownloadArchiveDto.md)| |
**key** | **str**| | [optional]
**slug** | **str**| | [optional]
### Return type
**bytearray**
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/octet-stream
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_download_info**
> DownloadResponseDto get_download_info(download_info_dto, key=key, slug=slug)
Retrieve download information
Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto
from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DownloadApi(api_client)
download_info_dto = generated.immich.openapi_client.DownloadInfoDto() # DownloadInfoDto |
key = 'key_example' # str | (optional)
slug = 'slug_example' # str | (optional)
try:
# Retrieve download information
api_response = api_instance.get_download_info(download_info_dto, key=key, slug=slug)
print("The response of DownloadApi->get_download_info:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DownloadApi->get_download_info: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**download_info_dto** | [**DownloadInfoDto**](DownloadInfoDto.md)| |
**key** | **str**| | [optional]
**slug** | **str**| | [optional]
### Return type
[**DownloadResponseDto**](DownloadResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# DownloadArchiveInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_ids** | **List[UUID]** | Asset IDs in this archive |
**size** | **int** | Archive size in bytes |
## Example
```python
from generated.immich.openapi_client.models.download_archive_info import DownloadArchiveInfo
# TODO update the JSON string below
json = "{}"
# create an instance of DownloadArchiveInfo from a JSON string
download_archive_info_instance = DownloadArchiveInfo.from_json(json)
# print the JSON string representation of the object
print(DownloadArchiveInfo.to_json())
# convert the object into a dict
download_archive_info_dict = download_archive_info_instance.to_dict()
# create an instance of DownloadArchiveInfo from a dict
download_archive_info_from_dict = DownloadArchiveInfo.from_dict(download_archive_info_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,32 +0,0 @@
# DownloadInfoDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_id** | **UUID** | Album ID to download | [optional]
**archive_size** | **int** | Archive size limit in bytes | [optional]
**asset_ids** | **List[UUID]** | Asset IDs to download | [optional]
**user_id** | **UUID** | User ID to download assets from | [optional]
## Example
```python
from generated.immich.openapi_client.models.download_info_dto import DownloadInfoDto
# TODO update the JSON string below
json = "{}"
# create an instance of DownloadInfoDto from a JSON string
download_info_dto_instance = DownloadInfoDto.from_json(json)
# print the JSON string representation of the object
print(DownloadInfoDto.to_json())
# convert the object into a dict
download_info_dto_dict = download_info_dto_instance.to_dict()
# create an instance of DownloadInfoDto from a dict
download_info_dto_from_dict = DownloadInfoDto.from_dict(download_info_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# DownloadResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archive_size** | **int** | Maximum archive size in bytes |
**include_embedded_videos** | **bool** | Whether to include embedded videos in downloads |
## Example
```python
from generated.immich.openapi_client.models.download_response import DownloadResponse
# TODO update the JSON string below
json = "{}"
# create an instance of DownloadResponse from a JSON string
download_response_instance = DownloadResponse.from_json(json)
# print the JSON string representation of the object
print(DownloadResponse.to_json())
# convert the object into a dict
download_response_dict = download_response_instance.to_dict()
# create an instance of DownloadResponse from a dict
download_response_from_dict = DownloadResponse.from_dict(download_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# DownloadResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archives** | [**List[DownloadArchiveInfo]**](DownloadArchiveInfo.md) | Archive information |
**total_size** | **int** | Total size in bytes |
## Example
```python
from generated.immich.openapi_client.models.download_response_dto import DownloadResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of DownloadResponseDto from a JSON string
download_response_dto_instance = DownloadResponseDto.from_json(json)
# print the JSON string representation of the object
print(DownloadResponseDto.to_json())
# convert the object into a dict
download_response_dto_dict = download_response_dto_instance.to_dict()
# create an instance of DownloadResponseDto from a dict
download_response_dto_from_dict = DownloadResponseDto.from_dict(download_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# DownloadUpdate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**archive_size** | **int** | Maximum archive size in bytes | [optional]
**include_embedded_videos** | **bool** | Whether to include embedded videos in downloads | [optional]
## Example
```python
from generated.immich.openapi_client.models.download_update import DownloadUpdate
# TODO update the JSON string below
json = "{}"
# create an instance of DownloadUpdate from a JSON string
download_update_instance = DownloadUpdate.from_json(json)
# print the JSON string representation of the object
print(DownloadUpdate.to_json())
# convert the object into a dict
download_update_dict = download_update_instance.to_dict()
# create an instance of DownloadUpdate from a dict
download_update_from_dict = DownloadUpdate.from_dict(download_update_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,30 +0,0 @@
# DuplicateDetectionConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Whether the task is enabled |
**max_distance** | **float** | Maximum distance threshold for duplicate detection |
## Example
```python
from generated.immich.openapi_client.models.duplicate_detection_config import DuplicateDetectionConfig
# TODO update the JSON string below
json = "{}"
# create an instance of DuplicateDetectionConfig from a JSON string
duplicate_detection_config_instance = DuplicateDetectionConfig.from_json(json)
# print the JSON string representation of the object
print(DuplicateDetectionConfig.to_json())
# convert the object into a dict
duplicate_detection_config_dict = duplicate_detection_config_instance.to_dict()
# create an instance of DuplicateDetectionConfig from a dict
duplicate_detection_config_from_dict = DuplicateDetectionConfig.from_dict(duplicate_detection_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# DuplicateResponseDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assets** | [**List[AssetResponseDto]**](AssetResponseDto.md) | Duplicate assets |
**duplicate_id** | **UUID** | Duplicate group ID |
**suggested_keep_asset_ids** | **List[UUID]** | Suggested asset IDs to keep based on file size and EXIF data |
## Example
```python
from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of DuplicateResponseDto from a JSON string
duplicate_response_dto_instance = DuplicateResponseDto.from_json(json)
# print the JSON string representation of the object
print(DuplicateResponseDto.to_json())
# convert the object into a dict
duplicate_response_dto_dict = duplicate_response_dto_instance.to_dict()
# create an instance of DuplicateResponseDto from a dict
duplicate_response_dto_from_dict = DuplicateResponseDto.from_dict(duplicate_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,372 +0,0 @@
# generated.immich.openapi_client.DuplicatesApi
All URIs are relative to *https://github.com/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_duplicate**](DuplicatesApi.md#delete_duplicate) | **DELETE** /duplicates/{id} | Dismiss a duplicate group
[**delete_duplicates**](DuplicatesApi.md#delete_duplicates) | **DELETE** /duplicates | Delete duplicates
[**get_asset_duplicates**](DuplicatesApi.md#get_asset_duplicates) | **GET** /duplicates | Retrieve duplicates
[**resolve_duplicates**](DuplicatesApi.md#resolve_duplicates) | **POST** /duplicates/resolve | Resolve duplicate groups
# **delete_duplicate**
> delete_duplicate(id)
Dismiss a duplicate group
Dismiss a duplicate group by its ID, unlinking all assets in the group without deleting them.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |
try:
# Dismiss a duplicate group
api_instance.delete_duplicate(id)
except Exception as e:
print("Exception when calling DuplicatesApi->delete_duplicate: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **UUID**| |
### Return type
void (empty response body)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **delete_duplicates**
> delete_duplicates(bulk_ids_dto)
Delete duplicates
Delete multiple duplicate assets specified by their IDs.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.bulk_ids_dto import BulkIdsDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
bulk_ids_dto = generated.immich.openapi_client.BulkIdsDto() # BulkIdsDto |
try:
# Delete duplicates
api_instance.delete_duplicates(bulk_ids_dto)
except Exception as e:
print("Exception when calling DuplicatesApi->delete_duplicates: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**bulk_ids_dto** | [**BulkIdsDto**](BulkIdsDto.md)| |
### Return type
void (empty response body)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_asset_duplicates**
> List[DuplicateResponseDto] get_asset_duplicates()
Retrieve duplicates
Retrieve a list of duplicate assets available to the authenticated user.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.duplicate_response_dto import DuplicateResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
try:
# Retrieve duplicates
api_response = api_instance.get_asset_duplicates()
print("The response of DuplicatesApi->get_asset_duplicates:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DuplicatesApi->get_asset_duplicates: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List[DuplicateResponseDto]**](DuplicateResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **resolve_duplicates**
> List[BulkIdResponseDto] resolve_duplicates(duplicate_resolve_dto)
Resolve duplicate groups
Resolve duplicate groups by synchronizing metadata across assets and deleting/trashing duplicates.
### Example
* Api Key Authentication (cookie):
* Api Key Authentication (api_key):
* Bearer (JWT) Authentication (bearer):
```python
import generated.immich.openapi_client
from generated.immich.openapi_client.models.bulk_id_response_dto import BulkIdResponseDto
from generated.immich.openapi_client.models.duplicate_resolve_dto import DuplicateResolveDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
host = "https://github.com/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = generated.immich.openapi_client.DuplicatesApi(api_client)
duplicate_resolve_dto = generated.immich.openapi_client.DuplicateResolveDto() # DuplicateResolveDto |
try:
# Resolve duplicate groups
api_response = api_instance.resolve_duplicates(duplicate_resolve_dto)
print("The response of DuplicatesApi->resolve_duplicates:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DuplicatesApi->resolve_duplicates: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**duplicate_resolve_dto** | [**DuplicateResolveDto**](DuplicateResolveDto.md)| |
### Return type
[**List[BulkIdResponseDto]**](BulkIdResponseDto.md)
### Authorization
[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# EmailNotificationsResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_invite** | **bool** | Whether to receive email notifications for album invites |
**album_update** | **bool** | Whether to receive email notifications for album updates |
**enabled** | **bool** | Whether email notifications are enabled |
## Example
```python
from generated.immich.openapi_client.models.email_notifications_response import EmailNotificationsResponse
# TODO update the JSON string below
json = "{}"
# create an instance of EmailNotificationsResponse from a JSON string
email_notifications_response_instance = EmailNotificationsResponse.from_json(json)
# print the JSON string representation of the object
print(EmailNotificationsResponse.to_json())
# convert the object into a dict
email_notifications_response_dict = email_notifications_response_instance.to_dict()
# create an instance of EmailNotificationsResponse from a dict
email_notifications_response_from_dict = EmailNotificationsResponse.from_dict(email_notifications_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,31 +0,0 @@
# EmailNotificationsUpdate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**album_invite** | **bool** | Whether to receive email notifications for album invites | [optional]
**album_update** | **bool** | Whether to receive email notifications for album updates | [optional]
**enabled** | **bool** | Whether email notifications are enabled | [optional]
## Example
```python
from generated.immich.openapi_client.models.email_notifications_update import EmailNotificationsUpdate
# TODO update the JSON string below
json = "{}"
# create an instance of EmailNotificationsUpdate from a JSON string
email_notifications_update_instance = EmailNotificationsUpdate.from_json(json)
# print the JSON string representation of the object
print(EmailNotificationsUpdate.to_json())
# convert the object into a dict
email_notifications_update_dict = email_notifications_update_instance.to_dict()
# create an instance of EmailNotificationsUpdate from a dict
email_notifications_update_from_dict = EmailNotificationsUpdate.from_dict(email_notifications_update_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,51 +0,0 @@
# ExifResponseDto
EXIF response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**city** | **str** | City name | [optional]
**country** | **str** | Country name | [optional]
**date_time_original** | **datetime** | Original date/time | [optional]
**description** | **str** | Image description | [optional]
**exif_image_height** | **int** | Image height in pixels | [optional]
**exif_image_width** | **int** | Image width in pixels | [optional]
**exposure_time** | **str** | Exposure time | [optional]
**f_number** | **float** | F-number (aperture) | [optional]
**file_size_in_byte** | **int** | File size in bytes | [optional]
**focal_length** | **float** | Focal length in mm | [optional]
**iso** | **int** | ISO sensitivity | [optional]
**latitude** | **float** | GPS latitude | [optional]
**lens_model** | **str** | Lens model | [optional]
**longitude** | **float** | GPS longitude | [optional]
**make** | **str** | Camera make | [optional]
**model** | **str** | Camera model | [optional]
**modify_date** | **datetime** | Modification date/time | [optional]
**orientation** | **str** | Image orientation | [optional]
**projection_type** | **str** | Projection type | [optional]
**rating** | **int** | Rating | [optional]
**state** | **str** | State/province name | [optional]
**time_zone** | **str** | Time zone | [optional]
## Example
```python
from generated.immich.openapi_client.models.exif_response_dto import ExifResponseDto
# TODO update the JSON string below
json = "{}"
# create an instance of ExifResponseDto from a JSON string
exif_response_dto_instance = ExifResponseDto.from_json(json)
# print the JSON string representation of the object
print(ExifResponseDto.to_json())
# convert the object into a dict
exif_response_dto_dict = exif_response_dto_instance.to_dict()
# create an instance of ExifResponseDto from a dict
exif_response_dto_from_dict = ExifResponseDto.from_dict(exif_response_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Some files were not shown because too many files have changed in this diff Show More